All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH iproute2] man: fix man page warnings
@ 2017-03-26 19:11 Alexander Alemayhu
  2017-04-04 21:47 ` Stephen Hemminger
  2017-04-05 14:56 ` Phil Sutter
  0 siblings, 2 replies; 4+ messages in thread
From: Alexander Alemayhu @ 2017-03-26 19:11 UTC (permalink / raw)
  To: netdev; +Cc: stephen, Alexander Alemayhu

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>
---
 man/man8/tc-flower.8   | 2 +-
 man/man8/tc-ife.8      | 2 +-
 man/man8/tc-matchall.8 | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/man/man8/tc-flower.8 b/man/man8/tc-flower.8
index fc5bac503324..ba290657c224 100644
--- a/man/man8/tc-flower.8
+++ b/man/man8/tc-flower.8
@@ -20,7 +20,7 @@ flower \- flow based traffic control filter
 .B indev
 .IR ifname " | "
 .BR skip_sw " | " skip_hw
-.R " | { "
+.RI " | { "
 .BR dst_mac " | " src_mac " } "
 .IR MASKED_LLADDR " | "
 .B vlan_id
diff --git a/man/man8/tc-ife.8 b/man/man8/tc-ife.8
index dae8b9be9bcb..a8f1f287d150 100644
--- a/man/man8/tc-ife.8
+++ b/man/man8/tc-ife.8
@@ -13,7 +13,7 @@ IFE - encapsulate/decapsulate metadata
 .IR SMAC " ] "
 .RB "[ " type
 .IR TYPE " ] "
-.R "[ "
+.RI "[ "
 .IR CONTROL " ] "
 .RB "[ " index
 .IR INDEX " ] "
diff --git a/man/man8/tc-matchall.8 b/man/man8/tc-matchall.8
index 53b2194e023a..e3cddb1f1ca5 100644
--- a/man/man8/tc-matchall.8
+++ b/man/man8/tc-matchall.8
@@ -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 " ] [ "
 .B action
 .IR ACTION_SPEC " ] [ "
 .B classid
-- 
2.9.3

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH iproute2] man: fix man page warnings
  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
  1 sibling, 0 replies; 4+ messages in thread
From: Stephen Hemminger @ 2017-04-04 21:47 UTC (permalink / raw)
  To: Alexander Alemayhu; +Cc: netdev

On Sun, 26 Mar 2017 21:11:14 +0200
Alexander Alemayhu <alexander@alemayhu.com> 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>

Applied

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH iproute2] man: fix man page warnings
  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
  2017-04-06  0:54   ` Alexander Alemayhu
  1 sibling, 1 reply; 4+ messages in thread
From: Phil Sutter @ 2017-04-05 14:56 UTC (permalink / raw)
  To: Alexander Alemayhu; +Cc: netdev, stephen

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH iproute2] man: fix man page warnings
  2017-04-05 14:56 ` Phil Sutter
@ 2017-04-06  0:54   ` Alexander Alemayhu
  0 siblings, 0 replies; 4+ messages in thread
From: Alexander Alemayhu @ 2017-04-06  0:54 UTC (permalink / raw)
  To: Phil Sutter; +Cc: netdev, stephen

On Wed, Apr 05, 2017 at 04:56:23PM +0200, Phil Sutter wrote:
> 
> 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.
>
I will keep your comment in mind for next time.

Thanks.

-- 
Mit freundlichen Grüßen

Alexander Alemayhu

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2017-04-06  0:54 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
2017-04-06  0:54   ` Alexander Alemayhu

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.