Re: Add docs stub for recovery.conf

From: Stephen Frost <sfrost(at)snowman(dot)net>
To: Craig Ringer <craig(dot)ringer(at)enterprisedb(dot)com>
Cc: Bruce Momjian <bruce(at)momjian(dot)us>, Isaac Morland <isaac(dot)morland(at)gmail(dot)com>, "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>, pgsql-hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Add docs stub for recovery.conf
Date: 2021-01-19 18:45:46
Message-ID: 20210119184546.GN27507@tamriel.snowman.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Greetings,

* Stephen Frost (sfrost(at)snowman(dot)net) wrote:
> * Craig Ringer (craig(dot)ringer(at)enterprisedb(dot)com) wrote:
> > On Thu, 14 Jan 2021 at 03:44, Stephen Frost <sfrost(at)snowman(dot)net> wrote:
> > > Alright, how does this look? The new entries are all under the
> > > 'obsolete' section to keep it out of the main line, but should work to
> > > 'fix' the links that currently 404 and provide a bit of a 'softer'
> > > landing for the other cases that currently just forcibly redirect using
> > > the website doc alias capability.
> >
> > Thanks for expanding the change to other high profile obsoleted or renamed
> > features and tools.
>
> Thanks for taking the time to review it and comment on it!
>
> > One minor point. I'm not sure this is quite the best way to spell the index
> > entries:
> >
> > + <indexterm>
> > + <primary>obsolete</primary>
> > + <secondary>pg_receivexlog</secondary>
> > + </indexterm>
> >
> > as it will produce an index term "obsolete" with a list of various
> > components under it. While that concentrates them nicely, it means people
> > won't actually find them if they're using the index alphabetically.
>
> Ah, yeah, that's definitely a good point and one that I hadn't really
> spent much time thinking about.
>
> > I'd slightly prefer
> >
> > + <indexterm>
> > + <primary>pg_receivexlog</primary>
> > + <seealso>pg_receivewal</secondary>
> > + </indexterm>
> >
> > even though that bulks the index up a little, because then people are a bit
> > more likely to find it.
>
> Yup, makes sense, updated patch attached which makes that change.
>
> > > I ended up not actually doing this for the catalog -> view change of
> > > pg_replication_slots simply because I don't really think folks will
> > > misunderstand or be confused by that redirect since it's still the same
> > > relation. If others disagree though, we could certainly change that
> > > too.
> >
> > I agree with you.
>
> Ok, great.
>
> How does the attached look then?
>
> Bruce, did you want to review or comment on this as to if it addresses
> your concerns appropriately? Would be great to get this in as there's
> the follow-on for default roles.

... really attached now, sorry about that. :)

Thanks,

Stephen

Attachment Content-Type Size
doc-rename-cleanup_v2.patch text/x-diff 11.6 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Justin Pryzby 2021-01-19 19:07:20 Re: [HACKERS] Custom compression methods
Previous Message Stephen Frost 2021-01-19 18:44:23 Re: Add docs stub for recovery.conf