Docs: inaccurate description about config settings - Mailing list pgsql-hackers

From Li Japin
Subject Docs: inaccurate description about config settings
Date
Msg-id 199703E4-A795-4FB8-911C-D0DE9F51519C@hotmail.com
Whole thread Raw
Responses Re: Docs: inaccurate description about config settings  (Ian Lawrence Barwick <barwick@gmail.com>)
List pgsql-hackers
Hi, hackers

When I setup a stream replication I found that the documentation says that promote_trigger_file
parameter can only be set in the postgresql.conf file or on the server command line, however, it
can also be put into postgresql.auto.conf. If I use include to import a new config, it works too.

There are many parameters use this description:
$ grep 'This parameter can only be set in the' -rn doc/
doc/src/sgml/sepgsql.sgml:273:      This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:1001:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:1040:        for details. This parameter can only be set in the
doc/src/sgml/config.sgml:1071:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:1133:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:1151:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:1169:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:1187:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:1204:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:1232:        This parameter can only be set in the
doc/src/sgml/config.sgml:1307:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:1334:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:1411:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:1445:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:1471:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:2180:         of 10.  This parameter can only be set in the
doc/src/sgml/config.sgml:2199:         This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:2227:         This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:2259:         This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:2817:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:2863:        This parameter can only be set in the <filename>postgresql.conf</filename>
doc/src/sgml/config.sgml:3012:        next higher multiple of 10. This parameter can only be set in the
doc/src/sgml/config.sgml:3036:        This parameter can only be set in the
….

I think this description is misleading. we should correct it, isn't it?

Regards,
Japin Li

pgsql-hackers by date:

Previous
From: gkokolatos@pm.me
Date:
Subject: Re: Reloptions for table access methods
Next
From: Georgios Kokolatos
Date:
Subject: Re: New default role- 'pg_read_all_data'