[PATCH net-next v2] net: rmnet: Use section heading markup for packet format subsections

[PATCH net-next v2] net: rmnet: Use section heading markup for packet format subsections

[Bagas Sanjaya]

Format subsections of "Packet format" section as reST subsections.

Link: https://lore.kernel.org/linux-doc/aO_MefPIlQQrCU3j@horms.kernel.org/
Suggested-by: Simon Horman <horms@kernel.org>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Changes since v1 [1]:

  - Keep section number letters in lowercase (Jakub)

[1]: https://lore.kernel.org/linux-doc/20251016092552.27053-1-bagasdotme@gmail.com/

 .../device_drivers/cellular/qualcomm/rmnet.rst         | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst b/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
index 289c146a829153..28753765fba288 100644
--- a/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
+++ b/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
@@ -28,6 +28,7 @@ these MAP frames and send them to appropriate PDN's.
 ================
 
 a. MAP packet v1 (data / control)
+---------------------------------
 
 MAP header fields are in big endian format.
 
@@ -54,6 +55,7 @@ Payload length includes the padding length but does not include MAP header
 length.
 
 b. Map packet v4 (data / control)
+---------------------------------
 
 MAP header fields are in big endian format.
 
@@ -107,6 +109,7 @@ over which checksum is computed.
 Checksum value, indicates the checksum computed.
 
 c. MAP packet v5 (data / control)
+---------------------------------
 
 MAP header fields are in big endian format.
 
@@ -134,6 +137,7 @@ Payload length includes the padding length but does not include MAP header
 length.
 
 d. Checksum offload header v5
+-----------------------------
 
 Checksum offload header fields are in big endian format.
 
@@ -154,7 +158,10 @@ indicates that the calculated packet checksum is invalid.
 
 Reserved bits must be zero when sent and ignored when received.
 
-e. MAP packet v1/v5 (command specific)::
+e. MAP packet v1/v5 (command specific)
+--------------------------------------
+
+Packet format::
 
     Bit             0             1         2-7      8 - 15           16 - 31
     Function   Command         Reserved     Pad   Multiplexer ID    Payload length
@@ -177,6 +184,7 @@ Command types
 = ==========================================
 
 f. Aggregation
+--------------
 
 Aggregation is multiple MAP packets (can be data or command) delivered to
 rmnet in a single linear skb. rmnet will process the individual

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

Re: [PATCH net-next v2] net: rmnet: Use section heading markup for packet format subsections

[Randy Dunlap]

On 10/21/25 7:54 PM, Bagas Sanjaya wrote:
> Format subsections of "Packet format" section as reST subsections.
> 
> Link: https://lore.kernel.org/linux-doc/aO_MefPIlQQrCU3j@horms.kernel.org/
> Suggested-by: Simon Horman <horms@kernel.org>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Nice, better with these headings.
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

One question to anyone who knows about rmnet: This doc file says:
  Command 1 indicates disabling flow while 2 is enabling flow

and it also says that Bit 0 is the Command bit (or field).
Should the Command bits (field) be larger than one bit?
or is it just 1-based (i.e., 0 means 1 and 1 means 2)?

Thanks.

> ---
> Changes since v1 [1]:
> 
>   - Keep section number letters in lowercase (Jakub)
> 
> [1]: https://lore.kernel.org/linux-doc/20251016092552.27053-1-bagasdotme@gmail.com/
> 
>  .../device_drivers/cellular/qualcomm/rmnet.rst         | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst b/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
> index 289c146a829153..28753765fba288 100644
> --- a/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
> +++ b/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
> @@ -28,6 +28,7 @@ these MAP frames and send them to appropriate PDN's.
>  ================
>  
>  a. MAP packet v1 (data / control)
> +---------------------------------
>  
>  MAP header fields are in big endian format.
>  
> @@ -54,6 +55,7 @@ Payload length includes the padding length but does not include MAP header
>  length.
>  
>  b. Map packet v4 (data / control)
> +---------------------------------
>  
>  MAP header fields are in big endian format.
>  
> @@ -107,6 +109,7 @@ over which checksum is computed.
>  Checksum value, indicates the checksum computed.
>  
>  c. MAP packet v5 (data / control)
> +---------------------------------
>  
>  MAP header fields are in big endian format.
>  
> @@ -134,6 +137,7 @@ Payload length includes the padding length but does not include MAP header
>  length.
>  
>  d. Checksum offload header v5
> +-----------------------------
>  
>  Checksum offload header fields are in big endian format.
>  
> @@ -154,7 +158,10 @@ indicates that the calculated packet checksum is invalid.
>  
>  Reserved bits must be zero when sent and ignored when received.
>  
> -e. MAP packet v1/v5 (command specific)::
> +e. MAP packet v1/v5 (command specific)
> +--------------------------------------
> +
> +Packet format::
>  
>      Bit             0             1         2-7      8 - 15           16 - 31
>      Function   Command         Reserved     Pad   Multiplexer ID    Payload length
> @@ -177,6 +184,7 @@ Command types
>  = ==========================================
>  
>  f. Aggregation
> +--------------
>  
>  Aggregation is multiple MAP packets (can be data or command) delivered to
>  rmnet in a single linear skb. rmnet will process the individual
> 
> base-commit: 962ac5ca99a5c3e7469215bf47572440402dfd59

-- 
~Randy

Re: [PATCH net-next v2] net: rmnet: Use section heading markup for packet format subsections

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Wed, 22 Oct 2025 09:54:57 +0700 you wrote:
> Format subsections of "Packet format" section as reST subsections.
> 
> Link: https://lore.kernel.org/linux-doc/aO_MefPIlQQrCU3j@horms.kernel.org/
> Suggested-by: Simon Horman <horms@kernel.org>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
> Changes since v1 [1]:
> 
> [...]

Here is the summary with links:
  - [net-next,v2] net: rmnet: Use section heading markup for packet format subsections
    https://git.kernel.org/netdev/net-next/c/9ff86092655f

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html