Re: [9.3] Should we mention "set_config(...)" in 18.1.3 in Server Configuration?

From: David Johnston <david(dot)g(dot)johnston(at)gmail(dot)com>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: "pgsql-docs(at)postgresql(dot)org" <pgsql-docs(at)postgresql(dot)org>
Subject: Re: [9.3] Should we mention "set_config(...)" in 18.1.3 in Server Configuration?
Date: 2014-09-09 19:40:45
Message-ID: CAKFQuwbn=wB_rgkJQRvUH+KOGUUPU9Hde3b0cZvSAv=62df95w@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

On Tue, Sep 9, 2014 at 3:13 PM, Bruce Momjian <bruce(at)momjian(dot)us> wrote:

> On Thu, Jun 12, 2014 at 11:32:49AM -0400, David Johnston wrote:
> > This addition still needs some work as well as the patch as a whole (see
> my
> > comments above). The attached PDF is the page that results from "make
> html";
> > the original patch has been re-attached as well and -hackers copied
> given the
> > lack of response on -doc.
> >
> > I am hoping this change would be something that could be included in
> 9.4; I
> > believe the enhancements would be most beneficial to newcomers who are
> just
> > getting started with PostgreSQL and would be using 9.4 as their starting
> point.
>
> [hackers CC removed]
>
> I have reviewed and updated this reworking of our configuration settings
> documentation and feel it is ready for application to head and 9.4;
> attached.
>
>
Minor corrections:

​First block: "
In the first section of this chapter, we
describe how to set configuration parameters"​

​- remove the comma

​Second Block:
- placement of the colon inside or outside of the emphasis tag is
inconsistent (string, unit, enum are inside; boolean and ​numeric are
outside)
- units: "An numeric value..." -> maybe "An unadorned numeric value...

​Third block:
​"Hash marks (<literal>#</literal>) designate the remainder of lines as
comments." -> "...designate the remainder of the line as a comment." I
read this at first as "remaining lines [in the file] ... "

"To embed a single quote in a parameter value, write either two quotes
(preferred) or backslash-quote." -> remove the comma
"Querying this view is the sames as" -> "the same as"
"In addition to setting global defaults or attaching" <- add a comma after
"defaults"

A few extra commas here-and-there which seem to have replaced my use of
colons but that maybe should just be removed completely. If I didn't note
it above it seemed OK to leave in (or I missed it entirely...)

David J.

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Bruce Momjian 2014-09-10 20:20:02 Re: [9.3] Should we mention "set_config(...)" in 18.1.3 in Server Configuration?
Previous Message Bruce Momjian 2014-09-09 19:13:17 Re: [9.3] Should we mention "set_config(...)" in 18.1.3 in Server Configuration?

Browse pgsql-hackers by date

  From Date Subject
Next Message Andres Freund 2014-09-09 20:22:45 Re: [Fwd: Re: proposal: new long psql parameter --on-error-stop]
Previous Message Tom Lane 2014-09-09 19:36:11 Re: Built-in binning functions