Re: Marking options deprecated in help output

From: Heikki Linnakangas <hlinnaka(at)iki(dot)fi>
To: Daniel Gustafsson <daniel(at)yesql(dot)se>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Marking options deprecated in help output
Date: 2023-02-24 20:31:57
Message-ID: 370af68a-0025-5b93-4230-600ec63dd3da@iki.fi
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 05/12/2022 11:42, Daniel Gustafsson wrote:
> In the pg_dump blob terminology thread it was briefly discussed [0] to mark
> parameters as deprecated in the --help output. The attached is a quick diff to
> show that that would look like. Personally I think it makes sense, not
> everyone will read the docs.

Makes sense. One minor suggestion; instead of this:

> -h, -H, --host=HOSTNAME database server host or socket directory
> (-H is deprecated)

How about putting the deprecated option on a separate line like this:

> -h, --host=HOSTNAME database server host or socket directory
> -H (same as -h, deprecated)

And same for --blobs and -no-blobs

- Heikki

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Imseih (AWS), Sami 2023-02-24 20:54:00 Doc update for pg_stat_statements normalization
Previous Message Joseph Koshakow 2023-02-24 19:44:01 Re: Inconsistency in ACL error message