Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Richard Guy Briggs <rgb@redhat.com>
To:     Linux-Audit Mailing List <linux-audit@redhat.com>,
        LKML <linux-kernel@vger.kernel.org>
Cc:     Eric Paris <eparis@parisplace.org>,
        Paul Moore <paul@paul-moore.com>,
        Richard Guy Briggs <rgb@redhat.com>,
        Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Subject: [PATCH] audit: drop /proc/PID/loginuid documentation Format field
Date:   Thu,  1 Apr 2021 15:10:27 -0400
Message-Id: <ea7f2e3b49b1cae523b58f128c8419c9b8565d9d.1617303032.git.rgb@redhat.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

Drop the "Format:" field from the /proc/PID/loginuid documentation and
integrate the information into the Description field since it is not
recognized by the "./scripts/get_abi.pl validate" command which causes a
warning.  Documentation/ABI/README describes the valid fields.

Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Richard Guy Briggs <rgb@redhat.com>
---
 .../ABI/stable/procfs-audit_loginuid          | 22 +++++++++----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/Documentation/ABI/stable/procfs-audit_loginuid b/Documentation/ABI/stable/procfs-audit_loginuid
index 9d55a3ff4b34..cda405178391 100644
--- a/Documentation/ABI/stable/procfs-audit_loginuid
+++ b/Documentation/ABI/stable/procfs-audit_loginuid
@@ -2,26 +2,26 @@ What:		Audit Login UID
 Date:		2005-02-01
 KernelVersion:	2.6.11-rc2 1e2d1492e178 ("[PATCH] audit: handle loginuid through proc")
 Contact:	linux-audit@redhat.com
-Format:		%u
 Users:		audit and login applications
 Description:
 		The /proc/$pid/loginuid pseudofile is written to set and
-		read to get the audit login UID of process $pid.  If it is
-		unset, permissions are not needed to set it.  The accessor must
-		have CAP_AUDIT_CONTROL in the initial user namespace to write
-		it if it has been set.  It cannot be written again if
-		AUDIT_FEATURE_LOGINUID_IMMUTABLE is enabled.  It cannot be
-		unset if AUDIT_FEATURE_ONLY_UNSET_LOGINUID is enabled.
-
+		read to get the audit login UID of process $pid as a
+		decimal unsigned int (%u, u32).  If it is unset,
+		permissions are not needed to set it.  The accessor must
+		have CAP_AUDIT_CONTROL in the initial user namespace to
+		write it if it has been set.  It cannot be written again
+		if AUDIT_FEATURE_LOGINUID_IMMUTABLE is enabled.  It
+		cannot be unset if AUDIT_FEATURE_ONLY_UNSET_LOGINUID is
+		enabled.
 
 What:		Audit Login Session ID
 Date:		2008-03-13
 KernelVersion:	2.6.25-rc7 1e0bd7550ea9 ("[PATCH] export sessionid alongside the loginuid in procfs")
 Contact:	linux-audit@redhat.com
-Format:		%u
 Users:		audit and login applications
 Description:
 		The /proc/$pid/sessionid pseudofile is read to get the
-		audit login session ID of process $pid.  It is set
-		automatically, serially assigned with each new login.
+		audit login session ID of process $pid as a decimal
+		unsigned int (%u, u32).  It is set automatically,
+		serially assigned with each new login.
 
-- 
2.27.0