Skip to contentSkip to conversation

docs: nvdimm: use ReST notation for subsection

PATCH Applied Lukas Bulwahn 2 participants 2 messages Jan 18, 2020 – Jan 24, 2020

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

PATCH 1/1 docs: nvdimm: use ReST notation for subsection

The ACPI Device Specific Methods (_DSM) paragraph is intended to be a subsection of the Submit Checklist Addendum section. Dan Williams however used Markdown notation for this subsection, which does not parse as intended in a ReST documentation.

Change the markup to ReST notation, as described in the Specific guidelines for the kernel documentation section in Documentation/doc-guide/sphinx.rst.

Fixes 47843401e3a0 ("libnvdimm, MAINTAINERS: Maintainer Entry Profile")

---
Jonathan, please pick this small doc fixup.

applies cleanly on v5.5-rc6, the current master (25e73aadf297) and next-20200117. I ran make htmldocs and checked the html output.

The subsection was added in v3, but unfortunately, nobody noticed this issue during the last review.
Thanks for the first maintainer entry profile, I look forward to read more of them.

 Documentation/nvdimm/maintainer-entry-profile.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
Documentation/nvdimm/maintainer-entry-profile.rst +2 -1
index 77081fd9be95..efe37adadcea 100644
@@ -33,7 +33,8 @@ Those tests need to be passed before the patches go upstream, but not
 necessarily before initial posting. Contact the list if you need help
 getting the test environment set up.
 
-### ACPI Device Specific Methods (_DSM)
+ACPI Device Specific Methods (_DSM)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Before patches enabling for a new _DSM family will be considered it must
 be assigned a format-interface-code from the NVDIMM Sub-team of the ACPI
 Specification Working Group. In general, the stance of the subsystem is
Signature · 1 line
2.17.1
maintainer Applied
#1 lore raw
Quoted 5 lines · On Sat, 18 Jan 2020 16:36:20 +0100 Lukas Bulwahn <[email protected]>…

The ACPI Device Specific Methods (_DSM) paragraph is intended to be a subsection of the Submit Checklist Addendum section. Dan Williams however used Markdown notation for this subsection, which does not parse as intended in a ReST documentation.

Quoted 8 lines

Change the markup to ReST notation, as described in the Specific guidelines for the kernel documentation section in Documentation/doc-guide/sphinx.rst.

Fixes 47843401e3a0 ("libnvdimm, MAINTAINERS: Maintainer Entry Profile")

---
Jonathan, please pick this small doc fixup.

Applied, thanks.

jon