[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v6 9/9] docs/doxygen: doxygen documentation for grant_table.h


  • To: Stefano Stabellini <sstabellini@xxxxxxxxxx>
  • From: Luca Fancellu <luca.fancellu@xxxxxxx>
  • Date: Fri, 2 Jul 2021 12:01:06 +0100
  • Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=arm.com; dmarc=pass action=none header.from=arm.com; dkim=pass header.d=arm.com; arc=none
  • Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=+uRhU4AslYb7IzQtRiQCkU8K6Wvpoh3wjruFiJ715nI=; b=jihwjj7qwUpTBDtb8m9/iR3RG/YbFzd/45kMgbBa9aM72Tnd7cWpdZGmmnLH/2JMWlyEKampQ2y6zuRM42BGr3w3kkG+Gw4prY1prO4WvQK/YW1lYvOq9MkvIvX/PSlGSv9cBnPPcfv9Ot1jrrgpXhhkGdTnqlN1mj90IPjjlEGWSa+mUw4riKwykm2DXbALLPvYY4LZ8O6YOCN6Z87mZk857cYPardFewXqKjHEWn/ByBI1UjC5G/6dHV36NBfA50hQ9VP1puUf7vqIcQ2RvBH28W0HoR8j648ZJ9FRzJTaYs2uVN7u5CZ6UyBz1OHMnx1a0HgKmBBzdnZk1ho/7A==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=E7hgOx7q9j482y+72cuLBiTRM6XghXxYeCUw4oT0TAQL7GExmYJAX9w/E6KTbsOyVNopeAk1L/z4dW2P6T6unX+qnafOsyxAh7yrkcreEDmd7YLXlXpBDCeZwj9DfpDCnNTnJyO7591BWuUaC96K6iLj7V/xEY1V5tvomeNaa0Ss8WMMGUp0m4j49r/UMiylQR+U6tOldx28bi/a78/xjqeppZomR15ukShnrdQGma2Xmv02/cNJiFlzmub2qKiJvtT4SVCDA1x0khDn0KUCV2vaBqBKuDP99zy5DjjC0LoliutG7jSCfLpYz1YTS8TzLIXaoS8j8VWLeixgsxB4uQ==
  • Authentication-results-original: kernel.org; dkim=none (message not signed) header.d=none;kernel.org; dmarc=none action=none header.from=arm.com;
  • Cc: xen-devel@xxxxxxxxxxxxxxxxxxxx, Bertrand Marquis <bertrand.marquis@xxxxxxx>, wei.chen@xxxxxxx, Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, George Dunlap <george.dunlap@xxxxxxxxxx>, Ian Jackson <iwj@xxxxxxxxxxxxxx>, Jan Beulich <jbeulich@xxxxxxxx>, Julien Grall <julien@xxxxxxx>, Wei Liu <wl@xxxxxxx>
  • Delivery-date: Fri, 02 Jul 2021 11:02:05 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
  • Nodisclaimer: true
  • Original-authentication-results: kernel.org; dkim=none (message not signed) header.d=none;kernel.org; dmarc=none action=none header.from=arm.com;


> On 1 Jul 2021, at 18:44, Stefano Stabellini <sstabellini@xxxxxxxxxx> wrote:
> 
> On Thu, 1 Jul 2021, Luca Fancellu wrote:
>> Hi Stefano,
>> 
>>> On 24 Jun 2021, at 00:34, Stefano Stabellini <sstabellini@xxxxxxxxxx> wrote:
>>> 
>>> On Mon, 10 May 2021, Luca Fancellu wrote:
>>>> Modification to include/public/grant_table.h:
>>>> 
>>>> 1) Add doxygen tags to:
>>>> - Create Grant tables section
>>>> - include variables in the generated documentation
>>>> - Used @keepindent/@endkeepindent to enclose comment
>>>>  section that are indented using spaces, to keep
>>>>  the indentation.
>>>> 2) Add .rst file for grant table for Arm64
>>> 
>>> Why only arm64?
>> 
>> This is a mistake, it should be just “Add .rst file for grant table"
>> 
>>> 
>>> 
>>>> Signed-off-by: Luca Fancellu <luca.fancellu@xxxxxxx>
>>>> ---
>>>> v6 changes:
>>>> - Fix misaligned comment
>>>> - Moved comments to make them display in the docs
>>>> - Included more documentation in the docs
>>>> (see output here: 
>>>> https://luca.fancellu.gitlab.io/xen-docs/hypercall-interfaces/common/grant_tables.html)
>>> 
>>> It looks much much better. All the info we care about seems to be there.
>>> The only things that I noticed missing and might be good to keep is the
>>> small comment about HYPERVISOR_grant_table_op:
>>> 
>>> /* ` enum neg_errnoval
>>> * ` HYPERVISOR_grant_table_op(enum grant_table_op cmd,
>>> * `                           void *args,
>>> * `                           unsigned int count)
>>> * `
>>> *
>>> * @args points to an array of a per-command data structure. The array
>>> * has @count members
>> 
>> Where do you want me to put this comment in the html page? In the end of the 
>> description in the top of the page?
> 
> Yeah, that looks like a good place

Great, for a preview, have a look on this: 
https://luca.fancellu.gitlab.io/xen-docs/hypercall-interfaces/common/grant_tables.html




 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.