make libpq documentation navigable between functions
Fabien COELHO <coelho@cri.ensmp.fr>
From: Fabien COELHO <coelho@cri.ensmp.fr>
To: PostgreSQL Developers <pgsql-hackers@lists.postgresql.org>
Date: 2019-05-12T09:02:16Z
Lists: pgsql-hackers
Attachments
- libpq-links.pl (text/x-perl)
- doc-libpq-links-1-a.patch (text/x-diff) patch
- doc-libpq-links-1-b.patch (text/x-diff) patch
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.
Commits
-
doc: Make libpq documentation navigable between functions
- e829337d42d0 13.0 landed
-
doc: Add support for xref to command and function elements
- 2e32a7711a8a 13.0 landed