unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: "pelzflorian (Florian Pelz)" <pelzflorian@pelzflorian.de>
To: "Ludovic Courtès" <ludo@gnu.org>
Cc: 69587@debbugs.gnu.org
Subject: [bug#69587] [PATCH v2] doc: Add “Source Tree Structure” section.
Date: Wed, 20 Mar 2024 18:05:04 +0100	[thread overview]
Message-ID: <87bk78u94v.fsf@pelzflorian.de> (raw)
In-Reply-To: <4b50aca680226c4eeba9b83f1d82d935aaae382d.1710931512.git.ludo@gnu.org> ("Ludovic Courtès"'s message of "Wed, 20 Mar 2024 11:49:13 +0100")

Hello, some small things to fix:

Ludovic Courtès <ludo@gnu.org> writes:
> +The following table gives an overview of the main directories and what
> +they contain.  Remember that in Guile, each module name is derived from
> +its file name---e.g., the module in file@file{guix/packages.scm}

The file@file should be @file, I presume.



> […]
> +The directories we have seen so far all live under @file{guix/}.  The
> +other important place is the @file{gnu/} directory, which contains
> +primarily package definitions as well as libraries and tools for Guix
> +System (@pxref{System Configuration}) and Guix Home (@pxref{Home
> +Configuration}), all of which build upon functionality provided by
> +@code{(guix @dots{})} modules@footnote{For this reason, @code{(guix
> +@dots{})}  modules

The double space is inappropriate.


> must generally not depend on @code{(gnu @dots{})}
> +modules, with one notable exception:

Perhaps better mention all three exceptions, not only build-system but
also direct #:use-module in scripts like pack and to a lesser degree
import.


> +@item po
> +This is the location of translations of Guix itself, of package synopses
> +and descriptions, of the manual, and of the cookbook.  Note that
> +@file{.po} files that live here are pulled directly from Weblate
> +(@pxref{Translating Guix}).`

At the end is a stray `.


> +With all this, a fair chunk of your operating system is at your
> +fingertips!  Beyond @command{grep} and @command{git grep}, @pxref{The
> +Perfect Setup} on how to navigate code from your editor, and
> +@pxref{Using Guix Interactively} for information on how to use
> +interactively use Scheme modules.  Enjoy!

The word “use” is duplicated.

Otherwise I’m happy and it LGTM.  Thank you!

Regards,
Florian




  reply	other threads:[~2024-03-20 18:21 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-06 16:37 [bug#69587] [PATCH] doc: Add “Source Tree Structure” section Ludovic Courtès
2024-03-08 18:01 ` pelzflorian (Florian Pelz)
2024-03-08 22:06   ` Ludovic Courtès
2024-03-09 14:38     ` pelzflorian (Florian Pelz)
2024-03-11 17:05       ` Ludovic Courtès
2024-03-11 18:09         ` pelzflorian (Florian Pelz)
2024-03-13 21:45           ` Ludovic Courtès
2024-03-14 11:30             ` pelzflorian (Florian Pelz)
2024-03-19 14:16               ` Ludovic Courtès
2024-03-20 10:49                 ` [bug#69587] [PATCH v2] " Ludovic Courtès
2024-03-20 17:05                   ` pelzflorian (Florian Pelz) [this message]
2024-03-21 16:49                     ` bug#69587: " Ludovic Courtès
2024-03-12 16:35         ` [bug#69587] [PATCH] " Giovanni Biscuolo
2024-03-12 18:41           ` pelzflorian (Florian Pelz)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87bk78u94v.fsf@pelzflorian.de \
    --to=pelzflorian@pelzflorian.de \
    --cc=69587@debbugs.gnu.org \
    --cc=ludo@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).