Skip to content

Commit a949b46

Browse files
rddunlapjrjohansen
authored andcommitted
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: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Ryan 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: John Johansen <john.johansen@canonical.com>
1 parent 44fbeeb commit a949b46

5 files changed

Lines changed: 8 additions & 8 deletions

File tree

security/apparmor/include/cred.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ static inline struct aa_label *aa_get_current_label(void)
117117
#define __end_current_label_crit_section(X) end_current_label_crit_section(X)
118118

119119
/**
120-
* end_label_crit_section - put a reference found with begin_current_label..
120+
* end_current_label_crit_section - put a reference found with begin_current_label..
121121
* @label: label reference to put
122122
*
123123
* Should only be used with a reference obtained with

security/apparmor/include/file.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ void aa_inherit_files(const struct cred *cred, struct files_struct *files);
104104

105105

106106
/**
107-
* aa_map_file_perms - map file flags to AppArmor permissions
107+
* aa_map_file_to_perms - map file flags to AppArmor permissions
108108
* @file: open file to map flags to AppArmor permissions
109109
*
110110
* Returns: apparmor permission set for the file

security/apparmor/include/lib.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ struct aa_policy {
170170

171171
/**
172172
* basename - find the last component of an hname
173-
* @name: hname to find the base profile name component of (NOT NULL)
173+
* @hname: hname to find the base profile name component of (NOT NULL)
174174
*
175175
* Returns: the tail (base profile name) name component of an hname
176176
*/

security/apparmor/include/match.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
#define DFA_START 1
1818

1919

20-
/**
20+
/*
2121
* The format used for transition tables is based on the GNU flex table
2222
* file format (--tables-file option; see Table File Format in the flex
2323
* info pages and the flex sources for documentation). The magic number

security/apparmor/include/perms.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ extern struct aa_perms allperms;
101101

102102
/**
103103
* aa_perms_accum_raw - accumulate perms with out masking off overlapping perms
104-
* @accum - perms struct to accumulate into
105-
* @addend - perms struct to add to @accum
104+
* @accum: perms struct to accumulate into
105+
* @addend: perms struct to add to @accum
106106
*/
107107
static inline void aa_perms_accum_raw(struct aa_perms *accum,
108108
struct aa_perms *addend)
@@ -128,8 +128,8 @@ static inline void aa_perms_accum_raw(struct aa_perms *accum,
128128

129129
/**
130130
* aa_perms_accum - accumulate perms, masking off overlapping perms
131-
* @accum - perms struct to accumulate into
132-
* @addend - perms struct to add to @accum
131+
* @accum: perms struct to accumulate into
132+
* @addend: perms struct to add to @accum
133133
*/
134134
static inline void aa_perms_accum(struct aa_perms *accum,
135135
struct aa_perms *addend)

0 commit comments

Comments
 (0)