From: Daniel Thompson <daniel.thompson@linaro.org>
To: Vinod Koul <vkoul@kernel.org>, Jonathan Corbet <corbet@lwn.net>
Cc: Daniel Thompson <daniel.thompson@linaro.org>,
Andy Shevchenko <andy.shevchenko@gmail.com>,
dmaengine@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, patches@linaro.org
Subject: [PATCH 2/2] Documentation: dmaengine: Correctly describe dmatest with channel unset
Date: Thu, 18 Nov 2021 10:09:52 +0000 [thread overview]
Message-ID: <20211118100952.27268-3-daniel.thompson@linaro.org> (raw)
In-Reply-To: <20211118100952.27268-1-daniel.thompson@linaro.org>
Currently the documentation states that channels must be configured before
running the dmatest. This has not been true since commit 6b41030fdc79
("dmaengine: dmatest: Restore default for channel"). Fix accordingly.
Fixes: 6b41030fdc79 ("dmaengine: dmatest: Restore default for channel")
Signed-off-by: Daniel Thompson <daniel.thompson@linaro.org>
---
Documentation/driver-api/dmaengine/dmatest.rst | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/Documentation/driver-api/dmaengine/dmatest.rst b/Documentation/driver-api/dmaengine/dmatest.rst
index 529cc2cbbb1b..cf9859cd0b43 100644
--- a/Documentation/driver-api/dmaengine/dmatest.rst
+++ b/Documentation/driver-api/dmaengine/dmatest.rst
@@ -153,13 +153,14 @@ Part 5 - Handling channel allocation
Allocating Channels
-------------------
-Channels are required to be configured prior to starting the test run.
-Attempting to run the test without configuring the channels will fail.
+Channels do not need to be configured prior to starting a test run. Attempting
+to run the test without configuring the channels will result in testing any
+channels that are available.
Example::
% echo 1 > /sys/module/dmatest/parameters/run
- dmatest: Could not start test, no channels configured
+ dmatest: No channels configured, continue with any
Channels are registered using the "channel" parameter. Channels can be requested by their
name, once requested, the channel is registered and a pending thread is added to the test list.
--
2.33.0
next prev parent reply other threads:[~2021-11-18 10:11 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-18 10:09 [PATCH 0/2] Documentation: dmaengine: Tweak dmatest docs Daniel Thompson
2021-11-18 10:09 ` [PATCH 1/2] Documentation: dmaengine: Add a description of what dmatest does Daniel Thompson
2021-11-18 10:09 ` Daniel Thompson [this message]
2021-11-22 7:01 ` [PATCH 0/2] Documentation: dmaengine: Tweak dmatest docs Vinod Koul
-- strict thread matches above, loose matches on Subject: below --
2021-08-18 15:13 Daniel Thompson
2021-08-18 15:13 ` [PATCH 2/2] Documentation: dmaengine: Correctly describe dmatest with channel unset Daniel Thompson
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=20211118100952.27268-3-daniel.thompson@linaro.org \
--to=daniel.thompson@linaro.org \
--cc=andy.shevchenko@gmail.com \
--cc=corbet@lwn.net \
--cc=dmaengine@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=patches@linaro.org \
--cc=vkoul@kernel.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).