Date: Tue, 26 Sep 2023 13:34:56 -0400
From: Bruce Momjian <bruce@momjian.us>
To: mark.a.sloan@gmail.com, pgsql-docs@lists.postgresql.org
Subject: Re: pg_upgrade doc uses inconsistent versions within the doc.
Message-ID: <ZRMWQCnV1lCAV7ES@momjian.us>
References: <169506804412.3727336.8571753495127355296@wrigleys.postgresql.org>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="HG1lXbT9nj8nVAbu"
Content-Disposition: inline
In-Reply-To: 
 <169506804412.3727336.8571753495127355296@wrigleys.postgresql.org>
Archived-At: 
 <https://www.postgresql.org/message-id/ZRMWQCnV1lCAV7ES%40momjian.us>
Precedence: bulk


--HG1lXbT9nj8nVAbu
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

On Mon, Sep 18, 2023 at 08:14:04PM +0000, PG Doc comments form wrote:
> The following documentation comment has been logged on the website:
> 
> Page: https://www.postgresql.org/docs/16/pgupgrade.html
> Description:
> 
> I feel like for readability the pg_upgrade doc should use the same
> old_version and new_version examples when showing examples throughout the
> doc page.  
> 
> as an exmaple I'm looking at :
> https://www.postgresql.org/docs/current/pgupgrade.html 
> 
> in some places the example commands use v9.6 and v16. (see step 8)
> 
> but in other places it mixes versions v9.5 and v9.6 (see step 11 sub step 8)

Good point.  I came up with the attached patch.  It uses 9.6 and current
--- the only problem is that the target directory is now:

	/vol1/pg_tblsp/PG_&majorversion;_202307071
	                                 ---------

and since the catalog version is not accessible from SGML, it will
usually not match the major version's catalog number.

I would apply this only to Postgres 17 since it isn't really a fix.

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EDB                                      https://enterprisedb.com

  Only you can decide what is important to you.

--HG1lXbT9nj8nVAbu
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment; filename="upgrade_version.diff"

diff --git a/doc/src/sgml/ref/pgupgrade.sgml b/doc/src/sgml/ref/pgupgrade.sgml
index bea0d1b93f..dc9e52a684 100644
--- a/doc/src/sgml/ref/pgupgrade.sgml
+++ b/doc/src/sgml/ref/pgupgrade.sgml
@@ -605,8 +605,8 @@ rsync --archive --delete --hard-links --size-only --no-inc-recursive old_cluster
        remote directory, e.g.,
 
 <programlisting>
-rsync --archive --delete --hard-links --size-only --no-inc-recursive /opt/PostgreSQL/9.5 \
-      /opt/PostgreSQL/9.6 standby.example.com:/opt/PostgreSQL
+rsync --archive --delete --hard-links --size-only --no-inc-recursive /opt/PostgreSQL/9.6 \
+      /opt/PostgreSQL/&majorversion; standby.example.com:/opt/PostgreSQL
 </programlisting>
 
        You can verify what the command will do using
@@ -635,8 +635,8 @@ rsync --archive --delete --hard-links --size-only --no-inc-recursive /opt/Postgr
        <application>rsync</application> command for each tablespace directory, e.g.:
 
 <programlisting>
-rsync --archive --delete --hard-links --size-only --no-inc-recursive /vol1/pg_tblsp/PG_9.5_201510051 \
-      /vol1/pg_tblsp/PG_9.6_201608131 standby.example.com:/vol1/pg_tblsp
+rsync --archive --delete --hard-links --size-only --no-inc-recursive /vol1/pg_tblsp/PG_9.6_201608131 \
+      /vol1/pg_tblsp/PG_&majorversion;_202307071 standby.example.com:/vol1/pg_tblsp
 </programlisting>
 
        If you have relocated <filename>pg_wal</filename> outside the data

--HG1lXbT9nj8nVAbu--