| Message ID | 20220804075448.98241-2-bagasdotme@gmail.com |
|---|---|
| State | Accepted |
| Commit | f13da0d9c3252eb922fc12495f2068fbb18c2e8f |
| Headers | show |
| Series | cxl: documentation fixes | expand |
On Thu, 4 Aug 2022 14:54:46 +0700 Bagas Sanjaya <bagasdotme@gmail.com> wrote: > Sphinx reported indentation warnings: > > Documentation/driver-api/cxl/memory-devices:457: ./drivers/cxl/core/region.c:732: WARNING: Unexpected indentation. > Documentation/driver-api/cxl/memory-devices:457: ./drivers/cxl/core/region.c:733: WARNING: Block quote ends without a blank line; unexpected unindent. > Documentation/driver-api/cxl/memory-devices:457: ./drivers/cxl/core/region.c:735: WARNING: Unexpected indentation. > > These warnings above are due to missing blank line padding in the nested list > in kernel-doc comment for cxl_rr_ep_add(). > > Add the paddings to fix the warnings. > > Fixes: 384e624bb211b4 ("cxl/region: Attach endpoint decoders") > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Looks right to me. Sphinx white space around lists is annoyingly fiddly but such is life. Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> > --- > drivers/cxl/core/region.c | 3 +++ > 1 file changed, 3 insertions(+) > > diff --git a/drivers/cxl/core/region.c b/drivers/cxl/core/region.c > index dc71ec457608d2..616db51c4e78cf 100644 > --- a/drivers/cxl/core/region.c > +++ b/drivers/cxl/core/region.c > @@ -728,11 +728,14 @@ static int cxl_rr_ep_add(struct cxl_region_ref *cxl_rr, > * in particular decoder target lists. > * > * The steps are: > + * > * - validate that there are no other regions with a higher HPA already > * associated with @port > * - establish a region reference if one is not already present > + * > * - additionally allocate a decoder instance that will host @cxlr on > * @port > + * > * - pin the region reference by the endpoint > * - account for how many entries in @port's target list are needed to > * cover all of the added endpoints.
diff --git a/drivers/cxl/core/region.c b/drivers/cxl/core/region.c index dc71ec457608d2..616db51c4e78cf 100644 --- a/drivers/cxl/core/region.c +++ b/drivers/cxl/core/region.c @@ -728,11 +728,14 @@ static int cxl_rr_ep_add(struct cxl_region_ref *cxl_rr, * in particular decoder target lists. * * The steps are: + * * - validate that there are no other regions with a higher HPA already * associated with @port * - establish a region reference if one is not already present + * * - additionally allocate a decoder instance that will host @cxlr on * @port + * * - pin the region reference by the endpoint * - account for how many entries in @port's target list are needed to * cover all of the added endpoints.
Sphinx reported indentation warnings: Documentation/driver-api/cxl/memory-devices:457: ./drivers/cxl/core/region.c:732: WARNING: Unexpected indentation. Documentation/driver-api/cxl/memory-devices:457: ./drivers/cxl/core/region.c:733: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/driver-api/cxl/memory-devices:457: ./drivers/cxl/core/region.c:735: WARNING: Unexpected indentation. These warnings above are due to missing blank line padding in the nested list in kernel-doc comment for cxl_rr_ep_add(). Add the paddings to fix the warnings. Fixes: 384e624bb211b4 ("cxl/region: Attach endpoint decoders") Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- drivers/cxl/core/region.c | 3 +++ 1 file changed, 3 insertions(+)