Re: [PATCH 1/2] system_data_types.7: srcfix

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

 



At 2020-09-27T22:24:19+0200, Alejandro Colomar wrote:
> Yup, I introduced that line a few patches ago because
> I didn't know .RB existed :)

At the risk of being the sort of tedious jerk who promotes is own work,
I recommend the table at the beginning of groff_man(7)[1], which can
serve almost as a quick-reference card for the macro package.

> BTW, thanks for all your comments.
> Thanks to them I improved the style in system_data_types.7,
> which I started a few weeks ago.

I've noticed!  I'm subscribed to the list and I think your efforts have
tripled the average monthly traffic. :D

But it's a good thing.  Section 7 of the manual is criminally underused,
and data types have long been badly neglected in documentation, with
functions sucking up all the oxygen.  In my opinion, every
externally-visible symbol a library exposes should be documented.

Regards,
Branden

[1] https://man7.org/linux/man-pages/man7/groff_man.7.html

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