diff mbox series

dma-buf: Fix kerneldoc formatting

Message ID 20201204200242.2671481-1-daniel.vetter@ffwll.ch (mailing list archive)
State New, archived
Headers show
Series dma-buf: Fix kerneldoc formatting | expand

Commit Message

Daniel Vetter Dec. 4, 2020, 8:02 p.m. UTC
I wanted to look up something and noticed the hyperlink doesn't work.
While fixing that also noticed a trivial kerneldoc comment typo in the
same section, fix that too.

Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
 Documentation/driver-api/dma-buf.rst | 2 +-
 include/linux/dma-buf-map.h          | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Simon Ser Dec. 4, 2020, 8:39 p.m. UTC | #1
On Friday, December 4th, 2020 at 9:02 PM, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:

> I wanted to look up something and noticed the hyperlink doesn't work.
> While fixing that also noticed a trivial kerneldoc comment typo in the
> same section, fix that too.

Reviewed-by: Simon Ser <contact@emersion.fr>
Ruhl, Michael J Dec. 7, 2020, 9:54 p.m. UTC | #2
>-----Original Message-----
>From: dri-devel <dri-devel-bounces@lists.freedesktop.org> On Behalf Of
>Daniel Vetter
>Sent: Friday, December 4, 2020 3:03 PM
>To: DRI Development <dri-devel@lists.freedesktop.org>
>Cc: Daniel Vetter <daniel.vetter@ffwll.ch>; Vetter, Daniel
><daniel.vetter@intel.com>
>Subject: [PATCH] dma-buf: Fix kerneldoc formatting
>
>I wanted to look up something and noticed the hyperlink doesn't work.
>While fixing that also noticed a trivial kerneldoc comment typo in the
>same section, fix that too.
>
>Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
>---
> Documentation/driver-api/dma-buf.rst | 2 +-
> include/linux/dma-buf-map.h          | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>
>diff --git a/Documentation/driver-api/dma-buf.rst b/Documentation/driver-
>api/dma-buf.rst
>index d6b2a195dbed..a2133d69872c 100644
>--- a/Documentation/driver-api/dma-buf.rst
>+++ b/Documentation/driver-api/dma-buf.rst
>@@ -190,7 +190,7 @@ DMA Fence uABI/Sync File
> Indefinite DMA Fences
> ~~~~~~~~~~~~~~~~~~~~~
>
>-At various times &dma_fence with an indefinite time until dma_fence_wait()
>+At various times struct dma_fence with an indefinite time until
>dma_fence_wait()
> finishes have been proposed. Examples include:
>
> * Future fences, used in HWC1 to signal when a buffer isn't used by the
>display
>diff --git a/include/linux/dma-buf-map.h b/include/linux/dma-buf-map.h

Ahh, something to do while compiling...

Both changes look good to me.

Reviewed-by: Michael J. Ruhl <michael.j.ruhl@intel.com>

M

>index 583a3a1f9447..278d489e4bdd 100644
>--- a/include/linux/dma-buf-map.h
>+++ b/include/linux/dma-buf-map.h
>@@ -122,7 +122,7 @@ struct dma_buf_map {
>
> /**
>  * DMA_BUF_MAP_INIT_VADDR - Initializes struct dma_buf_map to an
>address in system memory
>- * @vaddr:	A system-memory address
>+ * @vaddr_:	A system-memory address
>  */
> #define DMA_BUF_MAP_INIT_VADDR(vaddr_) \
> 	{ \
>--
>2.29.2
>
>_______________________________________________
>dri-devel mailing list
>dri-devel@lists.freedesktop.org
>https://lists.freedesktop.org/mailman/listinfo/dri-devel
Daniel Vetter Dec. 9, 2020, 12:29 a.m. UTC | #3
On Mon, Dec 07, 2020 at 09:54:13PM +0000, Ruhl, Michael J wrote:
> >-----Original Message-----
> >From: dri-devel <dri-devel-bounces@lists.freedesktop.org> On Behalf Of
> >Daniel Vetter
> >Sent: Friday, December 4, 2020 3:03 PM
> >To: DRI Development <dri-devel@lists.freedesktop.org>
> >Cc: Daniel Vetter <daniel.vetter@ffwll.ch>; Vetter, Daniel
> ><daniel.vetter@intel.com>
> >Subject: [PATCH] dma-buf: Fix kerneldoc formatting
> >
> >I wanted to look up something and noticed the hyperlink doesn't work.
> >While fixing that also noticed a trivial kerneldoc comment typo in the
> >same section, fix that too.
> >
> >Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> >---
> > Documentation/driver-api/dma-buf.rst | 2 +-
> > include/linux/dma-buf-map.h          | 2 +-
> > 2 files changed, 2 insertions(+), 2 deletions(-)
> >
> >diff --git a/Documentation/driver-api/dma-buf.rst b/Documentation/driver-
> >api/dma-buf.rst
> >index d6b2a195dbed..a2133d69872c 100644
> >--- a/Documentation/driver-api/dma-buf.rst
> >+++ b/Documentation/driver-api/dma-buf.rst
> >@@ -190,7 +190,7 @@ DMA Fence uABI/Sync File
> > Indefinite DMA Fences
> > ~~~~~~~~~~~~~~~~~~~~~
> >
> >-At various times &dma_fence with an indefinite time until dma_fence_wait()
> >+At various times struct dma_fence with an indefinite time until
> >dma_fence_wait()
> > finishes have been proposed. Examples include:
> >
> > * Future fences, used in HWC1 to signal when a buffer isn't used by the
> >display
> >diff --git a/include/linux/dma-buf-map.h b/include/linux/dma-buf-map.h
> 
> Ahh, something to do while compiling...
> 
> Both changes look good to me.
> 
> Reviewed-by: Michael J. Ruhl <michael.j.ruhl@intel.com>

Thanks for taking a look, patch applied.
-Daniel

> 
> M
> 
> >index 583a3a1f9447..278d489e4bdd 100644
> >--- a/include/linux/dma-buf-map.h
> >+++ b/include/linux/dma-buf-map.h
> >@@ -122,7 +122,7 @@ struct dma_buf_map {
> >
> > /**
> >  * DMA_BUF_MAP_INIT_VADDR - Initializes struct dma_buf_map to an
> >address in system memory
> >- * @vaddr:	A system-memory address
> >+ * @vaddr_:	A system-memory address
> >  */
> > #define DMA_BUF_MAP_INIT_VADDR(vaddr_) \
> > 	{ \
> >--
> >2.29.2
> >
> >_______________________________________________
> >dri-devel mailing list
> >dri-devel@lists.freedesktop.org
> >https://lists.freedesktop.org/mailman/listinfo/dri-devel
diff mbox series

Patch

diff --git a/Documentation/driver-api/dma-buf.rst b/Documentation/driver-api/dma-buf.rst
index d6b2a195dbed..a2133d69872c 100644
--- a/Documentation/driver-api/dma-buf.rst
+++ b/Documentation/driver-api/dma-buf.rst
@@ -190,7 +190,7 @@  DMA Fence uABI/Sync File
 Indefinite DMA Fences
 ~~~~~~~~~~~~~~~~~~~~~
 
-At various times &dma_fence with an indefinite time until dma_fence_wait()
+At various times struct dma_fence with an indefinite time until dma_fence_wait()
 finishes have been proposed. Examples include:
 
 * Future fences, used in HWC1 to signal when a buffer isn't used by the display
diff --git a/include/linux/dma-buf-map.h b/include/linux/dma-buf-map.h
index 583a3a1f9447..278d489e4bdd 100644
--- a/include/linux/dma-buf-map.h
+++ b/include/linux/dma-buf-map.h
@@ -122,7 +122,7 @@  struct dma_buf_map {
 
 /**
  * DMA_BUF_MAP_INIT_VADDR - Initializes struct dma_buf_map to an address in system memory
- * @vaddr:	A system-memory address
+ * @vaddr_:	A system-memory address
  */
 #define DMA_BUF_MAP_INIT_VADDR(vaddr_) \
 	{ \