doc: Mention how to use quotes with GUC names in error messages

Quotes should not be used except if a GUC name is a natural English word. Author: Álvaro Herrera Discussion: https://postgr.es/m/CAHut+Pv-kSN8SkxSdoHano_wPubqcg5789ejhCDZAcLFceBR-w@mail.gmail.com
2 years ago · a243569bf6
parent 8d9978a717
commit a243569bf6
1 changed files with 8 additions and 0 deletions
--- a/doc/src/sgml/sources.sgml
+++ b/doc/src/sgml/sources.sgml
@ -538,6 +538,14 @@ Hint:       The addendum, written as a complete sentence.
    variables that will not contain words (for example, operator names).
   </para>

+   <para>
+    In messages containing configuration variable names, do not include quotes
+    when the names are visibly not natural English words, such as when they
+    have underscores, are all-uppercase or have mixed case. Otherwise, quotes
+    must be added. Do include quotes in a message where an arbitrary variable
+    name is to be expanded.
+   </para>
+
   <para>
    There are functions in the backend that will double-quote their own output
    as needed (for example, <function>format_type_be()</function>).  Do not put