xbstream documentation missing option (including --decompress).

Description

Hi,

in the xbstream documentation (8.0 and 8.2), I do not see a reference to the --decompress option even if the help of the command is mentioning it (see below for full --help output). Other options are not documented, a list is below:

  • --decompress-threads=#

  • --directory=name

  • --parallel=#

  • --fifo-streams=#

  • --fifo-dir=name

  • --fifo-timeout=#

  • --absolute-names

I would expect all useful commands to be documented (--help and --version could be omitted). The impact of not documenting the --decompress command is that someone could think the restoration of a compressed backup first needs unpacking the stream, and then decompressing with xtrabackup --decompress, which would need extra disk space (I initially thought that, and for a moment, I thought it was a shame a feature to avoid extra disk space consumption was missing).

Many thanks for looking into this,

Jean-François Gagné

 

xbstream help output:

Environment

None

Activity

Show:

Aaditya Dubey February 8, 2024 at 10:36 AM

Hi

Thank you for the report and feedback!

Thank you connecting Percona!

Done

Details

Assignee

Reporter

Components

Fix versions

Affects versions

Priority

Smart Checklist

Created February 7, 2024 at 6:02 PM
Updated April 2, 2024 at 1:17 PM
Resolved February 14, 2024 at 2:26 PM