From mboxrd@z Thu Jan 1 00:00:00 1970 From: Alex Kost Subject: [PATCH] guix: Clean up --help messages. Date: Sun, 07 Jun 2015 12:20:30 +0300 Message-ID: <87r3pnub6p.fsf@gmail.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:53727) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Z1Wku-0001ms-M7 for guix-devel@gnu.org; Sun, 07 Jun 2015 05:20:37 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Z1Wkr-0007Gt-Dq for guix-devel@gnu.org; Sun, 07 Jun 2015 05:20:36 -0400 Received: from mail-la0-x234.google.com ([2a00:1450:4010:c03::234]:36646) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Z1Wkr-0007Fp-1J for guix-devel@gnu.org; Sun, 07 Jun 2015 05:20:33 -0400 Received: by laar3 with SMTP id r3so29599824laa.3 for ; Sun, 07 Jun 2015 02:20:32 -0700 (PDT) Received: from leviafan ([217.107.192.146]) by mx.google.com with ESMTPSA id x2sm3220381laj.8.2015.06.07.02.20.28 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 07 Jun 2015 02:20:30 -0700 (PDT) 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-bounces+gcggd-guix-devel=m.gmane.org@gnu.org To: guix-devel@gnu.org --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable This is a boring message about some really minor things. While working on "guix" shell completions, I noticed that "--help" messages want some nitpicking. I think that formatting of system actions should be adjusted to the formatting of guix subcommands and importers (an aligned list of commands). What about a newline between a description line and commands? Should it be there (as in =E2=80=98guix --help=E2=80=99 now) or = not (as in =E2=80=98guix import --help=E2=80=99)? --8<---------------cut here---------------start------------->8--- Some description here: some commands here --8<---------------cut here---------------end--------------->8--- The patch is attached, thanks. --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-guix-Clean-up-help-messages.patch >From 2b561a47cf29480b5a4d686a3f3596569f0394f6 Mon Sep 17 00:00:00 2001 From: Alex Kost Date: Sun, 7 Jun 2015 11:46:06 +0300 Subject: [PATCH] guix: Clean up --help messages. * guix/scripts/import.scm (show-help): Add newline before a list of importers. * guix/scripts/lint.scm (show-help): Split a long description line. * guix/scripts/system.scm (show-help): Format actions the same way as guix commands and importers are formatted. --- guix/scripts/import.scm | 1 + guix/scripts/lint.scm | 3 ++- guix/scripts/system.scm | 13 +++++++------ 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/guix/scripts/import.scm b/guix/scripts/import.scm index 06b4c17..45ce092 100644 --- a/guix/scripts/import.scm +++ b/guix/scripts/import.scm @@ -86,6 +86,7 @@ rather than \\n." Run IMPORTER with ARGS.\n")) (newline) (display (_ "IMPORTER must be one of the importers listed below:\n")) + (newline) (format #t "~{ ~a~%~}" importers) (display (_ " -h, --help display this help and exit")) diff --git a/guix/scripts/lint.scm b/guix/scripts/lint.scm index 3b139ce..3740b71 100644 --- a/guix/scripts/lint.scm +++ b/guix/scripts/lint.scm @@ -575,7 +575,8 @@ descriptions maintained upstream." (define (show-help) (display (_ "Usage: guix lint [OPTION]... [PACKAGE]... -Run a set of checkers on the specified package; if none is specified, run the checkers on all packages.\n")) +Run a set of checkers on the specified package; if none is specified, +run the checkers on all packages.\n")) (display (_ " -c, --checkers=CHECKER1,CHECKER2... only run the specificed checkers")) diff --git a/guix/scripts/system.scm b/guix/scripts/system.scm index b6d7d0d..f7c9d83 100644 --- a/guix/scripts/system.scm +++ b/guix/scripts/system.scm @@ -368,18 +368,19 @@ boot directly to the kernel or to the bootloader." Build the operating system declared in FILE according to ACTION.\n")) (newline) (display (_ "The valid values for ACTION are:\n")) + (newline) (display (_ "\ - - 'reconfigure', switch to a new operating system configuration\n")) + reconfigure switch to a new operating system configuration\n")) (display (_ "\ - - 'build', build the operating system without installing anything\n")) + build build the operating system without installing anything\n")) (display (_ "\ - - 'vm', build a virtual machine image that shares the host's store\n")) + vm build a virtual machine image that shares the host's store\n")) (display (_ "\ - - 'vm-image', build a freestanding virtual machine image\n")) + vm-image build a freestanding virtual machine image\n")) (display (_ "\ - - 'disk-image', build a disk image, suitable for a USB stick\n")) + disk-image build a disk image, suitable for a USB stick\n")) (display (_ "\ - - 'init', initialize a root file system to run GNU.\n")) + init initialize a root file system to run GNU.\n")) (show-build-options-help) (display (_ " -- 2.2.1 --=-=-=--