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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <Zl4SX4mF0EFuJLnc@tuebingen.mpg.de>
Date: Mon, 3 Jun 2024 20:58:39 +0200
From: Andre Noll <maan@...bingen.mpg.de>
To: Ahmad Fatoum <a.fatoum@...gutronix.de>
Cc: Dan Williams <dan.j.williams@...el.com>,
	Herbert Xu <herbert@...dor.apana.org.au>,
	"David S. Miller" <davem@...emloft.net>,
	Jonathan Corbet <corbet@....net>, Andre Noll <maan@...temlinux.org>,
	linux-crypto@...r.kernel.org, linux-doc@...r.kernel.org,
	linux-kernel@...r.kernel.org, kernel@...gutronix.de
Subject: Re: [PATCH v2] docs: crypto: async-tx-api: fix broken code example

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@...gutronix.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@...bingen.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/