Re: SPITupleTable members missing in docs

Fabien COELHO <coelho@cri.ensmp.fr>

From: Fabien COELHO <coelho@cri.ensmp.fr>
To: Daniel Gustafsson <daniel@yesql.se>
Cc: pgsql-docs@lists.postgresql.org, Michael Paquier <michael@paquier.xyz>, Tom Lane <tgl@sss.pgh.pa.us>
Date: 2019-07-12T14:56:31Z
Lists: pgsql-docs
Hello Daniel,

> Since this makes the number of internal members far outnumber the public 
> ones, also reword the statement about which fields can be used to try 
> and improve clarity.

Patch applies cleanly, doc build ok.

To take into account Tom's comment, I'd suggest a middle ground by 
commenting a public and private part explicitely in the struct, something 
like:

   typedef struct {
     /* PUBLIC members to be used by callers ... */
     ...
     ...
     /* PRIVATE members, not intended for external usage ... */
     ...
   } ... ;

Another option would be to use some python-like naming convention on such 
members, eg with a leading underline character.

Even if it is redundant with the paragraph below, it would make things 
visually clear as well.

Note: I'm probaly not a member of the pgdoc list, so the delivery may fail 
there.

-- 
Fabien.



Commits

  1. Clarify the distinction between public and private SPITupleTable fields.

  2. Prevent leakage of SPI tuple tables during subtransaction abort.