public inbox for util-linux@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] fdisk: remove angle brackets from usage
@ 2013-11-18 19:42 Phillip Susi
  2013-11-19  9:23 ` Karel Zak
  0 siblings, 1 reply; 4+ messages in thread
From: Phillip Susi @ 2013-11-18 19:42 UTC (permalink / raw)
  To: util-linux

Remove superfluous angle brackets and use square brackets
where appropriate to conform to the man page convention.

Signed-off-by: Phillip Susi <psusi@ubuntu.com>
---
 fdisks/fdisk.c | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/fdisks/fdisk.c b/fdisks/fdisk.c
index 874f9d1..3572c64 100644
--- a/fdisks/fdisk.c
+++ b/fdisks/fdisk.c
@@ -50,22 +50,22 @@ static void __attribute__ ((__noreturn__)) usage(FILE *out)
 	fputs(USAGE_HEADER, out);
 
 	fprintf(out,
-	      _(" %1$s [options] <disk>    change partition table\n"
-	        " %1$s [options] -l <disk> list partition table(s)\n"),
+	      _(" %1$s [options] [disk]    change partition table\n"
+	        " %1$s [options] -l [disk] list partition table(s)\n"),
 	       program_invocation_short_name);
 
 	fputs(USAGE_OPTIONS, out);
-	fputs(_(" -b <size>         sector size (512, 1024, 2048 or 4096)\n"), out);
-	fputs(_(" -c[=<mode>]       compatible mode: 'dos' or 'nondos' (default)\n"), out);
+	fputs(_(" -b size           sector size (512, 1024, 2048 or 4096)\n"), out);
+	fputs(_(" -c[=mode]         compatible mode: 'dos' or 'nondos' (default)\n"), out);
 	fputs(_(" -h                print this help text\n"), out);
-	fputs(_(" -c[=<mode>]       compatible mode: 'dos' or 'nondos' (default)\n"), out);
-	fputs(_(" -L[=<when>]       colorize output (auto, always or never)\n"), out);
-	fputs(_(" -t <type>         force fdisk to recognize specified partition table type only\n"), out);
-	fputs(_(" -u[=<unit>]       display units: 'cylinders' or 'sectors' (default)\n"), out);
+	fputs(_(" -c[=mode]         compatible mode: 'dos' or 'nondos' (default)\n"), out);
+	fputs(_(" -L[=when]         colorize output (auto, always or never)\n"), out);
+	fputs(_(" -t type           force fdisk to recognize specified partition table type only\n"), out);
+	fputs(_(" -u[=unit]         display units: 'cylinders' or 'sectors' (default)\n"), out);
 	fputs(_(" -v                print program version\n"), out);
-	fputs(_(" -C <number>       specify the number of cylinders\n"), out);
-	fputs(_(" -H <number>       specify the number of heads\n"), out);
-	fputs(_(" -S <number>       specify the number of sectors per track\n"), out);
+	fputs(_(" -C number         specify the number of cylinders\n"), out);
+	fputs(_(" -H number         specify the number of heads\n"), out);
+	fputs(_(" -S number         specify the number of sectors per track\n"), out);
 
 	fprintf(out, USAGE_MAN_TAIL("fdisk(8)"));
 	exit(out == stderr ? EXIT_FAILURE : EXIT_SUCCESS);
-- 
1.8.3.2


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH] fdisk: remove angle brackets from usage
  2013-11-18 19:42 [PATCH] fdisk: remove angle brackets from usage Phillip Susi
@ 2013-11-19  9:23 ` Karel Zak
  2013-11-19 14:43   ` Phillip Susi
  0 siblings, 1 reply; 4+ messages in thread
From: Karel Zak @ 2013-11-19  9:23 UTC (permalink / raw)
  To: Phillip Susi; +Cc: util-linux

On Mon, Nov 18, 2013 at 02:42:34PM -0500, Phillip Susi wrote:
> Remove superfluous angle brackets and use square brackets
> where appropriate to conform to the man page convention.

 The angle brackets are expected, see Documentation/howto-usage-function.txt.

    Karel
-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] fdisk: remove angle brackets from usage
  2013-11-19  9:23 ` Karel Zak
@ 2013-11-19 14:43   ` Phillip Susi
  2013-11-19 17:32     ` Karel Zak
  0 siblings, 1 reply; 4+ messages in thread
From: Phillip Susi @ 2013-11-19 14:43 UTC (permalink / raw)
  To: Karel Zak; +Cc: util-linux

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 11/19/2013 4:23 AM, Karel Zak wrote:
> On Mon, Nov 18, 2013 at 02:42:34PM -0500, Phillip Susi wrote:
>> Remove superfluous angle brackets and use square brackets where
>> appropriate to conform to the man page convention.
> 
> The angle brackets are expected, see
> Documentation/howto-usage-function.txt.

In that case, then fdisk should have square brackets added around the
<disk> since it is an optional argument.


-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.17 (MingW32)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBAgAGBQJSi3ksAAoJEJrBOlT6nu759TsH/2CdeIsN/IV8YgFmxaWDtI2+
cEXaGHsZSOrRJuiAbfQt/ktA5+V7x0VtyUZJanZtpHB3upNB2gz831cP3d2Tbw/z
6G8NFCy/IoJzZANci/5e+bcVch8r4mFHKv8ia8VUEUjbRMDBJxQ8QEKNu2MjuEPk
78GZmtObY6C/hn7Ec4842IXgzsNHozzc8a0ftC7g4zfsNmcUxwmwljuLrDd9ESrd
DuZhozwtHfsZrWURnX3gQcI/OvDXexZ8PGMO2Of9xYinw+1gvMkFQgULmwt/6HIO
SCaPc9wwNwdFDx45krXy/8dtolvIZ4my16LJTjiGGr/6tBUwkwLwT12dKj2Mbog=
=ouFR
-----END PGP SIGNATURE-----

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] fdisk: remove angle brackets from usage
  2013-11-19 14:43   ` Phillip Susi
@ 2013-11-19 17:32     ` Karel Zak
  0 siblings, 0 replies; 4+ messages in thread
From: Karel Zak @ 2013-11-19 17:32 UTC (permalink / raw)
  To: Phillip Susi; +Cc: util-linux

On Tue, Nov 19, 2013 at 09:43:56AM -0500, Phillip Susi wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
> 
> On 11/19/2013 4:23 AM, Karel Zak wrote:
> > On Mon, Nov 18, 2013 at 02:42:34PM -0500, Phillip Susi wrote:
> >> Remove superfluous angle brackets and use square brackets where
> >> appropriate to conform to the man page convention.
> > 
> > The angle brackets are expected, see
> > Documentation/howto-usage-function.txt.
> 
> In that case, then fdisk should have square brackets added around the
> <disk> since it is an optional argument.

 Yes, it's optional for -l. Fixed. Thanks.

    Karel

-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2013-11-19 17:32 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-11-18 19:42 [PATCH] fdisk: remove angle brackets from usage Phillip Susi
2013-11-19  9:23 ` Karel Zak
2013-11-19 14:43   ` Phillip Susi
2013-11-19 17:32     ` Karel Zak

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox