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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Am 20.07.2016 um 15:00 schrieb Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>:

> Em Wed, 20 Jul 2016 09:32:15 -0300
> Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> 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 for reporting ..
I guess it is the kernel-doc parser, currently I'am trying to eliminate
some base fails of the kernel-doc parser (e.g. you mailed handling of 
c functions) .. for this I test with your media_tree/doc-next ..
if you commit this to your doc-next I have an example (or where could I get it)
I will take a look about this also .. .. give me some time ;-)

-- Markus --

> 
> Thanks,
> Mauro
> --
> To unsubscribe from this list: send the line "unsubscribe linux-media" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux