Re: [HACKERS] [COMMITTERS] pgsql: Preventive maintenance in advance of pgindent run. - Mailing list pgsql-hackers

I wrote:
> BTW, I would say that the problem with -p is that somebody failed to
> understand the difference between --help and a man page.

Concretely, how about the attached?  I don't think this looks any
worse than the current layout.

            regards, tom lane

diff --git a/src/bin/pg_basebackup/pg_basebackup.c b/src/bin/pg_basebackup/pg_basebackup.c
index 866f88a..f2492e4 100644
--- a/src/bin/pg_basebackup/pg_basebackup.c
+++ b/src/bin/pg_basebackup/pg_basebackup.c
@@ -331,22 +331,17 @@ usage(void)
     printf(_("\nOptions controlling the output:\n"));
     printf(_("  -D, --pgdata=DIRECTORY receive base backup into directory\n"));
     printf(_("  -F, --format=p|t       output format (plain (default), tar)\n"));
-    printf(_("  -r, --max-rate=RATE    maximum transfer rate to transfer data directory\n"));
-    printf(_("                         (in kB/s, or use suffix \"k\" or \"M\")\n"));
-    printf(_("  -R, --write-recovery-conf\n"));
-    printf(_("                         write recovery.conf for replication\n"));
+    printf(_("  -r, --max-rate=RATE    maximum transfer rate (in kB/s)\n"));
+    printf(_("  -R, --write-recovery-conf  write recovery.conf for replication\n"));
     printf(_("  -S, --slot=SLOTNAME    replication slot to use\n"));
     printf(_("      --no-slot          prevent creation of temporary replication slot\n"));
-    printf(_("  -T, --tablespace-mapping=OLDDIR=NEWDIR\n"));
-    printf(_("                         relocate tablespace in OLDDIR to NEWDIR\n"));
-    printf(_("  -X, --wal-method=none|fetch|stream\n"));
-    printf(_("                         include required WAL files with specified method\n"));
+    printf(_("  -T, --tablespace-mapping=OLDDIR=NEWDIR  relocate tablespace\n"));
+    printf(_("  -X, --wal-method=none|fetch|stream  set method for including WAL files\n"));
     printf(_("      --waldir=WALDIR    location for the write-ahead log directory\n"));
     printf(_("  -z, --gzip             compress tar output\n"));
     printf(_("  -Z, --compress=0-9     compress tar output with given compression level\n"));
     printf(_("\nGeneral options:\n"));
-    printf(_("  -c, --checkpoint=fast|spread\n"));
-    printf(_("                         set fast or spread checkpointing\n"));
+    printf(_("  -c, --checkpoint=fast|spread  set fast or spread checkpointing\n"));
     printf(_("  -l, --label=LABEL      set backup label\n"));
     printf(_("  -n, --no-clean         do not clean up after errors\n"));
     printf(_("  -N, --no-sync          do not wait for changes to be written safely to disk\n"));
@@ -358,8 +353,7 @@ usage(void)
     printf(_("  -d, --dbname=CONNSTR   connection string\n"));
     printf(_("  -h, --host=HOSTNAME    database server host or socket directory\n"));
     printf(_("  -p, --port=PORT        database server port number\n"));
-    printf(_("  -s, --status-interval=INTERVAL\n"));
-    printf(_("                         time between status packets sent to server (in seconds)\n"));
+    printf(_("  -s, --status-interval=SECONDS  set time between status packets\n"));
     printf(_("  -U, --username=NAME    connect as specified database user\n"));
     printf(_("  -w, --no-password      never prompt for password\n"));
     printf(_("  -W, --password         force password prompt (should happen automatically)\n"));
diff --git a/src/bin/pg_waldump/pg_waldump.c b/src/bin/pg_waldump/pg_waldump.c
index 56843a5..e56d7e2 100644
--- a/src/bin/pg_waldump/pg_waldump.c
+++ b/src/bin/pg_waldump/pg_waldump.c
@@ -689,18 +689,14 @@ usage(void)
     printf(_("  -e, --end=RECPTR       stop reading at WAL location RECPTR\n"));
     printf(_("  -f, --follow           keep retrying after reaching end of WAL\n"));
     printf(_("  -n, --limit=N          number of records to display\n"));
-    printf(_("  -p, --path=PATH        directory in which to find log segment files or a\n"));
-    printf(_("                         directory with a ./pg_wal that contains such files\n"));
-    printf(_("                         (default: current directory, ./pg_wal, PGDATA/pg_wal)\n"));
+    printf(_("  -p, --path=PATH        directory in which to find log segment files\n"));
     printf(_("  -r, --rmgr=RMGR        only show records generated by resource manager RMGR\n"));
     printf(_("                         use --rmgr=list to list valid resource manager names\n"));
     printf(_("  -s, --start=RECPTR     start reading at WAL location RECPTR\n"));
     printf(_("  -t, --timeline=TLI     timeline from which to read log records\n"));
-    printf(_("                         (default: 1 or the value used in STARTSEG)\n"));
     printf(_("  -V, --version          output version information, then exit\n"));
     printf(_("  -x, --xid=XID          only show records with TransactionId XID\n"));
-    printf(_("  -z, --stats[=record]   show statistics instead of records\n"));
-    printf(_("                         (optionally, show per-record statistics)\n"));
+    printf(_("  -z, --stats[=record]   show statistics or per-record statistics, not records\n"));
     printf(_("  -?, --help             show this help, then exit\n"));
 }


-- 
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers