Fix the typo in the function documentation to please kernel doc
warnings.
Signed-off-by: Christian Göttsche <[email protected]>
---
security/apparmor/lsm.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/security/apparmor/lsm.c b/security/apparmor/lsm.c
index cef8c466af80..d0485fb0ed63 100644
--- a/security/apparmor/lsm.c
+++ b/security/apparmor/lsm.c
@@ -1124,7 +1124,7 @@ static int apparmor_socket_create(int family, int type, int protocol, int kern)
* @sock: socket that is being setup
* @family: family of socket being created
* @type: type of the socket
- * @ptotocol: protocol of the socket
+ * @protocol: protocol of the socket
* @kern: socket is a special kernel socket
*
* Note:
--
2.43.0
Document the unused function parameter of yama_relation_cleanup() to
please kernel doc warnings.
Signed-off-by: Christian Göttsche <[email protected]>
---
security/yama/yama_lsm.c | 1 +
1 file changed, 1 insertion(+)
diff --git a/security/yama/yama_lsm.c b/security/yama/yama_lsm.c
index 49dc52b454ef..f8e4acd41b72 100644
--- a/security/yama/yama_lsm.c
+++ b/security/yama/yama_lsm.c
@@ -111,6 +111,7 @@ static void report_access(const char *access, struct task_struct *target,
/**
* yama_relation_cleanup - remove invalid entries from the relation list
+ * @work: unused
*
*/
static void yama_relation_cleanup(struct work_struct *work)
--
2.43.0
On Fri, Mar 15, 2024 at 8:54 AM Christian Göttsche
<[email protected]> wrote:
>
> Document the unused function parameter of yama_relation_cleanup() to
> please kernel doc warnings.
>
> Signed-off-by: Christian Göttsche <[email protected]>
> ---
> security/yama/yama_lsm.c | 1 +
> 1 file changed, 1 insertion(+)
One small comment below, but otherwise looks okay to me.
Reviewed-by:
> diff --git a/security/yama/yama_lsm.c b/security/yama/yama_lsm.c
> index 49dc52b454ef..f8e4acd41b72 100644
> --- a/security/yama/yama_lsm.c
> +++ b/security/yama/yama_lsm.c
> @@ -111,6 +111,7 @@ static void report_access(const char *access, struct task_struct *target,
>
> /**
> * yama_relation_cleanup - remove invalid entries from the relation list
> + * @work: unused
> *
> */
> static void yama_relation_cleanup(struct work_struct *work)
Should we also take this opportunity to mark the parameter as '__always_unused'?
--
paul-moore.com
On Tue, Mar 26, 2024 at 3:18 PM Paul Moore <[email protected]> wrote:
>
> On Fri, Mar 15, 2024 at 8:54 AM Christian Göttsche
> <[email protected]> wrote:
> >
> > Document the unused function parameter of yama_relation_cleanup() to
> > please kernel doc warnings.
> >
> > Signed-off-by: Christian Göttsche <[email protected]>
> > ---
> > security/yama/yama_lsm.c | 1 +
> > 1 file changed, 1 insertion(+)
>
> One small comment below, but otherwise looks okay to me.
>
> Reviewed-by:
Bah, let's try that again ...
Reviewed-by: Paul Moore <[email protected]>
> > diff --git a/security/yama/yama_lsm.c b/security/yama/yama_lsm.c
> > index 49dc52b454ef..f8e4acd41b72 100644
> > --- a/security/yama/yama_lsm.c
> > +++ b/security/yama/yama_lsm.c
> > @@ -111,6 +111,7 @@ static void report_access(const char *access, struct task_struct *target,
> >
> > /**
> > * yama_relation_cleanup - remove invalid entries from the relation list
> > + * @work: unused
> > *
> > */
> > static void yama_relation_cleanup(struct work_struct *work)
>
> Should we also take this opportunity to mark the parameter as '__always_unused'?
--
paul-moore.com
On Fri, Mar 15, 2024 at 01:54:10PM +0100, Christian G?ttsche wrote:
> Document the unused function parameter of yama_relation_cleanup() to
> please kernel doc warnings.
>
> Signed-off-by: Christian G?ttsche <[email protected]>
Reviewed-by: Kees Cook <[email protected]>
--
Kees Cook
On Fri, Mar 15, 2024 at 01:54:09PM +0100, Christian G?ttsche wrote:
> Fix the typo in the function documentation to please kernel doc
> warnings.
>
> Signed-off-by: Christian G?ttsche <[email protected]>
Reviewed-by: Kees Cook <[email protected]>
--
Kees Cook