public inbox for [email protected]  

help / color / mirror / Atom feed

From: Thom Brown <[email protected]>
To: Fujii Masao <[email protected]>
Cc: [email protected]
Subject: Re: Confusing link in streaming replication section
Date: Wed, 24 Feb 2010 13:45:18 +0000
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
	<[email protected]>
	<[email protected]>

On 12 February 2010 16:15, Thom Brown <[email protected]> wrote:
> On 12 February 2010 01:57, Fujii Masao <[email protected]> wrote:
>> On Thu, Feb 11, 2010 at 7:43 AM, Thom Brown <[email protected]> wrote:
>>> I'm looking at the latest docs for PostgreSQL 9.0
>>> (http://developer.postgresql.org/pgdocs/postgres/streaming-replication.html)
>>> and under the description of primary_conninfo, there's a link to
>>> section 30.1 (http://developer.postgresql.org/pgdocs/postgres/libpq-connect.html)
>>> which is supposed to describe the string format.  Having looked at
>>> that page, however, it's not crystal clear what is meant by this
>>> string format.  One can only assume it's referring to the
>>> PQconnectdbParams section and the keywords that can be used for it,
>>> which would also apply to a connection string, but there's no mention
>>> of a "format" on that page.
>>
>> Thanks for the report!
>>
>> Though at first PQconnectdb() had been linked by the SR doc, instead
>> PQconnectdbParams() seems to have been linked wrongly when it was committed.
>> How about changing the link so as to point to PQconnectdb() again? Or
>> copy-pasting the following description from PQconnectdb() to the SR doc?
>>
>> -----------
>> The passed string can be empty to use all default parameters, or it can
>> contain one or more parameter settings separated by whitespace. Each
>> parameter setting is in the form keyword = value. Spaces around the equal
>> sign are optional. To write an empty value, or a value containing spaces,
>> surround it with single quotes, e.g., keyword = 'a value'. Single quotes
>> and backslashes within the value must be escaped with a backslash,
>> i.e., \' and \\.
>>
>> The currently recognized parameter key words are the same as above.
>> -----------
>
> Hmmm... well that last sentence refers to parameter key words which
> won't appear on the SR page unless you copy and paste all that
> information too.
>
> I think the problem I have with there being a link to the libpq
> control functions page is that the context of the settings isn't the
> same, meaning the text on that page is specifically targetting people
> looking for libpq info, rather than providing more generic information
> which may be better placed in an appendix or something similar.
>
> May I suggest a page on connection paramaters/connection strings which
> can be referenced by multiple locations?  Otherwise I can imagine the
> same information being presented a number of times throughout the
> documentation.
>
> Thanks
>
> Thom
>

Anyone had any thoughts on this?

Thom

view thread (13+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected]
  Subject: Re: Confusing link in streaming replication section
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox