pgsql: Move description of libpqwalreceiver hooks out of the replicatio

From: Michael Paquier <michael(at)paquier(dot)xyz>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: Move description of libpqwalreceiver hooks out of the replicatio
Date: 2020-07-02 04:59:54
Message-ID: E1jqrKE-0006Nz-Jm@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

Move description of libpqwalreceiver hooks out of the replication's README

src/backend/replication/README includes since 32bc08b a basic
description of the WAL receiver hooks available in walreceiver.h for a
module like libpqwalreceiver, but the README has never been updated to
reflect changes done to the hooks, so the contents of the README have
rotten with the time. This commit moves the description from the README
to walreceiver.h, where it will be hard to miss that a description
update or addition is needed depending on the modifications done to the
hooks.

Each hook now includes a description of what it does in walreceiver.h,
and the replication's README mentions walreceiver.h.

Thanks also to Amit Kapila for the discussion.

Author: Michael Paquier
Reviewed-by: Peter Eisentraut
Discussion: https://postgr.es/m/20200502024606.GA471944@paquier.xyz

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/641dd167a3424f97eed8416b5ef1c21dbbf8cf12

Modified Files
--------------
src/backend/replication/README | 29 +-------
src/include/replication/walreceiver.h | 136 ++++++++++++++++++++++++++++++++--
2 files changed, 132 insertions(+), 33 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Peter Geoghegan 2020-07-02 21:56:26 pgsql: nbtree: Rename _bt_search() variables.
Previous Message Michael Paquier 2020-07-01 08:14:22 pgsql: Refactor ObjectAddress field assignments in more places