From: torikoshia <torikoshia@oss.nttdata.com>
To: Peter Eisentraut <peter@eisentraut.org>
Cc: htamfids@gmail.com, Masahiro Ikeda <ikedamsh@oss.nttdata.com>
Cc: Pgsql Hackers <pgsql-hackers@postgresql.org>
Subject: Re: Make --help output fit within 80 columns per line
Date: Fri, 06 Oct 2023 21:44:48 +0900
Message-ID: <3514d73f84faaf5071c4580cdbd53e50@oss.nttdata.com> (raw)
In-Reply-To: <8decb0e3-6463-9eda-00dc-a05a3340b8bb@eisentraut.org>
References: <50ca8ff35a8dd8f9ec89963b503571a7@oss.nttdata.com>
<3965013067e7b6195132da6c0b80a609@oss.nttdata.com>
<70043684388c1a8d181cf8f3308ad3ec@oss.nttdata.com>
<c20d4fa43995b3bfbb2c2d06b7ed8731@oss.nttdata.com>
<7ab6295d479544ae9acb926dc3e556cf@oss.nttdata.com>
<c42695b0-1471-7d7a-1e60-04541673d507@eisentraut.org>
<eba6645a0e228958d8541f213d66da0f@oss.nttdata.com>
<8decb0e3-6463-9eda-00dc-a05a3340b8bb@eisentraut.org>
On 2023-09-25 15:27, torikoshia wrote:
> Ugh, regression tests failed and it appears to be due to reasons
> related to meson.
> I'm going to investigate it.
ISTM
On 2023-10-06 19:49, Peter Eisentraut wrote:
> On 25.09.23 08:27, torikoshia wrote:
>>> So in summary, I think 80 is a decent soft limit, but let's not
>>> stress out about some lines going over that, and make a hard limit of
>>> perhaps 120.
>>
>> +1. It may be a good compromise.
>> For enforcing the hard limit, is it better to add a regression test
>> like patch 0001?
>
>> Agreed. It seems inconsistent with other commands.
>> Patch 0002 removed environment-variable-based defaults in psql --help.
>
> I have committed 0002 and a different implementation of 0001. I set
> the maximum line length to 95, which is the current maximum in use.
Thanks!
BTW as far as I investigated, the original 0002 patch failed because
current meson doesn't accept subtest outputs.
As I commented below thread a few days ago, they once modified to
accept subtest outputs, but not anymore.
https://github.com/mesonbuild/meson/issues/10032> I'm open to discussing other line lengths, but
>
> 1) If we make it longer, then we should also adjust the existing
> wrapping so that we don't have a mix of lines wrapped at 80 and some
> significantly longer lines.
>
> 2) There are some general readability guidelines that suggest like 66
> or 72 characters per line. If you take that and add the option name
> itself and some indentation, then around 90 does seem like a sensible
> limit.
>
> 3) The examples from other tools posted earlier don't convince me.
> Some of their --help outputs look like junk and poorly taken care of.
>
> So I think nudging people to aim for 80..95 seems like a good target
> right now. But I'm not against adjustments.
--
Regards,
--
Atsushi Torikoshi
NTT DATA Group Corporation
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients from your mail client; the link fills in
the headers below: reply via email
Some clients, webmail especially, drop In-Reply-To and References from
a link, and the reply then starts a new thread: use the mbox below.
To: pgsql-hackers@postgresql.org
Cc: torikoshia@oss.nttdata.com, peter@eisentraut.org, ikedamsh@oss.nttdata.com
Subject: Re: Make --help output fit within 80 columns per line
In-Reply-To: <3514d73f84faaf5071c4580cdbd53e50@oss.nttdata.com>
References: <50ca8ff35a8dd8f9ec89963b503571a7@oss.nttdata.com> <3965013067e7b6195132da6c0b80a609@oss.nttdata.com> <70043684388c1a8d181cf8f3308ad3ec@oss.nttdata.com> <c20d4fa43995b3bfbb2c2d06b7ed8731@oss.nttdata.com> <7ab6295d479544ae9acb926dc3e556cf@oss.nttdata.com> <c42695b0-1471-7d7a-1e60-04541673d507@eisentraut.org> <eba6645a0e228958d8541f213d66da0f@oss.nttdata.com> <8decb0e3-6463-9eda-00dc-a05a3340b8bb@eisentraut.org> <3514d73f84faaf5071c4580cdbd53e50@oss.nttdata.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox