Re: [PATCH v2] docs: crypto: async-tx-api: fix broken code example
From: Andre Noll
Date: Mon Jun 03 2024 - 15:33:32 EST
On Wed, May 29, 10:08, Ahmad Fatoum wrote
> The code example fails to compile:
>
> 1) addr_conv is defined twice, once as a VLA, which have been phased out
>
> 2) submit is not a pointer, but is still dereferenced with ->
>
> 3) The first call to async_xor() lacked the trailing semicolon
>
> Fix these issues and while at it, fix some code style nitpicks as well:
>
> 1) make the functions static as users are unlikely to export them
>
> 2) include the relevant header
>
> 3) Shorten the example a bit by removing a redundant variable
> definition
>
> Fixes: 04ce9ab385dc ("async_xor: permit callers to pass in a 'dma/page scribble' region")
> Signed-off-by: Ahmad Fatoum <a.fatoum@xxxxxxxxxxxxxx>
> ---
> Changes in v2:
> - commit message: fix addr_conv typo (Andre)
> - commit message: note addition of missing semicolon (Andre)
> - add header include (Andre)
> - shorten code by removing redundant variable definition (Andre)
> - Link to v1: https://lore.kernel.org/r/20240523-async-dma-docs-v1-1-b900e0804e11@xxxxxxxxxxxxxx
Looks good to me now. Feel free to add
Reviewed-by: Andre Noll <maan@xxxxxxxxxxxxxxxx>
Best
Andre
--
Max Planck Institute for Biology
Tel: (+49) 7071 601 829
Max-Planck-Ring 5, 72076 Tübingen, Germany
http://people.tuebingen.mpg.de/maan/