docs: networking: can: change bcm_msg_head frames member to support flexible array

[PATCH v1] docs: networking: can: change bcm_msg_head frames member to support flexible array

Posted by Alex Tran 5 months ago

The documentation of the 'bcm_msg_head' struct does not match how
it is defined in 'bcm.h'. Changed the frames member to a flexible array,
matching the definition in the header file.

See commit 94dfc73e7cf4 ("treewide: uapi: Replace zero-length arrays with
flexible-array members")

Bug 217783 <https://bugzilla.kernel.org/show_bug.cgi?id=217783>

Signed-off-by: Alex Tran <alex.t.tran@gmail.com>
---
 Documentation/networking/can.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/networking/can.rst b/Documentation/networking/can.rst
index bc1b585355f7..7650c4b5be5f 100644
--- a/Documentation/networking/can.rst
+++ b/Documentation/networking/can.rst
@@ -742,7 +742,7 @@ The broadcast manager sends responses to user space in the same form:
             struct timeval ival1, ival2;    /* count and subsequent interval */
             canid_t can_id;                 /* unique can_id for task */
             __u32 nframes;                  /* number of can_frames following */
-            struct can_frame frames[0];
+            struct can_frame frames[];
     };
 
 The aligned payload 'frames' uses the same basic CAN frame structure defined
-- 
2.51.0

Re: [PATCH v1] docs: networking: can: change bcm_msg_head frames member to support flexible array

Posted by Marc Kleine-Budde 5 months ago

On 03.09.2025 20:17:09, Alex Tran wrote:
> The documentation of the 'bcm_msg_head' struct does not match how
> it is defined in 'bcm.h'. Changed the frames member to a flexible array,
> matching the definition in the header file.
> 
> See commit 94dfc73e7cf4 ("treewide: uapi: Replace zero-length arrays with
> flexible-array members")
> 
> Bug 217783 <https://bugzilla.kernel.org/show_bug.cgi?id=217783>
> 
> Signed-off-by: Alex Tran <alex.t.tran@gmail.com>

Applied to linux-can.

regards,
Marc

-- 
Pengutronix e.K.                 | Marc Kleine-Budde          |
Embedded Linux                   | https://www.pengutronix.de |
Vertretung Nürnberg              | Phone: +49-5121-206917-129 |
Amtsgericht Hildesheim, HRA 2686 | Fax:   +49-5121-206917-9   |

Re: [PATCH v1] docs: networking: can: change bcm_msg_head frames member to support flexible array

Posted by Oliver Hartkopp 5 months ago


On 04.09.25 05:17, Alex Tran wrote:
> The documentation of the 'bcm_msg_head' struct does not match how
> it is defined in 'bcm.h'. Changed the frames member to a flexible array,
> matching the definition in the header file.
> 
> See commit 94dfc73e7cf4 ("treewide: uapi: Replace zero-length arrays with
> flexible-array members")
> 
> Bug 217783 <https://bugzilla.kernel.org/show_bug.cgi?id=217783>
> 
> Signed-off-by: Alex Tran <alex.t.tran@gmail.com>

Acked-by: Oliver Hartkopp <socketcan@hartkopp.net>

Thanks Alex!

> ---
>   Documentation/networking/can.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/networking/can.rst b/Documentation/networking/can.rst
> index bc1b585355f7..7650c4b5be5f 100644
> --- a/Documentation/networking/can.rst
> +++ b/Documentation/networking/can.rst
> @@ -742,7 +742,7 @@ The broadcast manager sends responses to user space in the same form:
>               struct timeval ival1, ival2;    /* count and subsequent interval */
>               canid_t can_id;                 /* unique can_id for task */
>               __u32 nframes;                  /* number of can_frames following */
> -            struct can_frame frames[0];
> +            struct can_frame frames[];
>       };
>   
>   The aligned payload 'frames' uses the same basic CAN frame structure defined

Re: [PATCH v1] docs: networking: can: change bcm_msg_head frames member to support flexible array

Posted by Paolo Abeni 5 months ago

On 9/4/25 8:25 AM, Oliver Hartkopp wrote:
> On 04.09.25 05:17, Alex Tran wrote:
>> The documentation of the 'bcm_msg_head' struct does not match how
>> it is defined in 'bcm.h'. Changed the frames member to a flexible array,
>> matching the definition in the header file.
>>
>> See commit 94dfc73e7cf4 ("treewide: uapi: Replace zero-length arrays with
>> flexible-array members")
>>
>> Bug 217783 <https://bugzilla.kernel.org/show_bug.cgi?id=217783>
>>
>> Signed-off-by: Alex Tran <alex.t.tran@gmail.com>
> 
> Acked-by: Oliver Hartkopp <socketcan@hartkopp.net>

@Mark, @Oliver: I assume you want us to apply this patch directly to the
net tree, am I correct?

If so, @Alex: please use a formal 'Fixes:' tag for the blamed commit and
'Link: to reference the bz entry, thanks!

Paolo

Re: [PATCH v1] docs: networking: can: change bcm_msg_head frames member to support flexible array

Posted by Marc Kleine-Budde 5 months ago

On 09.09.2025 12:35:46, Paolo Abeni wrote:
> On 9/4/25 8:25 AM, Oliver Hartkopp wrote:
> > On 04.09.25 05:17, Alex Tran wrote:
> >> The documentation of the 'bcm_msg_head' struct does not match how
> >> it is defined in 'bcm.h'. Changed the frames member to a flexible array,
> >> matching the definition in the header file.
> >>
> >> See commit 94dfc73e7cf4 ("treewide: uapi: Replace zero-length arrays with
> >> flexible-array members")
> >>
> >> Bug 217783 <https://bugzilla.kernel.org/show_bug.cgi?id=217783>
> >>
> >> Signed-off-by: Alex Tran <alex.t.tran@gmail.com>
> > 
> > Acked-by: Oliver Hartkopp <socketcan@hartkopp.net>
> 
> @Mark, @Oliver: I assume you want us to apply this patch directly to the
> net tree, am I correct?

I'll take it.

> If so, @Alex: please use a formal 'Fixes:' tag for the blamed commit and
> 'Link: to reference the bz entry, thanks!

Will do.

Marc

-- 
Pengutronix e.K.                 | Marc Kleine-Budde          |
Embedded Linux                   | https://www.pengutronix.de |
Vertretung Nürnberg              | Phone: +49-5121-206917-129 |
Amtsgericht Hildesheim, HRA 2686 | Fax:   +49-5121-206917-9   |