suspicious wording in pg_rewind docs
Liudmila Mantrova <[email protected]>
| Newsgroups | gmane.comp.db.postgresql.devel.documentation |
|---|---|
| Message-ID | <[email protected]> |
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
pg-rewind-doc-fix.patch
(text/x-patch, 1.4 KB)
diff --git a/doc/src/sgml/ref/pg_rewind.sgml b/doc/src/sgml/ref/pg_rewind.sgml
index 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>