Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit a243569

Browse files
committed
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
1 parent 8d9978a commit a243569

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

doc/src/sgml/sources.sgml

+8
Original file line numberDiff line numberDiff line change
@@ -538,6 +538,14 @@ Hint: The addendum, written as a complete sentence.
538538
variables that will not contain words (for example, operator names).
539539
</para>
540540

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

0 commit comments

Comments
 (0)