Skip to content

Commit 3cb6c6c

Browse files
committed
libcapsicum: document return values
Reviewed by: emaste Requested by: des Differential Revision: https://reviews.freebsd.org/D45222
1 parent 87a1565 commit 3cb6c6c

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

lib/libcapsicum/capsicum_helpers.3

+26-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2323
.\" SUCH DAMAGE.
2424
.\"
25-
.Dd January 2, 2020
25+
.Dd May 16, 2024
2626
.Dt CAPSICUM_HELPERS 3
2727
.Os
2828
.Sh NAME
@@ -150,6 +150,31 @@ NLS data is used for localized error printing by
150150
and
151151
.Xr err 3 ,
152152
among others.
153+
.Sh RETURN VALUES
154+
Upon successful completion,
155+
.Fn caph_enter ,
156+
.Fn caph_enter_casper ,
157+
.Fn caph_rights_limit ,
158+
.Fn caph_ioctls_limit ,
159+
.Fn caph_fcntls_limit ,
160+
.Fn caph_limit_stream ,
161+
.Fn caph_limit_stdin ,
162+
.Fn caph_limit_stderr ,
163+
.Fn caph_limit_stdout ,
164+
and
165+
.Fn caph_limit_stdio
166+
return a value
167+
of 0.
168+
Otherwise, a value of -1 is returned and the global variable
169+
.Va errno
170+
is set to indicate the error.
171+
.Pp
172+
Functions
173+
.Fn caph_stream_rights ,
174+
.Fn caph_cache_tzdata ,
175+
and
176+
.Fn caph_cache_catpages
177+
can not fail.
153178
.Ed
154179
.Sh SEE ALSO
155180
.Xr cap_enter 2 ,

0 commit comments

Comments
 (0)