Received-SPF: pass (google.com: domain of linux-kernel+bounces-199648-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Date: Mon, 3 Jun 2024 20:58:39 +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>, 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 v2] docs: crypto: async-tx-api: fix broken code example
Message-ID: <Zl4SX4mF0EFuJLnc@tuebingen.mpg.de>
References: <20240529-async-dma-docs-v2-1-8faf87e72e6d@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: <20240529-async-dma-docs-v2-1-8faf87e72e6d@pengutronix.de>
User-Agent: Mutt/2.2.13 (00d56288) (2024-03-09)

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@pengutronix.de>
> ---
> 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@pengutronix.de

Looks good to me now. Feel free to add

	Reviewed-by: Andre Noll <maan@tuebingen.mpg.de>

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/