Re: [PATCH 0/1] newlib/libc/time/tzset_r.c(_tzset_unlocked_r): add POSIX <> quoted abbrs

[Jon Turney <jon.turney@dronecode.org.uk>]

On 18/02/2022 03:43, Brian Inglis wrote:
> On 2022-02-17 05:11, Corinna Vinschen wrote:
>> On Feb 16 12:18, Brian Inglis wrote:
>>> On 2022-02-16 01:55, Corinna Vinschen wrote:
>>>> On Feb 15 22:38, Brian Inglis wrote:
>>>>> I am inclined to use if defined in order:
>>>>> *    limits.h TZNAME_MAX
>>>>> *    unistd.h sysconf(_SC_TZNAME_MAX) if available
>>>>> *    limits.h _POSIX_TZNAME_MAX
>>>>> *    6!
>>>>
>>>> I'd replace 6 with #error
>>>
>>> That's probably for the best - I'll look at adding that to a v2 patch 
>>> set
>>> including doc update.
>>>
>>> What is required to remake newlib libc info and man pages?
>>
>> make info / make man?
> 
> Thanks for the kick!
> I finally found those targets under build64/newlib/Makefile and got 
> errors: it looks like python {lxml,ply} need to be manually upgraded to 
> python39-{lxml,ply} for these to work!
> 
> Both the updated tzset info and man pages now look awful with a 
> screenful of run on text!

That's odd since I would think the viewer should wrap appropriately.

> As far as I can see, I can only use blank lines and angle brackets for 
> formatting, so I will add a whole bunch more of those, retry if they 
> will now build as part of Cygwin, and see if I can get them to look much 
> better.
> 
> If anyone has any pointers to the embedded lib doc header semantic 
> formatting conventions I would be grateful for those.

Yeah, this should be described in the documentation section of the 
'HOWTO' file, but isn't.

Briefly:

'<<' and '>>' mark up function names and code
'<[' and ']>' mark up formal parameter and variable names

There are formatting instructions for bullet points, preformatted 
monospaced text and tables, which are probably best understood by 
looking at an existing example.

In theory, you can also use any texinfo markup, but if you use anything 
outside the very limited subset currently used and understood by 
makedocbook.

Unfortunately, makedocbook relies on the prototypes being marked-up in 
quite an exact way in order to be able to massage them into the very 
detailed content model of a docbook funcsynopsis.