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

Re: [PATCH v3] docs: fusa: Add Assumption of Use (AoU)


  • To: Bertrand Marquis <Bertrand.Marquis@xxxxxxx>, Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
  • From: Ayan Kumar Halder <ayankuma@xxxxxxx>
  • Date: Tue, 24 Sep 2024 09:43:01 +0100
  • Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=amd.com; dmarc=pass action=none header.from=amd.com; dkim=pass header.d=amd.com; arc=none
  • Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=dIjGWEfYrFmnz/963cl5kZFbXNPlCnciUu4ddZctey0=; b=J8yPVfqjpcrXl4okesXn+Fl72swgTY0Xiq/09dTSJNUJBpNWF2WpT1i1hn0dJaTjAt3Rh/ux2k/4NkmPezfR6q2XaXxVJ9BWjDRlKWD1uwUY7wY/2NyrM8phK1Z9OjCQVid34aEyfBD7n3vTOd1uUQY7yYuoZ3yb04HP71V34AOMtLsLVr1UrNaQ0O5p1cZ6QImSVT2CzvjolZOL7C7Js3JH69ud75CGzaEW68HGVW6bdsemj2hhg1runS57yRUCLcNWnkRaYQ7V6iC8jSY74CC2eaenHRQmgsN5B990c3s0KXWrF+a2u1bT6XZOGcB15iDnJKxw090Sher53BJAew==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=JuYEkshVwZdjT3yjiS61grGYn3+r+E4+VXN1c5pMm/cNiauMYwYdRvObuDCG0y4UD7vvXOIlOoDZGEznxRGvSdQu2/jRplKOKmq3IEuJqJnyVfMk1307+7SpgHLqvHG3kSpjYTDfwuPBC5VL33eGoKQGcB4gKBFp3jlxjXJW3jhfTg5LZSUJQJNQTkshbaSmRt7JC6mLOsSdq262VE3uQLCDfpTMhLRJbCsRiEahGxf5BkGQp34797Zi2HQa0EtDpSAP4NKruqA3umJAe46ek/KpM3ynXl4e9Hj6kkxMda0CIER/NcVit4MNKrJNnMOdGTr7lC/96Biiter282pOYA==
  • Authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=amd.com;
  • Cc: Ayan Kumar Halder <ayan.kumar.halder@xxxxxxx>, Xen-devel <xen-devel@xxxxxxxxxxxxxxxxxxxx>, Michal Orzel <michal.orzel@xxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, Artem Mygaiev <artem_mygaiev@xxxxxxxx>, Hisao Munakata <hisao.munakata.vt@xxxxxxxxxxx>, Julien Grall <julien@xxxxxxx>, Julien Grall <jgrall@xxxxxxxxxx>
  • Delivery-date: Tue, 24 Sep 2024 08:43:21 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>


On 24/09/2024 09:32, Bertrand Marquis wrote:
Hi Andrew,
Hi Andrew/Bertrand,

On 24 Sep 2024, at 10:15, Andrew Cooper <andrew.cooper3@xxxxxxxxxx> wrote:

On 24/09/2024 8:14 am, Bertrand Marquis wrote:
diff --git a/docs/fusa/reqs/intro.rst b/docs/fusa/reqs/intro.rst
index 245a219ff2..aa85ff821c 100644
--- a/docs/fusa/reqs/intro.rst
+++ b/docs/fusa/reqs/intro.rst
@@ -38,6 +38,16 @@ The requirements are linked using OpenFastTrace
OpenFastTrace parses through the requirements and generates a traceability
report.

+Assumption of Use
+=================
+
+To fulfill one or more design requirements, there may be underlying assumptions
+on one or more components that Xen interacts with directly or indirectly. For
+eg, there may be assumptions on the underlying platform (hardware + firmware +
+bootloader) to set certain registers, etc. The important thing here is that
+anyone who validates these requirements, need to consider the assumption on the
+other components.
I think there is a typo.
I would simplify a bit:
Xen is making several assumptions on the status of the platform or on some
functions being present and functional.
s/functional/functionality.
no that sounds weird, functional is right in the sentence i think.
"functional" is correct grammar here.  "functionality" would not be.
Yes, I have left it as "functional" in my v4. I saw this message after I had sent out the patch.

However, "functions being present and functional" less than ideal.  I'd
suggest "present and working", "present and operational" instead, or to
rework the first "functions" into something else.
"Present and operational" sounds good to me as they might be working
but be deactivated by firmware for example.

I think the definition of AoU, seems clear to us.

Also any of the suggestions made by Andrew or Bertrand seems ok. (I don't have any opinion which one sounds better).

I will leave it to Stefano to fix the patch on commit (as suggested by Bertrand in v4).

- Ayan




 


Rackspace

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