From: Liudmila Mantrova <l.mantrova@postgrespro.ru>
To: pgsql-docs@lists.postgresql.org
Subject: suspicious wording in pg_rewind docs
Date: Fri, 26 Jul 2019 21:08:47 +0300
Message-ID: <ad6ac5bb-6689-ddb0-dc60-c5fc197d728e@postgrespro.ru> (raw)
Hi everyone,
While reviewing docs for [1] I came across a phrase in pg_rewind.sgml
that seems confusing:
"... The point of divergence can be found either on the target timeline,
the source timeline, or their common ancestor. In the typical failover
scenario where the target cluster was shut down soon after the
divergence, this is not a problem, but if the target cluster ran for a
long time after the divergence, the old WAL files might no longer be
present. In that case, they can be manually copied from the WAL archive
to the |pg_wal| directory, or fetched on startup by configuring
primary_conninfo
<https://www.postgresql.org/docs/12/runtime-config-replication.html#GUC-PRIMARY-CONNINFO;
or restore_command
<https://www.postgresql.org/docs/12/runtime-config-wal.html#GUC-RESTORE-COMMAND;.
"
While beginning of this paragraph talks about scanning target cluster
WALs, the "or fetched on startup" part suggests that we are applying the
source cluster WALs already, so I would simply remove it from here. To
avoid source/target confusion, we could also add another hint that it's
target WALs we are talking about.
Please consider the attached fix.
[1]
https://www.postgresql.org/message-id/a3acff50-5a0d-9a2c-b3b2-ee36168955c1%40postgrespro.ru
--
Liudmila Mantrova
Technical writer at Postgres Professional: http://www.postgrespro.com
The Russian Postgres Company
Attachments:pg-rewind-doc-fix.patch (text/x-patch, 1.4K) downloaddiff --git a/doc/src/sgml/ref/pg_rewind.sgml b/doc/src/sgml/ref/pg_rewind.sgmlindex 52a1caa..a7e1705 100644--- a/doc/src/sgml/ref/pg_rewind.sgml+++ b/doc/src/sgml/ref/pg_rewind.sgml@@ -66,14 +66,12 @@ PostgreSQL documentation
can be found either on the target timeline, the source timeline, or their common
ancestor. In the typical failover scenario where the target cluster was
shut down soon after the divergence, this is not a problem, but if the
- target cluster ran for a long time after the divergence, the old WAL+ target cluster ran for a long time after the divergence, its old WAL
files might no longer be present. In that case, they can be manually
- copied from the WAL archive to the <filename>pg_wal</filename> directory, or- fetched on startup by configuring <xref linkend="guc-primary-conninfo"/> or- <xref linkend="guc-restore-command"/>. The use of- <application>pg_rewind</application> is not limited to failover, e.g. a standby- server can be promoted, run some write transactions, and then rewinded- to become a standby again.+ copied from the WAL archive to the <filename>pg_wal</filename> directory.+ The use of <application>pg_rewind</application> is not limited to failover,+ e.g. a standby server can be promoted, run some write transactions, and then+ get rewound to become a standby again.
</para>
<para>
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: l.mantrova@postgrespro.ru, pgsql-docs@lists.postgresql.org
Subject: Re: suspicious wording in pg_rewind docs
In-Reply-To: <ad6ac5bb-6689-ddb0-dc60-c5fc197d728e@postgrespro.ru>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox