make libpq documentation navigable between functions - Mailing list pgsql-hackers

From Fabien COELHO
Subject make libpq documentation navigable between functions
Date
Msg-id alpine.DEB.2.21.1905121032330.27203@lancre
Whole thread Raw
Responses Re: make libpq documentation navigable between functions  (Peter Eisentraut <peter.eisentraut@2ndquadrant.com>)
List pgsql-hackers
Hello dev,

While writing some libpq code, I found it quite irritating that the 
documentation is not navigable, so when a function appears in a 
description of another function and you are interested, there is no direct 
way to find it, you have to go to the index or to guess in which section 
it is going to appear.

Attached:
  - a first patch to add a few missing "id"
  - a script which adds the references
  - a second patch which is the result of applying the script
    on top of the first patch, so that all PQ* functions are
    replaced by links to their documentation.

While doing this, I noticed that two functions are not documented: 
PQregisterThreadLock and PQsetResultInstanceData.

-- 
Fabien.
Attachment

pgsql-hackers by date:

Previous
From: Michael Paquier
Date:
Subject: Re: Why is infinite_recurse test suddenly failing?
Next
From: Michael Paquier
Date:
Subject: Re: Wrong dead return value in jsonb_utils.c