From 4feb589bf48cbbd2d524002456fa822acf856bc3 Mon Sep 17 00:00:00 2001 From: Pierre Neidhardt Date: Wed, 10 Oct 2018 18:06:08 +0200 Subject: doc: Add recommendations for good origin URLs. * doc/contributing.texi (Submitting Patches): URL recommendations. --- doc/contributing.texi | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'doc/contributing.texi') diff --git a/doc/contributing.texi b/doc/contributing.texi index 68d8e7e2fb..91a87ef2dd 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -468,6 +468,14 @@ Please follow our code formatting rules, possibly running the @command{etc/indent-code.el} script to do that automatically for you (@pxref{Formatting Code}). +@item +When possible, use mirrors in the source URL (@pxref{Invoking guix download}). +Use reliable URLs, not generated ones. For instance, GitHub archives are not +necessarily identical from one generation to the next, so in this case it's +often better to clone the repository. Don't use the @command{name} field in +the URL: it is not very useful and if the name changes, the URL will probably +be wrong. + @end enumerate When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as -- cgit v1.2.3 From bca6396749492ea9f48b4bc31054d986e31b3e52 Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Fri, 16 Nov 2018 23:16:05 +0100 Subject: doc: Mention that ./pre-inst-env is generated. Suggested by swedebugia . * doc/contributing.texi (Running Guix Before It Is Installed): Mention that ./pre-inst-env is generated. --- doc/contributing.texi | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'doc/contributing.texi') diff --git a/doc/contributing.texi b/doc/contributing.texi index 91a87ef2dd..7417f28d14 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -112,7 +112,8 @@ run @code{make install}. To do that, you first need to have an environment with all the dependencies available (@pxref{Building from Git}), and then simply prefix each command with @command{./pre-inst-env} (the @file{pre-inst-env} script lives in the -top build tree of Guix), as in@footnote{The @option{-E} flag to +top build tree of Guix; it is generated by @command{./configure}), +as in@footnote{The @option{-E} flag to @command{sudo} guarantees that @code{GUILE_LOAD_PATH} is correctly set such that @command{guix-daemon} and the tools it uses can find the Guile modules they need.}: -- cgit v1.2.3