bug#33673: PATCH: Fwd: Re: bug#33673: "guix system --help" does not detail how to use --on-error=strategy

[swedebugia <swedebugia@riseup.net>]

[-- Attachment #1: Type: text/plain, Size: 1211 bytes --]

Is this patch ok?


-------- Forwarded Message --------
Subject: Re: bug#33673: "guix system --help" does not detail how to use 
--on-error=strategy
Date: Tue, 11 Dec 2018 18:10:06 +0100
From: Ludovic Courtès <ludo@gnu.org>
To: Efraim Flashner <efraim@flashner.co.il>
CC: swedebugia@riseup.net, 33673@debbugs.gnu.org

Hi!

Efraim Flashner <efraim@flashner.co.il> skribis:

> On Sun, Dec 09, 2018 at 12:16:47AM +0100, Ludovic Courtès wrote:

[...]

>> Improvements are always welcome of course.  The main criterion would be
>> to remain consistent with the rest of Guix and with GNU conventions that
>> we follow.  Maybe it’s best to discuss what you have in mind first?
>> 
>> Thank you,
>> Ludo’.
>> 
>
> I'd go with (one of: nothing-special, backtrace, debug)
> with the assumption that for more information the manual is more
> verbose.

Sounds good to me.  Would you like to send a patch?

> I also just noticed that we have 'man guix-system', which could be more
> verbose on the subject without needing to fit in a concise output.

Manual pages are generated from the ‘--help’ output, the canonical
documentation being the Info manual.

Thanks,
Ludo’.

[-- Attachment #2: 0001-system-Clarify-the-three-strategies-available.patch --]
[-- Type: text/x-patch, Size: 1747 bytes --]

From e71273a1b3b20bba8f4174ac4b98925bbc36ac0d Mon Sep 17 00:00:00 2001
From: swedebugia <swedebugia@riseup.net>
Date: Fri, 14 Dec 2018 19:41:41 +0100
Subject: [PATCH] system: Clarify the three strategies available.

* guix/scripts/system.scm (show-help): Clarify the three choices.
* doc/guix.texi (Invoking guix system): Add 3 @cindex to make on-error=strategy
  easier to find.
---
 doc/guix.texi           | 3 +++
 guix/scripts/system.scm | 2 +-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 20b5013fd..4c204c619 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -22628,6 +22628,9 @@ appear in the @code{operating-system} declaration actually exist
 needed at boot time are listed in @code{initrd-modules} (@pxref{Initial
 RAM Disk}).  Passing this option skips these tests altogether.
 
+@cindex on-error
+@cindex on-error strategy
+@cindex error strategy
 @item --on-error=@var{strategy}
 Apply @var{strategy} when an error occurs when reading @var{file}.
 @var{strategy} may be one of the following:
diff --git a/guix/scripts/system.scm b/guix/scripts/system.scm
index 8eb32c62b..d94917100 100644
--- a/guix/scripts/system.scm
+++ b/guix/scripts/system.scm
@@ -993,7 +993,7 @@ Some ACTIONS support additional ARGS.\n"))
                          instead of reading FILE, when applicable"))
   (display (G_ "
       --on-error=STRATEGY
-                         apply STRATEGY when an error occurs while reading FILE"))
+                         apply STRATEGY (one of: nothing-special, backtrace, debug) when an error occurs while reading FILE."))
   (display (G_ "
       --file-system-type=TYPE
                          for 'disk-image', produce a root file system of TYPE
-- 
2.18.0