Re: [PATCH v3 3/3] docs/doxygen: doxygen documentation for grant_table.h

[Jan Beulich <jbeulich@xxxxxxxx>]

On 29.04.2021 11:50, Luca Fancellu wrote:
>> On 29 Apr 2021, at 10:04, Jan Beulich <jbeulich@xxxxxxxx> wrote:
>> On 28.04.2021 16:59, Luca Fancellu wrote:
>>>> On 27 Apr 2021, at 14:57, Jan Beulich <jbeulich@xxxxxxxx> wrote:
>>>> On 26.04.2021 17:37, Luca Fancellu wrote:
>>>>> @@ -120,24 +132,26 @@ typedef uint32_t grant_ref_t;
>>>>> * [GST]: This field is written by the guest and read by Xen.
>>>>> */
>>>>>
>>>>> -/*
>>>>> - * Version 1 of the grant table entry structure is maintained purely
>>>>> - * for backwards compatibility.  New guests should use version 2.
>>>>> - */
>>>>> #if __XEN_INTERFACE_VERSION__ < 0x0003020a
>>>>> #define grant_entry_v1 grant_entry
>>>>> #define grant_entry_v1_t grant_entry_t
>>>>> #endif
>>>>> +/**
>>>>> + * Version 1 of the grant table entry structure is maintained purely
>>>>> + * for backwards compatibility.  New guests should use version 2.
>>>>> + */
>>>>
>>>> In case I didn't say so already before - I think this would be a good
>>>> opportunity to drop the comment pointing at v2. With v2 optionally
>>>> unavailable altogether, this can't possibly be a generally valid
>>>> course of action.
>>>
>>> Could you explain me better that? Do you want to get rid of this comment?
>>
>> Especially the second sentence is misleading. If new code used v2, it
>> would not work on Xen with v2 support turned off.
> 
> Can you suggest what to write here? I’m not very familiar with this xen
> Interface

I've sent a patch myself just a few seconds ago.

Jan