From: Peter Eisentraut <peter@eisentraut.org>
Date: Thu, 26 Sep 2019 08:51:39 +0000 (+0200)
Subject: doc: Update note about source code formatting
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=49e36e7901c691fd7e80ba56465b649a211290cf;p=postgresql

doc: Update note about source code formatting

Update the note about why not to use // comments, even though it's now
technically supported.

The note about variable declarations was dropped here because it's
addressed more properly later in the chapter.

Discussion: https://www.postgresql.org/message-id/flat/156924954640.1117.6309209869705522549%40wrigleys.postgresql.org
---

diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml
index 6294312ab7..25e7763c7c 100644
--- a/doc/src/sgml/sources.sgml
+++ b/doc/src/sgml/sources.sgml
@@ -26,9 +26,9 @@
    </para>
 
    <para>
-    Do not use C++ style comments (<literal>//</literal> comments).  Strict ANSI C
-    compilers do not accept them.  For the same reason, do not use C++
-    extensions such as declaring new variables mid-block.
+    To maintain a consistent coding style, do not use C++ style comments
+    (<literal>//</literal> comments).  <application>pgindent</application>
+    will replace them with <literal>/* ... */</literal>.
    </para>
 
    <para>