]> git.ipfire.org Git - thirdparty/postgresql.git/commitdiff
doc: Improve description of pg_restore --jobs
authorMichael Paquier <michael@paquier.xyz>
Sun, 11 Jan 2026 06:24:02 +0000 (15:24 +0900)
committerMichael Paquier <michael@paquier.xyz>
Sun, 11 Jan 2026 06:24:02 +0000 (15:24 +0900)
The parameter name used for the option value was named "number-of-jobs",
which was inconsistent with what all the other tools with an option
called --jobs use.  This commit updates the parameter name to "njobs".

Author: Tatsuro Yamada <yamatattsu@gmail.com>
Discussion: https://postgr.es/m/CAOKkKFvHqA6Tny0RKkezWVfVV91nPJyj4OGtMi3C1RznDVXqrg@mail.gmail.com

doc/src/sgml/ref/pg_restore.sgml

index a468a38361a138f0a9b3a0524f06fca72b1d50c8..2c295bbf8dc1c761377a33a5feb9ecb1867a513f 100644 (file)
@@ -259,14 +259,14 @@ PostgreSQL documentation
      </varlistentry>
 
      <varlistentry>
-      <term><option>-j <replaceable class="parameter">number-of-jobs</replaceable></option></term>
-      <term><option>--jobs=<replaceable class="parameter">number-of-jobs</replaceable></option></term>
+      <term><option>-j <replaceable class="parameter">njobs</replaceable></option></term>
+      <term><option>--jobs=<replaceable class="parameter">njobs</replaceable></option></term>
       <listitem>
        <para>
         Run the most time-consuming steps
         of <application>pg_restore</application> &mdash; those that load data,
         create indexes, or create constraints &mdash; concurrently, using up
-        to <replaceable class="parameter">number-of-jobs</replaceable>
+        to <replaceable class="parameter">njobs</replaceable>
         concurrent sessions.  This option can dramatically reduce the time
         to restore a large database to a server running on a
         multiprocessor machine.  This option is ignored when emitting a script