pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
pg_upgrade doc uses inconsistent versions within the doc.
6+ messages / 4 participants
[nested] [flat]

* pg_upgrade doc uses inconsistent versions within the doc.
@ 2023-09-18 20:14  PG Doc comments form <noreply@postgresql.org>
  0 siblings, 1 reply; 6+ messages in thread

From: PG Doc comments form @ 2023-09-18 20:14 UTC (permalink / raw)
  To: pgsql-docs@lists.postgresql.org; +Cc: mark.a.sloan@gmail.com

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)


^ permalink  raw  reply  [nested|flat] 6+ messages in thread

* Re: pg_upgrade doc uses inconsistent versions within the doc.
@ 2023-09-26 17:34  Bruce Momjian <bruce@momjian.us>
  parent: PG Doc comments form <noreply@postgresql.org>
  0 siblings, 1 reply; 6+ messages in thread

From: Bruce Momjian @ 2023-09-26 17:34 UTC (permalink / raw)
  To: mark.a.sloan@gmail.com; pgsql-docs@lists.postgresql.org

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.

Attachments:

  [text/x-diff] upgrade_version.diff (1.4K, ../../ZRMWQCnV1lCAV7ES@momjian.us/2-upgrade_version.diff)
  download | inline 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

^ permalink  raw  reply  [nested|flat] 6+ messages in thread

* Re: pg_upgrade doc uses inconsistent versions within the doc.
@ 2023-09-26 17:56  David G. Johnston <david.g.johnston@gmail.com>
  parent: Bruce Momjian <bruce@momjian.us>
  0 siblings, 1 reply; 6+ messages in thread

From: David G. Johnston @ 2023-09-26 17:56 UTC (permalink / raw)
  To: Bruce Momjian <bruce@momjian.us>; +Cc: mark.a.sloan@gmail.com; pgsql-docs@lists.postgresql.org

On Tue, Sep 26, 2023 at 10:35 AM Bruce Momjian <bruce@momjian.us> wrote:

> 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
>

I would get rid of any mentions of our old pre-v10 versioning scheme in the
current documentation.

David J.

^ permalink  raw  reply  [nested|flat] 6+ messages in thread

* Re: pg_upgrade doc uses inconsistent versions within the doc.
@ 2023-09-26 20:26  Bruce Momjian <bruce@momjian.us>
  parent: David G. Johnston <david.g.johnston@gmail.com>
  0 siblings, 1 reply; 6+ messages in thread

From: Bruce Momjian @ 2023-09-26 20:26 UTC (permalink / raw)
  To: David G. Johnston <david.g.johnston@gmail.com>; +Cc: mark.a.sloan@gmail.com; pgsql-docs@lists.postgresql.org

On Tue, Sep 26, 2023 at 10:56:27AM -0700, David G. Johnston wrote:
> On Tue, Sep 26, 2023 at 10:35 AM Bruce Momjian <bruce@momjian.us> wrote:
> 
>     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
> 
> 
> I would get rid of any mentions of our old pre-v10 versioning scheme in the
> current documentation.

Good point, how is this attached patch?

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

  Only you can decide what is important to you.

Attachments:

  [text/x-diff] upgrade_version.diff (3.1K, ../../ZRM+XeYQYZFIKDSn@momjian.us/2-upgrade_version.diff)
  download | inline diff:
diff --git a/doc/src/sgml/ref/pgupgrade.sgml b/doc/src/sgml/ref/pgupgrade.sgml
index bea0d1b93f..5dd2c446f7 100644
--- a/doc/src/sgml/ref/pgupgrade.sgml
+++ b/doc/src/sgml/ref/pgupgrade.sgml
@@ -40,9 +40,9 @@ PostgreSQL documentation
   <application>pg_upgrade</application> (formerly called <application>pg_migrator</application>) allows data
   stored in <productname>PostgreSQL</productname> data files to be upgraded to a later <productname>PostgreSQL</productname>
   major version without the data dump/restore typically required for
-  major version upgrades, e.g., from 9.5.8 to 9.6.4 or from 10.7 to 11.2.
-  It is not required for minor version upgrades, e.g., from 9.6.2 to 9.6.3
-  or from 10.1 to 10.2.
+  major version upgrades, e.g., from 12.14 to 13.10 or from 14.9 to 15.5.
+  It is not required for minor version upgrades, e.g., from 12.7 to 12.8
+  or from 14.1 to 14.5.
  </para>
 
  <para>
@@ -390,14 +390,14 @@ make prefix=/usr/local/pgsql.new install
      Make sure both database servers are stopped using, on Unix, e.g.:
 
 <programlisting>
-pg_ctl -D /opt/PostgreSQL/9.6 stop
+pg_ctl -D /opt/PostgreSQL/12 stop
 pg_ctl -D /opt/PostgreSQL/&majorversion; stop
 </programlisting>
 
      or on Windows, using the proper service names:
 
 <programlisting>
-NET STOP postgresql-9.6
+NET STOP postgresql-12
 NET STOP postgresql-&majorversion;
 </programlisting>
     </para>
@@ -473,9 +473,9 @@ SET PATH=%PATH%;C:\Program Files\PostgreSQL\&majorversion;\bin;
 
 <programlisting>
 pg_upgrade.exe
-        --old-datadir "C:/Program Files/PostgreSQL/9.6/data"
+        --old-datadir "C:/Program Files/PostgreSQL/12/data"
         --new-datadir "C:/Program Files/PostgreSQL/&majorversion;/data"
-        --old-bindir "C:/Program Files/PostgreSQL/9.6/bin"
+        --old-bindir "C:/Program Files/PostgreSQL/12/bin"
         --new-bindir "C:/Program Files/PostgreSQL/&majorversion;/bin"
 </programlisting>
 
@@ -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/12 \
+      /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_12_201909212 \
+      /vol1/pg_tblsp/PG_&majorversion;_202307071 standby.example.com:/vol1/pg_tblsp
 </programlisting>
 
        If you have relocated <filename>pg_wal</filename> outside the data

^ permalink  raw  reply  [nested|flat] 6+ messages in thread

* Re: pg_upgrade doc uses inconsistent versions within the doc.
@ 2023-09-27 07:42  Daniel Gustafsson <daniel@yesql.se>
  parent: Bruce Momjian <bruce@momjian.us>
  0 siblings, 1 reply; 6+ messages in thread

From: Daniel Gustafsson @ 2023-09-27 07:42 UTC (permalink / raw)
  To: Bruce Momjian <bruce@momjian.us>; +Cc: David G. Johnston <david.g.johnston@gmail.com>; mark.a.sloan@gmail.com; pgsql-docs@lists.postgresql.org

> On 26 Sep 2023, at 22:26, Bruce Momjian <bruce@momjian.us> wrote:
> On Tue, Sep 26, 2023 at 10:56:27AM -0700, David G. Johnston wrote:

>> I would get rid of any mentions of our old pre-v10 versioning scheme in the
>> current documentation.

For content such as this, a very big +1.

> Good point, how is this attached patch?

LGTM.

--
Daniel Gustafsson






^ permalink  raw  reply  [nested|flat] 6+ messages in thread

* Re: pg_upgrade doc uses inconsistent versions within the doc.
@ 2023-10-10 21:12  Bruce Momjian <bruce@momjian.us>
  parent: Daniel Gustafsson <daniel@yesql.se>
  0 siblings, 0 replies; 6+ messages in thread

From: Bruce Momjian @ 2023-10-10 21:12 UTC (permalink / raw)
  To: Daniel Gustafsson <daniel@yesql.se>; +Cc: David G. Johnston <david.g.johnston@gmail.com>; mark.a.sloan@gmail.com; pgsql-docs@lists.postgresql.org

On Wed, Sep 27, 2023 at 09:42:49AM +0200, Daniel Gustafsson wrote:
> > On 26 Sep 2023, at 22:26, Bruce Momjian <bruce@momjian.us> wrote:
> > On Tue, Sep 26, 2023 at 10:56:27AM -0700, David G. Johnston wrote:
> 
> >> I would get rid of any mentions of our old pre-v10 versioning scheme in the
> >> current documentation.
> 
> For content such as this, a very big +1.
> 
> > Good point, how is this attached patch?
> 
> LGTM.

Patch applied back to PG 16.

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

  Only you can decide what is important to you.





^ permalink  raw  reply  [nested|flat] 6+ messages in thread


end of thread, other threads:[~2023-10-10 21:12 UTC | newest]

Thread overview: 6+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2023-09-18 20:14 pg_upgrade doc uses inconsistent versions within the doc. PG Doc comments form <noreply@postgresql.org>
2023-09-26 17:34 ` Bruce Momjian <bruce@momjian.us>
2023-09-26 17:56   ` David G. Johnston <david.g.johnston@gmail.com>
2023-09-26 20:26     ` Bruce Momjian <bruce@momjian.us>
2023-09-27 07:42       ` Daniel Gustafsson <daniel@yesql.se>
2023-10-10 21:12         ` Bruce Momjian <bruce@momjian.us>

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