| Message ID | 20230625011349.1457810-6-cuigaosheng1@huawei.com (mailing list archive) |
|---|---|
| State | Handled Elsewhere |
| Headers | show |
| Series | Fix kernel-doc warnings in apparmor | expand |
Hi, Gaosheng Cui On Sun, 2023-06-25 at 09:13 +0800, Gaosheng Cui wrote: > Fix kernel-doc warnings: > > security/apparmor/label.c:166: warning: Excess function parameter > 'n' description in 'vec_cmp' > security/apparmor/label.c:166: warning: Excess function parameter > 'vec' description in 'vec_cmp' > security/apparmor/label.c:166: warning: Function parameter or member > 'an' not described in 'vec_cmp' > security/apparmor/label.c:166: warning: Function parameter or member > 'bn' not described in 'vec_cmp' > security/apparmor/label.c:166: warning: Function parameter or member > 'b' not described in 'vec_cmp' > security/apparmor/label.c:2051: warning: Function parameter or member > 'label' not described in '__label_update' > security/apparmor/label.c:266: warning: Function parameter or member > 'flags' not described in 'aa_vec_unique' > security/apparmor/label.c:594: warning: Excess function parameter > 'l' description in '__label_remove' > security/apparmor/label.c:594: warning: Function parameter or member > 'label' not described in '__label_remove' > security/apparmor/label.c:929: warning: Function parameter or member > 'label' not described in 'aa_label_insert' > security/apparmor/label.c:929: warning: Function parameter or member > 'ls' not described in 'aa_label_insert' > security/apparmor/label.c:1221: warning: Excess function parameter > 'ls' description in 'aa_label_merge' > security/apparmor/label.c:1302: warning: Excess function parameter > 'start' description in 'label_compound_match' > security/apparmor/label.c:1302: warning: Function parameter or member > 'rules' not described in 'label_compound_match' > security/apparmor/label.c:1302: warning: Function parameter or member > 'state' not described in 'label_compound_match' > security/apparmor/label.c:2051: warning: Function parameter or member > 'label' not described in '__label_update' > > Signed-off-by: Gaosheng Cui <cuigaosheng1@huawei.com> > --- > security/apparmor/label.c | 20 +++++++++++--------- > 1 file changed, 11 insertions(+), 9 deletions(-) > > diff --git a/security/apparmor/label.c b/security/apparmor/label.c > index 8a2af96f4da5..ce9c39102a93 100644 > --- a/security/apparmor/label.c > +++ b/security/apparmor/label.c > @@ -154,9 +154,10 @@ static int profile_cmp(struct aa_profile *a, struct aa_profile *b) > > /** > * vec_cmp - label comparison for set ordering > - * @a: label to compare (NOT NULL) > - * @vec: vector of profiles to compare (NOT NULL) > - * @n: length of @vec > + * @a: aa_profile to compare (NOT NULL) > + * @an: length of @a > + * @b: aa_profile to compare (NOT NULL) > + * @bn: length of @b > * > * Returns: <0 if a < vec > * ==0 if a == vec The "Returns:" part of the doc should also be changed to match the different parameter name. > @@ -256,6 +257,7 @@ static inline int unique(struct aa_profile **vec, int n) > * aa_vec_unique - canonical sort and unique a list of profiles > * @n: number of refcounted profiles in the list (@n > 0) > * @vec: list of profiles to sort and merge > + * @flags: null terminator flags of @vec > * > * Returns: the number of duplicates eliminated == references put > * > @@ -584,7 +586,7 @@ bool aa_label_is_unconfined_subset(struct aa_label *set, struct aa_label *sub) > > /** > * __label_remove - remove @label from the label set > - * @l: label to remove > + * @label: label to remove > * @new: label to redirect to > * > * Requires: labels_set(@label)->lock write_lock > @@ -917,8 +919,8 @@ struct aa_label *aa_label_find(struct aa_label *label) > > /** > * aa_label_insert - insert label @label into @ls or return existing label > - * @ls - labelset to insert @label into > - * @label - label to insert > + * @ls: labelset to insert @label into > + * @label: label to insert > * > * Requires: caller to hold a valid ref on @label > * > @@ -1204,7 +1206,6 @@ struct aa_label *aa_label_find_merge(struct aa_label *a, struct aa_label *b) > > /** > * aa_label_merge - attempt to insert new merged label of @a and @b > - * @ls: set of labels to insert label into (NOT NULL) > * @a: label to merge with @b (NOT NULL) > * @b: label to merge with @a (NOT NULL) > * @gfp: memory allocation type > @@ -1282,8 +1283,9 @@ static inline aa_state_t match_component(struct aa_profile *profile, > /** > * label_compound_match - find perms for full compound label > * @profile: profile to find perms for > + * @rules: ruleset to search > * @label: label to check access permissions for > - * @start: state to start match in > + * @state: state to start match in > * @subns: whether to do permission checks on components in a subns > * @request: permissions to request > * @perms: perms struct to set > @@ -2037,7 +2039,7 @@ static struct aa_label *labelset_next_stale(struct aa_labelset *ls) > > /** > * __label_update - insert updated version of @label into labelset > - * @label - the label to update/replace > + * @label: the label to update/replace > * > * Returns: new label that is up to date > * else NULL on failure Thanks, Georgia
diff --git a/security/apparmor/label.c b/security/apparmor/label.c index 8a2af96f4da5..ce9c39102a93 100644 --- a/security/apparmor/label.c +++ b/security/apparmor/label.c @@ -154,9 +154,10 @@ static int profile_cmp(struct aa_profile *a, struct aa_profile *b) /** * vec_cmp - label comparison for set ordering - * @a: label to compare (NOT NULL) - * @vec: vector of profiles to compare (NOT NULL) - * @n: length of @vec + * @a: aa_profile to compare (NOT NULL) + * @an: length of @a + * @b: aa_profile to compare (NOT NULL) + * @bn: length of @b * * Returns: <0 if a < vec * ==0 if a == vec @@ -256,6 +257,7 @@ static inline int unique(struct aa_profile **vec, int n) * aa_vec_unique - canonical sort and unique a list of profiles * @n: number of refcounted profiles in the list (@n > 0) * @vec: list of profiles to sort and merge + * @flags: null terminator flags of @vec * * Returns: the number of duplicates eliminated == references put * @@ -584,7 +586,7 @@ bool aa_label_is_unconfined_subset(struct aa_label *set, struct aa_label *sub) /** * __label_remove - remove @label from the label set - * @l: label to remove + * @label: label to remove * @new: label to redirect to * * Requires: labels_set(@label)->lock write_lock @@ -917,8 +919,8 @@ struct aa_label *aa_label_find(struct aa_label *label) /** * aa_label_insert - insert label @label into @ls or return existing label - * @ls - labelset to insert @label into - * @label - label to insert + * @ls: labelset to insert @label into + * @label: label to insert * * Requires: caller to hold a valid ref on @label * @@ -1204,7 +1206,6 @@ struct aa_label *aa_label_find_merge(struct aa_label *a, struct aa_label *b) /** * aa_label_merge - attempt to insert new merged label of @a and @b - * @ls: set of labels to insert label into (NOT NULL) * @a: label to merge with @b (NOT NULL) * @b: label to merge with @a (NOT NULL) * @gfp: memory allocation type @@ -1282,8 +1283,9 @@ static inline aa_state_t match_component(struct aa_profile *profile, /** * label_compound_match - find perms for full compound label * @profile: profile to find perms for + * @rules: ruleset to search * @label: label to check access permissions for - * @start: state to start match in + * @state: state to start match in * @subns: whether to do permission checks on components in a subns * @request: permissions to request * @perms: perms struct to set @@ -2037,7 +2039,7 @@ static struct aa_label *labelset_next_stale(struct aa_labelset *ls) /** * __label_update - insert updated version of @label into labelset - * @label - the label to update/replace + * @label: the label to update/replace * * Returns: new label that is up to date * else NULL on failure
Fix kernel-doc warnings: security/apparmor/label.c:166: warning: Excess function parameter 'n' description in 'vec_cmp' security/apparmor/label.c:166: warning: Excess function parameter 'vec' description in 'vec_cmp' security/apparmor/label.c:166: warning: Function parameter or member 'an' not described in 'vec_cmp' security/apparmor/label.c:166: warning: Function parameter or member 'bn' not described in 'vec_cmp' security/apparmor/label.c:166: warning: Function parameter or member 'b' not described in 'vec_cmp' security/apparmor/label.c:2051: warning: Function parameter or member 'label' not described in '__label_update' security/apparmor/label.c:266: warning: Function parameter or member 'flags' not described in 'aa_vec_unique' security/apparmor/label.c:594: warning: Excess function parameter 'l' description in '__label_remove' security/apparmor/label.c:594: warning: Function parameter or member 'label' not described in '__label_remove' security/apparmor/label.c:929: warning: Function parameter or member 'label' not described in 'aa_label_insert' security/apparmor/label.c:929: warning: Function parameter or member 'ls' not described in 'aa_label_insert' security/apparmor/label.c:1221: warning: Excess function parameter 'ls' description in 'aa_label_merge' security/apparmor/label.c:1302: warning: Excess function parameter 'start' description in 'label_compound_match' security/apparmor/label.c:1302: warning: Function parameter or member 'rules' not described in 'label_compound_match' security/apparmor/label.c:1302: warning: Function parameter or member 'state' not described in 'label_compound_match' security/apparmor/label.c:2051: warning: Function parameter or member 'label' not described in '__label_update' Signed-off-by: Gaosheng Cui <cuigaosheng1@huawei.com> --- security/apparmor/label.c | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-)