Re: Docs: inaccurate description about config settings

Поиск
Список
Период
Сортировка
От Ian Lawrence Barwick
Тема Re: Docs: inaccurate description about config settings
Дата
Msg-id CAB8KJ=iawAyLsXbeHLTrSamx42jChO_g2mtwi_t9R3WKh0_kMg@mail.gmail.com
обсуждение исходный текст
Ответ на Docs: inaccurate description about config settings  (Li Japin <japinli@hotmail.com>)
Ответы Re: Docs: inaccurate description about config settings
Список pgsql-hackers
2020年9月1日(火) 19:37 Li Japin <japinli@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 <link
linkend="config-setting-configuration-file">configuration file</link>

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



В списке pgsql-hackers по дате отправления:

Предыдущее
От: Dmitry Dolgov
Дата:
Сообщение: Group by reordering optimization
Следующее
От: Surafel Temesgen
Дата:
Сообщение: Re: Evaluate expression at planning time for two more cases