• Michael Paquier's avatar
    Move description of libpqwalreceiver hooks out of the replication's README · 641dd167
    Michael Paquier authored
    src/backend/replication/README includes since 32bc08b1 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
    641dd167
README 3.37 KB