Duplicated docs on libpq parameters
There seems to be a lot of duplication in the libpq documentation
between the connection string parameters and the environment variables.
They are close to identical but not exactly (for example, there is a
"and vs or" change in PGSSLMODE/sslmode).
Any reason not to just have the environment variable documentation refer
back to the connection option documentation?
//Magnus
Magnus Hagander <magnus@hagander.net> writes:
Any reason not to just have the environment variable documentation refer
back to the connection option documentation?
Well, not all of 'em are connection options.
I could see documenting the connection options more like the
GUC-variable options, ie a few words and a reference to the underlying
option. Or is that what you meant?
regards, tom lane
Tom Lane wrote:
Magnus Hagander <magnus@hagander.net> writes:
Any reason not to just have the environment variable documentation refer
back to the connection option documentation?Well, not all of 'em are connection options.
I could see documenting the connection options more like the
GUC-variable options, ie a few words and a reference to the underlying
option. Or is that what you meant?
Well, I was mostly thinking like:
PGSSLMODE
This corresponds to the <link>sslmode</link> connection option.
Then for those that aren't connection options, we'd keep the full
description. I'm not advocating we remove the whole chapter, just the
duplicated stuff. (I assume we can make the link above go directly to
the description for the option?)
//Magnus
Magnus Hagander wrote:
Well, I was mostly thinking like:
PGSSLMODE
This corresponds to the <link>sslmode</link> connection option.Then for those that aren't connection options, we'd keep the full
description. I'm not advocating we remove the whole chapter, just the
duplicated stuff. (I assume we can make the link above go directly to
the description for the option?)
You might need to add some extra id=foo attributes in the sslmode option
if they're not there already, but it should work.
--
Alvaro Herrera http://www.CommandPrompt.com/
The PostgreSQL Company - Command Prompt, Inc.
Magnus Hagander wrote:
Tom Lane wrote:
Magnus Hagander <magnus@hagander.net> writes:
Any reason not to just have the environment variable documentation refer
back to the connection option documentation?Well, not all of 'em are connection options.
I could see documenting the connection options more like the
GUC-variable options, ie a few words and a reference to the underlying
option. Or is that what you meant?Well, I was mostly thinking like:
PGSSLMODE
This corresponds to the <link>sslmode</link> connection option.Then for those that aren't connection options, we'd keep the full
description. I'm not advocating we remove the whole chapter, just the
duplicated stuff. (I assume we can make the link above go directly to
the description for the option?)
Done, with attached, applied patch.
--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com
+ If your life is a hard drive, Christ can be your backup. +