From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Pierre Neidhardt <mail@ambrevar.xyz>
Cc: Julien Lepiller <julien@lepiller.eu>, Alex Griffin <a@ajgrf.com>,
39599@debbugs.gnu.org
Subject: [bug#39599] [PATCH 1/4] build-system: Add copy-build-system.
Date: Fri, 21 Feb 2020 12:43:21 +0100 [thread overview]
Message-ID: <87lfowf9nq.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <87tv3k42r6.fsf@ambrevar.xyz> (Pierre Neidhardt's message of "Fri, 21 Feb 2020 12:07:57 +0100")
Pierre Neidhardt <mail@ambrevar.xyz> writes:
> Oh, yes, I see that. I thought it would help with readability. How are
> we supposed to visualize nested @itemize at the moment?
I don't think there's a clear answer, but, IMO, for readability sake, we
should not (ab)use nested lists in a manual.
There are three levels of such lists here. I think this is not
necessary. For example
--8<---------------cut here---------------start------------->8---
@item When @var{source} matches a file or directory without trailing slash, install it to @var{target}.
@itemize
@item If @var{target} has a trailing slash, install @var{source} basename beneath @var{target}.
@item Otherwise install @var{source} as @var{target}.
@end itemize
--8<---------------cut here---------------end--------------->8---
could be written as, e.g.,
--8<---------------cut here---------------start------------->8---
@item
When @var{source} matches a file or directory without a trailing slash,
install it to @var{target}. More accurately, if @var{target} ends with
a slash, install @var{source} basename beneath @var{target} directory.
Otherwise install @var{source} as @var{target}.
--8<---------------cut here---------------end--------------->8---
Similarly, instead of discussing about #:include and al. in a nested
list, this could happen in a subsequent paragraph, once "source" and
"target" are clarified, i.e., after "In all cases, the paths (BTW,
shouldn't it be "file names"?) relative to @var{source} are preserved
within @var{target}."
As a side note, are you sure about: "With @code{#:include}, install all
the files which (I would use "whose" here, but I'm not a native speaker)
path suffix (isn't it "basename" or, possibly better, "base name"
instead?) exactly matches one of the elements in the given list"? Do you
really mean that a file name matching two regexps is _not_ going to be
included?
Note that I know writing documentation is tedious; I don't want to sound
negative or boring.
Regards,
next prev parent reply other threads:[~2020-02-21 11:44 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-14 12:51 [bug#39599] [PATCH 0/2] New build system: copy-build-system Pierre Neidhardt
2020-02-14 12:53 ` [bug#39599] [PATCH 1/2] build-system: Add copy-build-system Pierre Neidhardt
2020-02-14 12:53 ` [bug#39599] [PATCH 2/2] gnu: gcide: Use the copy-build-system Pierre Neidhardt
2020-02-14 13:39 ` [bug#39599] [PATCH 1/2] build-system: Add copy-build-system Giovanni Biscuolo
2020-02-16 13:16 ` Pierre Neidhardt
2020-02-17 11:12 ` [bug#39599] [PATCH 1/4] " Pierre Neidhardt
2020-02-17 11:12 ` [bug#39599] [PATCH 2/4] gnu: gcide: Use the copy-build-system Pierre Neidhardt
2020-02-17 11:12 ` [bug#39599] [PATCH 3/4] gnu: Add clojure-wrapper Pierre Neidhardt
2020-02-17 11:12 ` [bug#39599] [PATCH 4/4] gnu: net-base: Use copy build system Pierre Neidhardt
2020-02-17 11:48 ` [bug#39599] [PATCH 1/4] build-system: Add copy-build-system Mathieu Othacehe
2020-02-20 9:47 ` Ricardo Wurmus
2020-02-20 10:00 ` Pierre Neidhardt
2020-02-20 1:06 ` Alex Griffin
2020-02-20 8:40 ` Pierre Neidhardt
2020-02-20 8:44 ` Mathieu Othacehe
2020-02-20 15:41 ` Pierre Neidhardt
2020-02-20 17:09 ` [bug#39599] " Julien Lepiller
2020-02-20 18:00 ` Pierre Neidhardt
2020-02-21 9:53 ` Pierre Neidhardt
2020-02-21 10:43 ` Nicolas Goaziou
2020-02-21 11:07 ` Pierre Neidhardt
2020-02-21 11:43 ` Nicolas Goaziou [this message]
2020-02-21 12:04 ` Pierre Neidhardt
2020-02-21 11:50 ` Tobias Geerinckx-Rice via Guix-patches via
2020-02-21 12:06 ` Pierre Neidhardt
2020-02-21 3:37 ` [bug#39599] Jack Hill
2020-02-21 3:37 ` [bug#39599] [PATCH v2] gnu: Add gnome-shell-extension-paperwm Jack Hill
2020-02-21 14:34 ` Alex Griffin
2020-02-21 16:22 ` Jack Hill
2020-02-21 18:48 ` Alex Griffin
2020-02-21 18:51 ` Jack Hill
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87lfowf9nq.fsf@nicolasgoaziou.fr \
--to=mail@nicolasgoaziou.fr \
--cc=39599@debbugs.gnu.org \
--cc=a@ajgrf.com \
--cc=julien@lepiller.eu \
--cc=mail@ambrevar.xyz \
/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 external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.