linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Ahmad Fatoum <a.fatoum@pengutronix.de>,
	Dan Williams <dan.j.williams@intel.com>,
	Herbert Xu <herbert@gondor.apana.org.au>,
	"David S. Miller" <davem@davemloft.net>,
	Andre Noll <maan@systemlinux.org>
Cc: linux-crypto@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, kernel@pengutronix.de,
	Ahmad Fatoum <a.fatoum@pengutronix.de>
Subject: Re: [PATCH v2] docs: crypto: async-tx-api: fix broken code example
Date: Wed, 12 Jun 2024 15:41:04 -0600	[thread overview]
Message-ID: <87cyolon4f.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20240529-async-dma-docs-v2-1-8faf87e72e6d@pengutronix.de>

Ahmad Fatoum <a.fatoum@pengutronix.de> writes:

> 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>

It looks like nobody has picked this up, so I've applied it.

Thanks,

jon

      parent reply	other threads:[~2024-06-12 21:41 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-29  8:08 [PATCH v2] docs: crypto: async-tx-api: fix broken code example Ahmad Fatoum
2024-06-03 18:58 ` Andre Noll
2024-06-12 21:41 ` Jonathan Corbet [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87cyolon4f.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=a.fatoum@pengutronix.de \
    --cc=dan.j.williams@intel.com \
    --cc=davem@davemloft.net \
    --cc=herbert@gondor.apana.org.au \
    --cc=kernel@pengutronix.de \
    --cc=linux-crypto@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=maan@systemlinux.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).