Re: Bk -words badness

[Kristaps Dzonsons <kristaps@bsd.lv>]

>> Ingo, how goes the `Bk' work?  Scanning through mandoc's rendering of
>> current manuals, I see a lot of the following sort of breakage:
>>
>> .Bk -words
>> .Op Fl a Ar b
>> .Op Fl a Ar b
>> .Op Fl a Ar b
>> .Op Fl a Ar b
>> .Op Fl a Ar b
>> .Op Fl a Ar b
>> .Op Fl a Ar b
>> .Op Fl a Ar b
>> .Op Fl a Ar b
>> .Op Fl a Ar b
>> .Op Fl a Ar b
>> .Op Fl a Ar b
>> ...
> 
> The enclosed patch is a first stab at this.  It only works for explicit
> `Bk -words' for now; it's trivial to extend this to SYNPRETTY.  As you
> can see, it simply checks whether it's in a KEEP mode and resets to
> PREKEEP if it's a line subsequent the prior node.
> 
> This fixes the badness mentioned above.

...so I visually checked this against /all/ OpenBSD manuals with `Bk'
and didn't notice anything out of the ordinary except ssh-keygen(1) and
crunchgen(8).  Both exhibit block-breaking behaviour regarding `Nm' and
`Bk'.

The only systematic difference I see between mandoc and groff is that
given two `Nm' blocks in the SYNOPSIS, groff remembers the first
indentation whilst mandoc will readjust itself.  I prefer the latter,
but that's just me.

Example (edited, as groff doesn't have our awesome -Owidth=xxx option):

groff:
     newfs [-Nq] [-b block-size] [-c fragments-per-cylinder-group]
           [-f frag-size] [-g avgfilesize] [-h avgfpdir]

     mount_mfs [-b block-size] [-c fragments-per-cylinder-group]
           [-f frag-size] [-i bytes] [-m free-space] [-o options]

mandoc:
     newfs [-Nq] [-b block-size] [-c fragments-per-cylinder-group]
           [-f frag-size] [-g avgfilesize] [-h avgfpdir]

     mount_mfs [-b block-size] [-c fragments-per-cylinder-group]
               [-f frag-size] [-i bytes] [-m free-space]

If this behaviour is desired, I think it's pretty trivial to implement
given an extra state variable.

Kristaps
--
 To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv