diff options
| author | Stephen Frost | 2021-03-31 20:23:25 +0000 |
|---|---|---|
| committer | Stephen Frost | 2021-03-31 20:23:25 +0000 |
| commit | 3b0c647bbfc52894d979976f1e6d60e40649bba7 (patch) | |
| tree | 90f2ef93dc87edf17180b1c9b14d7f63e43ba8e8 /doc/src/sgml/appendix-obsolete-pgresetxlog.sgml | |
| parent | 522d1a89f8d7ed45681988c60bd0a687332a4023 (diff) | |
Add a docs section for obsoleted and renamed functions and settings
The new appendix groups information on renamed or removed settings,
commands, etc into an out-of-the-way part of the docs.
The original id elements are retained in each subsection to ensure that
the same filenames are produced for HTML docs. This prevents /current/
links on the web from breaking, and allows users of the web docs
to follow links from old version pages to info on the changes in the
new version. Prior to this change, a link to /current/ for renamed
sections like the recovery.conf docs would just 404. Similarly if
someone searched for recovery.conf they would find the pg11 docs,
but there would be no /12/ or /current/ link, so they couldn't easily
find out that it was removed in pg12 or how to adapt.
Index entries are also added so that there's a breadcrumb trail for
users to follow when they know the old name, but not what we changed it
to. So a user who is trying to find out how to set standby_mode in
PostgreSQL 12+, or where pg_resetxlog went, now has more chance of
finding that information.
Craig Ringer and Stephen Frost
Reviewed-by: Euler Taveira
Discussion: https://postgr.es/m/CAGRY4nzPNOyYQ_1-pWYToUVqQ0ThqP5jdURnJMZPm539fdizOg%40mail.gmail.com
Backpatch-through: 10
Diffstat (limited to 'doc/src/sgml/appendix-obsolete-pgresetxlog.sgml')
| -rw-r--r-- | doc/src/sgml/appendix-obsolete-pgresetxlog.sgml | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/src/sgml/appendix-obsolete-pgresetxlog.sgml b/doc/src/sgml/appendix-obsolete-pgresetxlog.sgml new file mode 100644 index 00000000000..7d999301f15 --- /dev/null +++ b/doc/src/sgml/appendix-obsolete-pgresetxlog.sgml @@ -0,0 +1,24 @@ +<!-- doc/src/sgml/obsolete-pgresetxlog.sgml --> +<!-- + See doc/src/sgml/obsolete.sgml for why this file exists. Do not change the id attribute. +--> + +<sect1 id="app-pgresetxlog" xreflabel="pg_resetxlog"> + <title><command>pg_resetxlog</command> renamed to <command>pg_resetwal</command></title> + + <indexterm> + <primary>pg_resetxlog</primary> + <see>pg_resetwal</see> + </indexterm> + + <para> + PostgreSQL 9.6 and below provided a command named + <command>pg_resetxlog</command> + <indexterm><primary>pg_resetxlog</primary></indexterm> + to reset the write-ahead-log (WAL) files. This command was renamed to <command>pg_resetwal</command>, see + <xref linkend="app-pgresetwal"/> for documentation of <command>pg_resetwal</command> and see + <link linkend="release-prior">the release notes for PostgreSQL 10</link> for details + on this change. + </para> + +</sect1> |