Re: Documentation for bootstrap data conversion

John Naylor <jcnaylor@gmail.com>

From: John Naylor <jcnaylor@gmail.com>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: pgsql-hackers@lists.postgresql.org
Date: 2018-04-09T09:28:18Z
Lists: pgsql-hackers

Attachments

On 4/7/18, Tom Lane <tgl@sss.pgh.pa.us> wrote:
> John and I are probably both too close to the patch to be able to
> review this documentation for clarity and usefulness, so if anyone
> else wants to have a look, please comment.

No argument there, but I did want to note some minor details:

1.
         <filename>reformat_dat_file.pl</filename> preserves blank lines
         and comment lines as-is.

As it is now, it will actually collapse consecutive blank lines into
one. I maintain that was necessary during conversion to get some
semblance of consistency, but now it may not be a good idea to tie
developers' hands in surprising ways if they want double blank lines
in some places. It would be pretty easy to remove this behavior.
Apologies if it was not documented well enough.

2. I noticed the use of
<structname>pg_xxx.h</structname>
<structname>pg_xxx_d.h</structname>
where I would expect <filename>. Not sure if it matters.

3. It seems the preferred style is to refer to "bootstrap" relations
rather than "bootstrapped" relations. The attached patch makes code
comments more like the docs in this regard.

-John Naylor

Commits

  1. Improve consistency of comments in system catalog headers.

  2. Make reformat_dat_file.pl preserve all blank lines.