[PATCH net-next 0/6] xfrm docs update

Bagas Sanjaya posted 6 patches 1 month, 2 weeks ago
There is a newer version of this series
Documentation/networking/index.rst            |  5 +-
Documentation/networking/xfrm/index.rst       | 13 +++
.../networking/{ => xfrm}/xfrm_device.rst     | 20 +++--
.../networking/{ => xfrm}/xfrm_proc.rst       |  0
.../networking/{ => xfrm}/xfrm_sync.rst       | 83 ++++++++++---------
.../networking/{ => xfrm}/xfrm_sysctl.rst     |  0
MAINTAINERS                                   |  1 +
7 files changed, 70 insertions(+), 52 deletions(-)
create mode 100644 Documentation/networking/xfrm/index.rst
rename Documentation/networking/{ => xfrm}/xfrm_device.rst (95%)
rename Documentation/networking/{ => xfrm}/xfrm_proc.rst (100%)
rename Documentation/networking/{ => xfrm}/xfrm_sync.rst (68%)
rename Documentation/networking/{ => xfrm}/xfrm_sysctl.rst (100%)
[PATCH net-next 0/6] xfrm docs update
Posted by Bagas Sanjaya 1 month, 2 weeks ago
Hi,

Here are xfrm documentation patches. Patches [1-4/6] are formatting polishing;
[5/6] groups the docs and [6/6] adds MAINTAINERS entries for them.

Enjoy!

Bagas Sanjaya (6):
  Documentation: xfrm_device: Wrap iproute2 snippets in literal code
    block
  Documentation: xfrm_device: Use numbered list for offloading steps
  Documentation: xfrm_device: Separate hardware offload sublists
  Documentation: xfrm_sync: Properly reindent list text
  net: Move XFRM documentation into its own subdirectory
  MAINTAINERS: Add entry for XFRM documentation

 Documentation/networking/index.rst            |  5 +-
 Documentation/networking/xfrm/index.rst       | 13 +++
 .../networking/{ => xfrm}/xfrm_device.rst     | 20 +++--
 .../networking/{ => xfrm}/xfrm_proc.rst       |  0
 .../networking/{ => xfrm}/xfrm_sync.rst       | 83 ++++++++++---------
 .../networking/{ => xfrm}/xfrm_sysctl.rst     |  0
 MAINTAINERS                                   |  1 +
 7 files changed, 70 insertions(+), 52 deletions(-)
 create mode 100644 Documentation/networking/xfrm/index.rst
 rename Documentation/networking/{ => xfrm}/xfrm_device.rst (95%)
 rename Documentation/networking/{ => xfrm}/xfrm_proc.rst (100%)
 rename Documentation/networking/{ => xfrm}/xfrm_sync.rst (68%)
 rename Documentation/networking/{ => xfrm}/xfrm_sysctl.rst (100%)


base-commit: 61958b33ef0bab1c1874c933cd3910f495526782
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH net-next 0/6] xfrm docs update
Posted by Randy Dunlap 1 month, 1 week ago

On 10/29/25 1:26 AM, Bagas Sanjaya wrote:
> Hi,
> 
> Here are xfrm documentation patches. Patches [1-4/6] are formatting polishing;
> [5/6] groups the docs and [6/6] adds MAINTAINERS entries for them.
> 
> Enjoy!
> 
> Bagas Sanjaya (6):
>   Documentation: xfrm_device: Wrap iproute2 snippets in literal code
>     block
>   Documentation: xfrm_device: Use numbered list for offloading steps
>   Documentation: xfrm_device: Separate hardware offload sublists
>   Documentation: xfrm_sync: Properly reindent list text
>   net: Move XFRM documentation into its own subdirectory
>   MAINTAINERS: Add entry for XFRM documentation

LGTM.  Thanks.

for the series:
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

OK, one small nit. 3 of the section headings end with ':'
that should not be there.  See xfrm/index.html:

XFRM Framework
XFRM device - offloading the IPsec computations
  Overview
  Callbacks to implement
  Flow
XFRM proc - /proc/net/xfrm_* files
Transformation Statistics
XFRM sync
  1) Message Structure
  2) TLVS reflect the different parameters:
  3) Default configurations for the parameters:
  4) Message types
  Exceptions to threshold settings
XFRM Syscall
  /proc/sys/net/core/xfrm_* Variables:

Oh, and could/should
  Exceptions to threshold settings
be numbered, 5) ? It looks odd to be unnumbered.

-- 
~Randy
Re: [PATCH net-next 0/6] xfrm docs update
Posted by Bagas Sanjaya 1 month, 1 week ago
On Fri, Oct 31, 2025 at 09:58:33PM -0700, Randy Dunlap wrote:
> OK, one small nit. 3 of the section headings end with ':'
> that should not be there.  See xfrm/index.html:
> 
> XFRM Framework
> XFRM device - offloading the IPsec computations
>   Overview
>   Callbacks to implement
>   Flow
> XFRM proc - /proc/net/xfrm_* files
> Transformation Statistics
> XFRM sync
>   1) Message Structure
>   2) TLVS reflect the different parameters:
>   3) Default configurations for the parameters:
>   4) Message types
>   Exceptions to threshold settings
> XFRM Syscall
>   /proc/sys/net/core/xfrm_* Variables:

Sure, I'll clean them up in v2.

> 
> Oh, and could/should
>   Exceptions to threshold settings
> be numbered, 5) ? It looks odd to be unnumbered.

Ack.

Thanks.

-- 
An old man doll... just what I always wanted! - Clara