2022-08-04 07:57:01

by Bagas Sanjaya

[permalink] [raw]
Subject: [PATCH 2/3] cxl/region: describe targets and nr_targets members of cxl_region_params

Sphinx reported undescribed parameters in cxl_region_params struct:

./drivers/cxl/cxl.h:376: warning: Function parameter or member 'targets' not described in 'cxl_region_params'
./drivers/cxl/cxl.h:376: warning: Function parameter or member 'nr_targets' not described in 'cxl_region_params'

Describe these members.

Fixes: dd5ba0ebbdc414 ("cxl/region: Add a 'uuid' attribute")
Signed-off-by: Bagas Sanjaya <[email protected]>
---
drivers/cxl/cxl.h | 2 ++
1 file changed, 2 insertions(+)

diff --git a/drivers/cxl/cxl.h b/drivers/cxl/cxl.h
index 75674400cc8d41..65aaf15aa17e29 100644
--- a/drivers/cxl/cxl.h
+++ b/drivers/cxl/cxl.h
@@ -362,6 +362,8 @@ enum cxl_config_state {
* @interleave_ways: number of endpoints in the region
* @interleave_granularity: capacity each endpoint contributes to a stripe
* @res: allocated iomem capacity for this region
+ * @targets: active ordered targets in current decoder configuration
+ * @nr_targets: number of targets
*
* State transitions are protected by the cxl_region_rwsem
*/
--
An old man doll... just what I always wanted! - Clara