From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.9 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,INCLUDES_CR_TRAILER,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id E790AC07E95 for ; Fri, 2 Jul 2021 20:22:19 +0000 (UTC) Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id A1BC861164 for ; Fri, 2 Jul 2021 20:22:19 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org A1BC861164 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Received: from list by lists.xenproject.org with outflank-mailman.149332.276112 (Exim 4.92) (envelope-from ) id 1lzPff-0006Ta-33; Fri, 02 Jul 2021 20:21:55 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 149332.276112; Fri, 02 Jul 2021 20:21:55 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lzPff-0006TT-01; Fri, 02 Jul 2021 20:21:55 +0000 Received: by outflank-mailman (input) for mailman id 149332; Fri, 02 Jul 2021 20:21:53 +0000 Received: from us1-rack-iad1.inumbo.com ([172.99.69.81]) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lzPfd-0006TN-B2 for xen-devel@lists.xenproject.org; Fri, 02 Jul 2021 20:21:53 +0000 Received: from mail.kernel.org (unknown [198.145.29.99]) by us1-rack-iad1.inumbo.com (Halon) with ESMTPS id 85a8db1a-5c85-477b-8308-ad06038d411d; Fri, 02 Jul 2021 20:21:52 +0000 (UTC) Received: by mail.kernel.org (Postfix) with ESMTPSA id C20356135C; Fri, 2 Jul 2021 20:21:51 +0000 (UTC) X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 85a8db1a-5c85-477b-8308-ad06038d411d DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1625257312; bh=3+1YcGhflKHl8OpcsTPtGA8KDvz83imejjTVs+ylYh0=; h=Date:From:To:cc:Subject:In-Reply-To:References:From; b=Y0Kch2H7zr5Ri4/kM40qBxllmmjbe6wpcRRiVUXYPDIk3pjErcYgP/RdLXvbPSlOe IyC753h8MhHdNVEVIeJeZP7PugY+SQMb+wEiCD8WY8Fal/ACu81aCFwk+3XaKV2hLt ZDPXqH3hf7nJWIrK5oVudVB9P/BME/iPoOPJq6w7IJScej9DUqWHPworbjH1T5PBsd tR/201Fs7xBu6Cl4Cun795ZVhZDMXonsOh2RVBp09nKTz7hj0+DHVTo63wePSCGSDk jN19uhXKfizBui+Oo8L1Bt+TxuRTqAksb+/4xYepZT8SOgacJEKcNOGow98XBVxsNX 8skinA0SbvqYg== Date: Fri, 2 Jul 2021 13:21:51 -0700 (PDT) From: Stefano Stabellini X-X-Sender: sstabellini@sstabellini-ThinkPad-T480s To: Luca Fancellu cc: Stefano Stabellini , xen-devel@lists.xenproject.org, Bertrand Marquis , wei.chen@arm.com, Andrew Cooper , George Dunlap , Ian Jackson , Jan Beulich , Julien Grall , Wei Liu Subject: Re: [PATCH v6 9/9] docs/doxygen: doxygen documentation for grant_table.h In-Reply-To: <4E85233D-5371-4862-A0A5-2B653C677D54@arm.com> Message-ID: References: <20210510084105.17108-1-luca.fancellu@arm.com> <20210510084105.17108-10-luca.fancellu@arm.com> <31171081-1007-4B4E-91CC-25EA1041EB58@arm.com> <4E85233D-5371-4862-A0A5-2B653C677D54@arm.com> User-Agent: Alpine 2.21 (DEB 202 2017-01-01) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="8323329-961216169-1625257312=:9437" This message is in MIME format. The first part should be readable text, while the remaining parts are likely unreadable without MIME-aware tools. --8323329-961216169-1625257312=:9437 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8BIT On Fri, 2 Jul 2021, Luca Fancellu wrote: > > On 1 Jul 2021, at 18:44, Stefano Stabellini wrote: > > > > On Thu, 1 Jul 2021, Luca Fancellu wrote: > >> Hi Stefano, > >> > >>> On 24 Jun 2021, at 00:34, Stefano Stabellini 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 > >>>> --- > >>>> 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 Looks good! --8323329-961216169-1625257312=:9437--