GNU bug report logs - #40648
[PATCH] Add subsections to the Binary Installation section

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 40648 in the body.
You can then email your comments to 40648 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Steven vanZyl <rushsteve1 <at> rushsteve1.us>
To: guix-patches <at> gnu.org
Cc: Steven vanZyl <rushsteve1 <at> rushsteve1.us>
Subject: [PATCH] Add subsections to the Binary Installation section
Date: Wed, 15 Apr 2020 15:52:10 -0400

Break the Binary Installation section of the manual into two
subsections: Installation Script, and Manual Installation. With an
example for the Installation Script.

This serves to highlight the existence of the installation script as
the recommended way of installing Guix and provide an example of its
usage for users.

Additionally altered an example systemd command in the Manual
Installation section to turn two commands into one by using the --now
flag instead of calling start then enable.

Signed-off-by: Steven vanZyl <rushsteve1 <at> rushsteve1.us>
---
This is my first patch submission to Guix so I am rather new at this.
If I have made any mistakes please let me know and I will endeavor to
correct them as soon as possible.

 doc/guix.texi | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index ef5f68db24..8490977bd9 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -77,6 +77,7 @@ Copyright @copyright{} 2020 Jakub Kądziołka@*
 Copyright @copyright{} 2020 Jack Hill@*
 Copyright @copyright{} 2020 Naga Malleswari@*
 Copyright @copyright{} 2020 Brice Waegeneire@*
+Copyright @copyright{} 2020 Steven vanZyl@*
 
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -542,13 +543,25 @@ is described in the next sections.  The only requirement is to have
 GNU <at> tie{}tar and Xz.
 
 @c Note duplicated from the ``Installation'' node.
-@quotation Note
+@subsection Installation Script
+
 We recommend the use of this
 @uref{https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh,
 shell installer script}.  The script automates the download, installation, and
 initial configuration steps described below.  It should be run as the root
 user.
-@end quotation
+
+@example
+# cd /tmp/
+# wget https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh
+# chmod +x guix-install.sh
+# ./guix-install.sh
+@end example
+
+The script will then proceede to download and install GNU Guix,
+occasionally prompting you for confirmation of settings.
+
+@subsection Manual Installation
 
 Installing goes along these lines:
 
@@ -651,7 +664,7 @@ with these commands:
 @example
 # cp ~root/.config/guix/current/lib/systemd/system/guix-daemon.service \
      /etc/systemd/system/
-# systemctl start guix-daemon && systemctl enable guix-daemon
+# systemctl enable --now guix-daemon
 @end example
 
 If your host distro uses the Upstart init system:
-- 
2.26.0

Message #10 received at 40648-done <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Steven vanZyl <rushsteve1 <at> rushsteve1.us>
Cc: 40648-done <at> debbugs.gnu.org
Subject: Re: [bug#40648] [PATCH] Add subsections to the Binary Installation
 section
Date: Sun, 19 Apr 2020 13:27:49 +0200

Hi,

Steven vanZyl <rushsteve1 <at> rushsteve1.us> skribis:

> Break the Binary Installation section of the manual into two
> subsections: Installation Script, and Manual Installation. With an
> example for the Installation Script.
>
> This serves to highlight the existence of the installation script as
> the recommended way of installing Guix and provide an example of its
> usage for users.
>
> Additionally altered an example systemd command in the Manual
> Installation section to turn two commands into one by using the --now
> flag instead of calling start then enable.

Good ideas.  I pushed a variant of your patch as
40c6b1802cf014d5a747310606285e52ee3e3d3e.

Thanks!

Ludo’.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.