MIME-Version: 1.0
From: Aleksander Alekseev <aleksander@timescale.com>
Date: Thu, 19 Jun 2025 17:51:36 +0300
Message-ID: 
 <CAJ7c6TPQ0kkHQG-AqeAJ3PV_YtmDzcc7s+_V4=t+xgSnZm1cFw@mail.gmail.com>
Subject: [PATCH] pg_bsd_indent: improve formatting of multiline comments
To: PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Cc: Michael Paquier <michael@paquier.xyz>
Content-Type: multipart/mixed; boundary="00000000000085d9060637ede23a"
Archived-At: 
 <https://www.postgresql.org/message-id/CAJ7c6TPQ0kkHQG-AqeAJ3PV_YtmDzcc7s%2B_V4%3Dt%2BxgSnZm1cFw%40mail.gmail.com>
Precedence: bulk

--00000000000085d9060637ede23a
Content-Type: text/plain; charset="UTF-8"

Hi,

Michael (cc:'ed) pointed out [1] that pg_bsd_indent could do a
slightly better job when it comes to formatting multiline comments. I
prepared a patch that fixes this.

How to test it:

```
ninja -C build
cp build/src/tools/pg_bsd_indent/pg_bsd_indent ~/bin/pg_bsd_indent
cp src/tools/pgindent/pgindent ~/bin/pgindent
pgindent src/backend/utils/adt/varlena.c
git diff
```

Expected changes:

```
-/* name_text()
+/*
+ * name_text()
  * Converts a Name type to a text type.
  */
```

Everything else should work as before.

Thoughts and feedback are most welcomed.

[1]: https://postgr.es/m/CAJ7c6TN7ppSmZMPejvKZreOs%3D%2BkJEhrGQNuVpmTjj9W-%3DMjgCg%40mail.gmail.com

-- 
Best regards,
Aleksander Alekseev

--00000000000085d9060637ede23a
Content-Type: application/octet-stream;
	name="v1-0001-pg_bsd_indent-improve-formatting-of-multiline-com.patch"
Content-Disposition: attachment;
	filename="v1-0001-pg_bsd_indent-improve-formatting-of-multiline-com.patch"
Content-Transfer-Encoding: base64
Content-ID: <f_mc3hwjaz0>
X-Attachment-Id: f_mc3hwjaz0

RnJvbSBlMjE1NzliNjA3ODI4YTQxODEzOTE4MzM5NjcyMmNhNjdmYTk4NmJhIE1vbiBTZXAgMTcg
MDA6MDA6MDAgMjAwMQpGcm9tOiBBbGVrc2FuZGVyIEFsZWtzZWV2IDxhbGVrc2FuZGVyQHRpbWVz
Y2FsZS5jb20+CkRhdGU6IFRodSwgMTkgSnVuIDIwMjUgMTc6MzU6MjAgKzAzMDAKU3ViamVjdDog
W1BBVENIIHYxXSBwZ19ic2RfaW5kZW50OiBpbXByb3ZlIGZvcm1hdHRpbmcgb2YgbXVsdGlsaW5l
IGNvbW1lbnRzCgpGb3JtYXQgbXVsdGlsaW5lIGNvbW1lbnRzIGxpa2UgdGhpczoKCi8qIGxpbmUg
MQogKiBsaW5lIDIKICovCgouLi4gaW50bzoKCi8qCiAqIGxpbmUgMQogKiBsaW5lIDIKICovCgpU
aGlzIGlzIG1vcmUgY29uc2lzdGVudCB3aXRoIHdoYXQgd2UgY3VycmVudGx5IGhhdmUgaW4gdGhl
IHRyZWUuCgpBbGVrc2FuZGVyIEFsZWtzZWV2LiBSZXBvcnRlZCBieSBNaWNoYWVsIFBhcXVpZXIu
CkRpc2N1c3Npb246IFRPRE8gRklYTUUKLS0tCiBzcmMvdG9vbHMvcGdfYnNkX2luZGVudC9pbmRl
bnQuYyB8IDM1ICsrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysrCiAxIGZpbGUgY2hhbmdl
ZCwgMzUgaW5zZXJ0aW9ucygrKQoKZGlmZiAtLWdpdCBhL3NyYy90b29scy9wZ19ic2RfaW5kZW50
L2luZGVudC5jIGIvc3JjL3Rvb2xzL3BnX2JzZF9pbmRlbnQvaW5kZW50LmMKaW5kZXggMjYyMmNj
NjIyN2EuLjIwN2Y2NTdiYWFiIDEwMDY0NAotLS0gYS9zcmMvdG9vbHMvcGdfYnNkX2luZGVudC9p
bmRlbnQuYworKysgYi9zcmMvdG9vbHMvcGdfYnNkX2luZGVudC9pbmRlbnQuYwpAQCAtMTE4NCw2
ICsxMTg0LDQxIEBAIGNoZWNrX3R5cGU6CiAJCQkJICogY2hhcmFjdGVyIHdpbGwgY2F1c2UgdGhl
IGxpbmUgdG8gYmUgcHJpbnRlZCAqLwogCiAJY2FzZSBjb21tZW50OgkJLyogd2UgaGF2ZSBnb3R0
ZW4gYSAvIGZvbGxvd2VkIGJ5ICogdGhpcyBpcyBhIGJpZ2dpZSAqLworCSAgICAvKgorCSAgICAg
KiBGb3JjZSBsaW5lIGJyZWFrIGZvciBjb2x1bW4tMSBtdWx0aWxpbmUgY29tbWVudHMgYnkgaW5z
ZXJ0aW5nCisJICAgICAqIGEgbmV3bGluZSBpbnRvIHRoZSBidWZmZXIgcmlnaHQgYWZ0ZXIgc2xh
c2gtc3Rhci4gVGhpcyBtYWtlcyBwcl9jb21tZW50KCkKKwkgICAgICogdHJlYXQgaXQgYXMgYSBi
bG9jayBjb21tZW50IHRoYXQgc2hvdWxkIGJlIGZvcm1hdHRlZCB3aXRoIGxpbmUgYnJlYWtzLgor
CSAgICAgKiBJZ25vcmUgIioqKioqIiBhbmQgIi0tLS0tIiBjb21tZW50cy4KKwkgICAgICovCisJ
ICAgIGlmIChwcy5jb2xfMSAmJiAqYnVmX3B0ciAhPSAnXG4nICYmICpidWZfcHRyICE9ICctJyAm
JiAqYnVmX3B0ciAhPSAnKicpIHsKKwkJY2hhciAqdF9wdHI7CisJCWJvb2wgaXNfc2luZ2xlX2xp
bmUgPSBmYWxzZTsKKworCQkvKiBDaGVjayBpZiBjb21tZW50IGVuZCBzdGFyLXNsYXNoIGFwcGVh
cnMgb24gdGhlIHNhbWUgbGluZSAqLworCQl0X3B0ciA9IGJ1Zl9wdHI7CisJCXdoaWxlICgqdF9w
dHIgIT0gJ1wwJyAmJiAqdF9wdHIgIT0gJ1xuJykgeworCQkgICAgaWYgKHRfcHRyID49IGJ1Zl9l
bmQpCisJCQlmaWxsX2J1ZmZlcigpOworCQkgICAgaWYgKHRfcHRyWzBdID09ICcqJyAmJiB0X3B0
clsxXSA9PSAnLycpIHsKKwkJCWlzX3NpbmdsZV9saW5lID0gdHJ1ZTsKKwkJCWJyZWFrOworCQkg
ICAgfQorCQkgICAgdF9wdHIrKzsKKwkJfQorCisJCS8qIE9ubHkgdHJhbnNmb3JtIGlmIGl0J3Mg
Tk9UIGEgc2luZ2xlLWxpbmUgY29tbWVudCAqLworCQlpZiAoIWlzX3NpbmdsZV9saW5lKSB7CisJ
CSAgICAvKiBJbnNlcnQgbmV3bGluZSBhbmQgc3RhciByaWdodCBhZnRlciBzbGFzaC1zdGFyIGJ5
IHNoaWZ0aW5nIGJ1ZmZlciBjb250ZW50ICovCisJCSAgICBpZiAoYnVmX2VuZCA8IGluX2J1ZmZl
cl9saW1pdCAtIDMpIHsKKwkJCS8qIE1ha2Ugcm9vbSBmb3IgbmV3bGluZSArIHNwYWNlICsgc3Rh
ciAqLworCQkJbWVtbW92ZShidWZfcHRyICsgMywgYnVmX3B0ciwgYnVmX2VuZCAtIGJ1Zl9wdHIp
OworCQkJKmJ1Zl9wdHIgPSAnXG4nOworCQkJKihidWZfcHRyICsgMSkgPSAnICc7CisJCQkqKGJ1
Zl9wdHIgKyAyKSA9ICcqJzsKKwkJCWJ1Zl9lbmQgKz0gMzsKKwkJICAgIH0KKwkJfQorCSAgICB9
CiAJICAgIHByX2NvbW1lbnQoKTsKIAkgICAgYnJlYWs7CiAJfQkJCS8qIGVuZCBvZiBiaWcgc3dp
dGNoIHN0bXQgKi8KLS0gCjIuNDkuMAoK
--00000000000085d9060637ede23a--