[prev in list] [next in list] [prev in thread] [next in thread] 

List:       alsa-devel
Subject:    Re: [PATCH v4 39/52] docs: writing-an-alsa-driver.rst: fix some bad c:func: markups
From:       Takashi Iwai <tiwai () suse ! de>
Date:       2020-09-30 14:58:20
Message-ID: s5ha6x7gvlf.wl-tiwai () suse ! de
[Download RAW message or body]

On Wed, 30 Sep 2020 15:25:02 +0200,
Mauro Carvalho Chehab wrote:
> 
> Some such markups are invalid, as reported by Sphinx:
> 
> 	./Documentation/sound/kernel-api/writing-an-alsa-driver.rst:3317: WARNING: \
> Unparseable C cross-reference: 'snd_rawmidi_transmit*'  Invalid C declaration: \
> Expected end of definition. [error at 20]  snd_rawmidi_transmit*
> 	  --------------------^
> 	./Documentation/sound/kernel-api/writing-an-alsa-driver.rst:3917: WARNING: \
> Unparseable C cross-reference: 'copy_from/to_user'  Invalid C declaration: Expected \
> end of definition. [error at 9]  copy_from/to_user
> 	  ---------^
> 
> The first case seems to be better replaced by a literal.
> 
> For the second one, let's generate cross-references, by
> spliting it in two.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Reviewed-by: Takashi Iwai <tiwai@suse.de>


thanks,

Takashi


[prev in list] [next in list] [prev in thread] [next in thread]