Annotated guix source folder tree

Annotated guix source folder tree

[swedebugia]

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

Re: Annotated guix source folder tree

[Pierre Neidhardt]

[-- 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 --]

Re: Annotated guix source folder tree

[swedebugia]

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

Re: Annotated guix source folder tree

[Oleg Pykhalov]

[-- 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 --]

Re: Annotated guix source folder tree

[swedebugia]

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