GNU bug report logs - #69587
[PATCH] doc: Add “Source Tree Structure” section.

Previous Next

Full log

View this message in rfc822 format

From: "pelzflorian (Florian Pelz)" <pelzflorian <at> pelzflorian.de>
To: Giovanni Biscuolo <g <at> xelera.eu>
Cc: Ludovic Courtès <ludo <at> gnu.org>, 69587 <at> debbugs.gnu.org
Subject: [bug#69587] [PATCH] doc: Add “Source Tree Structure” section.
Date: Tue, 12 Mar 2024 19:41:06 +0100

Thank you Giovanni for voicing support; I’m afraid I sounded more
opposed than I am.

Giovanni Biscuolo <g <at> xelera.eu> writes:
> Also, please don't (dis)miss the usefulness of such documentation as a
> sort of meta-literate programming, probably also useful for expert Guix
> programmers too, IMHO

Do you think the following controversial parts should stay?  But what is
their audience, and why explain them but not the directories build-aux
and nix and some other not so important files in guix?

‘gnu/system’
     These are core Guix System modules, such as:

     ‘(gnu system)’
          Defines ‘operating-system’ (*note operating-system
          Reference::).
     ‘(gnu system file-systems)’
          Defines ‘file-system’ (*note File Systems::).
     ‘(gnu system mapped-devices)’
          Defines ‘mapped-device’ (*note Mapped Devices::).

‘gnu/build’
     These are modules that are either used on the “build side” when
     building operating systems or packages, or at run time by operating
     systems.

     ‘(gnu build accounts)’
          Creating ‘/etc/passwd’, ‘/etc/shadow’, etc.  (*note User
          Accounts::).
     ‘(gnu build activation)’
          Activating an operating system at boot time or reconfiguration
          time.
     ‘(gnu build file-systems)’
          Searching, checking, and mounting file systems.
     ‘(gnu build linux-boot)’
     ‘(gnu build hurd-boot)’
          Booting GNU/Linux and GNU/Hurd operating systems.
     ‘(gnu build linux-initrd)’
          Creating a Linux initial RAM disk (*note Initial RAM Disk::).

[…]
‘gnu/installer’
     This contains the text-mode graphical system installer (*note
     Guided Graphical Installation::).

‘gnu/machine’
     These are the “machine abstractions” used by ‘guix deploy’ (*note
     Invoking guix deploy::).

[…]
‘po’
     This is the location of translations of Guix itself, of package
     synopses and descriptions, of the manual, and of the cookbook
     (*note Translating Guix::).

> Last but not least, I have a feeling it's time to split the Guix manual
> in two: one for users, like "GNU Guix User Manual" and one for
> programmers [1], like "GNU Guix Programmer Manual", with chapters like
> "Programming Interface", "Platforms", "Bootstrapping", "Porting",
> "Contributing"... but that's another story, OT here.

Hmm why?  But yes, another story.

Regards,
Florian

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.