Re: Documentation for bootstrap data conversion

2018-04-19 Thread Tom Lane
John Naylor writes: > I've attached a patch that mostly touches boilerplate comments in the > headers and data files. I couldn't resist editing some comments for > clarity and consistency. Pushed, along with a little bit of extra tweaking to fix random discrepancies in the header comments. > Not

Re: Documentation for bootstrap data conversion

2018-04-19 Thread John Naylor
On 4/18/18, Tom Lane wrote: > John Naylor writes: >> and dug through a bit to find cases where 'catalog' is clearly a >> better term. Most of these are in the pg_*.h/.dat file boilerplate >> comments, which would be easy enough to change with a script. If we're >> going to do that, the word order

Re: Documentation for bootstrap data conversion

2018-04-18 Thread Tom Lane
John Naylor writes: > On 4/9/18, Tom Lane wrote: >> Meh, I think either is fine really. I do recall changing something >> in bki.sgml that referred to both "bootstrap relations" and "bootstrap >> catalogs" in practically the same sentence. I think that *is* confusing, >> because it's not obviou

Re: Documentation for bootstrap data conversion

2018-04-16 Thread John Naylor
On 4/9/18, Tom Lane wrote: >> 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. > > Meh, I think either is fine really. I do recall changing something > in bki.

Re: Documentation for bootstrap data conversion

2018-04-09 Thread Tom Lane
John Naylor writes: > On 4/9/18, Tom Lane wrote: >> I did note that in some internal comments, but forgot it when writing >> this. I agree that now that the conversion is done, it'd be better >> to remove that special case. Would you send a patch for that? > Sure, attached. Pushed, thanks. I

Re: Documentation for bootstrap data conversion

2018-04-09 Thread John Naylor
On 4/9/18, Tom Lane wrote: >> 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 b

Re: Documentation for bootstrap data conversion

2018-04-09 Thread Tom Lane
John Naylor writes: > On 4/7/18, Tom Lane wrote: >> reformat_dat_file.pl 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 co

Re: Documentation for bootstrap data conversion

2018-04-09 Thread John Naylor
On 4/7/18, Tom Lane 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. reformat_dat_

Re: Documentation for bootstrap data conversion

2018-04-06 Thread Tom Lane
Andres Freund writes: > Quick skim only: > "developers" here could possibly be understood to be any sort of > developer, rather than postgres ones. Perhaps just say "But the > structure of the catalogs can change between major versions."? OK. > This sounds like an exhaustive list of what genbk

Re: Documentation for bootstrap data conversion

2018-04-06 Thread Andres Freund
Hi, On 2018-04-06 14:27:39 -0400, Tom Lane 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. Quick skim only: > diff --git a/doc/src/sgml/bki.sgml b/doc/src/

Documentation for bootstrap data conversion

2018-04-06 Thread Tom Lane
I felt it was worth spending some extra effort on documentation for this change, since it's going to impact a lot of future patches. Accordingly, I've taken John's proposed README text and moved it into the SGML format, and done a fair amount of editing to extend the text and bring it all up to dat