Date: Mon, 29 Jun 2026 12:04:13 +0200
From: Christoph Berg <myon@debian.org>
To: PostgreSQL-development <pgsql-hackers@postgresql.org>
Cc: Michael Paquier <michael@paquier.xyz>
Subject: [PATCH] Document wal_compression=on
Message-ID: <akJDHRtXwGLTppsQ@msg.df7cb.de>
Mail-Followup-To: Christoph Berg <myon@debian.org>,
	PostgreSQL-development <pgsql-hackers@postgresql.org>,
	Michael Paquier <michael@paquier.xyz>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="e4Q8So2tphS9ic0E"
Content-Disposition: inline
Archived-At: 
 <https://www.postgresql.org/message-id/akJDHRtXwGLTppsQ%40msg.df7cb.de>
Precedence: bulk

--e4Q8So2tphS9ic0E
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

The docs currently don't say what wal_compression=on is, so here is a
patch.

Christoph

--e4Q8So2tphS9ic0E
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment;
	filename=0001-Document-wal_compression-on.patch

From 0cb33f052a9c162fa199bc9a71ee29240347e710 Mon Sep 17 00:00:00 2001
From: Christoph Berg <myon@debian.org>
Date: Mon, 29 Jun 2026 11:58:44 +0200
Subject: [PATCH] Document wal_compression=on

This was not included when lz4 support was added in
4035cd5d4eee4dae797bfc77ab07f8dcd8781b41, but since the value is still
legal and even mentioned in postgresql.conf.sample, it should be
documented.
---
 doc/src/sgml/config.sgml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 569fc0e7dba..d645a50476f 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -3671,6 +3671,7 @@ include_dir 'conf.d'
         was compiled with <option>--with-lz4</option>) and
         <literal>zstd</literal> (if <productname>PostgreSQL</productname>
         was compiled with <option>--with-zstd</option>).
+        The value <literal>on</literal> is a deprecated alias for <literal>pglz</literal>.
         The default value is <literal>off</literal>.
         Only superusers and users with the appropriate <literal>SET</literal>
         privilege can change this setting.
-- 
2.53.0


--e4Q8So2tphS9ic0E--