Re: Docs: inaccurate description about config settings
On Sep 1, 2020, at 8:20 PM, Ian Lawrence Barwick mailto:barw...@gmail.com>> wrote: 2020年9月1日(火) 19:37 Li Japin mailto:japi...@hotmail.com>>: 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/ (...) I think this description is misleading. we should correct it, isn't it? I must admit every time I see this wording, it strikes me as very specific and potentially confusing given the alternative files the parameter could be placed in. I think it would be clearer for anyone not familiar with the configuration file system to change occurrences of this wording to something like: This parameter can only be set in the configuration file which would link to: https://www.postgresql.org/docs/current/config-setting.html#CONFIG-SETTING-CONFIGURATION-FILE which provides more information. Though on that page it seems like it would be also sensible to bundle the section about include directives in the configuration file (19.1.5) together with the section about the configuration itself (19.1.2). +1 Attached is a fix following Ian Barwick’s suggestion. Regards, Japin Li fix-confusing-configuration-parameters-setting-desc.patch Description: fix-confusing-configuration-parameters-setting-desc.patch
Re: Docs: inaccurate description about config settings
2020年9月1日(火) 19:37 Li Japin : > > 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/ (...) > > I think this description is misleading. we should correct it, isn't it? I must admit every time I see this wording, it strikes me as very specific and potentially confusing given the alternative files the parameter could be placed in. I think it would be clearer for anyone not familiar with the configuration file system to change occurrences of this wording to something like: This parameter can only be set in the configuration file which would link to: https://www.postgresql.org/docs/current/config-setting.html#CONFIG-SETTING-CONFIGURATION-FILE which provides more information. Though on that page it seems like it would be also sensible to bundle the section about include directives in the configuration file (19.1.5) together with the section about the configuration itself (19.1.2). Regards Ian Barwick -- Ian Barwick https://www.2ndQuadrant.com/ PostgreSQL Development, 24x7 Support, Training & Services
Docs: inaccurate description about config settings
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 postgresql.conf doc/src/sgml/config.sgml:1001:This parameter can only be set in the postgresql.conf 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 postgresql.conf doc/src/sgml/config.sgml:1133:This parameter can only be set in the postgresql.conf doc/src/sgml/config.sgml:1151:This parameter can only be set in the postgresql.conf doc/src/sgml/config.sgml:1169:This parameter can only be set in the postgresql.conf doc/src/sgml/config.sgml:1187:This parameter can only be set in the postgresql.conf doc/src/sgml/config.sgml:1204:This parameter can only be set in the postgresql.conf 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 postgresql.conf doc/src/sgml/config.sgml:1334:This parameter can only be set in the postgresql.conf doc/src/sgml/config.sgml:1411:This parameter can only be set in the postgresql.conf doc/src/sgml/config.sgml:1445:This parameter can only be set in the postgresql.conf doc/src/sgml/config.sgml:1471:This parameter can only be set in the postgresql.conf 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 postgresql.conf doc/src/sgml/config.sgml:2227: This parameter can only be set in the postgresql.conf doc/src/sgml/config.sgml:2259: This parameter can only be set in the postgresql.conf doc/src/sgml/config.sgml:2817:This parameter can only be set in the postgresql.conf doc/src/sgml/config.sgml:2863:This parameter can only be set in the postgresql.conf 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
