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

[Ludovic Courtès]

Hello!

"pelzflorian (Florian Pelz)" <pelzflorian@pelzflorian.de> skribis:

> This section seems to be a good idea in general, but the examples are an
> opinionated selection.  I believe the list should be small.  Listing
> individual modules directly in ~/src/guix/guix directory is not useful
> to newcomers or often self-explanatory.  gnu/installer, gnu/system,
> gnu/build, gnu/machine is not useful to know.

Are you suggesting to remove the examples?

If that’s the case, we might as well not add the section or it would
become a bullet list with three items (guix/, gnu/, and tests/), no?

The selection is opinionated, indeed.  My thought was that it was a way
to connect the dots among things presented in the manual and to provide
a “guided tour” pretty much like Josselin’s talk.

> po is better not talked about, otherwise people edit translations
> directly in po, when they should use Weblate.

Not sure; there’s a link to “Translating Guix” that explains what to do.

>> +@table @file
>> +@item guix
>> +This is the location of core Guix mechanisms.  A few examples:
>
> What does core mean?

The examples were meant to illustrate what is meant by “core”.  Do you
think some other adjective or a longer description would help?

> Perhaps (guix …) should be listed after (gnu …)  and defined as the
> Guix mechanisms that do not belong in gnu?  Not quite sure either.

The order I chose is (roughly) from lower-level to higher-level:

(guix store) -> (guix derivation) -> (guix packages) -> …
… -> (gnu packages) -> (gnu system) -> …

Does that make sense?

Thanks for your feedback!

Ludo’.