configuration parameter descriptions - Mailing list pgsql-docs

From Ray Stell
Subject configuration parameter descriptions
Date
Msg-id 20110427154840.GA22607@cns.vt.edu
Whole thread Raw
Responses Re: configuration parameter descriptions  (Josh Kupershmidt <schmiddy@gmail.com>)
List pgsql-docs
I'd like to make a general suggestion on configuration parameter
documentation.  I'd like to see a high level entry as to whether the
parameter can be changed on the fly or not.  I think the Oracle docs refer
to this as static/dynamic.

Currently, dynamic parameters, those that can be changed in a running
cluster, can be identified by the fact that no statement is made.  This
can be confusing.

An example of the "static" entry follows:

 listen_addresses (string)

   parmater description .........
   This parameter can only be set at server start.

This might be communicated with something like:

  listen_addresses (string) /static

The current entry for maintenance_work_mem looks like this:

 maintenance_work_mem (integer)

     Specifies the maximum amount of memory...

which might look something like this:

 maintenance_work_mem (integer)  /dynamic

     Specifies the maximum amount of memory

I'd be willing to work on this adaptation if you need help.
I'd need some introduction to your text management.

Thanks,
Ray

pgsql-docs by date:

Previous
From: Jack Douglas
Date:
Subject: boolean states
Next
From: Josh Kupershmidt
Date:
Subject: Re: configuration parameter descriptions