Skip to contentSkip to conversation

docs: networking: Add title caret and missing doc

PATCH Superseded Adam Zerella 2 participants 3 messages Sep 28, 2019 – Oct 1, 2019

Subsystems (4)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 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.

---
 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..1f4a629e7caa 100644
@@ -24,6 +24,7 @@ Contents:
    google/gve
    mellanox/mlx5
    pensando/ionic
+   netronome/nfp
 
 .. 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.20.1
#1 lore raw
Quoted 17 lines · Adam Zerella

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.

---
 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 +0 -0
index f51f92571e39..1f4a629e7caa 100644

Documentation/networking/device_drivers/index.rst Contents: · line 27

Quoted 4 lines
Documentation/networking/device_drivers/index.rst +1 -0
@@ -24,6 +24,7 @@ Contents:
    google/gve
    mellanox/mlx5
    pensando/ionic
+   netronome/nfp

I wonder if it's worth keeping the entries in a roughly alphabetic order?

Quoted 15 lines
Documentation/networking/device_drivers/index.rst +0 -0
 .. 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
#2 lore raw
Quoted 13 lines · Jakub Kicinski
Quoted 12 lines · Adam Zerella

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.

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

Documentation/networking/device_drivers/index.rst Contents: · line 27

Quoted 9 lines
Documentation/networking/device_drivers/index.rst +1 -0
index f51f92571e39..1f4a629e7caa 100644
@@ -24,6 +24,7 @@ Contents:
    google/gve
    mellanox/mlx5
    pensando/ionic
+   netronome/nfp

I wonder if it's worth keeping the entries in a roughly alphabetic order?

For sure, I've re-submitted a v2 patch :)

Quoted 16 lines
Quoted 15 lines
Documentation/networking/device_drivers/index.rst +0 -0
 .. 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