All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Tobin C. Harding" <me@tobin.cc>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Daniel Borkmann <daniel@iogearbox.net>,
	Alexei Starovoitov <ast@kernel.org>,
	"David S. Miller" <davem@davemloft.net>,
	linux-doc@vger.kernel.org, netdev@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH bpf-next 03/13] docs: net: Add filter to index toctree
Date: Thu, 2 Aug 2018 08:32:56 +1000	[thread overview]
Message-ID: <20180801223256.GB31267@eros> (raw)
In-Reply-To: <20180801075212.6e42fa0c@lwn.net>

On Wed, Aug 01, 2018 at 07:52:12AM -0600, Jonathan Corbet wrote:
> On Wed,  1 Aug 2018 15:08:58 +1000
> "Tobin C. Harding" <me@tobin.cc> wrote:
> 
> > filter.rst was just created (from filter.txt).  We should include it in
> > the networking docs toctree.
> > 
> > Add filter to Documentation/networking/index.rst toctree.
> 
> So...the minorest of nits just to prove that I actually looked at
> this...:)

Thanks for the feedback Jon, I like when I get feedback as apposed to
just patches being applied - makes me feel like the work actually
matters, thanks.

> Adding it to the toctree at this point is going to make the
> docs build messy (OK, even messier than it already is) because the RST
> conversion hasn't really been done yet.  I'd do this at the end of the
> series, just in case somebody, somewhere, is crazy enough to try to
> bisect a docs build.

Will use this method for re-spin of this set and for future conversions.

> Something that's a bit more relevant, perhaps: this document is a bit of
> a mishmash.  It starts by talking about how to use cBPF for socket
> filters, then includes a long discussion about the features of eBPF
> which, as I understand it, is still not accessible to user space for
> socket filters. That latter part certainly merits being in its own file
> where people will actually find it?  And if it were me, I would move that
> file into the core API guide, since it will be relevant beyond networking.

And we have Documentation/bpf as well?  I'll have a go at splitting this
file up and/or moving it around.  The content is pretty heavy so I may
need some comments/ideas from the original authors.

I'll spin up a V2 and we can see how it looks.

thanks,
Tobin.
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

WARNING: multiple messages have this Message-ID (diff)
From: "Tobin C. Harding" <me@tobin.cc>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Daniel Borkmann <daniel@iogearbox.net>,
	Alexei Starovoitov <ast@kernel.org>,
	"David S. Miller" <davem@davemloft.net>,
	linux-doc@vger.kernel.org, netdev@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH bpf-next 03/13] docs: net: Add filter to index toctree
Date: Thu, 2 Aug 2018 08:32:56 +1000	[thread overview]
Message-ID: <20180801223256.GB31267@eros> (raw)
In-Reply-To: <20180801075212.6e42fa0c@lwn.net>

On Wed, Aug 01, 2018 at 07:52:12AM -0600, Jonathan Corbet wrote:
> On Wed,  1 Aug 2018 15:08:58 +1000
> "Tobin C. Harding" <me@tobin.cc> wrote:
> 
> > filter.rst was just created (from filter.txt).  We should include it in
> > the networking docs toctree.
> > 
> > Add filter to Documentation/networking/index.rst toctree.
> 
> So...the minorest of nits just to prove that I actually looked at
> this...:)

Thanks for the feedback Jon, I like when I get feedback as apposed to
just patches being applied - makes me feel like the work actually
matters, thanks.

> Adding it to the toctree at this point is going to make the
> docs build messy (OK, even messier than it already is) because the RST
> conversion hasn't really been done yet.  I'd do this at the end of the
> series, just in case somebody, somewhere, is crazy enough to try to
> bisect a docs build.

Will use this method for re-spin of this set and for future conversions.

> Something that's a bit more relevant, perhaps: this document is a bit of
> a mishmash.  It starts by talking about how to use cBPF for socket
> filters, then includes a long discussion about the features of eBPF
> which, as I understand it, is still not accessible to user space for
> socket filters. That latter part certainly merits being in its own file
> where people will actually find it?  And if it were me, I would move that
> file into the core API guide, since it will be relevant beyond networking.

And we have Documentation/bpf as well?  I'll have a go at splitting this
file up and/or moving it around.  The content is pretty heavy so I may
need some comments/ideas from the original authors.

I'll spin up a V2 and we can see how it looks.

thanks,
Tobin.

  reply	other threads:[~2018-08-01 22:33 UTC|newest]

Thread overview: 50+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-08-01  5:08 [PATCH bpf-next 00/13] docs: Convert BPF filter.txt to RST Tobin C. Harding
2018-08-01  5:08 ` Tobin C. Harding
2018-08-01  5:08 ` [PATCH bpf-next 01/13] docs: net: Rename filter.txt to filter.rst Tobin C. Harding
2018-08-01  5:08   ` Tobin C. Harding
2018-08-01  5:08 ` [PATCH bpf-next 02/13] docs: Update references " Tobin C. Harding
2018-08-01  5:08   ` Tobin C. Harding
2018-08-01  5:08 ` [PATCH bpf-next 03/13] docs: net: Add filter to index toctree Tobin C. Harding
2018-08-01  5:08   ` Tobin C. Harding
2018-08-01 13:52   ` Jonathan Corbet
2018-08-01 13:52     ` Jonathan Corbet
2018-08-01 22:32     ` Tobin C. Harding [this message]
2018-08-01 22:32       ` Tobin C. Harding
2018-08-01  5:08 ` [PATCH bpf-next 04/13] docs: net: Use correct heading adornments Tobin C. Harding
2018-08-01  5:08   ` Tobin C. Harding
2018-08-01  5:09 ` [PATCH bpf-next 05/13] docs: net: Fix indentation issues for code snippets Tobin C. Harding
2018-08-01  5:09   ` Tobin C. Harding
2018-08-03  8:44   ` Daniel Borkmann
2018-08-03  8:44     ` Daniel Borkmann
2018-08-06  0:22     ` Tobin C. Harding
2018-08-06  0:22       ` Tobin C. Harding
2018-08-01  5:09 ` [PATCH bpf-next 06/13] docs: net: Remove non-standard identifiers Tobin C. Harding
2018-08-01  5:09   ` Tobin C. Harding
2018-08-01  5:09 ` [PATCH bpf-next 07/13] docs: net: Use double ticks instead of single quote Tobin C. Harding
2018-08-01  5:09   ` Tobin C. Harding
2018-08-01  5:09 ` [PATCH bpf-next 08/13] docs: net: Use double ticks instead of single tick Tobin C. Harding
2018-08-01  5:09   ` Tobin C. Harding
2018-08-01  5:09 ` [PATCH bpf-next 09/13] docs: net: Use lowercase 'k' for kernel Tobin C. Harding
2018-08-01  5:09   ` Tobin C. Harding
2018-08-01  5:09 ` [PATCH bpf-next 10/13] docs: net: Embed reference to seccomp_filter Tobin C. Harding
2018-08-01  5:09   ` Tobin C. Harding
2018-08-01  5:09 ` [PATCH bpf-next 11/13] docs: net: Use correct RST list construct Tobin C. Harding
2018-08-01  5:09   ` Tobin C. Harding
2018-08-01  5:09 ` [PATCH bpf-next 12/13] docs: net: Fix various minor typos Tobin C. Harding
2018-08-01  5:09   ` Tobin C. Harding
2018-08-03  8:41   ` Daniel Borkmann
2018-08-03  8:41     ` Daniel Borkmann
2018-08-06  0:23     ` Tobin C. Harding
2018-08-06  0:23       ` Tobin C. Harding
2018-08-08  1:42     ` Tobin C. Harding
2018-08-08  1:42       ` Tobin C. Harding
2018-08-08 13:23       ` Jonathan Corbet
2018-08-08 13:23         ` Jonathan Corbet
2018-08-08 13:45         ` Daniel Borkmann
2018-08-08 13:45           ` Daniel Borkmann
2018-08-08 16:26           ` Markus Heiser
2018-08-08 16:26             ` Markus Heiser
2018-08-08 22:21             ` Tobin C. Harding
2018-08-08 22:21               ` Tobin C. Harding
2018-08-01  5:09 ` [PATCH bpf-next 13/13] docs: net: Fix authors list to render as a list Tobin C. Harding
2018-08-01  5:09   ` Tobin C. Harding

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=20180801223256.GB31267@eros \
    --to=me@tobin.cc \
    --cc=ast@kernel.org \
    --cc=corbet@lwn.net \
    --cc=daniel@iogearbox.net \
    --cc=davem@davemloft.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.