Re: [Intel-gfx] [PATCH v2 27/39] drm/i915: i915_scatterlist.h: fix some kernel-doc markups

Rodrigo Vivi
2022-07-16T14:43:49Z

On Wed, Jul 13, 2022 at 09:12:15AM +0100, Mauro Carvalho Chehab wrote:
> Building docs currently produces this warning:
>
> Documentation/foo/i915:159: ./drivers/gpu/drm/i915/i915_scatterlist.h:73: WARNING: Inline strong start-string without end-string.
>
> That's because @foo evaluates into **foo**, and placing anything
> after it without spaces cause Sphinx to warn and do the wrong
> thing.. So, replace them by a different Sphinx-compatible tag.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>

Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>

> ---
>
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH v2 00/39] at: https://lore.kernel.org/all/cover.1657699522.git.mchehab@kernel.org/
>
> drivers/gpu/drm/i915/i915_scatterlist.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/i915/i915_scatterlist.h b/drivers/gpu/drm/i915/i915_scatterlist.h
> index 0b8bf4be4330..5b5c4eee0f44 100644
> --- a/drivers/gpu/drm/i915/i915_scatterlist.h
> +++ b/drivers/gpu/drm/i915/i915_scatterlist.h
> @@ -70,7 +70,7 @@ static inline struct scatterlist *____sg_next(struct scatterlist *sg)
> *
> * Description:
> * If the entry is the last, return NULL; otherwise, step to the next
> - * element in the array (@sg@+1). If that's a chain pointer, follow it;
> + * element in the array (``sg@+1``). If that's a chain pointer, follow it;
> * otherwise just return the pointer to the current element.
> **/
> static inline struct scatterlist *__sg_next(struct scatterlist *sg)
> --
> 2.36.1
>