lkml.org 
[lkml]   [2023]   [Jan]   [11]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
SubjectRe: [PATCH] docs: deprecated.rst: Add note about DECLARE_FLEX_ARRAY() usage
Date
Kees Cook <keescook@chromium.org> writes:

> There wasn't any mention of when/where DECLARE_FLEX_ARRAY() should be
> used, so add the rationale and an example to the deprecation docs.
>
> Suggested-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: "Gustavo A. R. Silva" <gustavoars@kernel.org>
> Cc: linux-doc@vger.kernel.org
> Signed-off-by: Kees Cook <keescook@chromium.org>
> ---
> Documentation/process/deprecated.rst | 26 ++++++++++++++++++++++++++
> 1 file changed, 26 insertions(+)

I've applied this, but couldn't resist making one tweak...

> diff --git a/Documentation/process/deprecated.rst b/Documentation/process/deprecated.rst
> index c8fd53a11a20..fcac0a929efa 100644
> --- a/Documentation/process/deprecated.rst
> +++ b/Documentation/process/deprecated.rst
> @@ -346,3 +346,29 @@ struct_size() and flex_array_size() helpers::
> instance->count = count;
>
> memcpy(instance->items, source, flex_array_size(instance, items, instance->count));
> +
> +There are two special cases of replacement where the DECLARE_FLEX_ARRAY()
> +helper needs to be used. (Note that it is named __DECLARE_FLEX_ARRAY() for
> +use in UAPI headers.) When the flexible array is either alone in a struct,
> +or is part of a union.

The pedant in me couldn't stand leaving that sentence fragment, so I
made a complete sentence out of it.

Thanks,

jon

\
 
 \ /
  Last update: 2023-03-26 23:37    [W:0.026 / U:0.456 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site