Rotten parts of src/backend/replication/README

From: Michael Paquier <michael(at)paquier(dot)xyz>
To: Postgres hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Rotten parts of src/backend/replication/README
Date: 2020-05-02 02:46:06
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

Hi all,

The first part of src/backend/replication/README lists all the APIs
usable for a WAL receiver, but these have aged and lost track of most
changes that happened over the years. Four functions are listed in
the README, with incorrect signatures and many others are missing:
- walrcv_connect()
- walrcv_receive()
- walrcv_send()
- walrcv_disconnect()

I think that we should clean up that. And as it seems to me that
nobody really remembers to update this README, I would suggest to
update the first section of the README to refer to walreceiver.h for
details about each function, then move the existing API descriptions
from the README to walreceiver.h (while fixing the incomplete
descriptions of course). This way, if a new function is added or if
an existing function is changed, it is going to be hard to miss an
update of the function descriptions.

Any thoughts?


Browse pgsql-hackers by date

  From Date Subject
Next Message Thomas Munro 2020-05-02 03:53:20 Re: pgsql: Rationalize GetWalRcv{Write,Flush}RecPtr().
Previous Message Michael Paquier 2020-05-02 02:29:00 Re: +(pg_lsn, int8) and -(pg_lsn, int8) operators