Re: [PATCH] [media] doc-rst: Fix some Sphinx warnings

[Mauro Carvalho Chehab <mchehab@s-opensource.com>]

Em Wed, 20 Jul 2016 09:32:15 -0300
Mauro Carvalho Chehab <mchehab@s-opensource.com> escreveu:

> Fix all remaining media warnings with ReST that are fixable
> without changing at the Sphinx code.
> 

> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> index 83877719bef4..3d885d97d149 100644
> --- a/include/media/media-entity.h
> +++ b/include/media/media-entity.h
> @@ -180,8 +180,10 @@ struct media_pad {
>   *			view. The media_entity_pipeline_start() function
>   *			validates all links by calling this operation. Optional.
>   *
> - * .. note:: Those these callbacks are called with struct media_device.@graph_mutex
> - * mutex held.
> + * .. note::
> + *
> + *    Those these callbacks are called with struct media_device.@graph_mutex
> + *    mutex held.
>   */

The kernel-doc script did something wrong here... something bad
happened with "@graph_mutex". While it is showing the note box
properly, the message inside is:

	"Note

	 Those these callbacks are called with struct media_device.**graph_mutex** mutex held."


E. g. it converted @ to "**graph_mutex**" and some code seemed to
change it to: "\*\*graph_mutex\*\*", as this message is not showing
with a bold font, but, instead, with the double asterisks.

No idea how to fix it.

Thanks,
Mauro