public inbox for linux-security-module@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] landlock: fix struct layer_access_masks kernel-doc
@ 2026-01-23  2:51 Randy Dunlap
  2026-01-23 22:29 ` Günther Noack
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2026-01-23  2:51 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Günther Noack, Mickaël Salaün,
	linux-security-module, Paul Moore, James Morris, Serge E. Hallyn

Use the correct struct name and describe the struct member in
kernel-doc notation to prevent kernel-doc warnings.

WARNING: ../security/landlock/ruleset.h:313 expecting prototype for
  struct layer_accesses. Prototype was for struct layer_access_masks instead

Fixes: 1ebf8e8d3245 ("landlock: Transpose the layer masks data structure")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Something like this is needed. Feel free to massage/correct it some.

Cc: Günther Noack <gnoack3000@gmail.com>
Cc: Mickaël Salaün <mic@digikod.net>
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>

 security/landlock/ruleset.h |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

--- linux-next-20260121.orig/security/landlock/ruleset.h
+++ linux-next-20260121/security/landlock/ruleset.h
@@ -302,9 +302,9 @@ landlock_get_scope_mask(const struct lan
 }
 
 /**
- * struct layer_accesses - A boolean matrix of layers and access rights
- *
- * This has a bit for each combination of layer numbers and access rights.
+ * struct layer_access_masks - A boolean matrix of layers and access rights
+ * @access: This has a bit for each combination of layer numbers and access
+ * rights.
  * During access checks, it is used to represent the access rights for each
  * layer which still need to be fulfilled.  When all bits are 0, the access
  * request is considered to be fulfilled.

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] landlock: fix struct layer_access_masks kernel-doc
  2026-01-23  2:51 [PATCH] landlock: fix struct layer_access_masks kernel-doc Randy Dunlap
@ 2026-01-23 22:29 ` Günther Noack
  0 siblings, 0 replies; 2+ messages in thread
From: Günther Noack @ 2026-01-23 22:29 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-kernel, Mickaël Salaün, linux-security-module,
	Paul Moore, James Morris, Serge E. Hallyn

On Thu, Jan 22, 2026 at 06:51:19PM -0800, Randy Dunlap wrote:
> Use the correct struct name and describe the struct member in
> kernel-doc notation to prevent kernel-doc warnings.
> 
> WARNING: ../security/landlock/ruleset.h:313 expecting prototype for
>   struct layer_accesses. Prototype was for struct layer_access_masks instead
> 
> Fixes: 1ebf8e8d3245 ("landlock: Transpose the layer masks data structure")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Something like this is needed. Feel free to massage/correct it some.

The code that ended up in linux-next is an ongoing patch set and was
not the final version yet, so I'll take the liberty to include a
rewritten and fixed documentation in that place in the next patch set
version (I'll CC you).
https://lore.kernel.org/all/20251230103917.10549-3-gnoack3000@gmail.com/

Thank you for spotting this so quickly! We had actually overlooked it
in the code review so far.

–Günther

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-01-23 22:29 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-01-23  2:51 [PATCH] landlock: fix struct layer_access_masks kernel-doc Randy Dunlap
2026-01-23 22:29 ` Günther Noack

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox