Messages in this thread | | | Date | Sat, 11 Aug 2018 21:50:58 +1000 | From | "Tobin C. Harding" <> | Subject | Re: [PATCH bpf-next 0/4] Convert filter.txt to RST |
| |
On Fri, Aug 10, 2018 at 10:51:28AM -0700, Alexei Starovoitov wrote: > On Fri, Aug 10, 2018 at 5:57 AM Jonathan Corbet <corbet@lwn.net> wrote: > > > > The objective actually is to have SPDX tags in all files in the kernel. > > That includes documentation, even though people, as always, care less > > about the docs than they do the code. > > right, but let's do that as a separate patch set. > In the current set I'd focus on reviewing the actual doc changes. > In particular completely removing > Documentation/networking/filter.txt > feels wrong, since lots of websites point directly there. > Can we have at least few words there pointing to new location?
Something like ...
------------ filter.txt
BPF documentation can now be found in the following places:
- Introduction to BPF (Linux Socket Filter) - Documentation/userspace-api/socket-filter.rst - Classic BPF (cBPF) - Documentation/userspace-api/cBPF.rst - Internal BPF (eBPF) - Documentation/userspace-api/eBPF.rst
- SECCOMP BPF - Documentation/userspace-api/seccomp_filter.rst
- BPF Design Q&A - Documentation/bpf/bpf_design_QA.rst - BPF Development Q&A - Documentation/bpf/bpf_devel_QA.rst
-------------
Also this highlights that bpf/index.rst is not quite correct yet in this set. The Q&A files are indexed but not explicitly mentioned. My feeling is that bpf/index.rst should mirror the information above.
thanks, Tobin.
| |