From: "Ludovic Courtès" <ludo@gnu.org>
To: "Paul A. Patience" <paul@apatience.com>
Cc: "guix-devel@gnu.org" <guix-devel@gnu.org>
Subject: Re: What is the standard path for documentation?
Date: Tue, 08 Jun 2021 15:31:29 +0200 [thread overview]
Message-ID: <87lf7kfpou.fsf@gnu.org> (raw)
In-Reply-To: <VbM1b2VDklV7Xm00zeChkEsxJA-BR2CKozzWj-dEuLDk9UpA-GdZr3LM0vE43K1eLTaf1WTT1Qd-CmmvW5T12jN6vnMzXAmRb0bPhZ7b954=@apatience.com> (Paul A. Patience's message of "Wed, 02 Jun 2021 16:37:38 +0000")
Hi Paul,
"Paul A. Patience" <paul@apatience.com> skribis:
> What is the standard place to put documentation?
> The license files are automatically installed to the
> share/doc/NAME-VERSION directory
> (see install-licence-files in gnu-build-system.scm),
> but it seems like various packages install the actual
> documentation to share/doc/NAME.
Right, share/doc/NAME appears to be more common (perhaps we should fix
‘install-licence-files’).
> Also, is it alright for files in the documentation directories
> to refer to various other directories in the store?
> Deal.II installs the attached files as documentation, but
> I thought I saw the source of a Guix package make an attempt
> to strip build directory information from one of its output
> files.
Reference to the build directories are not great but OK.
However, the two log files you mention refer to build-time tools. As a
result, if you install those, the total size reported by ‘guix size
dealii’ will be noticeably bigger because the set of “references”
(run-time dependencies) would not include things like GCC and so on,
even though they are not actually used at run time.
Thus, I would not install these two files, especially since they seem to
be redundant with Guix-supported provenance tracking.
HTH!
Ludo’.
next prev parent reply other threads:[~2021-06-08 13:31 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-02 16:37 What is the standard path for documentation? Paul A. Patience
2021-06-08 13:31 ` Ludovic Courtès [this message]
2021-06-08 16:30 ` Paul A. Patience
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=87lf7kfpou.fsf@gnu.org \
--to=ludo@gnu.org \
--cc=guix-devel@gnu.org \
--cc=paul@apatience.com \
/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).