Re: make libpq documentation navigable between functions
Peter Eisentraut <peter.eisentraut@2ndquadrant.com>
From: Peter Eisentraut <peter.eisentraut@2ndquadrant.com>
To: Fabien COELHO <coelho@cri.ensmp.fr>
Cc: PostgreSQL Developers <pgsql-hackers@lists.postgresql.org>
Date: 2019-07-26T09:49:52Z
Lists: pgsql-hackers
On 2019-07-22 22:56, Fabien COELHO wrote: > Attached script does, hopefully, the expected transformation. It adds ids > to <function> occurrences when the id is not defined elsewhere. > > Attached v3 is the result of applying your kindly provided xslt patch plus > the script on "libpq.sgml". > > Three functions are ignored because no documentation is found: > PQerrorField (does not exist anywhere in the sources), > PQsetResultInstanceData (idem) and PQregisterThreadLock (it exists). > > Doc build works for me and looks ok. I have committed this with some additions. I have changed all the function-related id attributes in libpq.sgml to be mixed case, for easier readability. So if you run your script again, you can omit the lc() call. I also needed to make some changes to the markup in some places to remove extra whitespace that would have appeared in the generated link. (This was already happening in some places, but your patch would have repeated it in many places.) Also, due to some mysterious problems with the PDF toolchain I had to remove some links. Your script would find those, so I won't list them here. If you put those back in, the PDF build breaks. If you want to work out why, feel free to submit more patches. Otherwise I'm happy to leave it as is now; it's very useful. -- Peter Eisentraut http://www.2ndQuadrant.com/ PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services
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