[v2] xfrm docs update

[PATCH net-next v2 0/8] xfrm docs update

Posted by Bagas Sanjaya 3 months, 1 week ago

Hi,

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

Enjoy!

Changes since v1 [1]:

  - Also polish xfrm_sync section headings (Randy)
  - Apply review trailers (Randy)

[1]: https://lore.kernel.org/lkml/20251029082615.39518-1-bagasdotme@gmail.com/

Bagas Sanjaya (8):
  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
  Documentation: xfrm_sync: Trim excess section heading characters
  Documentation: xfrm_sync: Number the fifth section
  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       | 97 ++++++++++---------
 .../networking/{ => xfrm}/xfrm_sysctl.rst     |  0
 MAINTAINERS                                   |  1 +
 7 files changed, 77 insertions(+), 59 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 (64%)
 rename Documentation/networking/{ => xfrm}/xfrm_sysctl.rst (100%)


base-commit: 01cc760632b875c4ad0d8fec0b0c01896b8a36d4
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH net-next v2 0/8] xfrm docs update

Posted by Randy Dunlap 3 months, 1 week ago


On 11/1/25 2:47 AM, Bagas Sanjaya wrote:
> Hi,
> 
> Here are xfrm documentation patches. Patches [1-6/8] are formatting polishing;
> [7/8] groups the docs and [8/8] adds MAINTAINERS entries for them.
> 
> Enjoy!
> 
> Changes since v1 [1]:
> 
>   - Also polish xfrm_sync section headings (Randy)
>   - Apply review trailers (Randy)

Changes all look good. However, there is still one header that ends
with ':'. Not sure it is worth fixing.

XFRM Syscall
  /proc/sys/net/core/xfrm_* Variables:

> [1]: https://lore.kernel.org/lkml/20251029082615.39518-1-bagasdotme@gmail.com/
> 
> Bagas Sanjaya (8):
>   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
>   Documentation: xfrm_sync: Trim excess section heading characters
>   Documentation: xfrm_sync: Number the fifth section
>   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       | 97 ++++++++++---------
>  .../networking/{ => xfrm}/xfrm_sysctl.rst     |  0
>  MAINTAINERS                                   |  1 +
>  7 files changed, 77 insertions(+), 59 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 (64%)
>  rename Documentation/networking/{ => xfrm}/xfrm_sysctl.rst (100%)
> 
> 
> base-commit: 01cc760632b875c4ad0d8fec0b0c01896b8a36d4

-- 
~Randy

Re: [PATCH net-next v2 0/8] xfrm docs update

Posted by Bagas Sanjaya 3 months, 1 week ago

On Sat, Nov 01, 2025 at 11:58:37AM -0700, Randy Dunlap wrote:
> 
> 
> On 11/1/25 2:47 AM, Bagas Sanjaya wrote:
> > Hi,
> > 
> > Here are xfrm documentation patches. Patches [1-6/8] are formatting polishing;
> > [7/8] groups the docs and [8/8] adds MAINTAINERS entries for them.
> > 
> > Enjoy!
> > 
> > Changes since v1 [1]:
> > 
> >   - Also polish xfrm_sync section headings (Randy)
> >   - Apply review trailers (Randy)
> 
> Changes all look good. However, there is still one header that ends
> with ':'. Not sure it is worth fixing.
> 
> XFRM Syscall
>   /proc/sys/net/core/xfrm_* Variables:
> 

I'll also fix it in v3.

Thanks.

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