]> granicus.if.org Git - postgresql/commitdiff
doc: Update note about source code formatting
authorPeter Eisentraut <peter@eisentraut.org>
Thu, 26 Sep 2019 08:51:39 +0000 (10:51 +0200)
committerPeter Eisentraut <peter@eisentraut.org>
Thu, 26 Sep 2019 08:51:39 +0000 (10:51 +0200)
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

doc/src/sgml/sources.sgml

index 6294312ab7dfc98a0a2144440640c7e48f3ba609..25e7763c7c7696d308fa99b68cd72bef78ae3523 100644 (file)
@@ -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>