Skip to contentSkip to conversation

landlock: Fix kernel-doc for the nested quiet layer flag

PATCH New Mickaël Salaün 1 participant 1 message Jul 3

Subsystems (2)
lore
Share & tools
lore

Mickaël Salaün

author maintainer
#0 lore raw

PATCH 1/1 landlock: Fix kernel-doc for the nested quiet layer flag

kernel-doc emits "Excess struct member 'quiet' description in 'landlock_layer'" because "quiet" is a bitfield inside the named nested struct "flags", but its inline comment used the bare member name "@quiet:", which kernel-doc attributes to the enclosing landlock_layer.

Use the canonical dotted notation "@flags.quiet:" so kernel-doc resolves the nested member, and include it in the generated documentation.

Cc Justin Suess <[email protected]>
Cc Tingmao Wang <[email protected]>
Fixes a260c0055665 ("landlock: Add a place for flags to layer rules")
---
 security/landlock/ruleset.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
security/landlock/ruleset.h +2 -2
index 61f3c253d5c9..0437adf17428 100644
@@ -35,8 +35,8 @@ struct landlock_layer {
 	 */
 	struct {
 		/**
-		 * @quiet: Suppresses denial logs for the object covered by this
-		 * rule in this domain.  For filesystem rules, this inherits
+		 * @flags.quiet: Suppresses denial logs for the object covered by
+		 * this rule in this domain.  For filesystem rules, this inherits
 		 * down the file hierarchy.
 		 */
 		u8 quiet : 1;

base-commit: dc59e4fea9d83f03bad6bddf3fa2e52491777482

Signature · 1 line
2.54.0