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

Message-ID: <b23981e7-655c-f99e-82cf-0082084774d6@infradead.org>
Date:   Sun, 29 Oct 2017 17:08:52 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     moderated for non-subscribers <alsa-devel@...a-project.org>,
        Takashi Iwai <tiwai@...e.de>, Jaroslav Kysela <perex@...ex.cz>
Cc:     LKML <linux-kernel@...r.kernel.org>
Subject: [PATCH] sound: fix kernel-doc build warning

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
---
 sound/core/jack.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- lnx-414-rc7.orig/sound/core/jack.c
+++ lnx-414-rc7/sound/core/jack.c
@@ -310,7 +310,7 @@ EXPORT_SYMBOL(snd_jack_set_parent);
  * @type:    Jack report type for this key
  * @keytype: Input layer key type to be reported
  *
- * Map a SND_JACK_BTN_ button type to an input layer key, allowing
+ * Map a SND_JACK_BTN_* button type to an input layer key, allowing
  * reporting of keys on accessories via the jack abstraction.  If no
  * mapping is provided but keys are enabled in the jack type then
  * BTN_n numeric buttons will be reported.