2022-03-21 23:38:27

by Tom Rix

Subject: [PATCH] nvdimm/blk: Fix title level

From: Tom Rix <[email protected]>

make htmldocs fails with
Sphinx parallel build error:
docutils.utils.SystemMessage: ...nvdimm.rst:146:
(SEVERE/4) Title level inconsistent:

PMEM-REGIONs, Atomic Sectors, and DAX
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The PMEM vs BLK section was removed without changing
the PMEM-REGIONS... title line. Replace '^' with '_'.

Fixes: f8669f1d6a86 ("nvdimm/blk: Delete the block-aperture window driver")
Signed-off-by: Tom Rix <[email protected]>
---
Documentation/driver-api/nvdimm/nvdimm.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/driver-api/nvdimm/nvdimm.rst b/Documentation/driver-api/nvdimm/nvdimm.rst
index 7917f64710920..be8587a558e1e 100644
--- a/Documentation/driver-api/nvdimm/nvdimm.rst
+++ b/Documentation/driver-api/nvdimm/nvdimm.rst
@@ -15,7 +15,7 @@ Version 13
Supporting Documents
Git Trees
LIBNVDIMM PMEM
- PMEM-REGIONs, Atomic Sectors, and DAX
+ PMEM-REGIONs, Atomic Sectors, and DAX
Example NVDIMM Platform
LIBNVDIMM Kernel Device Model and LIBNDCTL Userspace API
LIBNDCTL: Context
@@ -144,7 +144,7 @@ can be immediately attached to nd_pmem. This latter mode is called
label-less or "legacy".

PMEM-REGIONs, Atomic Sectors, and DAX
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------------------

For the cases where an application or filesystem still needs atomic sector
update guarantees it can register a BTT on a PMEM device or partition. See
--
2.26.3

2022-03-25 14:05:53

by Dan Williams

Subject: Re: [PATCH] nvdimm/blk: Fix title level

On Mon, Mar 21, 2022 at 3:04 PM <[email protected]> wrote:
>
> From: Tom Rix <[email protected]>
>
> make htmldocs fails with
> Sphinx parallel build error:
> docutils.utils.SystemMessage: ...nvdimm.rst:146:
> (SEVERE/4) Title level inconsistent:
>
> PMEM-REGIONs, Atomic Sectors, and DAX
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> The PMEM vs BLK section was removed without changing
> the PMEM-REGIONS... title line. Replace '^' with '_'.
>
> Fixes: f8669f1d6a86 ("nvdimm/blk: Delete the block-aperture window driver")
> Signed-off-by: Tom Rix <[email protected]>
> ---

Looks good, thanks for the fix!

Jon, I'll take this through the nvdimm tree.