Skip to content

Commit 3e43d00

Browse files
committed
Wording in documentation refined from techwriters' feedback
1 parent 5089400 commit 3e43d00

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

doc/pgprobackup.xml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ doc/src/sgml/pgprobackup.sgml
293293
</listitem>
294294
<listitem condition="12+">
295295
<para>
296-
Catchup: <quote>catching up</quote> of a fallen-behind standby server.
296+
Catchup: cloning a <productname>PostgreSQL</productname> instance for a fallen-behind standby server to <quote>catch up</quote> with master.
297297
</para>
298298
</listitem>
299299
</itemizedlist>
@@ -3437,16 +3437,16 @@ pg_probackup delete -B <replaceable>backup_dir</replaceable> --instance <replace
34373437
</refsect2>
34383438

34393439
<refsect2 id="pbk-creating-backup-to-catchup" condition="12+">
3440-
<title>Cloning a Database Instance</title>
3440+
<title>Cloning <productname>PostgreSQL</productname> Instance</title>
34413441
<para>
34423442
<application>pg_probackup</application> can create a copy of a <productname>PostgreSQL</productname>
3443-
database instance directly, without using the backup catalog. This allows you
3443+
instance directly, without using the backup catalog. This allows you
34443444
to add a new standby server in a parallel mode or to have a standby
34453445
server that has fallen behind <quote>catch up</quote> with master.
34463446
</para>
34473447

34483448
<para>
3449-
Cloning a database instance is different from other <application>pg_probackup</application>
3449+
Cloning a <productname>PostgreSQL</productname> instance is different from other <application>pg_probackup</application>
34503450
processes:
34513451
<itemizedlist>
34523452
<listitem>
@@ -3469,12 +3469,12 @@ pg_probackup delete -B <replaceable>backup_dir</replaceable> --instance <replace
34693469
</para>
34703470

34713471
<para>
3472-
Before cloning a database instance, set up the source database server as follows:
3472+
Before cloning a <productname>PostgreSQL</productname> instance, set up the source database server as follows:
34733473
<itemizedlist>
34743474
<listitem>
34753475
<para>
34763476
<link linkend="pbk-configuring-the-database-cluster">Configure
3477-
the database cluster</link> that contains the database instance to copy.
3477+
the database cluster</link> for the instance to copy.
34783478
</para>
34793479
</listitem>
34803480
<listitem>
@@ -3491,8 +3491,8 @@ pg_probackup delete -B <replaceable>backup_dir</replaceable> --instance <replace
34913491
</para>
34923492

34933493
<para>
3494-
To clone a database instance, ensure that the source
3495-
database is running and accepting connections and
3494+
To clone a <productname>PostgreSQL</productname> instance, ensure that the source
3495+
database server is running and accepting connections and
34963496
on the server with the destination database, run the following command:
34973497
</para>
34983498
<programlisting>
@@ -3505,7 +3505,7 @@ pg_probackup catchup -b <replaceable>catchup-mode</replaceable> --source-pgdata=
35053505
<itemizedlist spacing="compact">
35063506
<listitem>
35073507
<para>
3508-
FULL — creates a full copy of the database instance.
3508+
FULL — creates a full copy of the <productname>PostgreSQL</productname> instance.
35093509
The destination directory must be empty for this mode.
35103510
</para>
35113511
</listitem>
@@ -3529,7 +3529,7 @@ pg_probackup catchup -b <replaceable>catchup-mode</replaceable> --source-pgdata=
35293529
</itemizedlist>
35303530
<para>
35313531
You can use <link linkend="pbk-connection-opts">connection_options</link> to specify
3532-
the connection to the source database, and if it is located on a different server,
3532+
the connection to the source database cluster. If it is located on a different server,
35333533
also specify <link linkend="pbk-remote-server-opts">remote_options</link>.
35343534
If the source database contains tablespaces that must be located in
35353535
a different directory, additionally specify the <option>--tablespace-mapping</option>
@@ -3544,7 +3544,7 @@ pg_probackup catchup -b <replaceable>catchup-mode</replaceable> --source-pgdata=
35443544
</programlisting>
35453545
</para>
35463546
<para>
3547-
For example, assume that a remote standby server with the database instance in <filename>/replica-pgdata</filename> data directory has fallen behind. To sync this database instance with that in <filename>/master-pgdata</filename> data directory, you can run
3547+
For example, assume that a remote standby server with the <productname>PostgreSQL</productname> instance in <filename>/replica-pgdata</filename> data directory has fallen behind. To sync this instance with the one in <filename>/master-pgdata</filename> data directory, you can run
35483548
the <command>catchup</command> command in the <literal>PTRACK</literal> mode on four parallel threads as follows:
35493549
<programlisting>
35503550
pg_probackup catchup --source-pgdata=/master-pgdata --destination-pgdata=/replica-pgdata -p 5432 -d postgres -U remote-postgres-user --stream --backup-mode=PTRACK --remote-host=remote-hostname --remote-user=remote-unix-username -j 4
@@ -4442,7 +4442,7 @@ pg_probackup catchup -b <replaceable>catchup_mode</replaceable>
44424442
[<replaceable>connection_options</replaceable>] [<replaceable>remote_options</replaceable>]
44434443
</programlisting>
44444444
<para>
4445-
Creates a copy of a <productname>PostgreSQL</productname> database
4445+
Creates a copy of a <productname>PostgreSQL</productname>
44464446
instance without using the backup catalog.
44474447

44484448
<variablelist>
@@ -4456,7 +4456,7 @@ pg_probackup catchup -b <replaceable>catchup_mode</replaceable>
44564456
<itemizedlist spacing="compact">
44574457
<listitem>
44584458
<para>
4459-
<literal>FULL</literal> — creates a full copy of the database instance.
4459+
<literal>FULL</literal> — creates a full copy of the <productname>PostgreSQL</productname> instance.
44604460
</para>
44614461
</listitem>
44624462
<listitem>
@@ -4481,7 +4481,7 @@ pg_probackup catchup -b <replaceable>catchup_mode</replaceable>
44814481
<term><option>--source-pgdata=<replaceable>path_to_pgdata_on_remote_server</replaceable></option></term>
44824482
<listitem>
44834483
<para>
4484-
Specifies the path to the data directory of the database to be copied, which can be local or remote.
4484+
Specifies the path to the data directory of the instance to be copied. The path can be local or remote.
44854485
</para>
44864486
</listitem>
44874487
</varlistentry>
@@ -4490,7 +4490,7 @@ pg_probackup catchup -b <replaceable>catchup_mode</replaceable>
44904490
<term><option>--destination-pgdata=<replaceable>path_to_local_dir</replaceable></option></term>
44914491
<listitem>
44924492
<para>
4493-
Specifies the path to the local data directory of the database to copy to.
4493+
Specifies the path to the local data directory to copy to.
44944494
</para>
44954495
</listitem>
44964496
</varlistentry>
@@ -4541,7 +4541,7 @@ pg_probackup catchup -b <replaceable>catchup_mode</replaceable>
45414541
</para>
45424542
<para>
45434543
For details on usage, see the section
4544-
<link linkend="pbk-creating-backup-to-catchup">Creating a Catchup Copy</link>.
4544+
<link linkend="pbk-creating-backup-to-catchup">Cloning <productname>PostgreSQL</productname> Instance</link>.
45454545
</para>
45464546
</refsect3>
45474547
</refsect2>

0 commit comments

Comments
 (0)