svn commit: r330362 - head/share/man/man9

[Konstantin Belousov]

On Sat, Mar 03, 2018 at 11:08:49PM +0000, Hans Petter Selasky wrote:
> Author: hselasky
> Date: Sat Mar  3 23:08:49 2018
> New Revision: 330362
> URL: https://svnweb.freebsd.org/changeset/base/330362
> 
> Log:
>   Document pause_sig(9) and update prototypes for existing pause(9) and
>   pause_sbt(9) functions.
>   
>   MFC after:	1 week
>   Suggested by:	cem@
>   Sponsored by:	Mellanox Technologies
> 
> Modified:
>   head/share/man/man9/Makefile
>   head/share/man/man9/sleep.9
> 
> Modified: head/share/man/man9/Makefile
> ==============================================================================
> --- head/share/man/man9/Makefile	Sat Mar  3 22:28:20 2018	(r330361)
> +++ head/share/man/man9/Makefile	Sat Mar  3 23:08:49 2018	(r330362)
> @@ -1830,6 +1830,7 @@ MLINKS+=sleep.9 msleep.9 \
>  	sleep.9 msleep_spin.9 \
>  	sleep.9 msleep_spin_sbt.9 \
>  	sleep.9 pause.9 \
> +	sleep.9 pause_sig.9 \
>  	sleep.9 pause_sbt.9 \
>  	sleep.9 tsleep.9 \
>  	sleep.9 tsleep_sbt.9 \
> 
> Modified: head/share/man/man9/sleep.9
> ==============================================================================
> --- head/share/man/man9/sleep.9	Sat Mar  3 22:28:20 2018	(r330361)
> +++ head/share/man/man9/sleep.9	Sat Mar  3 23:08:49 2018	(r330362)
> @@ -25,7 +25,7 @@
>  .\"
>  .\" $FreeBSD$
>  .\"
> -.Dd May 24, 2015
> +.Dd March 4, 2018
>  .Dt SLEEP 9
>  .Os
>  .Sh NAME
> @@ -34,6 +34,7 @@
>  .Nm msleep_spin ,
>  .Nm msleep_spin_sbt ,
>  .Nm pause ,
> +.Nm pause_sig ,
>  .Nm pause_sbt ,
pause_sbt is before pause_sig alphabetically.
This note is applicable for all insertions of the pause_sig name in the
man page.

>  .Nm tsleep ,
>  .Nm tsleep_sbt ,
> @@ -53,9 +54,11 @@
>  .Ft int
>  .Fn msleep_spin_sbt "void *chan" "struct mtx *mtx" "const char *wmesg" \
>  "sbintime_t sbt" "sbintime_t pr" "int flags"
> -.Ft void
> +.Ft int
>  .Fn pause "const char *wmesg" "int timo"
> -.Ft void
> +.Ft int
> +.Fn pause_sig "const char *wmesg" "int timo"
> +.Ft int
>  .Fn pause_sbt "const char *wmesg" "sbintime_t sbt" "sbintime_t pr" \
>   "int flags"
>  .Ft int
> @@ -73,6 +76,8 @@ The functions
>  .Fn msleep ,
>  .Fn msleep_spin ,
>  .Fn pause ,
> +.Fn pause_sig ,
> +.Fn pause_sbt ,
>  .Fn wakeup ,
>  and
>  .Fn wakeup_one
> @@ -82,8 +87,10 @@ external event, it is put to sleep by
>  .Fn tsleep ,
>  .Fn msleep ,
>  .Fn msleep_spin ,
> +.Fn pause ,
> +.Fn pause_sig ,
>  or
> -.Fn pause .
> +.Fn pause_sbt .
>  Threads may also wait using one of the locking primitive sleep routines
>  .Xr mtx_sleep 9 ,
>  .Xr rw_sleep 9 ,
> @@ -248,6 +255,11 @@ The thread can not be awakened early by signals or cal
>  .Fn wakeup
>  or
>  .Fn wakeup_one .
> +The
> +.Fn pause_sig
> +function is a variant of
> +.Fn pause
> +which can be awakened early by signals.
It would be useful to mention that pause_sbt(9) provides the same feature
by using a flag.

>  .Pp
>  The
>  .Fn wakeup_one
> @@ -385,6 +397,10 @@ The
>  .Fn pause
>  function appeared in
>  .Fx 7.0 .
> +The
> +.Fn pause_sig
> +function appeared in
> +.Fx 12.0 .
>  .Sh AUTHORS
>  .An -nosplit
>  This manual page was written by