From: "Tobin C. Harding" <me@tobin.cc>
To: Daniel Borkmann <daniel@iogearbox.net>,
Alexei Starovoitov <ast@kernel.org>
Cc: "Tobin C. Harding" <me@tobin.cc>,
Jonathan Corbet <corbet@lwn.net>,
"David S. Miller" <davem@davemloft.net>,
linux-doc@vger.kernel.org, netdev@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH bpf-next 10/13] docs: net: Embed reference to seccomp_filter
Date: Wed, 1 Aug 2018 15:09:05 +1000 [thread overview]
Message-ID: <20180801050908.29970-11-me@tobin.cc> (raw)
In-Reply-To: <20180801050908.29970-1-me@tobin.cc>
Typical RST documents embed the reference link straight in the text.
Currently document uses a '[1]' with the reference below that
paragraph.
Use RST :ref:`path/to/file` <label>` format and embed the reference to
seccomp_filter directly in the text. Add a label to seccomp_filter.rst
to enable the reference to function correctly.
Signed-off-by: Tobin C. Harding <me@tobin.cc>
---
Documentation/networking/filter.rst | 12 ++++++------
Documentation/userspace-api/seccomp_filter.rst | 2 ++
2 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/Documentation/networking/filter.rst b/Documentation/networking/filter.rst
index 10c4eab042df..1ed6972c3544 100644
--- a/Documentation/networking/filter.rst
+++ b/Documentation/networking/filter.rst
@@ -43,12 +43,12 @@ internal compiler that generates a structure that can eventually be loaded
via SO_ATTACH_FILTER to the kernel. ``tcpdump -i em1 port 22 -ddd``
displays what is being placed into this structure.
-Although we were only speaking about sockets here, BPF in Linux is used
-in many more places. There's xt_bpf for netfilter, cls_bpf in the kernel
-qdisc layer, SECCOMP-BPF (SECure COMPuting [1]), and lots of other places
-such as team driver, PTP code, etc where BPF is being used.
-
- [1] Documentation/userspace-api/seccomp_filter.rst
+Although we were only speaking about sockets here, BPF in Linux is used in
+many more places. There's xt_bpf for netfilter, cls_bpf in the kernel qdisc
+layer, SECCOMP-BPF (SECure COMPuting
+:ref:`Documentation/userspace-api/seccomp_filter.rst <seccomp_filter>`),
+and lots of other places such as team driver, PTP code, etc where BPF is
+being used.
Original BPF paper:
diff --git a/Documentation/userspace-api/seccomp_filter.rst b/Documentation/userspace-api/seccomp_filter.rst
index 82a468bc7560..6c3eb4908818 100644
--- a/Documentation/userspace-api/seccomp_filter.rst
+++ b/Documentation/userspace-api/seccomp_filter.rst
@@ -2,6 +2,8 @@
Seccomp BPF (SECure COMPuting with filters)
===========================================
+.. _seccomp_filter:
+
Introduction
============
--
2.17.1
--
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: Daniel Borkmann <daniel@iogearbox.net>,
Alexei Starovoitov <ast@kernel.org>
Cc: "Tobin C. Harding" <me@tobin.cc>,
Jonathan Corbet <corbet@lwn.net>,
"David S. Miller" <davem@davemloft.net>,
linux-doc@vger.kernel.org, netdev@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH bpf-next 10/13] docs: net: Embed reference to seccomp_filter
Date: Wed, 1 Aug 2018 15:09:05 +1000 [thread overview]
Message-ID: <20180801050908.29970-11-me@tobin.cc> (raw)
In-Reply-To: <20180801050908.29970-1-me@tobin.cc>
Typical RST documents embed the reference link straight in the text.
Currently document uses a '[1]' with the reference below that
paragraph.
Use RST :ref:`path/to/file` <label>` format and embed the reference to
seccomp_filter directly in the text. Add a label to seccomp_filter.rst
to enable the reference to function correctly.
Signed-off-by: Tobin C. Harding <me@tobin.cc>
---
Documentation/networking/filter.rst | 12 ++++++------
Documentation/userspace-api/seccomp_filter.rst | 2 ++
2 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/Documentation/networking/filter.rst b/Documentation/networking/filter.rst
index 10c4eab042df..1ed6972c3544 100644
--- a/Documentation/networking/filter.rst
+++ b/Documentation/networking/filter.rst
@@ -43,12 +43,12 @@ internal compiler that generates a structure that can eventually be loaded
via SO_ATTACH_FILTER to the kernel. ``tcpdump -i em1 port 22 -ddd``
displays what is being placed into this structure.
-Although we were only speaking about sockets here, BPF in Linux is used
-in many more places. There's xt_bpf for netfilter, cls_bpf in the kernel
-qdisc layer, SECCOMP-BPF (SECure COMPuting [1]), and lots of other places
-such as team driver, PTP code, etc where BPF is being used.
-
- [1] Documentation/userspace-api/seccomp_filter.rst
+Although we were only speaking about sockets here, BPF in Linux is used in
+many more places. There's xt_bpf for netfilter, cls_bpf in the kernel qdisc
+layer, SECCOMP-BPF (SECure COMPuting
+:ref:`Documentation/userspace-api/seccomp_filter.rst <seccomp_filter>`),
+and lots of other places such as team driver, PTP code, etc where BPF is
+being used.
Original BPF paper:
diff --git a/Documentation/userspace-api/seccomp_filter.rst b/Documentation/userspace-api/seccomp_filter.rst
index 82a468bc7560..6c3eb4908818 100644
--- a/Documentation/userspace-api/seccomp_filter.rst
+++ b/Documentation/userspace-api/seccomp_filter.rst
@@ -2,6 +2,8 @@
Seccomp BPF (SECure COMPuting with filters)
===========================================
+.. _seccomp_filter:
+
Introduction
============
--
2.17.1
next prev parent reply other threads:[~2018-08-01 5:12 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
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 ` Tobin C. Harding [this message]
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 ` [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=20180801050908.29970-11-me@tobin.cc \
--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.