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

[PATCH net-next] net: rmnet: Use section heading 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>
---
 .../cellular/qualcomm/rmnet.rst               | 20 +++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

diff --git a/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst b/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
index 289c146a829153..1115606496b67d 100644
--- a/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
+++ b/Documentation/networking/device_drivers/cellular/qualcomm/rmnet.rst
@@ -27,7 +27,8 @@ these MAP frames and send them to appropriate PDN's.
 2. Packet format
 ================
 
-a. MAP packet v1 (data / control)
+A. MAP packet v1 (data / control)
+---------------------------------
 
 MAP header fields are in big endian format.
 
@@ -53,7 +54,8 @@ Multiplexer ID is to indicate the PDN on which data has to be sent.
 Payload length includes the padding length but does not include MAP header
 length.
 
-b. Map packet v4 (data / control)
+B. MAP packet v4 (data / control)
+---------------------------------
 
 MAP header fields are in big endian format.
 
@@ -106,7 +108,8 @@ over which checksum is computed.
 
 Checksum value, indicates the checksum computed.
 
-c. MAP packet v5 (data / control)
+C. MAP packet v5 (data / control)
+---------------------------------
 
 MAP header fields are in big endian format.
 
@@ -133,7 +136,8 @@ Multiplexer ID is to indicate the PDN on which data has to be sent.
 Payload length includes the padding length but does not include MAP header
 length.
 
-d. Checksum offload header v5
+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
@@ -176,7 +183,8 @@ Command types
 3 is for error during processing of commands
 = ==========================================
 
-f. Aggregation
+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: cb85ca4c0a349e246cd35161088aa3689ae5c580
-- 
An old man doll... just what I always wanted! - Clara

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

[Simon Horman]

On Thu, Oct 16, 2025 at 04:25:52PM +0700, 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>

Reviewed-by: Simon Horman <horms@kernel.org>

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

[Jakub Kicinski]

On Thu, 16 Oct 2025 16:25:52 +0700 Bagas Sanjaya wrote:
> -a. MAP packet v1 (data / control)
> +A. MAP packet v1 (data / control)
> +---------------------------------

Why capitalize the "A" here? it could have stayed the way it was, IMO
lowercase is actually more common and (at least my) Sphinx doesn't seem
to detect this leading letter as in any way special.
-- 
pw-bot: cr

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

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 665 bytes --]

On Mon, Oct 20, 2025 at 05:16:29PM -0700, Jakub Kicinski wrote:
> On Thu, 16 Oct 2025 16:25:52 +0700 Bagas Sanjaya wrote:
> > -a. MAP packet v1 (data / control)
> > +A. MAP packet v1 (data / control)
> > +---------------------------------
> 
> Why capitalize the "A" here? it could have stayed the way it was, IMO
> lowercase is actually more common and (at least my) Sphinx doesn't seem
> to detect this leading letter as in any way special.

I follow Simon's suggestion in packet formatting patch [1].

Thanks.

[1]: https://lore.kernel.org/linux-doc/aO_MefPIlQQrCU3j@horms.kernel.org/

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

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

[Simon Horman]

On Mon, Oct 20, 2025 at 05:16:29PM -0700, Jakub Kicinski wrote:
> On Thu, 16 Oct 2025 16:25:52 +0700 Bagas Sanjaya wrote:
> > -a. MAP packet v1 (data / control)
> > +A. MAP packet v1 (data / control)
> > +---------------------------------
> 
> Why capitalize the "A" here? it could have stayed the way it was, IMO
> lowercase is actually more common and (at least my) Sphinx doesn't seem
> to detect this leading letter as in any way special.

It was a style choice on my part.
Which seemed to make sense to me at the time.
No other reason.
And no objections from my side to sticking to lower case.