Re: make libpq documentation navigable between functions

From: Peter Eisentraut <peter(dot)eisentraut(at)2ndquadrant(dot)com>
To: Fabien COELHO <coelho(at)cri(dot)ensmp(dot)fr>
Cc: PostgreSQL Developers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: make libpq documentation navigable between functions
Date: 2019-07-26 09:49:52
Message-ID: e885e202-9bf3-2346-efd2-777dd92c1254@2ndquadrant.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
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

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Fabien COELHO 2019-07-26 10:02:14 psql FETCH_COUNT feature does not work with combined queries
Previous Message Amit Kapila 2019-07-26 09:45:33 Re: POC: Cleaning up orphaned files using undo logs