Re: [PATCH] docs: crypto: async-tx-api: fix broken code example

From: Andre Noll
Date: Thu May 23 2024 - 10:35:37 EST


On Thu, May 23, 15:18, Ahmad Fatoum wrote
> The code example fails to compile:
>
> 1) ddr_conv is defined twice, once as a VLA, which have been phased out

addr_conv
>
> 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, make the functions static as users
> are unlikely to export them.

No objections, but please don't consider me authoritative. Two nits
below, FWIW.

> --- a/Documentation/crypto/async-tx-api.rst
> +++ b/Documentation/crypto/async-tx-api.rst
> @@ -150,38 +150,38 @@ of an operation.
> Perform a xor->copy->xor operation where each operation depends on the
> result from the previous operation::

Maybe add

#include <linux/async_tx.h>

>
> - void callback(void *param)
> + static void callback(void *param)
> {
> struct completion *cmp = param;
>
> complete(cmp);
> }

This could be simplified to

static void callback(void *param)
{
complete(param);
}

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/