v1-0001-GUC-names-docs.patch
application/octet-stream
Filename: v1-0001-GUC-names-docs.patch
Type: application/octet-stream
Part: 0
Message:
Re: GUC names in messages
Patch
Format: format-patch
Series: patch v1-0001
Subject: GUC names - docs
| File | + | − |
|---|---|---|
| doc/src/sgml/sources.sgml | 8 | 0 |
From d935519fa69d873a1b11340076910b31caad2a05 Mon Sep 17 00:00:00 2001
From: Peter Smith <peter.b.smith@fujitsu.com>
Date: Thu, 23 Nov 2023 14:05:58 +1100
Subject: [PATCH v1] GUC names - docs
---
doc/src/sgml/sources.sgml | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml
index 06d995e..45ad706 100644
--- a/doc/src/sgml/sources.sgml
+++ b/doc/src/sgml/sources.sgml
@@ -539,6 +539,14 @@ Hint: The addendum, written as a complete sentence.
</para>
<para>
+ In messages containing configuration variable names, do not include quotes
+ when the names are visibly not English natural words, such as when they
+ have underscores or 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
additional quotes around the output of such functions.
--
1.8.3.1