add a section exit status in syspatch.8

2020-07-21 Thread Solene Rapenne
this diff adds an EXIT STATUS section to syspatch man page.

syspatch exit with 1 on errors and 2 if syspatch updates itself.

If syspatch does nothing (because no syspatch) or install syspatches
successfully, the exit status is 0 in both case. Should we emphase
on this? I guess « Did syspatch install something? » is a common
question and the exit status can't help.


Index: syspatch.8
===
RCS file: /cvs/src/usr.sbin/syspatch/syspatch.8,v
retrieving revision 1.20
diff -u -p -r1.20 syspatch.8
--- syspatch.8  15 Jun 2019 16:54:19 -  1.20
+++ syspatch.8  19 Jul 2020 22:07:40 -
@@ -62,6 +62,8 @@ Directories containing the rollback tarb
 .Xr diff 1
 of installed patches.
 .El
+.Sh EXIT STATUS
+.Ex -std syspatch
 .Sh SEE ALSO
 .Xr signify 1 ,
 .Xr installurl 5 ,



Re: add a section exit status in syspatch.8

2020-07-21 Thread Antoine Jacoutot
On Tue, Jul 21, 2020 at 03:21:24PM +0200, Solene Rapenne wrote:
> this diff adds an EXIT STATUS section to syspatch man page.
> 
> syspatch exit with 1 on errors and 2 if syspatch updates itself.
> 
> If syspatch does nothing (because no syspatch) or install syspatches
> successfully, the exit status is 0 in both case. Should we emphase
> on this? I guess « Did syspatch install something? » is a common
> question and the exit status can't help.

No objection.

> 
> Index: syspatch.8
> ===
> RCS file: /cvs/src/usr.sbin/syspatch/syspatch.8,v
> retrieving revision 1.20
> diff -u -p -r1.20 syspatch.8
> --- syspatch.815 Jun 2019 16:54:19 -  1.20
> +++ syspatch.819 Jul 2020 22:07:40 -
> @@ -62,6 +62,8 @@ Directories containing the rollback tarb
>  .Xr diff 1
>  of installed patches.
>  .El
> +.Sh EXIT STATUS
> +.Ex -std syspatch
>  .Sh SEE ALSO
>  .Xr signify 1 ,
>  .Xr installurl 5 ,
> 
> 

-- 
Antoine