From nobody Thu May 16 18:28:08 2024 X-Original-To: dev-commits-src-main@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4VgJVw4ZZVz5LfXP; Thu, 16 May 2024 18:28:08 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4VgJVw47m9z4Yvg; Thu, 16 May 2024 18:28:08 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1715884088; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=XSLqunL8XnXwfCAkUOX8dMPVAHjbEThtiRvc6JBSj3I=; b=szxXUeic0+/YP/DHDp7607sA4HN619UD+zOfn6VzJNxJIFFf6xpBusIapzR2YVE5O4ELQZ ZWNibw7qSvUSWy1hSNCQlZu/kIgIY/d+i6fmavGe906cotZexITkkYPH8T7AYWoWMK3poI 2Hhqn4+wQD5Jy9VM2/Y3DRlVlIvFT2T1IFpDXmfYXnQvBEq2cAbu4kuIKk9YJgKu5Tzu3E TCKa/VveiLtJ61pnyXURTa+t2q8s7cLIsDfXT84VCppVNX8/cM2OOu07H3ok+cULtRhVcV ulttMap4GDsksAef/+io+wQWYObkJkLnJdrn1HMGUejW88uBnu5UBYvuadyyNQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1715884088; a=rsa-sha256; cv=none; b=UehItdijwin/+6RDdwjjMdKJbiXvcwhdP9ube+Lrefd3nmdQFJKofWmxtpS5xCSO6yPcHQ r8WraucWoOKauZTfu1iCpHFBGUZASMH1gvlf87SqPB678y6HuJjhiUMmB+UXfWJLYRuAwe GJVQL4PGJ0C0GYLR/wzrgtJ7roAErxkBGkMOBbGCm5f23yyDNNDvHbDzvR7VZgOvv1xWBH 4DnmHYg9W8rjWZjLZ7rU8WvZ7r10xVqg2ko8zfaDEDK1j6uOD1pad8eGpcwps1BLF9srPq 2Vvqn0f9OAfxjsjGZm+XwmhyLqAPZyTIdHdWaQ8ICHTvK+f2oMAlfwLNXU23Iw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1715884088; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=XSLqunL8XnXwfCAkUOX8dMPVAHjbEThtiRvc6JBSj3I=; b=IY2TeNwl431jdRD1DadWCRlmaay6eT3jGYlW9tJ2oLeb37w7msGlczT7IeJm2Sd74+0EuF KJbgU8CUfO0HxyZ5IlXcQfpz2rQG0a2g43a3ORVnEiFp+MyznipfyTb7tPX+RacFz32nii qk7kyUV8E031EzXgVmwJ+sscx+VwY+UweBcHqyHaorN7fC48If9doUMTAt/YMb+FBVLmls P8KmCMH65ER7VNAoUq3YpDNODIHPKK59PaGqVOGOUziqMqd8jYc2tUTL/by7WAvIsM5PWM Rzp7O/h8+01P7VvJPz+Ncc3VS76O4D9GErQnjey0HlT1365QNGWRbfCAD7p3JA== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4VgJVw3lvgz18bR; Thu, 16 May 2024 18:28:08 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 44GIS8rB055466; Thu, 16 May 2024 18:28:08 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 44GIS8jW055463; Thu, 16 May 2024 18:28:08 GMT (envelope-from git) Date: Thu, 16 May 2024 18:28:08 GMT Message-Id: <202405161828.44GIS8jW055463@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mariusz Zaborski Subject: git: 3cb6c6c9eeb3 - main - libcapsicum: document return values List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-main@freebsd.org Sender: owner-dev-commits-src-main@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: oshogbo X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 3cb6c6c9eeb36e0a29986fd518f5ccc567e9eb85 Auto-Submitted: auto-generated The branch main has been updated by oshogbo: URL: https://cgit.FreeBSD.org/src/commit/?id=3cb6c6c9eeb36e0a29986fd518f5ccc567e9eb85 commit 3cb6c6c9eeb36e0a29986fd518f5ccc567e9eb85 Author: Mariusz Zaborski AuthorDate: 2024-05-16 18:27:25 +0000 Commit: Mariusz Zaborski CommitDate: 2024-05-16 18:29:18 +0000 libcapsicum: document return values Reviewed by: emaste Requested by: des Differential Revision: https://reviews.freebsd.org/D45222 --- lib/libcapsicum/capsicum_helpers.3 | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/lib/libcapsicum/capsicum_helpers.3 b/lib/libcapsicum/capsicum_helpers.3 index 9c4c0bfa0229..38dd329ef2f3 100644 --- a/lib/libcapsicum/capsicum_helpers.3 +++ b/lib/libcapsicum/capsicum_helpers.3 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd January 2, 2020 +.Dd May 16, 2024 .Dt CAPSICUM_HELPERS 3 .Os .Sh NAME @@ -150,6 +150,31 @@ NLS data is used for localized error printing by and .Xr err 3 , among others. +.Sh RETURN VALUES +Upon successful completion, +.Fn caph_enter , +.Fn caph_enter_casper , +.Fn caph_rights_limit , +.Fn caph_ioctls_limit , +.Fn caph_fcntls_limit , +.Fn caph_limit_stream , +.Fn caph_limit_stdin , +.Fn caph_limit_stderr , +.Fn caph_limit_stdout , +and +.Fn caph_limit_stdio +return a value +of 0. +Otherwise, a value of -1 is returned and the global variable +.Va errno +is set to indicate the error. +.Pp +Functions +.Fn caph_stream_rights , +.Fn caph_cache_tzdata , +and +.Fn caph_cache_catpages +can not fail. .Ed .Sh SEE ALSO .Xr cap_enter 2 ,