From mboxrd@z Thu Jan 1 00:00:00 1970 From: Ricardo Wurmus Subject: improve installation instructions Date: Sat, 05 Jan 2019 17:58:52 +0100 Message-ID: <87k1jjrqgj.fsf@mdc-berlin.de> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggsout.gnu.org ([209.51.188.92]:42304 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gfpHx-0005MX-Kv for guix-devel@gnu.org; Sat, 05 Jan 2019 11:59:10 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gfpHu-0006e9-FV for guix-devel@gnu.org; Sat, 05 Jan 2019 11:59:09 -0500 Received: from sender-of-o53.zoho.com ([135.84.80.218]:21841) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gfpHu-0006bd-4a for guix-devel@gnu.org; Sat, 05 Jan 2019 11:59:06 -0500 List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org Sender: "Guix-devel" To: guix-devel@gnu.org Hey, I just installed Guix as a package manager on an aarch64 box. The manual makes it a little difficult to perform all these steps, because the commands cannot be easily copied. We do have the shell script, but the manual mentions it only in passing =E2=80=93 as a user I skipped over t= he introduction and went straight to step 1, right past the script. What do you think about mentioning the script in the Installation section and only asking users to look in the subsections for details? Here=E2=80=99s a draft patch: --8<---------------cut here---------------start------------->8--- diff --git a/doc/guix.texi b/doc/guix.texi index fcb5b8c08..f9afe2bc3 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -25,7 +25,7 @@ Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* Copyright @copyright{} 2014 Pierre-Antoine Rault@* Copyright @copyright{} 2015 Taylan Ulrich Bay=C4=B1rl=C4=B1/Kammer@* Copyright @copyright{} 2015, 2016, 2017 Leo Famulari@* -Copyright @copyright{} 2015, 2016, 2017, 2018 Ricardo Wurmus@* +Copyright @copyright{} 2015, 2016, 2017, 2018, 2019 Ricardo Wurmus@* Copyright @copyright{} 2016 Ben Woodcroft@* Copyright @copyright{} 2016, 2017, 2018 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018 Efraim Flashner@* @@ -394,29 +394,32 @@ garbage collection of packages (@pxref{Features}). @chapter Installation =20 @cindex installing Guix -@cindex official website -GNU Guix is available for download from its website at -@url{http://www.gnu.org/software/guix/}. This section describes the -software requirements of Guix, as well as how to install it and get -ready to use it. =20 -Note that this section is concerned with the installation of the package -manager, which can be done on top of a running GNU/Linux system. If, -instead, you want to install the complete GNU operating system, -@pxref{System Installation}. +We recommend the use of this +@uref{https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh, +shell installer script} to install Guix on top of a running GNU/Linux syst= em, +thereafter called a @dfn{foreign distro}.@footnote{This section is concern= ed +with the installation of the package manager, which can be done on top of a +running GNU/Linux system. If, instead, you want to install the complete G= NU +operating system, @pxref{System Installation}.} The script automates the +download, installation, and initial configuration of Guix. It should be r= un +as the root user. =20 @cindex foreign distro @cindex directories related to foreign distro - -When installed on a running GNU/Linux system---thereafter called a -@dfn{foreign distro}---GNU@tie{}Guix complements the available tools -without interference. Its data lives exclusively in two directories, -usually @file{/gnu/store} and @file{/var/guix}; other files on your -system, such as @file{/etc}, are left untouched. +When installed on a foreign distro, GNU@tie{}Guix complements the available +tools without interference. Its data lives exclusively in two directories, +usually @file{/gnu/store} and @file{/var/guix}; other files on your system, +such as @file{/etc}, are left untouched. =20 Once installed, Guix can be updated by running @command{guix pull} (@pxref{Invoking guix pull}). =20 +If you prefer to perform the installation steps manually or want to tweak +them, you may find the following subsections useful. They describe the +software requirements of Guix, as well as how to install it manually and g= et +ready to use it. + @menu * Binary Installation:: Getting Guix running in no time! * Requirements:: Software needed to build and run Guix. @@ -437,11 +440,6 @@ dependencies. This is often quicker than installing f= rom source, which is described in the next sections. The only requirement is to have GNU@tie{}tar and Xz. =20 -We provide a -@uref{https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh, -shell installer script}, which automates the download, installation, and -initial configuration of Guix. It should be run as the root user. - Installing goes along these lines: =20 @enumerate @@ -638,6 +636,10 @@ build procedure for Guix is the same as for other GNU = software, and is not covered here. Please see the files @file{README} and @file{INSTALL} in the Guix source tree for additional details. =20 +@cindex official website +GNU Guix is available for download from its website at +@url{https://www.gnu.org/software/guix/}. + GNU Guix depends on the following packages: =20 @itemize --8<---------------cut here---------------end--------------->8--- -- Ricardo