From 5e8068f04e13e12c182eca3e64ac4377e0c93a5d Mon Sep 17 00:00:00 2001 From: Heikki Linnakangas Date: Wed, 5 Jul 2023 10:02:15 +0300 Subject: [PATCH] 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 --- src/backend/replication/walsender.c | 3 +-- src/tools/pgindent/README | 1 - 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index d3a136b6f55..cedadb0036f 100644 --- 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 f5fdfc5d2ff..b649a21f593 100644 --- 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.