Re: Marking options deprecated in help output

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Heikki Linnakangas <hlinnaka(at)iki(dot)fi>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Marking options deprecated in help output
Date: 2023-02-28 23:12:11
Message-ID: 95693F32-77F5-4587-B47F-11D20BA8B901@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

> On 24 Feb 2023, at 21:31, Heikki Linnakangas <hlinnaka(at)iki(dot)fi> wrote:
> On 05/12/2022 11:42, Daniel Gustafsson wrote:

> 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)

If nothing else, it helps to keep it shorter and avoids breaking the line
between command and description, so I agree with you. Done in the attached v2.

--
Daniel Gustafsson

Attachment Content-Type Size
deprecated_options_v2.diff application/octet-stream 2.6 KB

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2023-02-28 23:20:21 Re: Refactoring SysCacheGetAttr to know when attr cannot be NULL
Previous Message Imseih (AWS), Sami 2023-02-28 23:11:30 Re: Doc update for pg_stat_statements normalization