Re: [PATCH] mctp.7: Add man page for Linux MCTP support

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

 



Hello Jeremy,

On 10/17/21 8:49 PM, Alejandro Colomar (man-pages) wrote:
+TO bit cleared) to indicate that is is directed to the same remote endpoint.
+.SH SEE ALSO
+.BR socket (7)
+.PP
+The kernel source file
+.IR Documentation/networking/mctp.rst .
+.PP
+The DSP0236 specification, at
+.UR https://www.dmtf.org/standards/pmci
+.UE .


Please, use break points for both URIs above.  See the source code of uri.7, which has plenty of examples.

See also "the Chicago Manual of Style" <https://libguides.lorainccc.edu/c.php?g=29361&p=183502> for guidelines on that.

Please, don't read those. As Branden and I discussed in another thread today, we prefer not following that style.

So instead of those sources, I'll just write it for you.

.IR Documentation/\:networking/\:mctp.rst .

.UR https://\:www.dmtf.org/\:standards/\:pmci


We could also break before dots, but since the names are short, I don't think it's needed. It could be:

.IR Documentation/\:networking/\:mctp\:.rst .

.UR https://\:www\:.dmtf\:.org/\:standards/\:pmci

If you are curious about the discussion we had about this, it's here:
<https://lists.gnu.org/archive/html/groff/2021-10/msg00045.html>.


Thanks,

Alex


--
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/



[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