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

[Brian Inglis <Brian.Inglis@SystematicSw.ab.ca>]

On 2022-02-18 07:16, Jon Turney wrote:
> 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.

There are now nested lists of fields and definitions which were indeed 
wrapped: into a single run on paragraph with no indentation or breaks, 
so it looks like the makedocbook docs mostly don't apply here!

>> 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.

I did get bullet lists working with "*- " prefix which marked with "- " 
but not "*", "* ", "**", "** "!
I used <[...]> and blank lines extensively to provide emphasis which 
mostly works in man pages, but as info pages convert those to uppercase, 
could not distinguish from uppercase literals, so I had to add the 
convention that those are indicated by apostrophe single quotes 'X' in 
both formats, although unnecessary in man pages, while in man format two 
adjacent variable names are concatenated, which I could not separate 
without inserting a visible character, which would be more confusing! ;^<

> 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.

I'll browse the other functions to see if I can find more example 
markup, but those constructs look more like what I would expect in guile 
or m4 scripts than makedocbook, which seems natively to be closer to 
restructured text or markdown: I prefer the latter over the former!

-- 
Take care. Thanks, Brian Inglis, Calgary, Alberta, Canada

This email may be disturbing to some readers as it contains
too much technical detail. Reader discretion is advised.
[Data in binary units and prefixes, physical quantities in SI.]