Change example in pgindent README on "/*-----" comments.

Most, but not all, of our "/*----" style comments have an end-guard
line with dashes at the end of the comment. However, pgindent doesn't
care about the end-guards, so they mostly just waste screen
space. Going forward, let's not require end-guards.

Remove a broken end-guard in a comment in walsender.c that led me to
think about this. Remove the end guard from another comment in
walsender.c for consistency, so that we use the same style in all
comments in the file.

However, we have thousands of existing "/*----" comments the repository,
so it's not worth the code churn to change them all.

Discussion: https://www.postgresql.org/message-id/fb083c91-d490-3b65-25f3-05e9118b6b0d%40iki.fi

diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c
index d3a136b6f55469535bddd1abaa689c8d61e105d6..cedadb0036f1a0ca7cd44c450a702d3f3012d2e9 100644 (file)
--- a/src/backend/replication/walsender.c
+++ b/src/backend/replication/walsender.c
@@ -1197,7 +1197,6 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd)
     * - second field: LSN at which we became consistent
     * - third field: exported snapshot's name
     * - fourth field: output plugin
-    *----------
     */
    tupdesc = CreateTemplateTupleDesc(4);
    TupleDescInitBuiltinEntry(tupdesc, (AttrNumber) 1, "slot_name",
@@ -2692,7 +2691,7 @@ WalSndSegmentOpen(XLogReaderState *state, XLogSegNo nextSegNo,
     * restored from the archive on this server, the file belonging to the old
     * timeline, 000000040000000000000013, might not exist. Their contents are
     * equal up to the switchpoint, because at a timeline switch, the used
-    * portion of the old segment is copied to the new file.  -------
+    * portion of the old segment is copied to the new file.
     */
    *tli_p = sendTimeLine;
    if (sendTimeLineIsHistoric)

diff --git a/src/tools/pgindent/README b/src/tools/pgindent/README
index f5fdfc5d2ff1021ec8e93732989d77ff99ab1066..b649a21f59302c108a530dd627c3f5fac8d756f0 100644 (file)
--- a/src/tools/pgindent/README
+++ b/src/tools/pgindent/README
@@ -104,7 +104,6 @@ the comment block with some dashes:
 
    /*----------
     * Text here will not be touched by pgindent.
-    *----------
     */
 
 Odd spacing around typedef names might indicate an incomplete typedefs list.