Misleading

Started by Nonameabout 9 years ago3 messagesdocs
Jump to latest
#1Noname
marek.cvoren@gmail.com

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/9.6/static/pgupgrade.html
Description:

Hello,

Please correct following part of pg_upgrade documentation:
`You can also specify user and port values, and whether you want the data
linked instead of copied (the default).`

It is not clear what is the default option. If you read the whole sentence,
then context might be misinterpreted to `data linked instead of copied` is
default but you meant that copying is default. Please correct this as it is
confusing and can lead someone to big troubles.

My suggestion:
- completely omit confusing default word:
`You can also specify user and port values, and whether you want the data
linked instead of copied.`

Thank you.

Cheers,
Marek

--
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs

#2Peter Eisentraut
peter_e@gmx.net
In reply to: Noname (#1)
Re: Misleading

On 3/28/17 07:02, marek.cvoren@gmail.com wrote:

Please correct following part of pg_upgrade documentation:
`You can also specify user and port values, and whether you want the data
linked instead of copied (the default).`

It is not clear what is the default option. If you read the whole sentence,
then context might be misinterpreted to `data linked instead of copied` is
default but you meant that copying is default. Please correct this as it is
confusing and can lead someone to big troubles.

My suggestion:
- completely omit confusing default word:
`You can also specify user and port values, and whether you want the data
linked instead of copied.`

It's debatable whether that sentence is unclear, I think, but the change
you propose actually loses the information about what mode is the
default, which wouldn't be good.

--
Peter Eisentraut http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

--
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs

#3Bruce Momjian
bruce@momjian.us
In reply to: Peter Eisentraut (#2)
Re: Misleading

On Wed, Apr 5, 2017 at 12:28:46AM -0400, Peter Eisentraut wrote:

On 3/28/17 07:02, marek.cvoren@gmail.com wrote:

My suggestion:
- completely omit confusing default word:
`You can also specify user and port values, and whether you want the data
linked instead of copied.`

It's debatable whether that sentence is unclear, I think, but the change
you propose actually loses the information about what mode is the
default, which wouldn't be good.

I have applied the attached doc patch to clarify this.

--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +

Attachments:

pg_upgrade.difftext/x-diff; charset=us-asciiDownload+4-4