Re: Add exclusive backup deprecation notes to documentation

From: Magnus Hagander <magnus(at)hagander(dot)net>
To: David Steele <david(at)pgmasters(dot)net>
Cc: Peter Eisentraut <peter(dot)eisentraut(at)2ndquadrant(dot)com>, Laurenz Albe <laurenz(dot)albe(at)cybertec(dot)at>, PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>, Martín Marqués <martin(at)2ndquadrant(dot)com>, Michael Paquier <michael(at)paquier(dot)xyz>
Subject: Re: Add exclusive backup deprecation notes to documentation
Date: 2019-03-01 13:10:57
Message-ID: CABUevEz4rGtf3-q1YBHHcE1v6G8Q1t7CsZ7HwvFS3CPw9bm82w@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Fri, Mar 1, 2019 at 2:07 PM David Steele <david(at)pgmasters(dot)net> wrote:

> On 3/1/19 1:13 PM, Peter Eisentraut wrote:
> > Please follow the 1-space indentation in the documentation files.
>
> Whoops. Will fix.
>
> > I think the style of mentioning all the problems in a note before the
> > actual description is a bit backwards.
>
> In the case of an important note like this I think it should be right at
> the top where people will see it. Not everyone reads to the end
>

Maybe have the first note say "This method is deprecated bceause it has
serious risks (see bellow)" and then list the actual risks at the end?

--
Magnus Hagander
Me: https://www.hagander.net/ <http://www.hagander.net/>
Work: https://www.redpill-linpro.com/ <http://www.redpill-linpro.com/>

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Christoph Berg 2019-03-01 13:12:15 Re: pgsql: Build src/port files as a library with -fPIC, and use that in li
Previous Message David Steele 2019-03-01 13:07:13 Re: Add exclusive backup deprecation notes to documentation