Date: Wed, 20 Nov 2024 11:22:51 -0500
From: Bruce Momjian <bruce@momjian.us>
To: christophe.courtois@dalibo.com, pgsql-docs@lists.postgresql.org
Subject: Re: wal_compression = on: what is the algorithm?
Message-ID: <Zz4M245abV1aujo5@momjian.us>
References: <173168465965.1547981.1990746268682320616@wrigleys.postgresql.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: 
 <173168465965.1547981.1990746268682320616@wrigleys.postgresql.org>
Archived-At: 
 <https://www.postgresql.org/message-id/Zz4M245abV1aujo5%40momjian.us>
Precedence: bulk

On Fri, Nov 15, 2024 at 03:30:59PM +0000, PG Doc comments form wrote:
> 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 think we kept 'on' just for backward compatibility, so we don't
mention it in the docs anymore.

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EDB                                      https://enterprisedb.com

  When a patient asks the doctor, "Am I going to die?", he means 
  "Am I going to die soon?"