diff options
author | Peter Eisentraut <peter@eisentraut.org> | 2024-05-06 09:56:54 +0200 |
---|---|---|
committer | Peter Eisentraut <peter@eisentraut.org> | 2024-05-06 09:56:54 +0200 |
commit | bde2eec1b54800ff11f8d638e88d887985c0ad22 (patch) | |
tree | 74aee2e571fd9ac2dc4ec0edda275d44a243a7db /doc/src | |
parent | 597f66942d0b18f2f15b478346bc74ae6fdb793b (diff) | |
download | postgresql-bde2eec1b54800ff11f8d638e88d887985c0ad22.tar.gz postgresql-bde2eec1b54800ff11f8d638e88d887985c0ad22.zip |
doc: Improve order of options on initdb reference page
Both the initdb --help output and the reference page have a section
for options and a section for less commonly used options. But some
recently added options were sprinkled around inconsistently. Fix that
by making the documentation match the --help output.
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/ref/initdb.sgml | 128 |
1 files changed, 64 insertions, 64 deletions
diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index dc9011b40ed..6c96c0c0681 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -343,34 +343,6 @@ PostgreSQL documentation </listitem> </varlistentry> - <varlistentry id="app-initdb-option-no-sync"> - <term><option>-N</option></term> - <term><option>--no-sync</option></term> - <listitem> - <para> - By default, <command>initdb</command> will wait for all files to be - written safely to disk. This option causes <command>initdb</command> - to return without waiting, which is faster, but means that a - subsequent operating system crash can leave the data directory - corrupt. Generally, this option is useful for testing, but should not - be used when creating a production installation. - </para> - </listitem> - </varlistentry> - - <varlistentry id="app-initdb-option-no-instructions"> - <term><option>--no-instructions</option></term> - <listitem> - <para> - By default, <command>initdb</command> will write instructions for how - to start the cluster at the end of its output. This option causes - those instructions to be left out. This is primarily intended for use - by tools that wrap <command>initdb</command> in platform-specific - behavior, where those instructions are likely to be incorrect. - </para> - </listitem> - </varlistentry> - <varlistentry id="app-initdb-option-pwfile"> <term><option>--pwfile=<replaceable>filename</replaceable></option></term> <listitem> @@ -381,42 +353,6 @@ PostgreSQL documentation </listitem> </varlistentry> - <varlistentry id="app-initdb-option-sync-method"> - <term><option>--sync-method=<replaceable>method</replaceable></option></term> - <listitem> - <para> - When set to <literal>fsync</literal>, which is the default, - <command>initdb</command> will recursively open and synchronize all - files in the data directory. The search for files will follow symbolic - links for the WAL directory and each configured tablespace. - </para> - <para> - On Linux, <literal>syncfs</literal> may be used instead to ask the - operating system to synchronize the whole file systems that contain the - data directory, the WAL files, and each tablespace. See - <xref linkend="guc-recovery-init-sync-method"/> for information about - the caveats to be aware of when using <literal>syncfs</literal>. - </para> - <para> - This option has no effect when <option>--no-sync</option> is used. - </para> - </listitem> - </varlistentry> - - <varlistentry id="app-initdb-option-sync-only"> - <term><option>-S</option></term> - <term><option>--sync-only</option></term> - <listitem> - <para> - Safely write all database files to disk and exit. This does not - perform any of the normal <application>initdb</application> operations. - Generally, this option is useful for ensuring reliable recovery after - changing <xref linkend="guc-fsync"/> from <literal>off</literal> to - <literal>on</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry id="app-initdb-option-text-search-config"> <term><option>-T <replaceable>config</replaceable></option></term> <term><option>--text-search-config=<replaceable>config</replaceable></option></term> @@ -560,6 +496,70 @@ PostgreSQL documentation </para> </listitem> </varlistentry> + + <varlistentry id="app-initdb-option-no-sync"> + <term><option>-N</option></term> + <term><option>--no-sync</option></term> + <listitem> + <para> + By default, <command>initdb</command> will wait for all files to be + written safely to disk. This option causes <command>initdb</command> + to return without waiting, which is faster, but means that a + subsequent operating system crash can leave the data directory + corrupt. Generally, this option is useful for testing, but should not + be used when creating a production installation. + </para> + </listitem> + </varlistentry> + + <varlistentry id="app-initdb-option-no-instructions"> + <term><option>--no-instructions</option></term> + <listitem> + <para> + By default, <command>initdb</command> will write instructions for how + to start the cluster at the end of its output. This option causes + those instructions to be left out. This is primarily intended for use + by tools that wrap <command>initdb</command> in platform-specific + behavior, where those instructions are likely to be incorrect. + </para> + </listitem> + </varlistentry> + + <varlistentry id="app-initdb-option-sync-method"> + <term><option>--sync-method=<replaceable>method</replaceable></option></term> + <listitem> + <para> + When set to <literal>fsync</literal>, which is the default, + <command>initdb</command> will recursively open and synchronize all + files in the data directory. The search for files will follow symbolic + links for the WAL directory and each configured tablespace. + </para> + <para> + On Linux, <literal>syncfs</literal> may be used instead to ask the + operating system to synchronize the whole file systems that contain the + data directory, the WAL files, and each tablespace. See + <xref linkend="guc-recovery-init-sync-method"/> for information about + the caveats to be aware of when using <literal>syncfs</literal>. + </para> + <para> + This option has no effect when <option>--no-sync</option> is used. + </para> + </listitem> + </varlistentry> + + <varlistentry id="app-initdb-option-sync-only"> + <term><option>-S</option></term> + <term><option>--sync-only</option></term> + <listitem> + <para> + Safely write all database files to disk and exit. This does not + perform any of the normal <application>initdb</application> operations. + Generally, this option is useful for ensuring reliable recovery after + changing <xref linkend="guc-fsync"/> from <literal>off</literal> to + <literal>on</literal>. + </para> + </listitem> + </varlistentry> </variablelist> </para> |