GNU bug report logs - #37898
[PATCH] small improvement to documentation

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 37898 in the body.
You can then email your comments to 37898 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: Kyle Andrews <kyle.c.andrews <at> gmail.com>
To: guix-patches <at> gnu.org
Subject: [PATCH] small improvement to documentation
Date: Wed, 23 Oct 2019 23:50:54 -0400

Hi Guix,

I am working my way through installing Guix on a system using the
"manual" method and wanted to help improve the documentation.

I find it difficult to read bash commands which make use of cryptic
short argument flags, so I have taken the liberty of replacing one such
instance of that in the manual with a human readable equivalent.

Also, following, the principle of parallel construction I included an
example of how to bring a network device up using ip in addition to
ifconfig.

Please see the patch below:

--8<---------------cut here---------------start------------->8---
From ff3c71cad60c50812bdf6d561a24ed59fb2e26bc Mon Sep 17 00:00:00 2001
From: Kyle Andrews <kyle.c.andrews <at> gmail.com>
Date: Wed, 23 Oct 2019 23:24:11 -0400
Subject: [PATCH] * doc/guix: Use human readable arguments for ip command.

---
 doc/guix.texi | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 6703c2756c..ff12a1bb51 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -66,6 +66,7 @@ Copyright @copyright{} 2019 Josh Holland@*
 Copyright @copyright{} 2019 Diego Nicola Barbato@*
 Copyright @copyright{} 2019 Ivan Petkov@*
 Copyright @copyright{} 2019 Jakob L. Kreuze@*
+Copyright @copyright{} 2019 Kyle Andrews@*

 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -2110,7 +2111,7 @@ ifconfig -a
 @dots{} or, using the GNU/Linux-specific @command{ip} command:

 @example
-ip a
+ip address
 @end example

 @c https://cgit.freedesktop.org/systemd/systemd/tree/src/udev/udev-builtin-net_id.c#n20
@@ -2128,6 +2129,13 @@ To configure a wired network run the following command, substituting
 ifconfig @var{interface} up
 @end example

+@noindent
+@dots{} or, using the GNU/Linux-specific @command{ip} command:
+
+@example
+ip link set @var{interface} up
+@end example
+
 @item Wireless connection
 @cindex wireless
 @cindex WiFi
--
2.23.0

--8<---------------cut here---------------end--------------->8---

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

From: Ludovic Courtès <ludo <at> gnu.org>
To: Kyle Andrews <kyle.c.andrews <at> gmail.com>
Cc: 37898-done <at> debbugs.gnu.org
Subject: Re: [bug#37898] [PATCH] small improvement to documentation
Date: Mon, 04 Nov 2019 23:14:27 +0100

Hello Kyle,

Kyle Andrews <kyle.c.andrews <at> gmail.com> skribis:

> I find it difficult to read bash commands which make use of cryptic
> short argument flags, so I have taken the liberty of replacing one such
> instance of that in the manual with a human readable equivalent.
>
> Also, following, the principle of parallel construction I included an
> example of how to bring a network device up using ip in addition to
> ifconfig.

That makes sense to me.

>>From ff3c71cad60c50812bdf6d561a24ed59fb2e26bc Mon Sep 17 00:00:00 2001
> From: Kyle Andrews <kyle.c.andrews <at> gmail.com>
> Date: Wed, 23 Oct 2019 23:24:11 -0400
> Subject: [PATCH] * doc/guix: Use human readable arguments for ip command.
>
> ---
>  doc/guix.texi | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)

I adjusted it the commit log and applied it.

Thank you!

Ludo’.

Previous Next

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