From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>,
Linux Networking <netdev@vger.kernel.org>
Cc: "David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
Simon Horman <horms@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
Steffen Klassert <steffen.klassert@secunet.com>,
Herbert Xu <herbert@gondor.apana.org.au>,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH net-next 5/6] net: Move XFRM documentation into its own subdirectory
Date: Wed, 29 Oct 2025 15:26:13 +0700 [thread overview]
Message-ID: <20251029082615.39518-6-bagasdotme@gmail.com> (raw)
In-Reply-To: <20251029082615.39518-1-bagasdotme@gmail.com>
XFRM docs are currently reside in Documentation/networking directory,
yet these are distinctive as a group of their own. Move them into xfrm
subdirectory.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/networking/index.rst | 5 +----
Documentation/networking/xfrm/index.rst | 13 +++++++++++++
Documentation/networking/{ => xfrm}/xfrm_device.rst | 0
Documentation/networking/{ => xfrm}/xfrm_proc.rst | 0
Documentation/networking/{ => xfrm}/xfrm_sync.rst | 6 +++---
Documentation/networking/{ => xfrm}/xfrm_sysctl.rst | 0
6 files changed, 17 insertions(+), 7 deletions(-)
create mode 100644 Documentation/networking/xfrm/index.rst
rename Documentation/networking/{ => xfrm}/xfrm_device.rst (100%)
rename Documentation/networking/{ => xfrm}/xfrm_proc.rst (100%)
rename Documentation/networking/{ => xfrm}/xfrm_sync.rst (99%)
rename Documentation/networking/{ => xfrm}/xfrm_sysctl.rst (100%)
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index c775cababc8c17..75db2251649b85 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -131,10 +131,7 @@ Contents:
vxlan
x25
x25-iface
- xfrm_device
- xfrm_proc
- xfrm_sync
- xfrm_sysctl
+ xfrm/index
xdp-rx-metadata
xsk-tx-metadata
diff --git a/Documentation/networking/xfrm/index.rst b/Documentation/networking/xfrm/index.rst
new file mode 100644
index 00000000000000..7d866da836fe76
--- /dev/null
+++ b/Documentation/networking/xfrm/index.rst
@@ -0,0 +1,13 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==============
+XFRM Framework
+==============
+
+.. toctree::
+ :maxdepth: 2
+
+ xfrm_device
+ xfrm_proc
+ xfrm_sync
+ xfrm_sysctl
diff --git a/Documentation/networking/xfrm_device.rst b/Documentation/networking/xfrm/xfrm_device.rst
similarity index 100%
rename from Documentation/networking/xfrm_device.rst
rename to Documentation/networking/xfrm/xfrm_device.rst
diff --git a/Documentation/networking/xfrm_proc.rst b/Documentation/networking/xfrm/xfrm_proc.rst
similarity index 100%
rename from Documentation/networking/xfrm_proc.rst
rename to Documentation/networking/xfrm/xfrm_proc.rst
diff --git a/Documentation/networking/xfrm_sync.rst b/Documentation/networking/xfrm/xfrm_sync.rst
similarity index 99%
rename from Documentation/networking/xfrm_sync.rst
rename to Documentation/networking/xfrm/xfrm_sync.rst
index c811c3edfa571a..41a336e0e7345d 100644
--- a/Documentation/networking/xfrm_sync.rst
+++ b/Documentation/networking/xfrm/xfrm_sync.rst
@@ -1,8 +1,8 @@
.. SPDX-License-Identifier: GPL-2.0
-====
-XFRM
-====
+=========
+XFRM sync
+=========
The sync patches work is based on initial patches from
Krisztian <hidden@balabit.hu> and others and additional patches
diff --git a/Documentation/networking/xfrm_sysctl.rst b/Documentation/networking/xfrm/xfrm_sysctl.rst
similarity index 100%
rename from Documentation/networking/xfrm_sysctl.rst
rename to Documentation/networking/xfrm/xfrm_sysctl.rst
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2025-10-29 8:26 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-29 8:26 [PATCH net-next 0/6] xfrm docs update Bagas Sanjaya
2025-10-29 8:26 ` [PATCH net-next 1/6] Documentation: xfrm_device: Wrap iproute2 snippets in literal code block Bagas Sanjaya
2025-10-29 8:26 ` [PATCH net-next 2/6] Documentation: xfrm_device: Use numbered list for offloading steps Bagas Sanjaya
2025-10-29 8:26 ` [PATCH net-next 3/6] Documentation: xfrm_device: Separate hardware offload sublists Bagas Sanjaya
2025-10-29 8:26 ` [PATCH net-next 4/6] Documentation: xfrm_sync: Properly reindent list text Bagas Sanjaya
2025-10-29 8:26 ` Bagas Sanjaya [this message]
2025-10-29 8:26 ` [PATCH net-next 6/6] MAINTAINERS: Add entry for XFRM documentation Bagas Sanjaya
2025-10-30 8:12 ` Steffen Klassert
2025-10-30 15:41 ` Jakub Kicinski
2025-10-30 15:44 ` Jakub Kicinski
2025-10-31 0:12 ` Bagas Sanjaya
2025-10-31 0:51 ` Jakub Kicinski
2025-11-01 4:58 ` [PATCH net-next 0/6] xfrm docs update Randy Dunlap
2025-11-01 9:14 ` Bagas Sanjaya
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=20251029082615.39518-6-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=herbert@gondor.apana.org.au \
--cc=horms@kernel.org \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=steffen.klassert@secunet.com \
/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).