Received-SPF: pass (google.com: domain of linux-crypto+bounces-4361-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
Date: Thu, 23 May 2024 16:17:00 +0200
From: Andre Noll <maan@tuebingen.mpg.de>
To: Ahmad Fatoum <a.fatoum@pengutronix.de>
Cc: Dan Williams <dan.j.williams@intel.com>,
	Herbert Xu <herbert@gondor.apana.org.au>,
	"David S. Miller" <davem@davemloft.net>,
	Jonathan Corbet <corbet@lwn.net>,
	Maciej Sosnowski <maciej.sosnowski@intel.com>,
	Andre Noll <maan@systemlinux.org>, linux-crypto@vger.kernel.org,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	kernel@pengutronix.de
Subject: Re: [PATCH] docs: crypto: async-tx-api: fix broken code example
Message-ID: <Zk9P3ITcqc-9EhZp@tuebingen.mpg.de>
References: <20240523-async-dma-docs-v1-1-b900e0804e11@pengutronix.de>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <20240523-async-dma-docs-v1-1-b900e0804e11@pengutronix.de>
User-Agent: Mutt/2.2.13 (00d56288) (2024-03-09)

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/