Re: Remove all "INTERFACE ROUTINES" style comments - Mailing list pgsql-hackers

From Thomas Munro
Subject Re: Remove all "INTERFACE ROUTINES" style comments
Date
Msg-id CAEepm=06fvK9KvjSRapDJ7U_R4b7n6AORSwZCV21Mi4VGq8VPQ@mail.gmail.com
Whole thread Raw
In response to Remove all "INTERFACE ROUTINES" style comments  (Andres Freund <andres@anarazel.de>)
Responses Re: Remove all "INTERFACE ROUTINES" style comments  (Tom Lane <tgl@sss.pgh.pa.us>)
Re: Remove all "INTERFACE ROUTINES" style comments  (Robert Haas <robertmhaas@gmail.com>)
List pgsql-hackers
On Fri, Jan 11, 2019 at 12:58 PM Andres Freund <andres@anarazel.de> wrote:
> A number of postgres files have sections like heapam's
>
>  * INTERFACE ROUTINES
>  *      relation_open   - open any relation by relation OID
>  *      relation_openrv - open any relation specified by a RangeVar
>  *      relation_close  - close any relation
>  *      heap_open       - open a heap relation by relation OID
>  *      heap_openrv     - open a heap relation specified by a RangeVar
>  *      heap_close      - (now just a macro for relation_close)
>  *      heap_beginscan  - begin relation scan
>  *      heap_rescan     - restart a relation scan
>  *      heap_endscan    - end relation scan
>  *      heap_getnext    - retrieve next tuple in scan
>  *      heap_fetch      - retrieve tuple with given tid
>  *      heap_insert     - insert tuple into a relation
>  *      heap_multi_insert - insert multiple tuples into a relation
>  *      heap_delete     - delete a tuple from a relation
>  *      heap_update     - replace a tuple in a relation with another tuple
>  *      heap_sync       - sync heap, for when no WAL has been written
>
> They're often out-of-date, and I personally never found them to be
> useful. A few people, including yours truly, have been removing a few
> here and there when overhauling a subsystem to avoid having to update
> and then adjust them.
>
> I think it might be a good idea to just do that for all at once. Having
> to consider separately committing a removal, updating them without
> fixing preexisting issues, or just leaving them outdated on a regular
> basis imo is a usless distraction.
>
> Comments?

+1

-- 
Thomas Munro
http://www.enterprisedb.com


pgsql-hackers by date:

Previous
From: Andres Freund
Date:
Subject: Remove all "INTERFACE ROUTINES" style comments
Next
From: Andres Freund
Date:
Subject: Re: What to name the current heap after pluggable storage / what torename?