forked frompostgres/postgres
- Notifications
You must be signed in to change notification settings - Fork6
Commit977d865
committed
Describe special values in GUC descriptions more consistently.
Many GUCs accept special values like -1 or an empty string todisable the feature, use a system default, etc. While thedocumentation consistently lists these special values, the GUCdescriptions do not. Many such descriptions fail to mention thespecial values, and those that do vary in phrasing and placement.This commit aims to bring some consistency to this area by applyingthe following rules:* Special values should be listed at the end of the long description.* Descriptions should use numerals (e.g., "0") instead of words (e.g., "zero").* Special value mentions should be concise and direct (e.g., "0 disables the timeout.", "An empty string means use the operating system setting.").* Multiple special values should be listed in ascending order.Of course, there are exceptions, such asmax_pred_locks_per_relation and search_path, whose special valuesare too complex to include. And there are cases likelisten_addresses, where the meaning of an empty string is arguablytoo obvious to include. In those cases, I've refrained from addingspecial value information to the GUC description.Reviewed-by: Peter Smith <smithpb2250@gmail.com>Reviewed-by: "David G. Johnston" <david.g.johnston@gmail.com>Reviewed-by: Daniel Gustafsson <daniel@yesql.se>Discussion:https://postgr.es/m/Z6aIy4aywxUZHAo6%40nathan1 parent67a0234 commit977d865
File tree
2 files changed
+84
-70
lines changed- src
- backend/utils/misc
- include/utils
2 files changed
+84
-70
lines changed0 commit comments
Comments
(0)