diff mbox series

docs: networking: fix x25-iface.rst heading & index order

Message ID 20230510022914.2230-1-rdunlap@infradead.org (mailing list archive)
State Accepted
Commit 77c964dad99a182a3df6add8bad73aca1be59890
Delegated to: Netdev Maintainers
Headers show
Series docs: networking: fix x25-iface.rst heading & index order | expand

Checks

Context Check Description
netdev/series_format warning Single patches do not need cover letters; Target tree name not specified in the subject
netdev/tree_selection success Guessed tree name to be net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 8 this patch: 8
netdev/cc_maintainers fail 1 blamed authors not CCed: mchehab+huawei@kernel.org; 1 maintainers not CCed: mchehab+huawei@kernel.org
netdev/build_clang success Errors and warnings before: 8 this patch: 8
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 8 this patch: 8
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 18 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Randy Dunlap May 10, 2023, 2:29 a.m. UTC
Fix the chapter heading for "X.25 Device Driver Interface" so that it
does not contain a trailing '-' character, which makes Sphinx
omit this heading from the contents.

Reverse the order of the x25.rst and x25-iface.rst files in the index
so that the project introduction (x25.rst) comes first.

Fixes: 883780af7209 ("docs: networking: convert x25-iface.txt to ReST")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Eric Dumazet <edumazet@google.com>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Paolo Abeni <pabeni@redhat.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Martin Schiller <ms@dev.tdt.de>
Cc: linux-x25@vger.kernel.org
---
 Documentation/networking/index.rst     |    2 +-
 Documentation/networking/x25-iface.rst |    3 +--
 2 files changed, 2 insertions(+), 3 deletions(-)

Comments

Bagas Sanjaya May 10, 2023, 8:29 a.m. UTC | #1
On 5/10/23 09:29, Randy Dunlap wrote:
> -============================-
>  X.25 Device Driver Interface
> -============================-
> +============================
>  

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
patchwork-bot+netdevbpf@kernel.org May 10, 2023, 9:40 a.m. UTC | #2
Hello:

This patch was applied to netdev/net.git (main)
by David S. Miller <davem@davemloft.net>:

On Tue,  9 May 2023 19:29:14 -0700 you wrote:
> Fix the chapter heading for "X.25 Device Driver Interface" so that it
> does not contain a trailing '-' character, which makes Sphinx
> omit this heading from the contents.
> 
> Reverse the order of the x25.rst and x25-iface.rst files in the index
> so that the project introduction (x25.rst) comes first.
> 
> [...]

Here is the summary with links:
  - docs: networking: fix x25-iface.rst heading & index order
    https://git.kernel.org/netdev/net/c/77c964dad99a

You are awesome, thank you!
diff mbox series

Patch

diff -- a/Documentation/networking/index.rst b/Documentation/networking/index.rst
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -116,8 +116,8 @@  Contents:
    udplite
    vrf
    vxlan
-   x25-iface
    x25
+   x25-iface
    xfrm_device
    xfrm_proc
    xfrm_sync
diff -- a/Documentation/networking/x25-iface.rst b/Documentation/networking/x25-iface.rst
--- a/Documentation/networking/x25-iface.rst
+++ b/Documentation/networking/x25-iface.rst
@@ -1,8 +1,7 @@ 
 .. SPDX-License-Identifier: GPL-2.0
 
-============================-
 X.25 Device Driver Interface
-============================-
+============================
 
 Version 1.1