Re: [PATCH 1/9] ldconfig.8: Fix markup nits

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Alex,

At 2023-01-04T13:26:33+0100, Alejandro Colomar wrote:
> This patch looks good to me.  However, I didn't apply it, since I have
> a few comments below.

Ok.  V3, here we come!

> >   .SH NAME
> >   ldconfig \- configure dynamic linker run-time bindings
> >   .SH SYNOPSIS
> 
> We should wrap this in .nf/.fi

That will have a cost.  It will mean using a lot of \c escape sequences
to connect the output lines.

The existing synopsis fits within 74 output columns on a terminal.

Do you think it's worth it?

> Although maybe this goes better in the style patch, since it's a
> formatting fix.

I can shift it.

> I will suggest again that I believe \% should be the default in manual
> pages. Count how many times you want to break highlighted stuff vs how
> many times you want to not break such stuff.

I don't see good prospects of this for the same reason that I was able
to talk Ingo Schwarze out of keeping section headings in shouting
capitals.  It's a matter of preference, but one preference means
discarding information irrevocably in the source document, and the other
means that the information is present but unused.

groff man(7) _has_ a mechanism for this, and has since groff 1.19
(2003).  It's the `HY` register.  People can put this in their man.local
files (on Debian-based systems, that's in /etc/groff).

.nr HY 0

Colin Watson's man-db man(1) also has a feature to suppress hyphenation,
using a hack; it's not pretty but it works even on other *roff
formatters.

I don't insist that people keep hyphenation enabled, but assuming that
no one will do so will keep us from putting worthwhile information in
our man pages.

If you dread the tedium of adding \% escape sequences to "keywords" all
over the place, I don't blame you.  This is one reason I proposed my
most ambitious man(7) extension yet, a two-macro semantic tag mechanism.

https://marc.info/?l=linux-man&m=165868366126909&w=2

As with the new `MR` in groff 1.23, you could then suppress hyphenation
in the internal macros that wrap "tagged" keywords.

> > -.\" FIXME glibc 2.7 added -i
> 
> And this is why comments are harmful.  I fint it rather uncommon for
> comments to be up-to-date with the code :P

I generally find FIXME comments useful.  It's a happy day when I find
one that's already been addressed.  :)

Regards,
Branden

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux