• Stephen Frost's avatar
    Add a docs section for obsoleted and renamed functions and settings · 3b0c647b
    Stephen Frost authored
    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
    3b0c647b
appendix-obsolete.sgml 1.58 KB