Skip to contentSkip to conversation

net/smc: fix document build WARNING from smc-sysctl.rst

PATCH Applied Dust Li 2 participants 2 messages Mar 3, 2022 – Mar 4, 2022

Subsystems (5)
lore
Share & tools
lore

Dust Li

author
#0 lore raw

PATCH 1/1 net/smc: fix document build WARNING from smc-sysctl.rst

Stephen reported the following warning messages from smc-sysctl.rst

Documentation/networking/smc-sysctl.rst:3: WARNING: Title overline too short.
Documentation/networking/smc-sysctl.rst: WARNING: document isn't included in any toctree

Fix the title overline and add smc-sysctl entry into Documentation/networking/index.rst

Fixes 12bbb0d163a9 ("net/smc: add sysctl for autocorking")
---
 Documentation/networking/index.rst      | 1 +
 Documentation/networking/smc-sysctl.rst | 6 +++---
 2 files changed, 4 insertions(+), 3 deletions(-)
Documentation/networking/index.rst +1 -0
index 58bc8cd367c6..ce017136ab05 100644
@@ -96,6 +96,7 @@ Contents:
    sctp
    secid
    seg6-sysctl
+   smc-sysctl
    statistics
    strparser
    switchdev
Documentation/networking/smc-sysctl.rst +3 -3
index c53f8c61c9e4..0987fd1bc220 100644
@@ -1,11 +1,11 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-=========
+==========
 SMC Sysctl
-=========
+==========
 
 /proc/sys/net/smc/* Variables
-==============================
+=============================
 
 autocorking_size - INTEGER
 	Setting SMC auto corking size:
Signature · 1 line
2.19.1.3.ge56e4f7
#1 lore raw
This patch was applied to netdev/net-next.git (master) by Jakub Kicinski <[email protected]>:

Hello:

This patch was applied to netdev/net-next.git (master) by Jakub Kicinski <[email protected]>:

Quoted 8 lines · On Thu, 3 Mar 2022 19:35:27 +0800 you wrote:

Stephen reported the following warning messages from smc-sysctl.rst

Documentation/networking/smc-sysctl.rst:3: WARNING: Title overline too short.
Documentation/networking/smc-sysctl.rst: WARNING: document isn't included in any toctree

[...]

Here is the summary with links:
- [net-next] net/smc: fix document build WARNING from smc-sysctl.rst

    https://git.kernel.org/netdev/net-next/c/f9f52c347428

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html