Re: Add docs stub for recovery.conf

From: Stephen Frost <sfrost(at)snowman(dot)net>
To: Euler Taveira <euler(at)eulerto(dot)com>
Cc: Craig Ringer <craig(dot)ringer(at)enterprisedb(dot)com>, 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-03-28 21:20:41
Message-ID: 20210328212040.GF20766@tamriel.snowman.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Greetings,

* Euler Taveira (euler(at)eulerto(dot)com) wrote:
> On Sun, Mar 28, 2021, at 2:22 PM, Stephen Frost wrote:
> > Unless there's anything further, will commit these soon.
> I briefly looked at this patch and have a few comments.
>
> +<sect1 id="app-pgreceivexlog" xreflabel="pg_receivexlog">
> + <title><command>pg_receivexlog</command> renamed to <command>pg_recievewal</command></title>
>
> s/pg_recievewal/pg_receivewal/

Hah! Good catch. Fixed.

> +<appendix id="appendix-obsolete">
> + <title>Obsolete or renamed features, settings and files</title>
>
> Section titles are capitalized so it should be "Obsolete or Renamed Features,
> Settings and Files". I find this section name too descriptive. I didn't follow
> this thread but maybe we might use a generic name that is also shorter than it
> such as "Incompatible or Obsolete Features".

Not sure how others feel, but 'incompatible' doesn't seem quite right to
me- we renamed some things between major versions but they're as
compatible as they were before. Having it be shorter does make sense to
me, so I updated the patch with "Obsolete or Renamed Features" instead.

I also reworded the section underneath a bit to mention renaming and to
include a comment about features, settings, and file names.

> + <primary>trigger_file</primary>
> + <see>promote_trigger_file</see>
> + </indexterm>
> + setting has been renamed to
> + <xref linkend="guc-promote-trigger-file"/>
> + </para>
>
> There should be a period after the <xref>.

Good catch, fixed.

Updated patches attached.

Thanks!

Stephen

Attachment Content-Type Size
doc-rename-cleanup_v5.patch text/x-diff 14.6 KB
doc-rename-cleanup_v5_v10.patch text/x-diff 8.3 KB
doc-rename-cleanup_v5_v11.patch text/x-diff 8.1 KB
doc-rename-cleanup_v5_v12.patch text/x-diff 14.6 KB
doc-rename-cleanup_v5_v13.patch text/x-diff 14.6 KB

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message David Rowley 2021-03-28 22:48:47 Re: Getting better results from valgrind leak tracking
Previous Message Thomas Munro 2021-03-28 21:15:31 Re: MultiXact\SLRU buffers configuration