All of lore.kernel.org
 help / color / mirror / Atom feed
From: Phil Sutter <phil@nwl.cc>
To: Alexander Alemayhu <alexander@alemayhu.com>
Cc: netdev@vger.kernel.org, stephen@networkplumber.org
Subject: Re: [PATCH iproute2] man: fix man page warnings
Date: Wed, 5 Apr 2017 16:56:23 +0200	[thread overview]
Message-ID: <20170405145623.GN19768@orbyte.nwl.cc> (raw)
In-Reply-To: <20170326191114.3756-1-alexander@alemayhu.com>

On Sun, Mar 26, 2017 at 09:11:14PM +0200, Alexander Alemayhu wrote:
> While generating PDFs from the man pages, I saw the warning below from
> several files. Compared the tc-matchall.8 with bridge.8 and used .RI
> instead of .R. It should have no effect on the man page rendering.
> 
>     `R' is a string (producing the registered sign), not a macro.
> 
> Signed-off-by: Alexander Alemayhu <alexander@alemayhu.com>

I know this has been applied already, but let me get this straight:

People using '.R' try to force "normal" font, like for every second
parameter to '.IR' but in fact they could just leave the macro away
since lines starting without any macro will get normal font settings
anyway.

With this in mind, I see better solutions for the changes in this patch:

[...]
> @@ -20,7 +20,7 @@ flower \- flow based traffic control filter
>  .B indev
>  .IR ifname " | "
>  .BR skip_sw " | " skip_hw
> -.R " | { "
> +.RI " | { "

Just merge this into previous line:

|  .BR skip_sw " | " skip_hw " | {"

Note the missing space at the end, as that comes for free anyway. :)

[...]
> @@ -13,7 +13,7 @@ IFE - encapsulate/decapsulate metadata
>  .IR SMAC " ] "
>  .RB "[ " type
>  .IR TYPE " ] "
> -.R "[ "
> +.RI "[ "

Same here:

| .IR TYPE " ] ["

[...]
> @@ -7,7 +7,7 @@ matchall \- traffic control filter that matches every packet
>  .ti -8
>  .BR tc " " filter " ... " matchall " [ "
>  .BR skip_sw " | " skip_hw
> -.R " ] [ "
> +.RI " ] [ "

And here as well:

|  .BR skip_sw " | " skip_hw " ] ["

Cheers, Phil

  parent reply	other threads:[~2017-04-05 14:56 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-03-26 19:11 [PATCH iproute2] man: fix man page warnings Alexander Alemayhu
2017-04-04 21:47 ` Stephen Hemminger
2017-04-05 14:56 ` Phil Sutter [this message]
2017-04-06  0:54   ` Alexander Alemayhu

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170405145623.GN19768@orbyte.nwl.cc \
    --to=phil@nwl.cc \
    --cc=alexander@alemayhu.com \
    --cc=netdev@vger.kernel.org \
    --cc=stephen@networkplumber.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.