Re: refactoring basebackup.c

From: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
To: Robert Haas <robertmhaas(at)gmail(dot)com>
Cc: "Shinoda, Noriyoshi (PN Japan FSIP)" <noriyoshi(dot)shinoda(at)hpe(dot)com>, Justin Pryzby <pryzby(at)telsasoft(dot)com>, Jeevan Ladhe <jeevanladhe(dot)os(at)gmail(dot)com>, Dipesh Pandit <dipesh(dot)pandit(at)gmail(dot)com>, Abhijit Menon-Sen <ams(at)toroid(dot)org>, Dmitry Dolgov <9erthalion6(at)gmail(dot)com>, Jeevan Ladhe <jeevan(dot)ladhe(at)enterprisedb(dot)com>, Mark Dilger <mark(dot)dilger(at)enterprisedb(dot)com>, "pgsql-hackers(at)postgresql(dot)org" <pgsql-hackers(at)postgresql(dot)org>, tushar <tushar(dot)ahuja(at)enterprisedb(dot)com>
Subject: Re: refactoring basebackup.c
Date: 2022-02-16 16:11:31
Message-ID: 202202161611.kvj7zsvvue5v@alvherre.pgsql
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 2022-Feb-14, Robert Haas wrote:

> A more consistent way of writing the supported syntax would be like this:
>
> -Z, --compress={[{client|server}-]{gzip|lz4}}[:LEVEL]|LEVEL|none}
>
> I would be somewhat inclined to leave the level-only variant
> undocumented and instead write it like this:
>
> -Z, --compress={[{client|server}-]{gzip|lz4}}[:LEVEL]|none}

This is hard to interpret for humans though because of the nested
brackets and braces. It gets considerably easier if you split it in
separate variants:

-Z, --compress=[{client|server}-]{gzip|lz4}[:LEVEL]
-Z, --compress=LEVEL
-Z, --compress=none
compress tar output with given compression method or level

or, if you choose to leave the level-only variant undocumented, then

-Z, --compress=[{client|server}-]{gzip|lz4}[:LEVEL]
-Z, --compress=none
compress tar output with given compression method or level

There still are some nested brackets and braces, but the scope is
reduced enough that interpreting seems quite a bit simpler.

--
Álvaro Herrera 39°49'30"S 73°17'W — https://www.EnterpriseDB.com/

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Geoghegan 2022-02-16 16:12:53 Re: do only critical work during single-user vacuum?
Previous Message Robert Haas 2022-02-16 15:51:36 Re: refactoring basebackup.c (zstd)