linux-kernel - Re: [PATCH v2] apparmor: fix some kernel-doc issues in header files

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-ID: <b105b0bb-9dcc-4611-ace5-5bf58375c7af@canonical.com>
Date: Sat, 17 May 2025 01:51:54 -0700
From: John Johansen <john.johansen@...onical.com>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: Ryan Lee <ryan.lee@...onical.com>, John Johansen <john@...armor.net>,
 apparmor@...ts.ubuntu.com, linux-security-module@...r.kernel.org,
 Paul Moore <paul@...l-moore.com>, James Morris <jmorris@...ei.org>,
 "Serge E. Hallyn" <serge@...lyn.com>
Subject: Re: [PATCH v2] apparmor: fix some kernel-doc issues in header files

On 5/2/25 21:49, Randy Dunlap wrote:
> Fix kernel-doc warnings in apparmor header files as reported by
> scripts/kernel-doc:
> 
> cred.h:128: warning: expecting prototype for end_label_crit_section(). Prototype was for end_current_label_crit_section() instead
> file.h:108: warning: expecting prototype for aa_map_file_perms(). Prototype was for aa_map_file_to_perms() instead
> 
> lib.h:159: warning: Function parameter or struct member 'hname' not described in 'basename'
> lib.h:159: warning: Excess function parameter 'name' description in 'basename'
> 
> match.h:21: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>   * The format used for transition tables is based on the GNU flex table
> 
> perms.h:109: warning: Function parameter or struct member 'accum' not described in 'aa_perms_accum_raw'
> perms.h:109: warning: Function parameter or struct member 'addend' not described in 'aa_perms_accum_raw'
> perms.h:136: warning: Function parameter or struct member 'accum' not described in 'aa_perms_accum'
> perms.h:136: warning: Function parameter or struct member 'addend' not described in 'aa_perms_accum'
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Reviewed-by: Ryan Lee <ryan.lee@...onical.com>
> Cc: John Johansen <john.johansen@...onical.com>
> Cc: John Johansen <john@...armor.net>
> Cc: apparmor@...ts.ubuntu.com
> Cc: linux-security-module@...r.kernel.org
> Cc: Paul Moore <paul@...l-moore.com>
> Cc: James Morris <jmorris@...ei.org>
> Cc: "Serge E. Hallyn" <serge@...lyn.com>
> ---
> v2: add better commit message (Ryan)

Acked-by: John Johansen <john.johansen@...onical.com>

> 
>   security/apparmor/include/cred.h  |    2 +-
>   security/apparmor/include/file.h  |    2 +-
>   security/apparmor/include/lib.h   |    2 +-
>   security/apparmor/include/match.h |    2 +-
>   security/apparmor/include/perms.h |    8 ++++----
>   5 files changed, 8 insertions(+), 8 deletions(-)
> 
> --- linux-next-20250501.orig/security/apparmor/include/cred.h
> +++ linux-next-20250501/security/apparmor/include/cred.h
> @@ -117,7 +117,7 @@ static inline struct aa_label *aa_get_cu
>   #define __end_current_label_crit_section(X) end_current_label_crit_section(X)
>   
>   /**
> - * end_label_crit_section - put a reference found with begin_current_label..
> + * end_current_label_crit_section - put a reference found with begin_current_label..
>    * @label: label reference to put
>    *
>    * Should only be used with a reference obtained with
> --- linux-next-20250501.orig/security/apparmor/include/file.h
> +++ linux-next-20250501/security/apparmor/include/file.h
> @@ -104,7 +104,7 @@ void aa_inherit_files(const struct cred
>   
>   
>   /**
> - * aa_map_file_perms - map file flags to AppArmor permissions
> + * aa_map_file_to_perms - map file flags to AppArmor permissions
>    * @file: open file to map flags to AppArmor permissions
>    *
>    * Returns: apparmor permission set for the file
> --- linux-next-20250501.orig/security/apparmor/include/lib.h
> +++ linux-next-20250501/security/apparmor/include/lib.h
> @@ -170,7 +170,7 @@ struct aa_policy {
>   
>   /**
>    * basename - find the last component of an hname
> - * @name: hname to find the base profile name component of  (NOT NULL)
> + * @hname: hname to find the base profile name component of  (NOT NULL)
>    *
>    * Returns: the tail (base profile name) name component of an hname
>    */
> --- linux-next-20250501.orig/security/apparmor/include/match.h
> +++ linux-next-20250501/security/apparmor/include/match.h
> @@ -17,7 +17,7 @@
>   #define DFA_START			1
>   
>   
> -/**
> +/*
>    * The format used for transition tables is based on the GNU flex table
>    * file format (--tables-file option; see Table File Format in the flex
>    * info pages and the flex sources for documentation). The magic number
> --- linux-next-20250501.orig/security/apparmor/include/perms.h
> +++ linux-next-20250501/security/apparmor/include/perms.h
> @@ -101,8 +101,8 @@ extern struct aa_perms allperms;
>   
>   /**
>    * aa_perms_accum_raw - accumulate perms with out masking off overlapping perms
> - * @accum - perms struct to accumulate into
> - * @addend - perms struct to add to @accum
> + * @accum: perms struct to accumulate into
> + * @addend: perms struct to add to @accum
>    */
>   static inline void aa_perms_accum_raw(struct aa_perms *accum,
>   				      struct aa_perms *addend)
> @@ -128,8 +128,8 @@ static inline void aa_perms_accum_raw(st
>   
>   /**
>    * aa_perms_accum - accumulate perms, masking off overlapping perms
> - * @accum - perms struct to accumulate into
> - * @addend - perms struct to add to @accum
> + * @accum: perms struct to accumulate into
> + * @addend: perms struct to add to @accum
>    */
>   static inline void aa_perms_accum(struct aa_perms *accum,
>   				  struct aa_perms *addend)