make libpq documentation navigable between functions

From: Fabien COELHO <coelho(at)cri(dot)ensmp(dot)fr>
To: PostgreSQL Developers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: make libpq documentation navigable between functions
Date: 2019-05-12 09:02:16
Message-ID: alpine.DEB.2.21.1905121032330.27203@lancre
Views: Raw Message | Whole Thread | Download mbox
Thread:
Lists: 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 Content-Type Size
libpq-links.pl text/x-perl 513 bytes
doc-libpq-links-1-a.patch text/x-diff 3.0 KB
doc-libpq-links-1-b.patch text/x-diff 133.3 KB

Browse pgsql-hackers by date

  From Date Subject
Next Message Michael Paquier 2019-05-12 09:07:38 Re: Wrong dead return value in jsonb_utils.c
Previous Message Michael Paquier 2019-05-12 08:57:23 Re: Why is infinite_recurse test suddenly failing?