Hi Nathan, > > Personally I don't have a strong opinion on this. We can easily add an > > exception for "/* ---" and "/* ===" comments if somebody believes this > > is a problem. I choose not to add such an exception just yet only > > because I don't like unnecessary exceptions :) > > +1 for adding an exception for "/* -----" style comments. I tested running > pgindent after applying the patch, and the first thing I noticed was all > these (IMHO) unnecessary changes. I don't think it helps readability, and > even if it did, it's arguably not worth the churn.
OK, here is the corrected patch v5. -- Best regards, Aleksander Alekseev
From f87137673c0b3da5aed296f88016e8d8edfd3915 Mon Sep 17 00:00:00 2001 From: Aleksander Alekseev <[email protected]> Date: Fri, 20 Jun 2025 16:31:36 +0300 Subject: [PATCH v5] pgindent: improve formatting of multiline comments Format multiline comments like this: /* line 1 * line 2 */ ... into: /* * line 1 * line 2 */ This is more consistent with what we currently have in the tree. Author: Aleksander Alekseev <[email protected]> Reported-by: Michael Paquier <[email protected]> Reviewed-by: Arseniy Mukhin <[email protected]> Reviewed-by: Nathan Bossart <[email protected]> Discussion: https://postgr.es/m/CAJ7c6TPQ0kkHQG-AqeAJ3PV_YtmDzcc7s%2B_V4%3Dt%2BxgSnZm1cFw%40mail.gmail.com --- src/tools/pgindent/pgindent | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/src/tools/pgindent/pgindent b/src/tools/pgindent/pgindent index b7d71808924..670e204e917 100755 --- a/src/tools/pgindent/pgindent +++ b/src/tools/pgindent/pgindent @@ -281,6 +281,9 @@ sub post_indent # Fix run-together comments to have a tab between them $source =~ s!\*/(/\*.*\*/)$!*/\t$1!gm; + # Postprocess multiline comments except for /**... and /*-... ones + $source =~ s!^(/\*[^\*\-].*?\*/)!postprocess_multiline_comment($1)!mgse; + ## Functions # Use a single space before '*' in function return types @@ -289,6 +292,39 @@ sub post_indent return $source; } +sub postprocess_multiline_comment +{ + my $source = shift; + my @lines = split "\n", $source; + + # Only format comments that match the expected format, + # or at least that could have been the author's intent. + if (($lines[0] ne "/*" && $lines[-1] ne " */") or ($lines[1] !~ m!^ \*!)) + { + return $source; + } + + # Check each line except for the fist and the last one + for my $i ( 1 .. scalar @lines - 2 ) + { + $lines[$i] = " *".$lines[$i] if $lines[$i] !~ /^ \*/; + } + + # Keep /* === and /* --- lines as is + if ($lines[0] !~ m!^/\* [=-]+!) { + $lines[0] =~ s!/\*(.+)!/\*\n *$1!; + } + + # Keep === */ and --- */ lines as is + if ($lines[-1] !~ m![=-]+ \*/$!) { + $lines[-1] =~ s!(.+) \*/!$1\n \*/!; + } + + $source = join "\n", @lines; + + return $source; +} + sub run_indent { my $source = shift; -- 2.43.0
