diff options
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/appendix-obsolete-basic-archive.sgml | 25 | ||||
-rw-r--r-- | doc/src/sgml/appendix-obsolete.sgml | 1 | ||||
-rw-r--r-- | doc/src/sgml/archive-modules.sgml | 2 | ||||
-rw-r--r-- | doc/src/sgml/basic-archive.sgml (renamed from doc/src/sgml/basic-wal-module.sgml) | 30 | ||||
-rw-r--r-- | doc/src/sgml/contrib.sgml | 2 | ||||
-rw-r--r-- | doc/src/sgml/filelist.sgml | 3 |
6 files changed, 18 insertions, 45 deletions
diff --git a/doc/src/sgml/appendix-obsolete-basic-archive.sgml b/doc/src/sgml/appendix-obsolete-basic-archive.sgml deleted file mode 100644 index 5070b3b6abf..00000000000 --- a/doc/src/sgml/appendix-obsolete-basic-archive.sgml +++ /dev/null @@ -1,25 +0,0 @@ -<!-- doc/src/sgml/appendix-obsolete-basic-archive.sgml --> -<!-- - See doc/src/sgml/appendix-obsolete.sgml for why this file exists. Do not change the id attribute. ---> - -<sect1 id="basic-archive" xreflabel="basic_archive"> - <title><command>basic_archive</command> renamed to <command>basic_wal_module</command></title> - - <indexterm> - <primary>basic_archive</primary> - <see>basic_wal_module</see> - </indexterm> - - <para> - PostgreSQL 15 provided an archive module named - <filename>basic_archive</filename> - <indexterm><primary>basic_archive</primary></indexterm>. - This module was renamed to <filename>basic_wal_module</filename>. See - <xref linkend="basic-wal-module"/> for documentation of - <filename>basic_wal_module</filename>, and see - <link linkend="release-prior">the release notes for PostgreSQL 16</link> - for details on this change. - </para> - -</sect1> diff --git a/doc/src/sgml/appendix-obsolete.sgml b/doc/src/sgml/appendix-obsolete.sgml index 87c1b1020df..b1a00c8ce67 100644 --- a/doc/src/sgml/appendix-obsolete.sgml +++ b/doc/src/sgml/appendix-obsolete.sgml @@ -38,6 +38,5 @@ &obsolete-pgxlogdump; &obsolete-pgresetxlog; &obsolete-pgreceivexlog; - &obsolete-basic-archive; </appendix> diff --git a/doc/src/sgml/archive-modules.sgml b/doc/src/sgml/archive-modules.sgml index 1a32006e2c7..ef02051f7f0 100644 --- a/doc/src/sgml/archive-modules.sgml +++ b/doc/src/sgml/archive-modules.sgml @@ -32,7 +32,7 @@ </para> <para> - The <filename>contrib/basic_wal_module</filename> module contains a working + The <filename>contrib/basic_archive</filename> module contains a working example, which demonstrates some useful techniques. </para> diff --git a/doc/src/sgml/basic-wal-module.sgml b/doc/src/sgml/basic-archive.sgml index c418b01eb85..b4d43ced203 100644 --- a/doc/src/sgml/basic-wal-module.sgml +++ b/doc/src/sgml/basic-archive.sgml @@ -1,16 +1,16 @@ -<!-- doc/src/sgml/basic-wal-module.sgml --> +<!-- doc/src/sgml/basic-archive.sgml --> -<sect1 id="basic-wal-module" xreflabel="basic_wal_module"> - <title>basic_wal_module — an example write-ahead log module</title> +<sect1 id="basic-archive" xreflabel="basic_archive"> + <title>basic_archive — an example WAL archive module</title> - <indexterm zone="basic-wal-module"> - <primary>basic_wal_module</primary> + <indexterm zone="basic-archive"> + <primary>basic_archive</primary> </indexterm> <para> - <filename>basic_wal_module</filename> is an example of an archive module. - This module copies completed WAL segment files to the specified directory. - This may not be especially useful, but it can serve as a starting point for + <filename>basic_archive</filename> is an example of an archive module. This + module copies completed WAL segment files to the specified directory. This + may not be especially useful, but it can serve as a starting point for developing your own archive module. For more information about archive modules, see <xref linkend="archive-modules"/>. </para> @@ -21,15 +21,15 @@ must be enabled. </para> - <sect2 id="basic-wal-module-configuration-parameters"> + <sect2 id="basic-archive-configuration-parameters"> <title>Configuration Parameters</title> <variablelist> <varlistentry> <term> - <varname>basic_wal_module.archive_directory</varname> (<type>string</type>) + <varname>basic_archive.archive_directory</varname> (<type>string</type>) <indexterm> - <primary><varname>basic_wal_module.archive_directory</varname> configuration parameter</primary> + <primary><varname>basic_archive.archive_directory</varname> configuration parameter</primary> </indexterm> </term> <listitem> @@ -52,12 +52,12 @@ <programlisting> # postgresql.conf archive_mode = 'on' -archive_library = 'basic_wal_module' -basic_wal_module.archive_directory = '/path/to/archive/directory' +archive_library = 'basic_archive' +basic_archive.archive_directory = '/path/to/archive/directory' </programlisting> </sect2> - <sect2 id="basic-wal-module-notes"> + <sect2 id="basic-archive-notes"> <title>Notes</title> <para> @@ -70,7 +70,7 @@ basic_wal_module.archive_directory = '/path/to/archive/directory' </para> </sect2> - <sect2 id="basic-wal-module-author"> + <sect2 id="basic-archive-author"> <title>Author</title> <para> diff --git a/doc/src/sgml/contrib.sgml b/doc/src/sgml/contrib.sgml index 3225284eead..12c79b798ba 100644 --- a/doc/src/sgml/contrib.sgml +++ b/doc/src/sgml/contrib.sgml @@ -105,7 +105,7 @@ CREATE EXTENSION <replaceable>extension_name</replaceable>; &auth-delay; &auto-explain; &basebackup-to-shell; - &basic-wal-module; + &basic-archive; &bloom; &btree-gin; &btree-gist; diff --git a/doc/src/sgml/filelist.sgml b/doc/src/sgml/filelist.sgml index 2d36c34ce81..0d6be9a2faf 100644 --- a/doc/src/sgml/filelist.sgml +++ b/doc/src/sgml/filelist.sgml @@ -116,7 +116,7 @@ <!ENTITY amcheck SYSTEM "amcheck.sgml"> <!ENTITY auth-delay SYSTEM "auth-delay.sgml"> <!ENTITY auto-explain SYSTEM "auto-explain.sgml"> -<!ENTITY basic-wal-module SYSTEM "basic-wal-module.sgml"> +<!ENTITY basic-archive SYSTEM "basic-archive.sgml"> <!ENTITY basebackup-to-shell SYSTEM "basebackup-to-shell.sgml"> <!ENTITY bloom SYSTEM "bloom.sgml"> <!ENTITY btree-gin SYSTEM "btree-gin.sgml"> @@ -200,4 +200,3 @@ <!ENTITY obsolete-pgxlogdump SYSTEM "appendix-obsolete-pgxlogdump.sgml"> <!ENTITY obsolete-pgresetxlog SYSTEM "appendix-obsolete-pgresetxlog.sgml"> <!ENTITY obsolete-pgreceivexlog SYSTEM "appendix-obsolete-pgreceivexlog.sgml"> -<!ENTITY obsolete-basic-archive SYSTEM "appendix-obsolete-basic-archive.sgml"> |