doc: Fix some gaps with the documentation related to LZ4

The upstream project is officially named "LZ4", and the documentation
was confused with the option value that can be used with DDLs supporting
this option, and the project name.

Documentation related to the configure option --with-lz4 was missing, so
add something for that.

Author: Dilip Kumar, Michael Paquier
Reviewed-by: Justin Pryzby
Discussion: https://postgr.es/m/YJaOZQDXBVySq+Cc@paquier.xyz

diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml
index 29ee9605b61dc0cf50a51ce587de4de8d0fe60d2..6d06ad22b92b4cd583b4feff39adc8597700c75a 100644 (file)
--- a/doc/src/sgml/catalogs.sgml
+++ b/doc/src/sgml/catalogs.sgml
@@ -1363,7 +1363,7 @@
        The current compression method of the column.  If it is an invalid
        compression method (<literal>'\0'</literal>) then column data will not
        be compressed.  Otherwise, <literal>'p'</literal> = pglz compression or
-       <literal>'l'</literal> = lz4 compression.
+       <literal>'l'</literal> = <productname>LZ4</productname> compression.
       </para></entry>
      </row>
 

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index a71c8821f6a80a2f5810b3c8289cfe712d17b9e9..f129a87501420e883c4b4bc284cc9a13a775f443 100644 (file)
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -8321,9 +8321,9 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
         <command>CREATE TABLE</command> statement can override this default
         by specifying the <literal>COMPRESSION</literal> column option.
 
-        The supported compression methods are <literal>pglz</literal> and
-        (if configured at the time <productname>PostgreSQL</productname> was
-        built) <literal>lz4</literal>.
+        The supported compression methods are <literal>pglz</literal> and,
+        if <productname>PostgreSQL</productname> was compiled with
+        <literal>--with-lz4</literal>, <literal>lz4</literal>.
         The default is <literal>pglz</literal>.
        </para>
       </listitem>

diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml
index 50d9fa2021511fe9f7cfcaede8d997b9ab904fc7..3c0aa118c76bfa8ed473a7cc1ad02eabc0e0e7bb 100644 (file)
--- a/doc/src/sgml/installation.sgml
+++ b/doc/src/sgml/installation.sgml
@@ -266,6 +266,14 @@ su - postgres
      </para>
     </listitem>
 
+    <listitem>
+     <para>
+      You need <productname>LZ4</productname>, if you want to support
+      compression of data with this method; see
+      <xref linkend="guc-default-toast-compression"/>.
+     </para>
+    </listitem>
+
     <listitem>
      <para>
       To build the <productname>PostgreSQL</productname> documentation,
@@ -966,6 +974,17 @@ build-postgresql:
        </listitem>
       </varlistentry>
 
+      <varlistentry>
+       <term><option>--with-lz4</option></term>
+       <listitem>
+        <para>
+         Build with <productname>LZ4</productname> compression support.
+         This allows the use of <productname>LZ4</productname> for
+         compression of table data.
+        </para>
+       </listitem>
+      </varlistentry>
+
       <varlistentry>
        <term><option>--with-ssl=<replaceable>LIBRARY</replaceable></option>
        <indexterm>