docs: networking: Add title caret and missing doc

PATCH Applied Adam Zerella 2 participants 2 messages Oct 1, 2019

Subsystems (4)

Networking Network drivers Documentation CAN-J1939 network layer

lore

Share & tools

lore

Adam Zerella

author

2019-10-01 11:17 UTC #0 lore raw

PATCH v2 1/1 docs: networking: Add title caret and missing doc

Resolving a couple of Sphinx documentation warnings that are generated in the networking section.

- WARNING: document isn't included in any toctree
- WARNING: Title underline too short.

Signed-off-by Adam Zerella <[email protected]>

---

v2: Moved 'netronome/nfp' into alphabetical order

---
 Documentation/networking/device_drivers/index.rst | 1 +
 Documentation/networking/j1939.rst                | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

Documentation/networking/device_drivers/index.rst +1 -0

index f51f92571e39..c1f7f75e5fd9 100644
@@ -23,6 +23,7 @@ Contents:
    intel/ice
    google/gve
    mellanox/mlx5
+   netronome/nfp
    pensando/ionic
 
 .. only::  subproject and html

Documentation/networking/j1939.rst +1 -1

index ce7e7a044e08..dc60b13fcd09 100644
@@ -272,7 +272,7 @@ supported flags are:
 * MSG_DONTWAIT, i.e. non-blocking operation.
 
 recvmsg(2)
-^^^^^^^^^
+^^^^^^^^^^
 
 In most cases recvmsg(2) is needed if you want to extract more information than
 recvfrom(2) can provide. For example package priority and timestamp. The

Signature · 1 line

2.21.0

David Miller

maintainer Applied

2019-10-01 16:20 UTC #1 lore raw

From: Adam Zerella <[email protected]>
Date: Tue, 1 Oct 2019 21:16:58 +1000

Quoted 7 lines

Resolving a couple of Sphinx documentation warnings that are generated in the networking section.
- WARNING: document isn't included in any toctree
- WARNING: Title underline too short.
Signed-off-by Adam Zerella <[email protected]>

Applied.