diff mbox series

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

Message ID 20220303113527.62047-1-dust.li@linux.alibaba.com (mailing list archive)
State Accepted
Commit f9f52c3474282a5485b28cf188b47d6e2efee185
Delegated to: Netdev Maintainers
Headers show
Series [net-next] net/smc: fix document build WARNING from smc-sysctl.rst | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter success Single patches do not need cover letters
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers warning 2 maintainers not CCed: linux-doc@vger.kernel.org corbet@lwn.net
netdev/build_clang success Errors and warnings before: 0 this patch: 0
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/verify_fixes success Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 0 this patch: 0
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 21 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Dust Li March 3, 2022, 11:35 a.m. UTC
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")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Dust Li <dust.li@linux.alibaba.com>
---
 Documentation/networking/index.rst      | 1 +
 Documentation/networking/smc-sysctl.rst | 6 +++---
 2 files changed, 4 insertions(+), 3 deletions(-)

Comments

patchwork-bot+netdevbpf@kernel.org March 4, 2022, 5:30 a.m. UTC | #1
Hello:

This patch was applied to netdev/net-next.git (master)
by Jakub Kicinski <kuba@kernel.org>:

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!
diff mbox series

Patch

diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index 58bc8cd367c6..ce017136ab05 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -96,6 +96,7 @@  Contents:
    sctp
    secid
    seg6-sysctl
+   smc-sysctl
    statistics
    strparser
    switchdev
diff --git a/Documentation/networking/smc-sysctl.rst b/Documentation/networking/smc-sysctl.rst
index c53f8c61c9e4..0987fd1bc220 100644
--- a/Documentation/networking/smc-sysctl.rst
+++ b/Documentation/networking/smc-sysctl.rst
@@ -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: