On 09/10/17 01:11, Markus Heiser wrote:
>
>> 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 --
A different "problem" this time:
Documentation/driver-api/basics.rst pulls in include/linux/kernel.h.
<linux/kernel.h> has kernel-doc notation for (among others) trace_printk()
and trace_puts().
Part of the text for trace_printk() says:
* Note: __trace_printk is an internal function for trace_printk and
* the @ip is passed in via the trace_printk macro.
I am seeing this 'produced' (when I view the output html) as:
__trace_printk is an internal function for trace_printk and
the ip is passed in via the trace_printk macro.
(BUT the first line is all BOLD).
I tried changing that to
\_\_trace_printk is an internal function...
with the same BOLD result.
So I tried the source as
``__trace_printk`` is an internal function...
with the same BOLD result.
Maybe this is a s/w bug?
Running Sphinx v1.3.1
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
