Skip to content

Commit f60420c

Browse files
nathan-bossartnathan-bossart
committed
doc: Alphabetize long options for pg_dump[all].
The current ordering strategy for these pages is to list the short options in alphabetical order followed by the long options in alphabetical order. If an option has both a short variant and a long variant, the short variant takes precedence. This commit moves a few recently added options to match this style. We should probably adjust all pages and --help output to list the long and short options in one combined alphabetical list (with the long variants taking precedence), but that is a much larger change, so it is left as a future exercise. Oversights in commits a5cf808, 1fd1bd8, and bde2fb7. Reviewed-by: Álvaro Herrera <alvherre@kurilemu.de> Reviewed-by: Peter Eisentraut <peter@eisentraut.org> Discussion: https://postgr.es/m/aBFBtsltgu3-IU1d%40nathan
1 parent 368c3fb commit f60420c

File tree

2 files changed

+109
-110
lines changed

2 files changed

+109
-110
lines changed

‎doc/src/sgml/ref/pg_dump.sgml

Lines changed: 41 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -655,17 +655,6 @@ PostgreSQL documentation
655655
</listitem>
656656
</varlistentry>
657657

658-
<varlistentry>
659-
<term><option>--statistics-only</option></term>
660-
<listitem>
661-
<para>
662-
Dump only the statistics, not the schema (data definitions) or data.
663-
Statistics for tables, materialized views, and indexes are dumped.
664-
</para>
665-
666-
</listitem>
667-
</varlistentry>
668-
669658
<varlistentry>
670659
<term><option>-Z <replaceable class="parameter">level</replaceable></option></term>
671660
<term><option>-Z <replaceable class="parameter">method</replaceable></option>[:<replaceable>detail</replaceable>]</term>
@@ -1124,19 +1113,19 @@ PostgreSQL documentation
11241113
</varlistentry>
11251114

11261115
<varlistentry>
1127-
<term><option>--no-security-labels</option></term>
1116+
<term><option>--no-schema</option></term>
11281117
<listitem>
11291118
<para>
1130-
Do not dump security labels.
1119+
Do not dump schema (data definitions).
11311120
</para>
11321121
</listitem>
11331122
</varlistentry>
11341123

11351124
<varlistentry>
1136-
<term><option>--no-schema</option></term>
1125+
<term><option>--no-security-labels</option></term>
11371126
<listitem>
11381127
<para>
1139-
Do not dump schema (data definitions).
1128+
Do not dump security labels.
11401129
</para>
11411130
</listitem>
11421131
</varlistentry>
@@ -1232,33 +1221,6 @@ PostgreSQL documentation
12321221
</listitem>
12331222
</varlistentry>
12341223

1235-
<varlistentry>
1236-
<term><option>--with-data</option></term>
1237-
<listitem>
1238-
<para>
1239-
Dump data. This is the default.
1240-
</para>
1241-
</listitem>
1242-
</varlistentry>
1243-
1244-
<varlistentry>
1245-
<term><option>--with-schema</option></term>
1246-
<listitem>
1247-
<para>
1248-
Dump schema (data definitions). This is the default.
1249-
</para>
1250-
</listitem>
1251-
</varlistentry>
1252-
1253-
<varlistentry>
1254-
<term><option>--with-statistics</option></term>
1255-
<listitem>
1256-
<para>
1257-
Dump statistics. This is the default.
1258-
</para>
1259-
</listitem>
1260-
</varlistentry>
1261-
12621224
<varlistentry>
12631225
<term><option>--on-conflict-do-nothing</option></term>
12641226
<listitem>
@@ -1392,6 +1354,16 @@ PostgreSQL documentation
13921354
</listitem>
13931355
</varlistentry>
13941356

1357+
<varlistentry>
1358+
<term><option>--statistics-only</option></term>
1359+
<listitem>
1360+
<para>
1361+
Dump only the statistics, not the schema (data definitions) or data.
1362+
Statistics for tables, materialized views, and indexes are dumped.
1363+
</para>
1364+
</listitem>
1365+
</varlistentry>
1366+
13951367
<varlistentry>
13961368
<term><option>--strict-names</option></term>
13971369
<listitem>
@@ -1467,6 +1439,33 @@ PostgreSQL documentation
14671439
</listitem>
14681440
</varlistentry>
14691441

1442+
<varlistentry>
1443+
<term><option>--with-data</option></term>
1444+
<listitem>
1445+
<para>
1446+
Dump data. This is the default.
1447+
</para>
1448+
</listitem>
1449+
</varlistentry>
1450+
1451+
<varlistentry>
1452+
<term><option>--with-schema</option></term>
1453+
<listitem>
1454+
<para>
1455+
Dump schema (data definitions). This is the default.
1456+
</para>
1457+
</listitem>
1458+
</varlistentry>
1459+
1460+
<varlistentry>
1461+
<term><option>--with-statistics</option></term>
1462+
<listitem>
1463+
<para>
1464+
Dump statistics. This is the default.
1465+
</para>
1466+
</listitem>
1467+
</varlistentry>
1468+
14701469
<varlistentry>
14711470
<term><option>-?</option></term>
14721471
<term><option>--help</option></term>

‎doc/src/sgml/ref/pg_dumpall.sgml

Lines changed: 68 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -205,37 +205,6 @@ PostgreSQL documentation
205205
</listitem>
206206
</varlistentry>
207207

208-
<varlistentry>
209-
<term><option>--filter=<replaceable class="parameter">filename</replaceable></option></term>
210-
<listitem>
211-
<para>
212-
Specify a filename from which to read patterns for databases excluded
213-
from the dump. The patterns are interpreted according to the same rules
214-
as <option>--exclude-database</option>.
215-
To read from <literal>STDIN</literal>, use <filename>-</filename> as the
216-
filename. The <option>--filter</option> option can be specified in
217-
conjunction with <option>--exclude-database</option> for excluding
218-
databases, and can also be specified more than once for multiple filter
219-
files.
220-
</para>
221-
222-
<para>
223-
The file lists one database pattern per row, with the following format:
224-
<synopsis>
225-
exclude database <replaceable class="parameter">PATTERN</replaceable>
226-
</synopsis>
227-
</para>
228-
229-
<para>
230-
Lines starting with <literal>#</literal> are considered comments and
231-
ignored. Comments can be placed after an object pattern row as well.
232-
Blank lines are also ignored. See <xref linkend="app-psql-patterns"/>
233-
for how to perform quoting in patterns.
234-
</para>
235-
236-
</listitem>
237-
</varlistentry>
238-
239208
<varlistentry>
240209
<term><option>-g</option></term>
241210
<term><option>--globals-only</option></term>
@@ -345,16 +314,6 @@ exclude database <replaceable class="parameter">PATTERN</replaceable>
345314
</listitem>
346315
</varlistentry>
347316

348-
<varlistentry>
349-
<term><option>--statistics-only</option></term>
350-
<listitem>
351-
<para>
352-
Dump only the statistics, not the schema (data definitions) or data.
353-
Statistics for tables, materialized views, and indexes are dumped.
354-
</para>
355-
</listitem>
356-
</varlistentry>
357-
358317
<varlistentry>
359318
<term><option>--binary-upgrade</option></term>
360319
<listitem>
@@ -444,6 +403,37 @@ exclude database <replaceable class="parameter">PATTERN</replaceable>
444403
</listitem>
445404
</varlistentry>
446405

406+
<varlistentry>
407+
<term><option>--filter=<replaceable class="parameter">filename</replaceable></option></term>
408+
<listitem>
409+
<para>
410+
Specify a filename from which to read patterns for databases excluded
411+
from the dump. The patterns are interpreted according to the same rules
412+
as <option>--exclude-database</option>.
413+
To read from <literal>STDIN</literal>, use <filename>-</filename> as the
414+
filename. The <option>--filter</option> option can be specified in
415+
conjunction with <option>--exclude-database</option> for excluding
416+
databases, and can also be specified more than once for multiple filter
417+
files.
418+
</para>
419+
420+
<para>
421+
The file lists one database pattern per row, with the following format:
422+
<synopsis>
423+
exclude database <replaceable class="parameter">PATTERN</replaceable>
424+
</synopsis>
425+
</para>
426+
427+
<para>
428+
Lines starting with <literal>#</literal> are considered comments and
429+
ignored. Comments can be placed after an object pattern row as well.
430+
Blank lines are also ignored. See <xref linkend="app-psql-patterns"/>
431+
for how to perform quoting in patterns.
432+
</para>
433+
434+
</listitem>
435+
</varlistentry>
436+
447437
<varlistentry>
448438
<term><option>--if-exists</option></term>
449439
<listitem>
@@ -640,33 +630,6 @@ exclude database <replaceable class="parameter">PATTERN</replaceable>
640630
</listitem>
641631
</varlistentry>
642632

643-
<varlistentry>
644-
<term><option>--with-data</option></term>
645-
<listitem>
646-
<para>
647-
Dump data. This is the default.
648-
</para>
649-
</listitem>
650-
</varlistentry>
651-
652-
<varlistentry>
653-
<term><option>--with-schema</option></term>
654-
<listitem>
655-
<para>
656-
Dump schema (data definitions). This is the default.
657-
</para>
658-
</listitem>
659-
</varlistentry>
660-
661-
<varlistentry>
662-
<term><option>--with-statistics</option></term>
663-
<listitem>
664-
<para>
665-
Dump statistics. This is the default.
666-
</para>
667-
</listitem>
668-
</varlistentry>
669-
670633
<varlistentry>
671634
<term><option>--no-unlogged-table-data</option></term>
672635
<listitem>
@@ -722,6 +685,16 @@ exclude database <replaceable class="parameter">PATTERN</replaceable>
722685
</listitem>
723686
</varlistentry>
724687

688+
<varlistentry>
689+
<term><option>--statistics-only</option></term>
690+
<listitem>
691+
<para>
692+
Dump only the statistics, not the schema (data definitions) or data.
693+
Statistics for tables, materialized views, and indexes are dumped.
694+
</para>
695+
</listitem>
696+
</varlistentry>
697+
725698
<varlistentry>
726699
<term><option>--use-set-session-authorization</option></term>
727700
<listitem>
@@ -735,6 +708,33 @@ exclude database <replaceable class="parameter">PATTERN</replaceable>
735708
</listitem>
736709
</varlistentry>
737710

711+
<varlistentry>
712+
<term><option>--with-data</option></term>
713+
<listitem>
714+
<para>
715+
Dump data. This is the default.
716+
</para>
717+
</listitem>
718+
</varlistentry>
719+
720+
<varlistentry>
721+
<term><option>--with-schema</option></term>
722+
<listitem>
723+
<para>
724+
Dump schema (data definitions). This is the default.
725+
</para>
726+
</listitem>
727+
</varlistentry>
728+
729+
<varlistentry>
730+
<term><option>--with-statistics</option></term>
731+
<listitem>
732+
<para>
733+
Dump statistics. This is the default.
734+
</para>
735+
</listitem>
736+
</varlistentry>
737+
738738
<varlistentry>
739739
<term><option>-?</option></term>
740740
<term><option>--help</option></term>

0 commit comments

Comments
 (0)