Re: [Xen-devel] [PATCH 3/4] xen/public: Document HYPERCALL_console_io()

["Jan Beulich" <JBeulich@xxxxxxxx>]

>>> On 16.04.19 at 11:54, <julien.grall@xxxxxxx> wrote:
> On 4/9/19 12:42 PM, Jan Beulich wrote:
>>>>> On 09.04.19 at 13:26, <julien.grall@xxxxxxx> wrote:
>>> On 03/04/2019 14:04, Jan Beulich wrote:
>>>> Also please note the quotation used by the mentioned
>>>> existing doc comments, as well as a few other formal aspects
>>>> (like them also making clear what the return type is). I think
>>>> that's a model used elsewhere as well, so I think you should
>>>> follow it here.
>>>
>>> I haven't replicated the ` because I have no idea what they are used for. I
>>> would appreciate if you provide pointer how to use them.
>> 
>> Well, I can only point you at the history of things, e.g.
>> 262e118a37 "docs/html/: Annotations for two hypercalls".
> 
> Thank you for the pointer. However, we don't seem to use this formatting 
> everywhere. For instance, the formatting used in my patch seems to be 
> consistent with xen/include/public/vcpu.h.
> 
> Furthermore, the description of the hypercall is done on top of the 
> definition of the hypercall number. Before I rework this patch, could we 
> agree on what formatting we want?

Well, FAOD (see Ian's earlier reply) the style to be used is as suggested,
and eventually vcpu.h should be switched too.

Jan



_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/mailman/listinfo/xen-devel