Message ID | 20220804075448.98241-3-bagasdotme@gmail.com |
---|---|
State | Accepted |
Commit | 038e6eb803870113ca78fc70905a27aaa7141fd9 |
Headers | show |
Series | cxl: documentation fixes | expand |
On Thu, 4 Aug 2022 14:54:47 +0700 Bagas Sanjaya <bagasdotme@gmail.com> wrote: > 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") That seems unlikely to be right tag. Probably b9686e8c8e39 With that tidied up. Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> > --- > 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 > */
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 */
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 <bagasdotme@gmail.com> --- drivers/cxl/cxl.h | 2 ++ 1 file changed, 2 insertions(+)