Message ID | 20220129025101.38355-2-yang.lee@linux.alibaba.com (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | [-next,1/3] apparmor: Fix match_mnt_path_str() and match_mnt() kernel-doc comment | expand |
On 1/28/22 18:51, Yang Li wrote: > Add the description of @ns_name, change function name aa_u16_chunck to > unpack_u16_chunk and verify_head to verify_header in kernel-doc comment > to remove warnings found by running scripts/kernel-doc, which is caused > by using 'make W=1'. > > security/apparmor/policy_unpack.c:224: warning: expecting prototype for > aa_u16_chunck(). Prototype was for unpack_u16_chunk() instead > security/apparmor/policy_unpack.c:678: warning: Function parameter or > member 'ns_name' not described in 'unpack_profile' > security/apparmor/policy_unpack.c:950: warning: expecting prototype for > verify_head(). Prototype was for verify_header() instead > > Reported-by: Abaci Robot <abaci@linux.alibaba.com> > Signed-off-by: Yang Li <yang.lee@linux.alibaba.com> Acked-by: John Johansen <john.johansen@canonical.com> I have pulled this into my tree > --- > security/apparmor/policy_unpack.c | 5 +++-- > 1 file changed, 3 insertions(+), 2 deletions(-) > > diff --git a/security/apparmor/policy_unpack.c b/security/apparmor/policy_unpack.c > index 55dca9e3af50..3cc0fd2dff87 100644 > --- a/security/apparmor/policy_unpack.c > +++ b/security/apparmor/policy_unpack.c > @@ -214,7 +214,7 @@ static void *kvmemdup(const void *src, size_t len) > } > > /** > - * aa_u16_chunck - test and do bounds checking for a u16 size based chunk > + * unpack_u16_chunk - test and do bounds checking for a u16 size based chunk > * @e: serialized data read head (NOT NULL) > * @chunk: start address for chunk of data (NOT NULL) > * > @@ -671,6 +671,7 @@ static int datacmp(struct rhashtable_compare_arg *arg, const void *obj) > /** > * unpack_profile - unpack a serialized profile > * @e: serialized data extent information (NOT NULL) > + * @ns_name: pointer of newly allocated copy of %NULL in case of error > * > * NOTE: unpack profile sets audit struct if there is a failure > */ > @@ -939,7 +940,7 @@ static struct aa_profile *unpack_profile(struct aa_ext *e, char **ns_name) > } > > /** > - * verify_head - unpack serialized stream header > + * verify_header - unpack serialized stream header > * @e: serialized data read head (NOT NULL) > * @required: whether the header is required or optional > * @ns: Returns - namespace if one is specified else NULL (NOT NULL)
diff --git a/security/apparmor/policy_unpack.c b/security/apparmor/policy_unpack.c index 55dca9e3af50..3cc0fd2dff87 100644 --- a/security/apparmor/policy_unpack.c +++ b/security/apparmor/policy_unpack.c @@ -214,7 +214,7 @@ static void *kvmemdup(const void *src, size_t len) } /** - * aa_u16_chunck - test and do bounds checking for a u16 size based chunk + * unpack_u16_chunk - test and do bounds checking for a u16 size based chunk * @e: serialized data read head (NOT NULL) * @chunk: start address for chunk of data (NOT NULL) * @@ -671,6 +671,7 @@ static int datacmp(struct rhashtable_compare_arg *arg, const void *obj) /** * unpack_profile - unpack a serialized profile * @e: serialized data extent information (NOT NULL) + * @ns_name: pointer of newly allocated copy of %NULL in case of error * * NOTE: unpack profile sets audit struct if there is a failure */ @@ -939,7 +940,7 @@ static struct aa_profile *unpack_profile(struct aa_ext *e, char **ns_name) } /** - * verify_head - unpack serialized stream header + * verify_header - unpack serialized stream header * @e: serialized data read head (NOT NULL) * @required: whether the header is required or optional * @ns: Returns - namespace if one is specified else NULL (NOT NULL)
Add the description of @ns_name, change function name aa_u16_chunck to unpack_u16_chunk and verify_head to verify_header in kernel-doc comment to remove warnings found by running scripts/kernel-doc, which is caused by using 'make W=1'. security/apparmor/policy_unpack.c:224: warning: expecting prototype for aa_u16_chunck(). Prototype was for unpack_u16_chunk() instead security/apparmor/policy_unpack.c:678: warning: Function parameter or member 'ns_name' not described in 'unpack_profile' security/apparmor/policy_unpack.c:950: warning: expecting prototype for verify_head(). Prototype was for verify_header() instead Reported-by: Abaci Robot <abaci@linux.alibaba.com> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com> --- security/apparmor/policy_unpack.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)