[PATCH] dma-buf: fix htmldocs error for dma_buf_attach_revocable

[PATCH] dma-buf: fix htmldocs error for dma_buf_attach_revocable

[Sumit Semwal]

linux-next testing showed this htmldoc error due to a missing extra
line in the comments; add it.

Fixes: be6d4c9e9d714 ("dma-buf: Add dma_buf_attach_revocable()")
Reported-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Sumit Semwal <sumit.semwal@linaro.org>
---
 drivers/dma-buf/dma-buf.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/dma-buf/dma-buf.c b/drivers/dma-buf/dma-buf.c
index a202a308c079..532c3f14bf9d 100644
--- a/drivers/dma-buf/dma-buf.c
+++ b/drivers/dma-buf/dma-buf.c
@@ -1353,6 +1353,7 @@ EXPORT_SYMBOL_NS_GPL(dma_buf_attach_revocable, "DMA_BUF");
  * Upon return importers may continue to access the DMA-buf memory. The caller
  * must do two additional waits to ensure that the memory is no longer being
  * accessed:
+ *
  *  1) Until dma_resv_wait_timeout() retires fences the importer is allowed to
  *     fully access the memory.
  *  2) Until the importer calls unmap it is allowed to speculatively
-- 
2.51.1

Re: [PATCH] dma-buf: fix htmldocs error for dma_buf_attach_revocable

[Christian König]

On 4/10/26 14:37, Sumit Semwal wrote:
> linux-next testing showed this htmldoc error due to a missing extra
> line in the comments; add it.
> 
> Fixes: be6d4c9e9d714 ("dma-buf: Add dma_buf_attach_revocable()")
> Reported-by: Mark Brown <broonie@kernel.org>
> Signed-off-by: Sumit Semwal <sumit.semwal@linaro.org>

Reviewed-by: Christian König <christian.koenig@amd.com>

> ---
>  drivers/dma-buf/dma-buf.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/dma-buf/dma-buf.c b/drivers/dma-buf/dma-buf.c
> index a202a308c079..532c3f14bf9d 100644
> --- a/drivers/dma-buf/dma-buf.c
> +++ b/drivers/dma-buf/dma-buf.c
> @@ -1353,6 +1353,7 @@ EXPORT_SYMBOL_NS_GPL(dma_buf_attach_revocable, "DMA_BUF");
>   * Upon return importers may continue to access the DMA-buf memory. The caller
>   * must do two additional waits to ensure that the memory is no longer being
>   * accessed:
> + *
>   *  1) Until dma_resv_wait_timeout() retires fences the importer is allowed to
>   *     fully access the memory.
>   *  2) Until the importer calls unmap it is allowed to speculatively

Re: [PATCH] dma-buf: fix htmldocs error for dma_buf_attach_revocable

[Sumit Semwal]

Hi Christian,

On Fri, 10 Apr 2026 at 18:14, Christian König <christian.koenig@amd.com> wrote:
>
> On 4/10/26 14:37, Sumit Semwal wrote:
> > linux-next testing showed this htmldoc error due to a missing extra
> > line in the comments; add it.
> >
> > Fixes: be6d4c9e9d714 ("dma-buf: Add dma_buf_attach_revocable()")
> > Reported-by: Mark Brown <broonie@kernel.org>
> > Signed-off-by: Sumit Semwal <sumit.semwal@linaro.org>
>
> Reviewed-by: Christian König <christian.koenig@amd.com>

Thank you; pushed to drm-misc-next-fixes!

Best,
Sumit
>
> > ---
> >  drivers/dma-buf/dma-buf.c | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/drivers/dma-buf/dma-buf.c b/drivers/dma-buf/dma-buf.c
> > index a202a308c079..532c3f14bf9d 100644
> > --- a/drivers/dma-buf/dma-buf.c
> > +++ b/drivers/dma-buf/dma-buf.c
> > @@ -1353,6 +1353,7 @@ EXPORT_SYMBOL_NS_GPL(dma_buf_attach_revocable, "DMA_BUF");
> >   * Upon return importers may continue to access the DMA-buf memory. The caller
> >   * must do two additional waits to ensure that the memory is no longer being
> >   * accessed:
> > + *
> >   *  1) Until dma_resv_wait_timeout() retires fences the importer is allowed to
> >   *     fully access the memory.
> >   *  2) Until the importer calls unmap it is allowed to speculatively
>

Claude review: dma-buf: fix htmldocs error for dma_buf_attach_revocable

[Claude Code Review Bot]

Overall Series Review

Subject: dma-buf: fix htmldocs error for dma_buf_attach_revocable
Author: Sumit Semwal <sumit.semwal@linaro.org>
Patches: 3
Reviewed: 2026-04-12T09:39:23.643607

---

This is a trivial single-patch series that fixes a kernel-doc (htmldocs) formatting error introduced by commit `be6d4c9e9d714` ("dma-buf: Add dma_buf_attach_revocable()"). The fix is correct and minimal — it adds a single blank comment line between a paragraph and a numbered list in the `dma_buf_invalidate_mappings()` kernel-doc comment, which is required by the RST/kernel-doc parser to properly render the list.

The patch is well-formed: it has appropriate Fixes tag, Reported-by, and Signed-off-by. No concerns.

**Verdict: Looks good to merge.**

---
Generated by Claude Code Patch Reviewer

Claude review: dma-buf: fix htmldocs error for dma_buf_attach_revocable

[Claude Code Review Bot]

Patch Review

**Status: Looks good (Reviewed-by worthy)**

The problem: In the kernel-doc comment for `dma_buf_invalidate_mappings()`, the text:

```c
 * accessed:
 *  1) Until dma_resv_wait_timeout() ...
```

is missing a blank comment line between the paragraph ending in `:` and the start of the numbered list. The RST parser doesn't recognize the numbered list without that separator.

The fix adds the required blank `*` line:

```c
 * accessed:
 *
 *  1) Until dma_resv_wait_timeout() ...
```

This is the standard kernel-doc convention — a blank `*` line is needed before a list block for proper RST rendering. I confirmed the current tree at `drivers/dma-buf/dma-buf.c:1355-1356` has exactly this missing blank line.

**Minor nit (non-blocking):** The subject says "for dma_buf_attach_revocable" but the comment being fixed is actually on `dma_buf_invalidate_mappings()`. The Fixes tag correctly points to the commit that introduced the problematic comment, but the subject could be slightly more precise as "fix htmldocs error for dma_buf_invalidate_mappings". This is cosmetic and not worth a respin.

No functional or correctness issues. The patch is trivially correct.

---
Generated by Claude Code Patch Reviewer