From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:470:142:3::10]:40256) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hmBjP-00036g-F2 for guix-patches@gnu.org; Sat, 13 Jul 2019 02:42:04 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hmBjO-0006Pm-2i for guix-patches@gnu.org; Sat, 13 Jul 2019 02:42:03 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:60786) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hmBjN-0006P8-UU for guix-patches@gnu.org; Sat, 13 Jul 2019 02:42:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hmBjN-0002Jd-PF for guix-patches@gnu.org; Sat, 13 Jul 2019 02:42:01 -0400 Subject: [bug#36635] Simplify contributing instructions Resent-Message-ID: Received: from eggs.gnu.org ([2001:470:142:3::10]:40177) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hmBj8-00033i-Jc for guix-patches@gnu.org; Sat, 13 Jul 2019 02:41:47 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hmBj7-0005tr-8R for guix-patches@gnu.org; Sat, 13 Jul 2019 02:41:46 -0400 Received: from pelzflorian.de ([5.45.111.108]:55790 helo=mail.pelzflorian.de) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hmBj6-0005pt-KH for guix-patches@gnu.org; Sat, 13 Jul 2019 02:41:45 -0400 Received: from pelzflorian.localdomain (unknown [5.45.111.108]) by mail.pelzflorian.de (Postfix) with ESMTPSA id 605233600E9 for ; Sat, 13 Jul 2019 08:41:41 +0200 (CEST) Date: Sat, 13 Jul 2019 08:41:40 +0200 From: "pelzflorian (Florian Pelz)" Message-ID: <20190713064140.froxjbrj4pzzsfh2@pelzflorian.localdomain> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="xd7wotvy4h5ecbve" Content-Disposition: inline List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+kyle=kyleam.com@gnu.org Sender: "Guix-patches" To: 36635@debbugs.gnu.org --xd7wotvy4h5ecbve Content-Type: text/plain; charset=us-ascii Content-Disposition: inline I believe we want to be able to refer users who have bugs to the Guix manual sections on Contributing. In , the contributing instructions in the Guix manual were not understood properly. I hope the attached patch could alleviate this a little. Regards, Florian --xd7wotvy4h5ecbve Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename="0001-doc-Reorder-and-clarify-contributing-instructions.patch" >From 3d6f944daa314e3bf064ef262a5c79ada1c70e6e Mon Sep 17 00:00:00 2001 From: Florian Pelz Date: Sat, 13 Jul 2019 08:29:26 +0200 Subject: [PATCH] doc: Reorder and clarify contributing instructions. * doc/contributing.texi (Building from Git, Running Guix Before It Is Installed): Make instructions using Guix come first and clarify which code is an instruction and which is merely an example. --- doc/contributing.texi | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/doc/contributing.texi b/doc/contributing.texi index e00634eed4..f5eff842b9 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -38,19 +38,6 @@ version from the Git repository: git clone https://git.savannah.gnu.org/git/guix.git @end example -When building Guix from a checkout, -the following packages are required in addition to those mentioned in -the installation instructions (@pxref{Requirements}). - -@itemize -@item @url{http://gnu.org/software/autoconf/, GNU Autoconf}; -@item @url{http://gnu.org/software/automake/, GNU Automake}; -@item @url{http://gnu.org/software/gettext/, GNU Gettext}; -@item @url{http://gnu.org/software/texinfo/, GNU Texinfo}; -@item @url{http://www.graphviz.org/, Graphviz}; -@item @url{http://www.gnu.org/software/help2man/, GNU Help2man (optional)}. -@end itemize - The easiest way to set up a development environment for Guix is, of course, by using Guix! The following command starts a new shell where all the dependencies and appropriate environment variables are set up to @@ -61,7 +48,22 @@ guix environment guix --pure @end example @xref{Invoking guix environment}, for more information on that command. -Extra dependencies can be added with @option{--ad-hoc}: + +If you are unable to use Guix when building Guix from a checkout, the +following are the required packages in addition to those mentioned in the +installation instructions (@pxref{Requirements}). + +@itemize +@item @url{http://gnu.org/software/autoconf/, GNU Autoconf}; +@item @url{http://gnu.org/software/automake/, GNU Automake}; +@item @url{http://gnu.org/software/gettext/, GNU Gettext}; +@item @url{http://gnu.org/software/texinfo/, GNU Texinfo}; +@item @url{http://www.graphviz.org/, Graphviz}; +@item @url{http://www.gnu.org/software/help2man/, GNU Help2man (optional)}. +@end itemize + +On Guix, extra dependencies can be added by instead running @command{guix +environment} with @option{--ad-hoc}: @example guix environment guix --pure --ad-hoc help2man git strace @@ -113,8 +115,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; it is generated by @command{./configure}), -as in@footnote{The @option{-E} flag to +top build tree of Guix; it is generated by @command{./configure}). +An example@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.}: @@ -125,7 +127,7 @@ $ ./pre-inst-env guix build hello @end example @noindent -Similarly, for a Guile session using the Guix modules: +Similarly, an example for a Guile session using the Guix modules: @example $ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))' -- 2.22.0 --xd7wotvy4h5ecbve--