diff mbox

[1/4] ip: document exit code

Message ID 1430931483-28595-2-git-send-email-stephen@networkplumber.org
State Accepted, archived
Delegated to: stephen hemminger
Headers show

Commit Message

Stephen Hemminger May 6, 2015, 4:58 p.m. UTC
From: Stephen Hemminger <shemming@brocade.com>

The ip command has always had a consistent exit status
document it so that developers see it.
---
 man/man8/ip.8 | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Vadym Kochan May 6, 2015, 5:16 p.m. UTC | #1
Hi,

On Wed, May 06, 2015 at 09:58:00AM -0700, Stephen Hemminger wrote:
> From: Stephen Hemminger <shemming@brocade.com>
> 
> The ip command has always had a consistent exit status
> document it so that developers see it.
> ---
>  man/man8/ip.8 | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/man/man8/ip.8 b/man/man8/ip.8
> index 43ddac9..9574a50 100644
> --- a/man/man8/ip.8
> +++ b/man/man8/ip.8
> @@ -275,6 +275,10 @@ Usually it is
>  or, if the objects of this class cannot be listed,
>  .BR "help" .
>  
> +.SH EXIT STATUS
> +Exit statsis is 0 if command was sucessful, and 1 if there is a syntax error.
statsis -> status ?                 sucessful -> successful ?

> +If an error was reported by the kernel exit status is 2.
> +
>  .SH HISTORY
>  .B ip
>  was written by Alexey N. Kuznetsov and added in Linux 2.2.
> -- 
> 2.1.4
> 
> --
> To unsubscribe from this list: send the line "unsubscribe netdev" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/man/man8/ip.8 b/man/man8/ip.8
index 43ddac9..9574a50 100644
--- a/man/man8/ip.8
+++ b/man/man8/ip.8
@@ -275,6 +275,10 @@  Usually it is
 or, if the objects of this class cannot be listed,
 .BR "help" .
 
+.SH EXIT STATUS
+Exit statsis is 0 if command was sucessful, and 1 if there is a syntax error.
+If an error was reported by the kernel exit status is 2.
+
 .SH HISTORY
 .B ip
 was written by Alexey N. Kuznetsov and added in Linux 2.2.