linux-kernel - Re: [PATCH v4 39/52] docs: writing-an-alsa-driver.rst: fix some bad c:func: markups

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 30 Sep 2020 16:58:20 +0200
From:   Takashi Iwai <tiwai@...e.de>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Arnd Bergmann <arnd@...db.de>,
        Jaroslav Kysela <perex@...ex.cz>,
        Julia Lawall <Julia.Lawall@...ia.fr>,
        Takashi Iwai <tiwai@...e.com>, alsa-devel@...a-project.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v4 39/52] docs: writing-an-alsa-driver.rst: fix some bad c:func: markups

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@...nel.org>

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


thanks,

Takashi