Received: from malur.postgresql.org ([217.196.149.56]) by arkaria.postgresql.org with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1qkf3x-00FVLH-Ii for pgsql-hackers@arkaria.postgresql.org; Mon, 25 Sep 2023 06:27:21 +0000 Received: from localhost ([127.0.0.1] helo=malur.postgresql.org) by malur.postgresql.org with esmtp (Exim 4.94.2) (envelope-from ) id 1qkf3w-00FYFy-1l for pgsql-hackers@arkaria.postgresql.org; Mon, 25 Sep 2023 06:27:20 +0000 Received: from makus.postgresql.org ([2001:4800:3e1:1::229]) by malur.postgresql.org with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1qkf3v-00FYFc-JP for pgsql-hackers@lists.postgresql.org; Mon, 25 Sep 2023 06:27:19 +0000 Received: from oss.nttdata.com ([49.212.34.109]) by makus.postgresql.org with esmtps (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1qkf3s-006UqP-3s for pgsql-hackers@postgresql.org; Mon, 25 Sep 2023 06:27:18 +0000 Received: from oss.nttdata.com (localhost [127.0.0.1]) by oss.nttdata.com (Postfix) with ESMTPA id 306A1608F6; Mon, 25 Sep 2023 15:27:12 +0900 (JST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at oss.nttdata.com MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=_e65bfc3da5718f634c67e29d2c52dd8d" Content-Transfer-Encoding: 8bit Date: Mon, 25 Sep 2023 15:27:12 +0900 From: torikoshia To: Peter Eisentraut , htamfids@gmail.com Cc: Masahiro Ikeda , Pgsql Hackers Subject: Re: Make --help output fit within 80 columns per line In-Reply-To: References: <50ca8ff35a8dd8f9ec89963b503571a7@oss.nttdata.com> <3965013067e7b6195132da6c0b80a609@oss.nttdata.com> <70043684388c1a8d181cf8f3308ad3ec@oss.nttdata.com> <7ab6295d479544ae9acb926dc3e556cf@oss.nttdata.com> User-Agent: Roundcube Webmail/1.4.11 Message-ID: X-Sender: torikoshia@oss.nttdata.com List-Id: List-Help: List-Subscribe: List-Post: List-Owner: List-Archive: Archived-At: Precedence: bulk --=_e65bfc3da5718f634c67e29d2c52dd8d Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset=UTF-8; format=flowed On Tue, Sep 19, 2023 at 3:23 AM Greg Sabino Mullane wrote: Thanks for your investigation! > On Fri, Sep 15, 2023 at 11:11 AM torikoshia > wrote: >> I do not intend to adhere to this rule(my terminals are usually bigger >> than 80 chars per line), but wouldn't it be a not bad direction to use >> 80 characters for all commands? > > Well, that's the question du jour, isn't it? The 80 character limit is > based on punch cards, and really has no place in modern systems. While > gnu systems are stuck in the past, many other ones have moved on to > more sensible defaults: > > $ wget --help | wc -L > 110 > > $ gcloud --help | wc -L > 122 > > $ yum --help | wc -L > 122 > > git is an interesting one, as they force things through a pager for > their help, but if you look at their raw help text files, they have > plenty of times they go past 80 when needed: > > $ wc -L git/Documentation/git-*.txt | sort -g | tail -20 > 109 git-filter-branch.txt > 109 git-rebase.txt > 116 git-diff-index.txt > 116 git-http-fetch.txt > 117 git-restore.txt > 122 git-checkout.txt > 122 git-ls-tree.txt > 129 git-init-db.txt > 131 git-push.txt > 132 git-update-ref.txt > 142 git-maintenance.txt > 144 git-interpret-trailers.txt > 146 git-cat-file.txt > 148 git-repack.txt > 161 git-config.txt > 162 git-notes.txt > 205 git-stash.txt > 251 git-submodule.txt > > 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? On 2023-09-21 16:45, Peter Eisentraut wrote: > On 31.08.23 09:47, torikoshia wrote: >> BTW, psql --help outputs the content of PGHOST, which caused a failure >> in the test: >> >> ``` >> -h, --host=HOSTNAME      database server host or socket directory >>                          (default: >> "/var/folders/m7/9snkd5b54cx_b4lxkl9ljlcc0000gn/T/LobrmSUf7t") >> ``` >> >> It may be overkill, added a logic for removing the content of PGHOST. > > I wonder, should we remove this? We display the > environment-variable-based defaults in psql --help, but not for any > other programs. This is potentially misleading. Agreed. It seems inconsistent with other commands. Patch 0002 removed environment-variable-based defaults in psql --help. -- Regards, -- Atsushi Torikoshi NTT DATA Group Corporation --=_e65bfc3da5718f634c67e29d2c52dd8d Content-Transfer-Encoding: base64 Content-Type: text/x-diff; name=v1-0001-Added-a-test-for-checking-the-line-length-of-help.patch Content-Disposition: attachment; filename=v1-0001-Added-a-test-for-checking-the-line-length-of-help.patch; size=992 RnJvbSBiMGFlMDgyNjM3NGNlODZjOTVlZTM2NjM3OTEzYjY1Zjg2NWQ2ZTBiIE1vbiBTZXAgMTcg MDA6MDA6MDAgMjAwMQpGcm9tOiBBdHN1c2hpIFRvcmlrb3NoaSA8dG9yaWtvc2hpYUBvc3MubnR0 ZGF0YS5jb20+CkRhdGU6IE1vbiwgMjUgU2VwIDIwMjMgMTA6NDA6MzYgKzA5MDAKU3ViamVjdDog W1BBVENIIHYxIDEvMl0gQWRkZWQgYSB0ZXN0IGZvciBjaGVja2luZyB0aGUgbGluZSBsZW5ndGgg b2YgLS1oZWxwCiBvdXRwdXQuCgotLS0KIHNyYy90ZXN0L3BlcmwvUG9zdGdyZVNRTC9UZXN0L1V0 aWxzLnBtIHwgOCArKysrKysrKwogMSBmaWxlIGNoYW5nZWQsIDggaW5zZXJ0aW9ucygrKQoKZGlm ZiAtLWdpdCBhL3NyYy90ZXN0L3BlcmwvUG9zdGdyZVNRTC9UZXN0L1V0aWxzLnBtIGIvc3JjL3Rl c3QvcGVybC9Qb3N0Z3JlU1FML1Rlc3QvVXRpbHMucG0KaW5kZXggZDY2ZmUxY2Y0NS4uMjkxYjVk Y2JiYiAxMDA2NDQKLS0tIGEvc3JjL3Rlc3QvcGVybC9Qb3N0Z3JlU1FML1Rlc3QvVXRpbHMucG0K KysrIGIvc3JjL3Rlc3QvcGVybC9Qb3N0Z3JlU1FML1Rlc3QvVXRpbHMucG0KQEAgLTg4NCw2ICs4 ODQsMTQgQEAgc3ViIHByb2dyYW1faGVscF9vawogCW9rKCRyZXN1bHQsICIkY21kIC0taGVscCBl eGl0IGNvZGUgMCIpOwogCWlzbnQoJHN0ZG91dCwgJycsICIkY21kIC0taGVscCBnb2VzIHRvIHN0 ZG91dCIpOwogCWlzKCRzdGRlcnIsICcnLCAiJGNtZCAtLWhlbHAgbm90aGluZyB0byBzdGRlcnIi KTsKKworCSMgV2Ugc2V0IHRoZSBoYXJkIGxpbWl0IG9uIHRoZSBsZW5ndGggb2YgbGluZSB0byAx MjAKKwlzdWJ0ZXN0ICIkY21kIC0taGVscCBvdXRwdXRzIGZpdCB3aXRoaW4gMTIwIGNvbHVtbnMg cGVyIGxpbmUiID0+IHN1YiB7CisJZm9yZWFjaCBteSAkbGluZSAoc3BsaXQgL1xuLywgJHN0ZG91 dCkKKwl7CisJCW9rKGxlbmd0aCgkbGluZSkgPD0gMTIwLCAiJGxpbmUiKTsKKwl9Cit9OwogCXJl dHVybjsKIH0KIAotLSAKMi4zOS4yCgo= --=_e65bfc3da5718f634c67e29d2c52dd8d Content-Transfer-Encoding: base64 Content-Type: text/x-diff; name=v1-0002-Squashed-commit-of-the-following.patch Content-Disposition: attachment; filename=v1-0002-Squashed-commit-of-the-following.patch; size=2695 RnJvbSAyMDdjNDA1OWI0MmU5NzViYzc4ODQ1MjgzODA5OWRhODI1OTcyZDE1IE1vbiBTZXAgMTcg MDA6MDA6MDAgMjAwMQpGcm9tOiBBdHN1c2hpIFRvcmlrb3NoaSA8dG9yaWtvc2hpYUBvc3MubnR0 ZGF0YS5jb20+CkRhdGU6IE1vbiwgMjUgU2VwIDIwMjMgMTA6NTI6MDggKzA5MDAKU3ViamVjdDog W1BBVENIIHYxIDIvMl0gUmVtb3ZlZCBlbnZpcm9ubWVudC12YXJpYWJsZS1iYXNlZCBkZWZhdWx0 cyBpbiBwc3FsIC0taGVscAoKLS0tCiBzcmMvYmluL3BzcWwvaGVscC5jIHwgMzMgKysrKy0tLS0t LS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tCiAxIGZpbGUgY2hhbmdlZCwgNCBpbnNlcnRpb25zKCsp LCAyOSBkZWxldGlvbnMoLSkKCmRpZmYgLS1naXQgYS9zcmMvYmluL3BzcWwvaGVscC5jIGIvc3Jj L2Jpbi9wc3FsL2hlbHAuYwppbmRleCAxMjI4MGMwZTU0Li4zYjJkNTllMmVlIDEwMDY0NAotLS0g YS9zcmMvYmluL3BzcWwvaGVscC5jCisrKyBiL3NyYy9iaW4vcHNxbC9oZWxwLmMKQEAgLTUwLDIy ICs1MCwxMCBAQAogdm9pZAogdXNhZ2UodW5zaWduZWQgc2hvcnQgaW50IHBhZ2VyKQogewotCWNv bnN0IGNoYXIgKmVudjsKLQljb25zdCBjaGFyICp1c2VyOwotCWNoYXIJICAgKmVycnN0cjsKIAlQ UUV4cEJ1ZmZlckRhdGEgYnVmOwogCWludAkJCW5sY291bnQ7CiAJRklMRQkgICAqb3V0cHV0Owog Ci0JLyogRmluZCBkZWZhdWx0IHVzZXIsIGluIGNhc2Ugd2UgbmVlZCBpdC4gKi8KLQl1c2VyID0g Z2V0ZW52KCJQR1VTRVIiKTsKLQlpZiAoIXVzZXIpCi0JewotCQl1c2VyID0gZ2V0X3VzZXJfbmFt ZSgmZXJyc3RyKTsKLQkJaWYgKCF1c2VyKQotCQkJcGdfZmF0YWwoIiVzIiwgZXJyc3RyKTsKLQl9 Ci0KIAkvKgogCSAqIFRvIGF2b2lkIGNvdW50aW5nIHRoZSBvdXRwdXQgbGluZXMgbWFudWFsbHks IGJ1aWxkIHRoZSBvdXRwdXQgaW4gImJ1ZiIKIAkgKiBhbmQgdGhlbiBjb3VudCB0aGVtLgpAQCAt NzcsMTMgKzY1LDggQEAgdXNhZ2UodW5zaWduZWQgc2hvcnQgaW50IHBhZ2VyKQogCUhFTFAwKCIg IHBzcWwgW09QVElPTl0uLi4gW0RCTkFNRSBbVVNFUk5BTUVdXVxuXG4iKTsKIAogCUhFTFAwKCJH ZW5lcmFsIG9wdGlvbnM6XG4iKTsKLQkvKiBEaXNwbGF5IGRlZmF1bHQgZGF0YWJhc2UgKi8KLQll bnYgPSBnZXRlbnYoIlBHREFUQUJBU0UiKTsKLQlpZiAoIWVudikKLQkJZW52ID0gdXNlcjsKIAlI RUxQMCgiICAtYywgLS1jb21tYW5kPUNPTU1BTkQgICAgcnVuIG9ubHkgc2luZ2xlIGNvbW1hbmQg KFNRTCBvciBpbnRlcm5hbCkgYW5kIGV4aXRcbiIpOwotCUhFTFBOKCIgIC1kLCAtLWRibmFtZT1E Qk5BTUUgICAgICBkYXRhYmFzZSBuYW1lIHRvIGNvbm5lY3QgdG8gKGRlZmF1bHQ6IFwiJXNcIilc biIsCi0JCSAgZW52KTsKKwlIRUxQMCgiICAtZCwgLS1kYm5hbWU9REJOQU1FICAgICAgZGF0YWJh c2UgbmFtZSB0byBjb25uZWN0IHRvXG4iKTsKIAlIRUxQMCgiICAtZiwgLS1maWxlPUZJTEVOQU1F ICAgICAgZXhlY3V0ZSBjb21tYW5kcyBmcm9tIGZpbGUsIHRoZW4gZXhpdFxuIik7CiAJSEVMUDAo IiAgLWwsIC0tbGlzdCAgICAgICAgICAgICAgIGxpc3QgYXZhaWxhYmxlIGRhdGFiYXNlcywgdGhl biBleGl0XG4iKTsKIAlIRUxQMCgiICAtdiwgLS1zZXQ9LCAtLXZhcmlhYmxlPU5BTUU9VkFMVUVc biIKQEAgLTEyOCwxNyArMTExLDkgQEAgdXNhZ2UodW5zaWduZWQgc2hvcnQgaW50IHBhZ2VyKQog CQkgICIgICAgICAgICAgICAgICAgICAgICAgICAgICBzZXQgcmVjb3JkIHNlcGFyYXRvciBmb3Ig dW5hbGlnbmVkIG91dHB1dCB0byB6ZXJvIGJ5dGVcbiIpOwogCiAJSEVMUDAoIlxuQ29ubmVjdGlv biBvcHRpb25zOlxuIik7Ci0JLyogRGlzcGxheSBkZWZhdWx0IGhvc3QgKi8KLQllbnYgPSBnZXRl bnYoIlBHSE9TVCIpOwotCUhFTFBOKCIgIC1oLCAtLWhvc3Q9SE9TVE5BTUUgICAgICBkYXRhYmFz ZSBzZXJ2ZXIgaG9zdCBvciBzb2NrZXQgZGlyZWN0b3J5IChkZWZhdWx0OiBcIiVzXCIpXG4iLAot CQkgIGVudiA/IGVudiA6IF8oImxvY2FsIHNvY2tldCIpKTsKLQkvKiBEaXNwbGF5IGRlZmF1bHQg cG9ydCAqLwotCWVudiA9IGdldGVudigiUEdQT1JUIik7Ci0JSEVMUE4oIiAgLXAsIC0tcG9ydD1Q T1JUICAgICAgICAgIGRhdGFiYXNlIHNlcnZlciBwb3J0IChkZWZhdWx0OiBcIiVzXCIpXG4iLAot CQkgIGVudiA/IGVudiA6IERFRl9QR1BPUlRfU1RSKTsKLQkvKiBEaXNwbGF5IGRlZmF1bHQgdXNl ciAqLwotCUhFTFBOKCIgIC1VLCAtLXVzZXJuYW1lPVVTRVJOQU1FICBkYXRhYmFzZSB1c2VyIG5h bWUgKGRlZmF1bHQ6IFwiJXNcIilcbiIsCi0JCSAgdXNlcik7CisJSEVMUDAoIiAgLWgsIC0taG9z dD1IT1NUTkFNRSAgICAgIGRhdGFiYXNlIHNlcnZlciBob3N0IG9yIHNvY2tldCBkaXJlY3Rvcnlc biIpOworCUhFTFAwKCIgIC1wLCAtLXBvcnQ9UE9SVCAgICAgICAgICBkYXRhYmFzZSBzZXJ2ZXIg cG9ydFxuIik7CisJSEVMUDAoIiAgLVUsIC0tdXNlcm5hbWU9VVNFUk5BTUUgIGRhdGFiYXNlIHVz ZXIgbmFtZVxuIik7CiAJSEVMUDAoIiAgLXcsIC0tbm8tcGFzc3dvcmQgICAgICAgIG5ldmVyIHBy b21wdCBmb3IgcGFzc3dvcmRcbiIpOwogCUhFTFAwKCIgIC1XLCAtLXBhc3N3b3JkICAgICAgICAg ICBmb3JjZSBwYXNzd29yZCBwcm9tcHQgKHNob3VsZCBoYXBwZW4gYXV0b21hdGljYWxseSlcbiIp OwogCi0tIAoyLjM5LjIKCg== --=_e65bfc3da5718f634c67e29d2c52dd8d--