]> www.infradead.org Git - users/jedix/linux-maple.git/commit
docs: crypto: async-tx-api: fix broken code example
authorAhmad Fatoum <a.fatoum@pengutronix.de>
Wed, 29 May 2024 08:08:29 +0000 (10:08 +0200)
committerJonathan Corbet <corbet@lwn.net>
Wed, 12 Jun 2024 21:41:09 +0000 (15:41 -0600)
commite8496ad6d804234933791daf3198c3a7fee522aa
treec2e004d410da4249bdaeb95f695f89f6a701f44b
parent99a021edde0287d04afc0de6a72d7f8fbfcecdd0
docs: crypto: async-tx-api: fix broken code example

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>
Reviewed-by: Andre Noll <maan@tuebingen.mpg.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240529-async-dma-docs-v2-1-8faf87e72e6d@pengutronix.de
Documentation/crypto/async-tx-api.rst