Re: proposal: psql –help reflecting service or URI usage

From: Paul Förster <paul(dot)foerster(at)gmail(dot)com>
To: Mark Dilger <mark(dot)dilger(at)enterprisedb(dot)com>
Cc: Postgres hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: proposal: psql –help reflecting service or URI usage
Date: 2021-03-06 13:55:13
Message-ID: 33E8737F-F3C8-403F-9786-EC45C7F1EA78@gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi Mark,

sorry for the delay.

> On 01. Mar, 2021, at 17:02, Mark Dilger <mark(dot)dilger(at)enterprisedb(dot)com> wrote:
>
> The output from --help should fit in a terminal window with only 80 characters width. For example, in src/bin/scripts/createuser.c the line about --interactive is wrapped:

I see.

> You can find counter-examples where applications do not follow this rule. pg_isready is one of them.

yes, I noticed that.

> There is a pattern in the client applications that the --help output is less verbose than the docs (see, for example, https://www.postgresql.org/docs/13/reference-client.html) Your proposed patch makes psql's --help output a bit more verbose about this issue while leaving the other applications less so, without any obvious reason for the difference.

I could do the other tools too, that wouldn't be a problem. But I'm not good at writing docs. And I found that the man pages would have to be adapted too, which would be a big one for me as I'm no man guru.

> Over the years, many proposals get made and debated, with some accepted and some rejected. The rejected proposals often have some merit, and get suggested again, only to get rejected for the same reasons as the previous times they were suggested. So searching the archives before posting a patch can sometimes be enlightening. The difficulty in my experience is knowing what words and phrases to search for. It can be a bit time consuming trying to find a prior discussion on a topic.

I've searched the archives for quite some time and found tons of hits for the search term "help". But that's useless because all people ask for "help". :-) Beside that, I found nothing which even remotely discussed the topic.

But I generally see your points so I drop the proposal. It was only an idea after all :-) Thanks for your input.

Cheers,
Paul

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message er 2021-03-06 14:00:46 is cfbot's apply aging intentional?
Previous Message Michael Paquier 2021-03-06 13:00:38 Re: [PATCH] pgbench: Bug fix for the -d option