Re: [PATCH v3 1/2] audit: document /proc/PID/loginuid

[Mauro Carvalho Chehab]

Em Thu, 18 Mar 2021 15:19:10 -0400
Richard Guy Briggs <rgb@xxxxxxxxxx> escreveu:

> Describe the /proc/PID/loginuid interface in Documentation/ABI/stable that
> was added 2005-02-01 by commit 1e2d1492e178 ("[PATCH] audit: handle
> loginuid through proc")
> 
> Signed-off-by: Richard Guy Briggs <rgb@xxxxxxxxxx>
> ---
>  Documentation/ABI/stable/procfs-audit_loginuid | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
>  create mode 100644 Documentation/ABI/stable/procfs-audit_loginuid
> 
> diff --git a/Documentation/ABI/stable/procfs-audit_loginuid b/Documentation/ABI/stable/procfs-audit_loginuid
> new file mode 100644
> index 000000000000..e7c100b9ab18
> --- /dev/null
> +++ b/Documentation/ABI/stable/procfs-audit_loginuid
> @@ -0,0 +1,15 @@
> +What:		Audit Login UID
> +Date:		2005-02-01
> +KernelVersion:	2.6.11-rc2 1e2d1492e178 ("[PATCH] audit: handle loginuid through proc")
> +Contact:	linux-audit@xxxxxxxxxx
> +Format:		%u

The ABI definition doesn't include a "Format:" symbol. See:

	Documentation/ABI/README

For the valid ones.

This change causes a warning at the ABI parser:


	$ ./scripts/get_abi.pl validate
	Warning: file Documentation/ABI/stable/procfs-audit_loginuid#5:
		tag 'contact' is invalid. Line
			Format:		%u
	Warning: file Documentation/ABI/stable/procfs-audit_loginuid#21:
		tag 'contact' is invalid. Line
			Format:		%u

You should either drop it or add it to the parser and to the README
file, if the ABI maintainers are ok with such new field.

Thanks,
Mauro