mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] docs: add index entry for networking/msg_zerocopy
@ 2018-01-06  1:30 Tobin C. Harding
  2018-01-09 17:58 ` Jonathan Corbet
  0 siblings, 1 reply; 3+ messages in thread
From: Tobin C. Harding @ 2018-01-06  1:30 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Tobin C. Harding, Willem de Bruijn, linux-doc, linux-kernel

Currently msg_zerocopy is not included in any toctree. Sphinx emits a
build warning to this effect. The other three rst files in
Documentation/networking are all indexed. We can add msg_zerocopy to the
toctree to enable navigation of the document via HTML kernel docs.

Add msg_zerocopy to the networking/ toctree.

Signed-off-by: Tobin C. Harding <me@tobin.cc>
---
 Documentation/networking/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index 66e620866245..19e8a927d79b 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -9,6 +9,7 @@ Contents:
    batman-adv
    kapi
    z8530book
+   msg_zerocopy
 
 .. only::  subproject
 
-- 
2.7.4

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] docs: add index entry for networking/msg_zerocopy
  2018-01-06  1:30 [PATCH] docs: add index entry for networking/msg_zerocopy Tobin C. Harding
@ 2018-01-09 17:58 ` Jonathan Corbet
  2018-01-09 20:23   ` Tobin C. Harding
  0 siblings, 1 reply; 3+ messages in thread
From: Jonathan Corbet @ 2018-01-09 17:58 UTC (permalink / raw)
  To: Tobin C. Harding; +Cc: Willem de Bruijn, linux-doc, linux-kernel

On Sat,  6 Jan 2018 12:30:37 +1100
"Tobin C. Harding" <me@tobin.cc> wrote:

> Currently msg_zerocopy is not included in any toctree. Sphinx emits a
> build warning to this effect. The other three rst files in
> Documentation/networking are all indexed. We can add msg_zerocopy to the
> toctree to enable navigation of the document via HTML kernel docs.
> 
> Add msg_zerocopy to the networking/ toctree.

We had a bit of a race condition here, and this fix was sent in by two
people.  Dave Miller took the other one, so I'll drop this one.  Sorry
about that - thanks for the fix!

jon

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] docs: add index entry for networking/msg_zerocopy
  2018-01-09 17:58 ` Jonathan Corbet
@ 2018-01-09 20:23   ` Tobin C. Harding
  0 siblings, 0 replies; 3+ messages in thread
From: Tobin C. Harding @ 2018-01-09 20:23 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: Willem de Bruijn, linux-doc, linux-kernel

On Tue, Jan 09, 2018 at 10:58:23AM -0700, Jonathan Corbet wrote:
> On Sat,  6 Jan 2018 12:30:37 +1100
> "Tobin C. Harding" <me@tobin.cc> wrote:
> 
> > Currently msg_zerocopy is not included in any toctree. Sphinx emits a
> > build warning to this effect. The other three rst files in
> > Documentation/networking are all indexed. We can add msg_zerocopy to the
> > toctree to enable navigation of the document via HTML kernel docs.
> > 
> > Add msg_zerocopy to the networking/ toctree.
> 
> We had a bit of a race condition here, and this fix was sent in by two
> people.  Dave Miller took the other one, so I'll drop this one.  Sorry
> about that - thanks for the fix!

No worries, just good to see it fixed - one less docs build warning.

thanks,
Tobin.

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2018-01-09 20:24 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-01-06  1:30 [PATCH] docs: add index entry for networking/msg_zerocopy Tobin C. Harding
2018-01-09 17:58 ` Jonathan Corbet
2018-01-09 20:23   ` Tobin C. Harding

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

Powered by JetHome