From nobody Thu Feb 1 21:31:08 2024 X-Original-To: dev-commits-src-all@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 4TQsXY3VfWz58jCq; Thu, 1 Feb 2024 21:31:09 +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 4TQsXY1JQlz4bs3; Thu, 1 Feb 2024 21:31:09 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1706823069; 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=cs0+MgxEKzp6E1tRx5rJJuJM5QY3qKXmU6ulJdGo2Oc=; b=fhPBemJCKWavFpsEdKmzE8qLFZwda+3YRR7LN37Bn+wXf1Q/1ofS9xqqD8Z6+zYfdq5nSM Dx/quyPQja4ytQ+o/K2whpPVrP/EXgyiMSuJQHIgVtW16FT37hlkyhm1ZP2jVF/qvs8FOx 8iYOoTkVnzIGCCEiCA2FmUr5kxuzfta+urjln40yKErSbCIzqzkBWFD5plgL/5ksTEwOII uZJ1I6A06Ztb/DlkeFsf+JxAzRBu6X/sGqFiwH2CTQPPmd3JZvv1Dks19m3KiGbyr6pAJx 52z1UBeSFa2GRHyAgO4uOuCOLxpvFllT8fGlXCdPji7HHlWvegMrshoX/EiS0A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1706823069; 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=cs0+MgxEKzp6E1tRx5rJJuJM5QY3qKXmU6ulJdGo2Oc=; b=Ufg+H4A8opXfZObBk/gmfq8vRdrsXyNRPA9ojnB4vQTSAgAnxIwFOzFtx8IDhaLy3UTxCD +62XnRgP5Qfd7nlKn1n/8LJC5dIwBwWwVzN1BJsTNaRkNCTrND/5fmdZ6dXE/SNK0h2F4U HqsaksX/u5BZuh2sg/Q6IHJqDQ7LLklY6cTCH9yEF3j992MpFqaq9EaRRXbn3SLLjVc76W hzLM9K58B/TQAs/WYLoVg3L1SApPteF9j9kYiRTRDC0G3H7Dx1FgkXVpQUMSBcP5sY5bwy lfQjKxYj7UdHbbo35hpELVvHMCOiE3pQQxOfuGN9gWeTHLL9vNlFhayE7eQxCg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1706823069; a=rsa-sha256; cv=none; b=KWajHvoapJQVhd57LALE9DeJUJgegVDfC0+X1S9yJhtMKOX5yXvJPowtCANft6tkUQLU2Y J3gYTe+/s7cBfgOvYpVcR7mk1sU6VfpS2IxVh/7xBzRpY9mN8+SAYXP7pOkT76On/TD7D4 TWYlAf/P0gHX4yv+Dw3UEuwdYiZewL6PxT7KxG/NSLw2xcimPbiGiLxd/X1+BKYWStSBBt jSE8rqlSfJ4wn00J7VDNb7qKiJfQWJ6iXZMSefID6JMCBZrAlbZVXsp2LOxLBpSGkl9oFd vT/qg5bUsMZr2zbwQHQLUy3OApdEQk8C4JikbXbUyYql1AUXw9sJHYCjVKABIQ== 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 4TQsXY0PfJz1Gw0; Thu, 1 Feb 2024 21:31:09 +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 411LV8Cd080464; Thu, 1 Feb 2024 21:31:08 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 411LV87e080461; Thu, 1 Feb 2024 21:31:08 GMT (envelope-from git) Date: Thu, 1 Feb 2024 21:31:08 GMT Message-Id: <202402012131.411LV87e080461@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Olivier Certner Subject: git: 44c898329da1 - stable/14 - login_cap(3): Document login_getcapenum() List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: olce X-Git-Repository: src X-Git-Refname: refs/heads/stable/14 X-Git-Reftype: branch X-Git-Commit: 44c898329da12257b298cd48736cd2113ed5a6d8 Auto-Submitted: auto-generated The branch stable/14 has been updated by olce: URL: https://cgit.FreeBSD.org/src/commit/?id=44c898329da12257b298cd48736cd2113ed5a6d8 commit 44c898329da12257b298cd48736cd2113ed5a6d8 Author: Olivier Certner AuthorDate: 2023-06-20 20:09:57 +0000 Commit: Olivier Certner CommitDate: 2024-02-01 21:28:46 +0000 login_cap(3): Document login_getcapenum() Reviewed by: emaste Approved by: emaste (mentor) MFC after: 3 days Sponsored by: Kumacom SAS Differential Revision: https://reviews.freebsd.org/D40685 (cherry picked from commit 97256feb7a65cccac51a03846c5308894a2cb445) Approved by: markj (mentor) --- lib/libutil/login_cap.3 | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/lib/libutil/login_cap.3 b/lib/libutil/login_cap.3 index 0281c8428ed5..86142c3b19f9 100644 --- a/lib/libutil/login_cap.3 +++ b/lib/libutil/login_cap.3 @@ -25,6 +25,7 @@ .Nm login_getcapbool , .Nm login_getcaplist , .Nm login_getcapnum , +.Nm login_getcapenum , .Nm login_getcapstr , .Nm login_getcapsize , .Nm login_getcaptime , @@ -60,6 +61,8 @@ .Fn login_getcaptime "login_cap_t *lc" "const char *cap" "rlim_t def" "rlim_t error" .Ft rlim_t .Fn login_getcapnum "login_cap_t *lc" "const char *cap" "rlim_t def" "rlim_t error" +.Ft int +.Fn login_getcapenum "login_cap_t *lc" "const char *cap" "const char * const *values" .Ft rlim_t .Fn login_getcapsize "login_cap_t *lc" "const char *cap" "rlim_t def" "rlim_t error" .Ft int @@ -459,6 +462,31 @@ If the given capability tag cannot be found, the parameter is returned, and if an error occurs, the .Fa error parameter is returned. +.It Fn login_getcapenum +This function returns whether the searched capability is a string with value +among a predefined set passed in argument +.Fa values +as a NULL-terminated array of strings. +.Pp +A non-negative value indicates a match and is the index of the capability's +value in array +.Fa values . +Other possible return values are: +.Bl -tag -width "-4" +.It -4 +Returned if +.Fa lc +or +.Fa cap +are insufficiently initialized or invalid. +.It -3 +Returned on allocation failure (out of memory). +.It -2 +Returned if the capability isn't specified or its value is not a string. +.It -1 +Returned if the capability is specified and a string but its value is not among +.Fa values . +.El .It Fn login_getcapsize .Fn login_getcapsize returns a value representing a size (typically, file or memory)