linux-kernel - Re: [PATCH] sound: fix kernel-doc build warning

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] [day] [month] [year] [list]

Message-ID: <s5hinexf6ue.wl-tiwai@suse.de>
Date:   Mon, 30 Oct 2017 08:11:21 +0100
From:   Takashi Iwai <tiwai@...e.de>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     moderated for non-subscribers <alsa-devel@...a-project.org>,
        Jaroslav Kysela <perex@...ex.cz>,
        LKML <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] sound: fix kernel-doc build warning

On Mon, 30 Oct 2017 01:08:52 +0100,
Randy Dunlap wrote:
> 
> From: Randy Dunlap <rdunlap@...radead.org>
> 
> Fix kernel-doc build error. A symbol that ends with an underscore
> character ('_') has special meaning in reST (reStructuredText), so add
> a '*' to prevent this error and to indicate that there are several of
> these values to choose from.
> 
> ../sound/core/jack.c:312: ERROR: Unknown target name: "snd_jack_btn".
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc:	Jaroslav Kysela <perex@...ex.cz>
> Cc:	Takashi Iwai <tiwai@...e.com>
> Cc:	alsa-devel@...a-project.org

Thanks, applied.

I vaguely remember that we had this because the asterisk caused an
error with the old kerneldoc before ReST.


Takashi