All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: unlisted-recipients:; (no To-header on input)
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Vinod Koul <vkoul@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
	dmaengine@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH 3/9] docs: dmaengine: provider.rst: get rid of some warnings
Date: Tue,  3 Mar 2020 16:50:33 +0100	[thread overview]
Message-ID: <62cf2a87b379a92c9c0e5a40c2ae8a138b01fe0a.1583250595.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <afbe367ccb7b9abcb9fab7bc5cb5e0686c105a53.1583250595.git.mchehab+huawei@kernel.org>

Get rid of those warnings by adding extra blank lines:

    Documentation/driver-api/dmaengine/provider.rst:270: WARNING: Unexpected indentation.
    Documentation/driver-api/dmaengine/provider.rst:273: WARNING: Block quote ends without a blank line; unexpected unindent.
    Documentation/driver-api/dmaengine/provider.rst:288: WARNING: Unexpected indentation.
    Documentation/driver-api/dmaengine/provider.rst:290: WARNING: Block quote ends without a blank line; unexpected unindent.

While here, use parenthesis after get_metadata_ptr/set_metadata_len,
as, if some day someone adds a kerneldoc markup for those, it
should automatically generate a cross-reference to them.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/driver-api/dmaengine/provider.rst | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/Documentation/driver-api/dmaengine/provider.rst b/Documentation/driver-api/dmaengine/provider.rst
index 790a15089f1f..56e5833e8a07 100644
--- a/Documentation/driver-api/dmaengine/provider.rst
+++ b/Documentation/driver-api/dmaengine/provider.rst
@@ -266,11 +266,15 @@ to use.
   attached (via the dmaengine_desc_attach_metadata() helper to the descriptor.
 
   From the DMA driver the following is expected for this mode:
+
   - DMA_MEM_TO_DEV / DEV_MEM_TO_MEM
+
     The data from the provided metadata buffer should be prepared for the DMA
     controller to be sent alongside of the payload data. Either by copying to a
     hardware descriptor, or highly coupled packet.
+
   - DMA_DEV_TO_MEM
+
     On transfer completion the DMA driver must copy the metadata to the client
     provided metadata buffer before notifying the client about the completion.
     After the transfer completion, DMA drivers must not touch the metadata
@@ -284,10 +288,14 @@ to use.
   and dmaengine_desc_set_metadata_len() is provided as helper functions.
 
   From the DMA driver the following is expected for this mode:
-  - get_metadata_ptr
+
+  - get_metadata_ptr()
+
     Should return a pointer for the metadata buffer, the maximum size of the
     metadata buffer and the currently used / valid (if any) bytes in the buffer.
-  - set_metadata_len
+
+  - set_metadata_len()
+
     It is called by the clients after it have placed the metadata to the buffer
     to let the DMA driver know the number of valid bytes provided.
 
-- 
2.24.1


  parent reply	other threads:[~2020-03-03 15:50 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-03 15:50 [PATCH 1/9] docs: trace: events.rst: convert some new stuff to ReST format Mauro Carvalho Chehab
2020-03-03 15:50 ` [PATCH 2/9] docs: watch_queue.rst: supress some Sphinx warnings Mauro Carvalho Chehab
2020-03-10 17:53   ` Jonathan Corbet
2020-03-10 18:29   ` David Howells
2020-03-11 12:11     ` Mauro Carvalho Chehab
2020-03-03 15:50 ` Mauro Carvalho Chehab [this message]
2020-03-06 13:39   ` [PATCH 3/9] docs: dmaengine: provider.rst: get rid of some warnings Vinod Koul
2020-03-03 15:50 ` [PATCH 4/9] docs: driver.rst: supress two ReSt warnings Mauro Carvalho Chehab
2020-03-10 17:54   ` Jonathan Corbet
2020-03-03 15:50 ` [PATCH 5/9] docs: gpio: driver.rst: don't mark literal blocks twice Mauro Carvalho Chehab
2020-03-04 14:20   ` Bartosz Golaszewski
2020-03-03 15:50 ` [PATCH 6/9] docs: translations: it: avoid duplicate refs at programming-language.rst Mauro Carvalho Chehab
2020-03-03 17:19   ` Nick Desaulniers
2020-03-04  8:34   ` Federico Vaga
2020-03-10 17:55   ` Jonathan Corbet
2020-03-03 15:50 ` [PATCH 7/9] docs: filesystems: fuse.rst: supress a Sphinx warning Mauro Carvalho Chehab
2020-03-10 17:55   ` Jonathan Corbet
2020-03-03 15:50 ` [PATCH 8/9] docs: perf: imx-ddr.rst: get rid of a warning Mauro Carvalho Chehab
2020-03-03 15:50   ` Mauro Carvalho Chehab
2020-03-10 17:56   ` Jonathan Corbet
2020-03-10 17:56     ` Jonathan Corbet
2020-03-03 15:50 ` [PATCH 9/9] docs: hw-vuln: tsx_async_abort.rst: get rid of an unused ref Mauro Carvalho Chehab
2020-03-10 17:57   ` Jonathan Corbet
2020-03-03 20:42 ` [PATCH 1/9] docs: trace: events.rst: convert some new stuff to ReST format Tom Zanussi
2020-03-03 20:48 ` Steven Rostedt
2020-03-10 17:49   ` Jonathan Corbet

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=62cf2a87b379a92c9c0e5a40c2ae8a138b01fe0a.1583250595.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=dmaengine@vger.kernel.org \
    --cc=linux-doc@vger.kernel.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.