Commit a949b46e authored by Randy Dunlap's avatar Randy Dunlap Committed by John Johansen
Browse files

apparmor: fix some kernel-doc issues in header files 



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: default avatarRandy Dunlap <rdunlap@infradead.org>
Reviewed-by: default avatarRyan Lee <ryan.lee@canonical.com>
Cc: John Johansen <john.johansen@canonical.com>
Cc: John Johansen <john@apparmor.net>
Cc: apparmor@lists.ubuntu.com
Cc: linux-security-module@vger.kernel.org
Cc: Paul Moore <paul@paul-moore.com>
Cc: James Morris <jmorris@namei.org>
Cc: "Serge E. Hallyn" <serge@hallyn.com>
Signed-off-by: default avatarJohn Johansen <john.johansen@canonical.com>
parent 44fbeeb3

security/apparmor/include/cred.h

+1 −1
Original line number Diff line number Diff line
@@ -117,7 +117,7 @@ static inline struct aa_label *aa_get_current_label(void) 
#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

security/apparmor/include/file.h

+1 −1
Original line number Diff line number Diff line
@@ -104,7 +104,7 @@ void aa_inherit_files(const struct cred *cred, struct files_struct *files); 




/**

 * 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

security/apparmor/include/lib.h

+1 −1
Original line number Diff line number Diff line
@@ -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

 */

security/apparmor/include/match.h

+1 −1
Original line number Diff line number Diff line
@@ -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

security/apparmor/include/perms.h

+4 −4
Original line number Diff line number Diff line
@@ -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(struct aa_perms *accum, 


/**

 * 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)