Re: [PATCH v2 redux] man-pages.7: Update nonbreaking space advice

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

 



Hi, Branden!

On 11/12/21 22:50, G. Branden Robinson wrote:
* Advise usage of \~ escape instead of \SPACE; the former, a groff
   extension from circa 1990, has been supported by Heirloom Doctools
   troff since 2005 and by mandoc since 2019.  The advantage is that
   \~ is an _adjustable_ non-breaking space, so it will typeset
   non-jarringly both in .EX/.EE examples when filling is off, and in
   normal running text (which is filled).

See linux-man@ list discussion at
<https://lore.kernel.org/linux-man/\
20210729115508.pt6btsqd7g5tuhg6@localhost.localdomain/> and follow-ups.

Patch applied!
It was perfect this time (I added a signed-off-by line on your behalf; you can add it automatically with `git commit -sm "foo"`, BTW).
See below what I received.

Cheers,
Alex

---

$ git am -s patches/recv/*
Applying: man-pages.7: Update nonbreaking space advice
$ git commit --amend   # To add your Signed-off-by line
$ git show
commit 6351ebc3829d2411b8d6339bb3129f363fd713b7 (HEAD -> main)
Author: G. Branden Robinson <g.branden.robinson@xxxxxxxxx>
Date:   Sat Nov 13 08:50:14 2021 +1100

    man-pages.7: Update nonbreaking space advice

    * Advise usage of \~ escape instead of \SPACE; the former, a groff
      extension from circa 1990, has been supported by Heirloom Doctools
      troff since 2005 and by mandoc since 2019.  The advantage is that
      \~ is an _adjustable_ non-breaking space, so it will typeset
      non-jarringly both in .EX/.EE examples when filling is off, and in
      normal running text (which is filled).

    See linux-man@ list discussion at
    <https://lore.kernel.org/linux-man/\
    20210729115508.pt6btsqd7g5tuhg6@localhost.localdomain/> and follow-ups.

    Signed-off-by: G. Branden Robinson <g.branden.robinson@xxxxxxxxx>
    Signed-off-by: Alejandro Colomar <alx.manpages@xxxxxxxxx>

diff --git a/man7/man-pages.7 b/man7/man-pages.7
index 96c3deb20..23015b00a 100644
--- a/man7/man-pages.7
+++ b/man7/man-pages.7
@@ -689,7 +689,7 @@ If the command is short, then it can be included inline in the text,
 in italic format, for example,
 .IR "man 7 man-pages" .
 In this case, it may be worth using nonbreaking spaces
-("\e\ ") at suitable places in the command.
+(\e\(ti) at suitable places in the command.
 Command options should be written in italics (e.g.,
 .IR \-l ).
 .PP


--
Alejandro Colomar
Linux man-pages comaintainer; http://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