Skip to contentSkip to conversation

mm/folio_batch: document missing struct members

PATCH Applied Oscar Alejandro Sánchez Lucero 3 participants 4 messages Nov 13 – Nov 14

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 mm/folio_batch: document missing struct members

Add missing kernel-doc descriptions for @nr, @i, @percpu_pvec_drained, and @folios in struct folio_batch to fix warnings.

---
 include/linux/folio_batch.h | 5 +++++
 1 file changed, 5 insertions(+)
include/linux/folio_batch.h +5 -0
index b45946adc50b..7731dcd249a8 100644
@@ -18,6 +18,11 @@ struct folio;
 
 /**
  * struct folio_batch - A collection of folios.
+ * @nr: Number of folios currently in the batch.
+ * @i: Index of the next folio to process in folio_batch_next().
+ * @percpu_pvec_drained: Whether the per-CPU deferred LRU queues have already
+ *                       been drained during __folio_batch_release().
+ * @folios: Array of pointers to the folios in the batch.
  *
  * The folio_batch is used to amortise the cost of retrieving and
  * operating on a set of folios.  The order of folios in the batch may be

---
base-commit: 9d66f26fefacebfeed15de31c1123451a17ff119
change-id: 20261112-folio-batch-doc-fa4f7e18ec85

Best regards,

Signature · 1 line
Oscar Alejandro Sánchez Lucero <[email protected]>
maintainer Reviewed-by on v1 1/1
#1 lore raw
Quoted 29 lines · Oscar Alejandro Sánchez Lucero

Add missing kernel-doc descriptions for @nr, @i, @percpu_pvec_drained, and @folios in struct folio_batch to fix warnings.

---
 include/linux/folio_batch.h | 5 +++++
 1 file changed, 5 insertions(+)
include/linux/folio_batch.h +5 -1
index b45946adc50b..7731dcd249a8 100644
@@ -18,6 +18,11 @@ struct folio;
 
 /**
  * struct folio_batch - A collection of folios.
+ * @nr: Number of folios currently in the batch.
+ * @i: Index of the next folio to process in folio_batch_next().
+ * @percpu_pvec_drained: Whether the per-CPU deferred LRU queues have already
+ *                       been drained during __folio_batch_release().
+ * @folios: Array of pointers to the folios in the batch.
  *
  * The folio_batch is used to amortise the cost of retrieving and
  * operating on a set of folios.  The order of folios in the batch may be
 
---

base-commit: 9d66f26fefacebfeed15de31c1123451a17ff119
change-id: 20261112-folio-batch-doc-fa4f7e18ec85

Quoted 1 line

Best regards,

Waiting for more review before queuing this.

Signature · 3 lines
Cheers,

David
reviewer Reviewed-by
#2 lore raw
Quoted 26 lines · David Hildenbrand (Arm)
Quoted 25 lines · Oscar Alejandro Sánchez Lucero

Add missing kernel-doc descriptions for @nr, @i, @percpu_pvec_drained, and @folios in struct folio_batch to fix warnings.

---
 include/linux/folio_batch.h | 5 +++++
 1 file changed, 5 insertions(+)
include/linux/folio_batch.h +5 -0
index b45946adc50b..7731dcd249a8 100644
@@ -18,6 +18,11 @@ struct folio;
 
 /**
  * struct folio_batch - A collection of folios.
+ * @nr: Number of folios currently in the batch.
+ * @i: Index of the next folio to process in folio_batch_next().
+ * @percpu_pvec_drained: Whether the per-CPU deferred LRU queues have already
+ *                       been drained during __folio_batch_release().
+ * @folios: Array of pointers to the folios in the batch.
  *
  * The folio_batch is used to amortise the cost of retrieving and
  * operating on a set of folios.  The order of folios in the batch may be
Quoted 7 lines
Quoted 5 lines

---
base-commit: 9d66f26fefacebfeed15de31c1123451a17ff119
change-id: 20261112-folio-batch-doc-fa4f7e18ec85

Best regards,

Waiting for more review before queuing this.

Dreams do come true ;)

Quoted 7 lines

--
Cheers,

David

--
Cheers, Lorenzo

maintainer Applied
#3 lore raw
In reply to Oscar Alejandro Sánchez Lucero
Quoted 2 lines · Oscar Alejandro Sánchez Lucero

Add missing kernel-doc descriptions for @nr, @i, @percpu_pvec_drained, and @folios in struct folio_batch to fix warnings.

Applied, thanks!

tree: mm/core.git
branch: core-7.5.misc

Applied patches will appear soon in mm-next, followed by linux-next.

Please report any outstanding bugs that were missed during review, so we can either drop the patch series or decide how to fix it up.

It is encouraged to provide Acked-bys, Reviewed-bys, and Tested-bys even though the patches have already been applied. If possible, patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase, trailer updates or similar. Further, this is not a guarantee that the patches will go upstream. If in doubt, please check the listed branch.

[1/1] mm/folio_batch: document missing struct members

      https://git.kernel.org/mm/core/c/a8064247
Signature · 3 lines
Cheers,

David