Skip to contentSkip to conversation

Documentation: build warnings related to missing blank lines after explicit markups has been fixed

PATCH In review Sameer Rahmani 2 participants 2 messages Feb 3, 2020 – Feb 5, 2020

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

PATCH 1/1 Documentation: build warnings related to missing blank lines after explicit markups has been fixed

Fix for several documentation build warnings related to missing blank lines after explicit mark up.

Exact warning message:
WARNING: Explicit markup ends without a blank line; unexpected unindent.

---
 Documentation/doc-guide/contributing.rst       | 1 +
 Documentation/doc-guide/maintainer-profile.rst | 1 +
 Documentation/trace/kprobetrace.rst            | 2 +-
 3 files changed, 3 insertions(+), 1 deletion(-)
Documentation/doc-guide/contributing.rst +1 -0
index 10956583d22e..67ee3691f91f 100644
@@ -1,4 +1,5 @@
 .. SPDX-License-Identifier: GPL-2.0
+
 How to help improve kernel documentation
 ========================================
 
Documentation/doc-guide/maintainer-profile.rst +1 -0
index aee2f508cc89..5afc0ddba40a 100644
@@ -1,4 +1,5 @@
 .. SPDX-License-Identifier: GPL-2.0
+
 Documentation subsystem maintainer entry profile
 ================================================
 
Documentation/trace/kprobetrace.rst +1 -1
index 55993055902c..cc4c5fc313df 100644
@@ -97,6 +97,7 @@ which shows given pointer in "symbol+offset" style.
 For $comm, the default type is "string"; any other type is invalid.
 
 .. _user_mem_access:
+
 User Memory Access
 ------------------
 Kprobe events supports user-space memory access. For that purpose, you can use
@@ -252,4 +253,3 @@ And you can see the traced information via /sys/kernel/debug/tracing/trace.
 Each line shows when the kernel hits an event, and <- SYMBOL means kernel
 returns from SYMBOL(e.g. "sys_open+0x1b/0x1d <- do_sys_open" means kernel
 returns from do_sys_open to sys_open+0x1b).
-
Signature · 1 line
2.25.0
maintainer
#1 lore raw
Quoted 6 lines · On Mon, 3 Feb 2020 20:15:43 +0000 Sameer Rahmani <[email protected]> wrote:

Fix for several documentation build warnings related to missing blank lines after explicit mark up.

Exact warning message:
WARNING: Explicit markup ends without a blank line; unexpected unindent.

Quoted 6 lines
---
 Documentation/doc-guide/contributing.rst       | 1 +
 Documentation/doc-guide/maintainer-profile.rst | 1 +
 Documentation/trace/kprobetrace.rst            | 2 +-
 3 files changed, 3 insertions(+), 1 deletion(-)

Argh. I ask people to look for warnings, then add two myself...embarrassing. Many thanks for fixing these, applied.

If I'm not mistaken, this is your first accepted kernel patch. Congratulations, and I'm glad you started with documentation!

jon