--sync-method isn't documented to take an argument

From: Robert Haas <robertmhaas(at)gmail(dot)com>
To: "pgsql-hackers(at)postgresql(dot)org" <pgsql-hackers(at)postgresql(dot)org>, Nathan Bossart <nathandbossart(at)gmail(dot)com>
Subject: --sync-method isn't documented to take an argument
Date: 2023-10-04 13:08:57
Message-ID: CA+TgmoZi7pcx-ec3oJLWSr2R=Dn2Zeiyx3EXQKc_1TTvA6Eepg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

The various command-line utilities that have recently acquired a
--sync-method option document it like this:

<term><option>--sync-method</option></term>

But that is not how we document options which take an argument. We do
it like this:

<term><option>--pgdata=<replaceable>directory</replaceable></option></term>
<term><option>--filenode=<replaceable>filenode</replaceable></option></term>

etc.

This one should be something like this:

<term><option>--sync-method=<replaceable>method</replaceable></option></term>

--
Robert Haas
EDB: http://www.enterprisedb.com

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Daniel Gustafsson 2023-10-04 13:15:37 Re: --sync-method isn't documented to take an argument
Previous Message Peter Geoghegan 2023-10-04 12:16:33 Re: Eager page freeze criteria clarification