From nobody Mon Jan 29 22:32:07 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 4TP32H6ptlz57ZDC; Mon, 29 Jan 2024 22:32:07 +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 4TP32H59L1z4fkQ; Mon, 29 Jan 2024 22:32:07 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1706567527; 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=ZpgpHczOPtuqAFvrqI2DiEy3Dx8ao/RxUtvEBih5kIA=; b=b9rlcbw0kz/3xIKoKJVWbtbmld55m3nf7uDkBX26eyHze1i0/TrJJy2SWBDJUBAomYt/mS XVn7Q3urHnlLoNxzNxEig91Jbtd986KzKpcZQa3FDaZ5Ahtn4zb8vSHHNuaJCO5eV+M9kN AvO/GYygwzqhIkpAKotkvcTaFJlMTBii6kHW64SBgNivzCoRg95/8/8WDxkId9qAVXI2hl 7MWDH7jgVz427nHfsVI27l0KQJ4Ahou4XdJX57Usqj3H87cIwYYzsRhqqCQzJ9Rny7Lbl3 uRAgR45Q9ma06Bx0Es1d7dHOx8zHFn9mqJCfycNkjl0oVjaFYnx5lZmMFTz/lQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1706567527; 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=ZpgpHczOPtuqAFvrqI2DiEy3Dx8ao/RxUtvEBih5kIA=; b=aEJe8FEckdCc3RGywmGmf4CfHWTQIGFyRFFQa8cGjG8svLQZU8vXNAg2AcCxL3Ngsv8wVX wrD1yjEHbRbiUsdsYPUDEasDyfMdBQU59Znou4BZRgBwRqbLa0DO6qV5qa+9JpmerGmNDF x3ybC9o1XSL7tWqvqBoqMinP167xm72Mu6JrgplGkcgLAml1AFr6UYBVb6cKyuJiv3Yzco ox3113OQr3jFnziNErjiZLdMRZGRdDuhf3UHCbriyx1zjX5LNZX65hY94smWAmCNXGvD4r EYHXez4dTVPPETnXEO1AOtLXl00H5DkOe+IpJFbjebJZe4AC18wMQKq6D2hLHw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1706567527; a=rsa-sha256; cv=none; b=HkuTHOwDDEvS/JG8sVopfuPxghFVmbOMpVpsbn8gVTnxjKFgBlqV1M8k8IvXD+ehyxCgb7 tvU3Fowl4/d4GPvF4EOZPbpKEdTcss8RpUlege/Lnom8Bm9t1YulszGkx8YrD1cvPrCBr4 91AOluBDKVVaucby7Z6eg/mpxkMBpa63rX4AF7V8qob9jDeqMLygfrkpYpUDHNfdijuvki Dy4DPgIiY/ijtnJWU1CkHalxvkVGHmW9UUW94z6/Zebe5CUEZttjvsdrN61ctcKy+AZnJN C2PQdnibJFy9nMYMoYiSsmNkhRlssq46KAAPTeCs10cZj3IxVmTWS2W2z2lPNA== 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 4TP32H4HC9z190L; Mon, 29 Jan 2024 22:32:07 +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 40TMW7H0013319; Mon, 29 Jan 2024 22:32:07 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 40TMW7vf013316; Mon, 29 Jan 2024 22:32:07 GMT (envelope-from git) Date: Mon, 29 Jan 2024 22:32:07 GMT Message-Id: <202401292232.40TMW7vf013316@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Olivier Certner Subject: git: 97256feb7a65 - main - 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/main X-Git-Reftype: branch X-Git-Commit: 97256feb7a65cccac51a03846c5308894a2cb445 Auto-Submitted: auto-generated The branch main has been updated by olce: URL: https://cgit.FreeBSD.org/src/commit/?id=97256feb7a65cccac51a03846c5308894a2cb445 commit 97256feb7a65cccac51a03846c5308894a2cb445 Author: Olivier Certner AuthorDate: 2023-06-20 20:09:57 +0000 Commit: Olivier Certner CommitDate: 2024-01-29 21:58:05 +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 --- 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)