netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH iproute2] ip-rule.8: Bring synopsis in line with description
@ 2023-01-25  8:20 Sven Neuhaus
  2023-01-25 14:48 ` Simon Horman
  2023-01-25 15:53 ` [PATCH iproute2 v2 1/1] " Sven Neuhaus
  0 siblings, 2 replies; 4+ messages in thread
From: Sven Neuhaus @ 2023-01-25  8:20 UTC (permalink / raw)
  To: netdev; +Cc: sven-netdev

Rename the option "priority" (with the aliases "preference" or "order") 
in the SYNOPSIS to be the same as under "DESCRIPTION".

diff --git a/man/man8/ip-rule.8 b/man/man8/ip-rule.8
index 2c12bf64..43820cf7 100644
--- a/man/man8/ip-rule.8
+++ b/man/man8/ip-rule.8
@@ -42,8 +42,8 @@ ip-rule \- routing policy database management
  .IR STRING " ] [ "
  .B  oif
  .IR STRING " ] [ "
-.B  pref
-.IR NUMBER " ] [ "
+.B  priority
+.IR PREFERENCE " ] [ "
  .IR l3mdev " ] [ "
  .B uidrange
  .IR NUMBER "-" NUMBER " ] [ "

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

* Re: [PATCH iproute2] ip-rule.8: Bring synopsis in line with description
  2023-01-25  8:20 [PATCH iproute2] ip-rule.8: Bring synopsis in line with description Sven Neuhaus
@ 2023-01-25 14:48 ` Simon Horman
  2023-01-25 15:53 ` [PATCH iproute2 v2 1/1] " Sven Neuhaus
  1 sibling, 0 replies; 4+ messages in thread
From: Simon Horman @ 2023-01-25 14:48 UTC (permalink / raw)
  To: Sven Neuhaus; +Cc: netdev

On Wed, Jan 25, 2023 at 09:20:22AM +0100, Sven Neuhaus wrote:
> Rename the option "priority" (with the aliases "preference" or "order") in
> the SYNOPSIS to be the same as under "DESCRIPTION".

Seems reasonable to me.
But if so, should 'list' also be updated to 'show'
a but further up in the SYNOPSIS?

> diff --git a/man/man8/ip-rule.8 b/man/man8/ip-rule.8
> index 2c12bf64..43820cf7 100644
> --- a/man/man8/ip-rule.8
> +++ b/man/man8/ip-rule.8
> @@ -42,8 +42,8 @@ ip-rule \- routing policy database management
>  .IR STRING " ] [ "
>  .B  oif
>  .IR STRING " ] [ "
> -.B  pref
> -.IR NUMBER " ] [ "
> +.B  priority
> +.IR PREFERENCE " ] [ "
>  .IR l3mdev " ] [ "
>  .B uidrange
>  .IR NUMBER "-" NUMBER " ] [ "
> 

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

* [PATCH iproute2 v2 1/1] ip-rule.8: Bring synopsis in line with description
  2023-01-25  8:20 [PATCH iproute2] ip-rule.8: Bring synopsis in line with description Sven Neuhaus
  2023-01-25 14:48 ` Simon Horman
@ 2023-01-25 15:53 ` Sven Neuhaus
  2023-01-25 16:17   ` Simon Horman
  1 sibling, 1 reply; 4+ messages in thread
From: Sven Neuhaus @ 2023-01-25 15:53 UTC (permalink / raw)
  To: netdev; +Cc: sven-netdev

From: Sven Neuhaus <sven-netdev@sven.de>

Bring ip-rule.8 synopsis in line with description

The parameters "show" and "priority" were listed in the synopsis using
other aliases than in the description.

Signed-off-by: Sven Neuhaus <sven-netdev@sven.de>
---
V1 -> V2: Include Simon Horman's suggestion, adding "show".
  man/man8/ip-rule.8 | 6 +++---
  1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/man/man8/ip-rule.8 b/man/man8/ip-rule.8
index 2c12bf64..743d88c6 100644
--- a/man/man8/ip-rule.8
+++ b/man/man8/ip-rule.8
@@ -15,7 +15,7 @@ ip-rule \- routing policy database management

  .ti -8
  .B  ip rule
-.RB "[ " list
+.RB "[ " show
  .RI "[ " SELECTOR " ]]"

  .ti -8
@@ -42,8 +42,8 @@ ip-rule \- routing policy database management
  .IR STRING " ] [ "
  .B  oif
  .IR STRING " ] [ "
-.B  pref
-.IR NUMBER " ] [ "
+.B  priority
+.IR PREFERENCE " ] [ "
  .IR l3mdev " ] [ "
  .B uidrange
  .IR NUMBER "-" NUMBER " ] [ "
-- 
2.30.1

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

* Re: [PATCH iproute2 v2 1/1] ip-rule.8: Bring synopsis in line with description
  2023-01-25 15:53 ` [PATCH iproute2 v2 1/1] " Sven Neuhaus
@ 2023-01-25 16:17   ` Simon Horman
  0 siblings, 0 replies; 4+ messages in thread
From: Simon Horman @ 2023-01-25 16:17 UTC (permalink / raw)
  To: Sven Neuhaus; +Cc: netdev

On Wed, Jan 25, 2023 at 04:53:08PM +0100, Sven Neuhaus wrote:
> From: Sven Neuhaus <sven-netdev@sven.de>
> 
> Bring ip-rule.8 synopsis in line with description
> 
> The parameters "show" and "priority" were listed in the synopsis using
> other aliases than in the description.
> 
> Signed-off-by: Sven Neuhaus <sven-netdev@sven.de>

FWIIW,

Reviewed-by: Simon Horman <simon.horman@corigine.com>

> ---
> V1 -> V2: Include Simon Horman's suggestion, adding "show".
>  man/man8/ip-rule.8 | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/man/man8/ip-rule.8 b/man/man8/ip-rule.8
> index 2c12bf64..743d88c6 100644
> --- a/man/man8/ip-rule.8
> +++ b/man/man8/ip-rule.8
> @@ -15,7 +15,7 @@ ip-rule \- routing policy database management
> 
>  .ti -8
>  .B  ip rule
> -.RB "[ " list
> +.RB "[ " show
>  .RI "[ " SELECTOR " ]]"
> 
>  .ti -8
> @@ -42,8 +42,8 @@ ip-rule \- routing policy database management
>  .IR STRING " ] [ "
>  .B  oif
>  .IR STRING " ] [ "
> -.B  pref
> -.IR NUMBER " ] [ "
> +.B  priority
> +.IR PREFERENCE " ] [ "
>  .IR l3mdev " ] [ "
>  .B uidrange
>  .IR NUMBER "-" NUMBER " ] [ "
> -- 
> 2.30.1
> 

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

end of thread, other threads:[~2023-01-25 16:17 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-01-25  8:20 [PATCH iproute2] ip-rule.8: Bring synopsis in line with description Sven Neuhaus
2023-01-25 14:48 ` Simon Horman
2023-01-25 15:53 ` [PATCH iproute2 v2 1/1] " Sven Neuhaus
2023-01-25 16:17   ` Simon Horman

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).