wal_compression = on: what is the algorithm? - Mailing list pgsql-docs

From PG Doc comments form
Subject wal_compression = on: what is the algorithm?
Date
Msg-id 173168465965.1547981.1990746268682320616@wrigleys.postgresql.org
Whole thread Raw
Responses Re: wal_compression = on: what is the algorithm?
List pgsql-docs
The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/16/runtime-config-wal.html
Description:

In
https://www.postgresql.org/docs/16/runtime-config-wal.html#GUC-WAL-COMPRESSION,
the option "on" is not described:

“The supported methods are pglz, lz4 (if PostgreSQL was compiled with
--with-lz4) and zstd (if PostgreSQL was compiled with --with-zstd). The
default value is off. ”

"on" was an available option before PG 15, and still seen in some docs.
If I understand the code in src/backend/utils/misc/guc_tables.c, "on" is the
same as "pglz". So I suggest:

“The supported methods are pglz, lz4 (if PostgreSQL was compiled with
--with-lz4) and zstd (if PostgreSQL was compiled with --with-zstd). The
default value is off.  The value on is synonym of pglz.”

I didn't see this discussed in
https://www.postgresql.org/message-id/flat/3037310D-ECB7-4BF1-AF20-01C10BB33A33%40yandex-team.ru

pgsql-docs by date:

Previous
From: Greg Sabino Mullane
Date:
Subject: Re: Generated names (suffix) for constraints not described in docs
Next
From: Egor Rogov
Date:
Subject: Re: Parallel index build for BRIN