* [PATCH] docs: networking: Add title caret and missing doc
@ 2019-09-28 12:39 Adam Zerella
2019-09-30 18:37 ` Jakub Kicinski
0 siblings, 1 reply; 3+ messages in thread
From: Adam Zerella @ 2019-09-28 12:39 UTC (permalink / raw)
Cc: davem, netdev, linux-doc, 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.
Signed-off-by: Adam Zerella <adam.zerella@gmail.com>
---
Documentation/networking/device_drivers/index.rst | 1 +
Documentation/networking/j1939.rst | 2 +-
2 files changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/networking/device_drivers/index.rst b/Documentation/networking/device_drivers/index.rst
index f51f92571e39..1f4a629e7caa 100644
--- a/Documentation/networking/device_drivers/index.rst
+++ b/Documentation/networking/device_drivers/index.rst
@@ -24,6 +24,7 @@ Contents:
google/gve
mellanox/mlx5
pensando/ionic
+ netronome/nfp
.. only:: subproject and html
diff --git a/Documentation/networking/j1939.rst b/Documentation/networking/j1939.rst
index ce7e7a044e08..dc60b13fcd09 100644
--- a/Documentation/networking/j1939.rst
+++ b/Documentation/networking/j1939.rst
@@ -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.20.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] docs: networking: Add title caret and missing doc
2019-09-28 12:39 [PATCH] docs: networking: Add title caret and missing doc Adam Zerella
@ 2019-09-30 18:37 ` Jakub Kicinski
2019-10-01 11:18 ` Adam Zerella
0 siblings, 1 reply; 3+ messages in thread
From: Jakub Kicinski @ 2019-09-30 18:37 UTC (permalink / raw)
To: Adam Zerella; +Cc: davem, netdev, linux-doc
On Sat, 28 Sep 2019 22:39:17 +1000, Adam Zerella wrote:
> 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 <adam.zerella@gmail.com>
> ---
> Documentation/networking/device_drivers/index.rst | 1 +
> Documentation/networking/j1939.rst | 2 +-
> 2 files changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/networking/device_drivers/index.rst b/Documentation/networking/device_drivers/index.rst
> index f51f92571e39..1f4a629e7caa 100644
> --- a/Documentation/networking/device_drivers/index.rst
> +++ b/Documentation/networking/device_drivers/index.rst
> @@ -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?
> .. only:: subproject and html
>
> diff --git a/Documentation/networking/j1939.rst b/Documentation/networking/j1939.rst
> index ce7e7a044e08..dc60b13fcd09 100644
> --- a/Documentation/networking/j1939.rst
> +++ b/Documentation/networking/j1939.rst
> @@ -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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] docs: networking: Add title caret and missing doc
2019-09-30 18:37 ` Jakub Kicinski
@ 2019-10-01 11:18 ` Adam Zerella
0 siblings, 0 replies; 3+ messages in thread
From: Adam Zerella @ 2019-10-01 11:18 UTC (permalink / raw)
To: Jakub Kicinski; +Cc: davem, netdev, linux-doc
On Mon, Sep 30, 2019 at 11:37:54AM -0700, Jakub Kicinski wrote:
> On Sat, 28 Sep 2019 22:39:17 +1000, Adam Zerella wrote:
> > 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 <adam.zerella@gmail.com>
> > ---
> > Documentation/networking/device_drivers/index.rst | 1 +
> > Documentation/networking/j1939.rst | 2 +-
> > 2 files changed, 2 insertions(+), 1 deletion(-)
> >
> > diff --git a/Documentation/networking/device_drivers/index.rst b/Documentation/networking/device_drivers/index.rst
> > index f51f92571e39..1f4a629e7caa 100644
> > --- a/Documentation/networking/device_drivers/index.rst
> > +++ b/Documentation/networking/device_drivers/index.rst
> > @@ -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 :)
> > .. only:: subproject and html
> >
> > diff --git a/Documentation/networking/j1939.rst b/Documentation/networking/j1939.rst
> > index ce7e7a044e08..dc60b13fcd09 100644
> > --- a/Documentation/networking/j1939.rst
> > +++ b/Documentation/networking/j1939.rst
> > @@ -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
>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-10-01 11:18 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-09-28 12:39 [PATCH] docs: networking: Add title caret and missing doc Adam Zerella
2019-09-30 18:37 ` Jakub Kicinski
2019-10-01 11:18 ` Adam Zerella
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).