Re: mdoc.7 tweaks

[Kristaps Dzonsons <kristaps@bsd.lv>]

Jason McIntyre wrote:
> On Mon, Aug 02, 2010 at 10:57:11PM +0200, Ingo Schwarze wrote:
>> Everything not related to .Sx / .Sy is ok schwarze@.
>>
>>> *) uses Sy for macros instead of Sx. we could use something else but
>>>    not, please, Sx.
>> Hmm, i'm not sure.
>> Using exactly Sx (and not anything else) has a point.
>> On http://mdocml.bsd.lv/mdoc.7.html , you can easily navigate
>> the whole manual using the macro hyperlinks.
>> I know that is irrelevant for man(1), and for terminal output
>> in general, but it may still be considered useful.
>>
> 
> hmm. so i have probably confused two things: when we are talking about a
> section, Sx is correct. but to just refer to macros, we shouldn;t use
> Sx. but i see now that the macro name was additionally also a macro
> name.
> 
>> That seems easy; i guess it's a typo, and i would just change lb to lB
>> and rb to rB, like this:
>>
>>   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lBres...\(rB
>>
> 
> ah.
> 
>> Are you really sure we should switch from .Sx to .Sy right now?
>>
>> If yes, we need to get it right at once, including choosing the
>> macro we really want, but i do not want to digress into .Sy vs. .Ic
>> vs. whatever bikeshedding as long as we do not even agree that we
>> need to get rid of .Sx at all.
>>
>> If no, will you pull the .Sx/.Sy parts out of the diff for now,
>> or shall i do it?
>>
> 
> we should undo the Sx/Sy parts of my diff. which is most of the diff ;(
> anyway, i have to sleep now. if you want to take this further, carry on.
> if not i'll try and find time tomorrow to redo it.

Hi,

(Note that I'm back...)

I'm fine with using `Sy' within the "usage" section when used with the 
macro already being documented, but in general I heavily use `Sx' 
because it works so well with the hyperlinking.

I'm fine with the other changes, although I didn't look them over 
carefully.  Ingo, since you've looked this over carefully, can you check 
this in when you'd like?  I'm not sure what the OpenBSD/mandoc sync 
state is with respect to mdoc.7, but they should be consistent.

Thanks,

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