From: Adam Zerella <adam.zerella@gmail.com>
To: Jakub Kicinski <jakub.kicinski@netronome.com>
Cc: davem@davemloft.net, netdev@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH] docs: networking: Add title caret and missing doc
Date: Tue, 1 Oct 2019 21:18:36 +1000 [thread overview]
Message-ID: <20191001111836.GA10737@gmail.com> (raw)
In-Reply-To: <20190930113754.5902855e@cakuba.netronome.com>
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
>
prev parent reply other threads:[~2019-10-01 11:18 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
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 message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191001111836.GA10737@gmail.com \
--to=adam.zerella@gmail.com \
--cc=davem@davemloft.net \
--cc=jakub.kicinski@netronome.com \
--cc=linux-doc@vger.kernel.org \
--cc=netdev@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).