linux/Documentation/crypto
Ahmad Fatoum e8496ad6d8 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: 04ce9ab385 ("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
2024-06-12 15:41:09 -06:00
..
device_drivers crypto: octeontx2 - add devlink option to set t106 mode 2023-12-29 11:25:38 +08:00
api-aead.rst crypto: doc - optimize compilation 2016-12-13 16:38:07 -07:00
api-akcipher.rst crypto: doc - optimize compilation 2016-12-13 16:38:07 -07:00
api-digest.rst crypto: doc - Fix hash export state information 2017-02-03 18:16:11 +08:00
api-intro.rst It's been a busy cycle for documentation - hopefully the busiest for a 2020-08-04 22:47:54 -07:00
api-kpp.rst crypto: doc - optimize compilation 2016-12-13 16:38:07 -07:00
api-rng.rst crypto: doc - optimize compilation 2016-12-13 16:38:07 -07:00
api-samples.rst crypto: doc - improve the skcipher API example code 2019-06-13 14:31:40 +08:00
api-skcipher.rst crypto: remove cipher routines from public crypto API 2021-01-03 08:41:35 +11:00
api.rst crypto: doc: properly format ToC headings 2023-11-17 13:05:26 -07:00
architecture.rst crypto: ablkcipher - remove deprecated and unused ablkcipher support 2019-11-17 09:02:49 +08:00
asymmetric-keys.rst docs: crypto: convert asymmetric-keys.txt to ReST 2020-06-19 14:03:46 -06:00
async-tx-api.rst docs: crypto: async-tx-api: fix broken code example 2024-06-12 15:41:09 -06:00
crypto_engine.rst crypto: engine - Add KPP Support to Crypto Engine 2021-10-29 21:04:03 +08:00
descore-readme.rst docs: crypto: descore-readme.txt: convert to ReST format 2020-06-19 14:05:22 -06:00
devel-algos.rst crypto: ahash - remove support for nonzero alignmask 2023-10-27 18:04:29 +08:00
index.rst Another moderately busy cycle for documentation, including: 2024-01-11 19:46:52 -08:00
intro.rst
userspace-if.rst crypto: af_alg - Support symmetric encryption via keyring keys 2022-10-28 12:36:34 +08:00