Skip to contentSkip to conversation

mm/damon: add kernel-doc comments for probes and rnd_state of damon_ctx

PATCH Applied SJ Park 1 participant 3 messages Jun 28

Subsystems (2)
lore
Share & tools
lore

SJ Park

author maintainer
#0 lore raw

cover mm/damon: add kernel-doc comments for probes and rnd_state of damon_ctx

The two fields of damon_ctx struct don’t have their kernel-doc comments. That causes kernel document builds to warn. Fix those.

The broken commits are in the mm-stable tree. As the issue is not significant and the next merge window for 7.2 is expected to open today, apparently it is too late to squash these fixes to the broken commits. I hope these to be merged into 7.2 release after the merge window, so that those don't bother stable@.

SJ Park (2):
mm/damon: add a kernel-doc comment for damon_ctx->probes mm/damon: add a kernel-doc comment for damon_ctx->rnd_state

 include/linux/damon.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

base-commit: 7875263842e9465bb31d0dbbcbd899610dfe43b4

Signature · 1 line
2.47.3
author maintainer
#1 lore raw

PATCH 1/2 mm/damon: add a kernel-doc comment for damon_ctx->probes

Fix below document build warning:

    WARNING: ../include/linux/damon.h:909 struct member 'probes' not described in 'damon_ctx'
Fixes 18c777859f28 ("mm/damon/core: embed damon_probe objects in damon_ctx")
---
 include/linux/damon.h | 1 +
 1 file changed, 1 insertion(+)
include/linux/damon.h +1 -0
index 783d921075f25..535f675625724 100644
@@ -841,6 +841,7 @@ struct damon_attrs {
  * including damon_call() and damos_walk().
  *
  * @ops:	Set of monitoring operations for given use cases.
+ * @probes:	Head of probes (&damon_probe) list.
  * @addr_unit:	Scale factor for core to ops address conversion.
  * @min_region_sz:	Minimum region size.
  * @pause:	Pause kdamond main loop.
Signature · 1 line
2.47.3
author maintainer
#2 lore raw

PATCH 2/2 mm/damon: add a kernel-doc comment for damon_ctx->rnd_state

In reply to SJ Park

Fix below kernel document build warning:

    WARNING: ../include/linux/damon.h:909 struct member 'rnd_state' not described in 'damon_ctx'
Fixes 9012c4e647df ("mm/damon: replace damon_rand() with a per-ctx lockless PRNG")
---
 include/linux/damon.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/damon.h +1 -1
index 535f675625724..cfbbf8ba28f63 100644
@@ -847,6 +847,7 @@ struct damon_attrs {
  * @pause:	Pause kdamond main loop.
  * @adaptive_targets:	Head of monitoring targets (&damon_target) list.
  * @schemes:		Head of schemes (&damos) list.
+ * @rnd_state:	Per-ctx PRNG state for damon_rand().
  */
 struct damon_ctx {
 	struct damon_attrs attrs;
@@ -904,7 +905,6 @@ struct damon_ctx {
 	struct list_head adaptive_targets;
 	struct list_head schemes;
 
-	/* Per-ctx PRNG state for damon_rand(); kdamond is the sole consumer. */
 	struct rnd_state rnd_state;
 };
 
Signature · 1 line
2.47.3