> Am 09.09.2017 um 18:46 schrieb Randy Dunlap <rdunlap@xxxxxxxxxxxxx>:
>
> Hi,
>
> What is the suggested way(s) to fix this warning:
>
> ../kernel/sched/fair.c:7584: WARNING: Inline emphasis start-string without end-string.
>
> from this source:
>
> * this CPU. The amount of the imbalance is returned in *imbalance.
>
>
> I have a patch that changes that to env->imbalance, but what I am really looking
> for is a way to include a '*' in the kernel-doc, for cases like this:
>
> /**
> * foofunc - do the bar and update its value
> * @bar: pointer to input value, to be updated for return
> *
> * fu the *bar with baz
> */
> void foofunc(unsigned long long *bar, unsigned long long baz)
> {
> *bar = *bar + 42 * baz;
> *bar %= baz;
> }
>
Hy Randy,
since kernel-doc comments are reST markup, I recommend to use ``*bar``
which is rendered as "inline literal" (monspace).
see ``inline literal``:
http://docutils.sourceforge.net/docs/user/rst/quickref.html#inline-markup
One to alternative to "inline literal" is to escape reST markup with a
backslash, e.g.: \*bar
For backslash escape see:
http://docutils.sourceforge.net/docs/user/rst/quickref.html#escaping
-- Markus --
>
> thanks.
> --
> ~Randy
> --
> To unsubscribe from this list: send the line "unsubscribe linux-doc" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at http://vger.kernel.org/majordomo-info.html
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
