Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 2434d60

Browse files
committed
Put new command-line option into sensible order in help output
We have two existing conventions for long options: either alphabetical among short options, or all long options after all the short options. But the convention apparently used here, next to a functionally related option, is not one of them.
1 parent fde9c06 commit 2434d60

File tree

2 files changed

+32
-33
lines changed

2 files changed

+32
-33
lines changed

doc/src/sgml/ref/pg_waldump.sgml

+31-31
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,37 @@ PostgreSQL documentation
241241
</listitem>
242242
</varlistentry>
243243

244+
<varlistentry>
245+
<term><option>-x <replaceable>xid</replaceable></option></term>
246+
<term><option>--xid=<replaceable>xid</replaceable></option></term>
247+
<listitem>
248+
<para>
249+
Only display records marked with the given transaction ID.
250+
</para>
251+
</listitem>
252+
</varlistentry>
253+
254+
<varlistentry>
255+
<term><option>-z</option></term>
256+
<term><option>--stats[=record]</option></term>
257+
<listitem>
258+
<para>
259+
Display summary statistics (number and size of records and
260+
full-page images) instead of individual records. Optionally
261+
generate statistics per-record instead of per-rmgr.
262+
</para>
263+
264+
<para>
265+
If <application>pg_waldump</application> is terminated by signal
266+
<systemitem>SIGINT</systemitem>
267+
(<keycombo action="simul"><keycap>Control</keycap><keycap>C</keycap></keycombo>),
268+
the summary of the statistics computed is displayed up to the
269+
termination point. This operation is not supported on
270+
<productname>Windows</productname>.
271+
</para>
272+
</listitem>
273+
</varlistentry>
274+
244275
<varlistentry>
245276
<term><option>--save-fullpage=<replaceable>save_path</replaceable></option></term>
246277
<listitem>
@@ -307,37 +338,6 @@ PostgreSQL documentation
307338
</listitem>
308339
</varlistentry>
309340

310-
<varlistentry>
311-
<term><option>-x <replaceable>xid</replaceable></option></term>
312-
<term><option>--xid=<replaceable>xid</replaceable></option></term>
313-
<listitem>
314-
<para>
315-
Only display records marked with the given transaction ID.
316-
</para>
317-
</listitem>
318-
</varlistentry>
319-
320-
<varlistentry>
321-
<term><option>-z</option></term>
322-
<term><option>--stats[=record]</option></term>
323-
<listitem>
324-
<para>
325-
Display summary statistics (number and size of records and
326-
full-page images) instead of individual records. Optionally
327-
generate statistics per-record instead of per-rmgr.
328-
</para>
329-
330-
<para>
331-
If <application>pg_waldump</application> is terminated by signal
332-
<systemitem>SIGINT</systemitem>
333-
(<keycombo action="simul"><keycap>Control</keycap><keycap>C</keycap></keycombo>),
334-
the summary of the statistics computed is displayed up to the
335-
termination point. This operation is not supported on
336-
<productname>Windows</productname>.
337-
</para>
338-
</listitem>
339-
</varlistentry>
340-
341341
<varlistentry>
342342
<term><option>-?</option></term>
343343
<term><option>--help</option></term>

src/bin/pg_waldump/pg_waldump.c

+1-2
Original file line numberDiff line numberDiff line change
@@ -774,11 +774,10 @@ usage(void)
774774
" (default: 1 or the value used in STARTSEG)\n"));
775775
printf(_(" -V, --version output version information, then exit\n"));
776776
printf(_(" -w, --fullpage only show records with a full page write\n"));
777-
printf(_(" --save-fullpage=PATH\n"
778-
" save full page images\n"));
779777
printf(_(" -x, --xid=XID only show records with transaction ID XID\n"));
780778
printf(_(" -z, --stats[=record] show statistics instead of records\n"
781779
" (optionally, show per-record statistics)\n"));
780+
printf(_(" --save-fullpage=DIR save full page images to DIR\n"));
782781
printf(_(" -?, --help show this help, then exit\n"));
783782
printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
784783
printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);

0 commit comments

Comments
 (0)