Re: [PATCH] pg_bsd_indent: improve formatting of multiline comments

Aleksander Alekseev <aleksander@timescale.com>

From: Aleksander Alekseev <aleksander@timescale.com>
To: PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Cc: Arseniy Mukhin <arseniy.mukhin.dev@gmail.com>, Bruce Momjian <bruce@momjian.us>, Michael Paquier <michael@paquier.xyz>
Date: 2025-06-23T10:42:32Z
Lists: pgsql-hackers

Commits

Same data as JSON: GET /api/v1/messages/:b64id/commits the thread's linked commits as JSON, with link sources. API reference →
  1. pgindent: improve formatting of multiline comments.

  2. Adjust style of some debugging macros.

  3. Fix a couple of comments.

  4. Add IGNORE NULLS/RESPECT NULLS option to Window functions.

  5. Split WaitEventSet functions to separate source file

Attachments

Hi Arseniy,

Thanks for the feedback!

> Now it affects 4 times more files (380). What I noticed:
> 1) Most of the comments are bordered comments like this:
> -/* --------------------------------------------------------------------------------
> +/*
> + * --------------------------------------------------------------------------------
>   * Public IO related functions operating on IO Handles
>   * --------------------------------------------------------------------------------
>   */
>
> Do we want to skip such comments?
> I have also seen comments with '====' border.

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 :)

> 2) Some comments like this:
>
> before:
> /* Author: Linus Tolke
>    (actually most if the code is "borrowed" from the distribution and just
>    slightly modified)
>  */
>
> after:
> /*
>  * Author: Linus Tolke
>    (actually most if the code is "borrowed" from the distribution and just
>    slightly modified)
>  */
>
> I guess closing */ on the separate line is the trigger?
> If I'm not wrong there are only 3 such comments, maybe it is easier to
> fix them by hand?)
>
> 3) It seems all geqo related file contains such comment:
> -/* contributed by:
> +/*
> + * contributed by:
>     =*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=
>     *  Martin Utesch                             * Institute of
> Automatic Control          *

You are right, these comments shouldn't have been changed. Apparently
the script is going to need slightly more complicated checks that I
initially thought.

Here is the corrected patch v4.

-- 
Best regards,
Aleksander Alekseev