diff mbox

sound: fix kernel-doc build warning

Message ID b23981e7-655c-f99e-82cf-0082084774d6@infradead.org (mailing list archive)
State New, archived
Headers show

Commit Message

Randy Dunlap Oct. 30, 2017, 12:08 a.m. UTC 
From: Randy Dunlap <rdunlap@infradead.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@infradead.org>
Cc:	Jaroslav Kysela <perex@perex.cz>
Cc:	Takashi Iwai <tiwai@suse.com>
Cc:	alsa-devel@alsa-project.org
---
 sound/core/jack.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Takashi Iwai Oct. 30, 2017, 7:11 a.m. UTC | #1 
On Mon, 30 Oct 2017 01:08:52 +0100,
Randy Dunlap wrote:
> 
> From: Randy Dunlap <rdunlap@infradead.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@infradead.org>
> Cc:	Jaroslav Kysela <perex@perex.cz>
> Cc:	Takashi Iwai <tiwai@suse.com>
> Cc:	alsa-devel@alsa-project.org

Thanks, applied.

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


Takashi
diff mbox

Patch

--- 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.