* Annotated guix source folder tree
@ 2018-11-07 17:44 swedebugia
2018-11-07 17:53 ` Pierre Neidhardt
2018-11-14 16:32 ` Oleg Pykhalov
0 siblings, 2 replies; 5+ messages in thread
From: swedebugia @ 2018-11-07 17:44 UTC (permalink / raw)
To: guix-devel
Hi
I exported the tree and would like an annotated version to be added to
the manual.
Would you agree that this is a good idea?
I started the annotation below for the directories I know about. :)
We could have two versions: 1 for new users with a stripped down tree
and a full version for hackers/tinkerers.
What do you think?
$ tree -d
.
├── build-aux
│ ├── cuirass
│ └── hydra
├── doc ; Documentation
│ └── images
├── etc
│ ├── completion ; Completion syntax files for
different shells
│ │ ├── bash
│ │ ├── fish
│ │ └── zsh
│ ├── git
│ ├── snippets
│ │ ├── scheme-mode
│ │ └── text-mode
│ └── substitutes
├── gnu ; Base of the modules that make up Guix
│ ├── bootloader
│ ├── build
│ ├── packages ; The packages roughly categorized in
files
│ │ ├── aux-files
│ │ │ ├── emacs
│ │ │ └── linux-libre
│ │ ├── bootstrap ; Bootstrap file for running guix on
different CPU architectures
│ │ │ ├── aarch64-linux
│ │ │ ├── armhf-linux
│ │ │ ├── i686-linux
│ │ │ ├── mips64el-linux
│ │ │ └── x86_64-linux
│ │ └── patches ; Patches used in package-records to
make software build reproducibly
│ ├── services ; Service definitions for GuixSD
│ ├── system
│ │ └── examples ; Example GuixSD operating system
definitions
│ └── tests ; Tests to ensure everything works
as expected
├── guix
│ ├── build ; Build related code running isolated
on the daemon side.
│ ├── build-system ; Build systems to handle packages
written in different programming languages
│ ├── import ; Helper code to import packages from
other package collections
│ ├── scripts
│ │ ├── container
│ │ ├── import
│ │ └── system ; Guix commands related to system
manipulation
│ ├── store ; Code related to the monadic store
managed by the daemon
│ └── tests ; Tests to ensure everything works as
expected
├── m4
├── nix ; Build daemon written in C++ yet to be
ported to Guile Scheme
│ ├── boost
│ │ └── format
│ ├── libstore
│ ├── libutil
│ ├── nix-daemon
│ └── scripts
├── po ; Translation documents
│ ├── doc
│ ├── guix
│ └── packages
├── scripts
└── tests ; Tests to ensure everything works
as expected
--
Cheers
Swedebugia
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: Annotated guix source folder tree
2018-11-07 17:44 Annotated guix source folder tree swedebugia
@ 2018-11-07 17:53 ` Pierre Neidhardt
2018-11-08 9:32 ` swedebugia
2018-11-14 16:32 ` Oleg Pykhalov
1 sibling, 1 reply; 5+ messages in thread
From: Pierre Neidhardt @ 2018-11-07 17:53 UTC (permalink / raw)
To: swedebugia; +Cc: guix-devel
[-- Attachment #1: Type: text/plain, Size: 115 bytes --]
Neat! Maybe align the "; "-prefixed comments to the same column?
--
Pierre Neidhardt
https://ambrevar.xyz/
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 487 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: Annotated guix source folder tree
2018-11-07 17:53 ` Pierre Neidhardt
@ 2018-11-08 9:32 ` swedebugia
0 siblings, 0 replies; 5+ messages in thread
From: swedebugia @ 2018-11-08 9:32 UTC (permalink / raw)
To: Pierre Neidhardt; +Cc: guix-devel
On 2018-11-07 18:53, Pierre Neidhardt wrote:
> Neat! Maybe align the "; "-prefixed comments to the same column?
I tried but Thunderbird did not enable me to do that :-\
--
Cheers
Swedebugia
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: Annotated guix source folder tree
2018-11-07 17:44 Annotated guix source folder tree swedebugia
2018-11-07 17:53 ` Pierre Neidhardt
@ 2018-11-14 16:32 ` Oleg Pykhalov
2018-11-14 18:38 ` swedebugia
1 sibling, 1 reply; 5+ messages in thread
From: Oleg Pykhalov @ 2018-11-14 16:32 UTC (permalink / raw)
To: swedebugia; +Cc: guix-devel
[-- Attachment #1: Type: text/plain, Size: 427 bytes --]
Hello.
swedebugia <swedebugia@riseup.net> writes:
> I exported the tree and would like an annotated version to be added to
> the manual.
>
> Would you agree that this is a good idea?
It could be useful. What do you think about a page similar to HIER(7)
manual? We could name it GUIX-HIER(7) similar to existing GUIX-* man
pages and it should be possible to write it in doc/guix.texi as well.
[…]
Oleg.
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: Annotated guix source folder tree
2018-11-14 16:32 ` Oleg Pykhalov
@ 2018-11-14 18:38 ` swedebugia
0 siblings, 0 replies; 5+ messages in thread
From: swedebugia @ 2018-11-14 18:38 UTC (permalink / raw)
To: Oleg Pykhalov; +Cc: guix-devel
On 2018-11-14 17:32, Oleg Pykhalov wrote:
> Hello.
>
> swedebugia <swedebugia@riseup.net> writes:
>
>> I exported the tree and would like an annotated version to be added to
>> the manual.
>>
>> Would you agree that this is a good idea?
>
> It could be useful. What do you think about a page similar to HIER(7)
> manual? We could name it GUIX-HIER(7) similar to existing GUIX-* man
> pages and it should be possible to write it in doc/guix.texi as well.
Looks good. I did not know that one.
I will prepare a patch for a subsection on the contributing section as
this is mainly relevant for contributors and can be linked to from other
parts of the manual if necessary.
--
Cheers
Swedebugia
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2018-11-14 18:39 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-11-07 17:44 Annotated guix source folder tree swedebugia
2018-11-07 17:53 ` Pierre Neidhardt
2018-11-08 9:32 ` swedebugia
2018-11-14 16:32 ` Oleg Pykhalov
2018-11-14 18:38 ` swedebugia
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).