From mboxrd@z Thu Jan 1 00:00:00 1970 From: Alex Kost Subject: Re: [PATCH] guix: Clean up --help messages. Date: Sun, 07 Jun 2015 22:26:13 +0300 Message-ID: <87ioazb9re.fsf@gmail.com> References: <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]:60365) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Z1gD7-0003l4-0w for guix-devel@gnu.org; Sun, 07 Jun 2015 15:26:22 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Z1gD2-0006Zo-Ro for guix-devel@gnu.org; Sun, 07 Jun 2015 15:26:20 -0400 Received: from mail-lb0-x22e.google.com ([2a00:1450:4010:c04::22e]:34223) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Z1gD2-0006Y2-Fa for guix-devel@gnu.org; Sun, 07 Jun 2015 15:26:16 -0400 Received: by lbcmx3 with SMTP id mx3so69119533lbc.1 for ; Sun, 07 Jun 2015 12:26:15 -0700 (PDT) Received: from leviafan ([217.107.192.146]) by mx.google.com with ESMTPSA id j6sm111189laj.13.2015.06.07.12.26.14 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 07 Jun 2015 12:26:14 -0700 (PDT) In-Reply-To: <87r3pnub6p.fsf@gmail.com> (Alex Kost's message of "Sun, 07 Jun 2015 12:20:30 +0300") 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 Sorry, there is another thing I forgot. Currently =E2=80=98guix package --= help=E2=80=99 displays the following: --8<---------------cut here---------------start------------->8--- Usage: guix package [OPTION]... PACKAGES... Install, remove, or upgrade PACKAGES in a single transaction. -i, --install=3DPACKAGE install PACKAGE -e, --install-from-expression=3DEXP install the package EXP evaluates to -r, --remove=3DPACKAGE remove PACKAGE ... --8<---------------cut here---------------end--------------->8--- I think it is not clear that multiple packages may be installed/removed by a single command. If it would look like this: -i, --install=3DPACKAGE... install PACKAGEs it may not be clear how the PACKAGEs are separated, since it is a common practice to use "," to separate things after an "=3D" sign. So I suggest to remove "=3D" from =E2=80=98--install=E2=80=99 and =E2=80=98--remove=E2= =80=99 options: -i, --install PACKAGE ... install PACKAGEs In my opinion it is the most clear way for that. WDYT? The modified patch is attached. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-guix-Clean-up-help-messages.patch >From 58cf074945b1c20e3badb86bf2ed222f89b2c879 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/package.scm | 10 ++++++---- guix/scripts/system.scm | 13 +++++++------ 4 files changed, 16 insertions(+), 11 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/package.scm b/guix/scripts/package.scm index 4ae5114..d9f38fb 100644 --- a/guix/scripts/package.scm +++ b/guix/scripts/package.scm @@ -422,15 +422,17 @@ ENTRIES, a list of manifest entries, in the context of PROFILE." (substitutes? . #t))) (define (show-help) - (display (_ "Usage: guix package [OPTION]... PACKAGES... -Install, remove, or upgrade PACKAGES in a single transaction.\n")) + (display (_ "Usage: guix package [OPTION]... +Install, remove, or upgrade packages in a single transaction.\n")) (display (_ " - -i, --install=PACKAGE install PACKAGE")) + -i, --install PACKAGE ... + install PACKAGEs")) (display (_ " -e, --install-from-expression=EXP install the package EXP evaluates to")) (display (_ " - -r, --remove=PACKAGE remove PACKAGE")) + -r, --remove PACKAGE ... + remove PACKAGEs")) (display (_ " -u, --upgrade[=REGEXP] upgrade all the installed packages matching REGEXP")) (display (_ " 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.4.2 --=-=-=--