[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v3] docs: fusa: Add Assumption of Use (AoU)
- To: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
- From: Bertrand Marquis <Bertrand.Marquis@xxxxxxx>
- Date: Tue, 24 Sep 2024 08:32:23 +0000
- Accept-language: en-GB, en-US
- Arc-authentication-results: i=2; mx.microsoft.com 1; spf=pass (sender ip is 63.35.35.123) smtp.rcpttodomain=lists.xenproject.org smtp.mailfrom=arm.com; dmarc=pass (p=none sp=none pct=100) action=none header.from=arm.com; dkim=pass (signature was verified) header.d=arm.com; arc=pass (0 oda=1 ltdi=1 spf=[1,1,smtp.mailfrom=arm.com] dkim=[1,1,header.d=arm.com] dmarc=[1,1,header.from=arm.com])
- 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=2; 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=E/GPS2Ndk/UfblQ3M8tOdpi0q3J9AFosfAuR8lPmrbU=; b=cci8tDGnPRGXtuht0nzqQBJL/IxcQv+eApAeMx4pTt5ivz+qCpY5lmFUl6bPxLMV8bwZE2xaMDob5z29DWwn0jWDAKVOK+Y9r/JgGR5Z8S6xVwdf8klejW88bY2r7bnOEttgvJlzdzXuSFOexF+6JDlc/J7WpnQ4RLH/m/JbH6aSx2pzR0mp7rklF5kQSdsVSvEeKkUFS3+4PwFNLfhyIBRCpXRlBHmCbN7rToaem2cN2CO8BHq990JfI7HGeX+ZLKWT6tYowXKBpzrxRG8cGguqp8Q5RqrUkhEPUMfB+0qyHfXUlMRVVDx5LTBi+/OPySRGtS+JZopPbI3jn3kZcA==
- 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=E/GPS2Ndk/UfblQ3M8tOdpi0q3J9AFosfAuR8lPmrbU=; b=maIiIFGFIOx05i2om79g2GJrEXT2kJQThAFpkl48Kn3d0JutNgDucAoXC5RvGkluF6/A0sWtOA7XhUf7t0C+gkG0nb+yXq6m7Dn2h0hDGPK+OzauuqHoX4iqkATpCkn9vBJAcNXnkwIAAU2drtIcqb1a6C9kPGLOpcnQWZydUUToKEqus4s1oER4yHvxFqHWtQ5YvHTUnCrDmRxA3CdjZV2B3wemtFkeIzDalh/1wkjiAxhyxs+Sd3TZLbrl1oshvPJlLTUJrsK7m+gKgFeMOvznQWhW+05EUYeUgp48KOjjkbRVs3GapWxvXN3cYPT0SjeQJIuZUh5n+ibu4oZ2oQ==
- Arc-seal: i=2; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=pass; b=RGNqMQ/GLmZjvp9niV3kd/u+gGE+HyW+srqiSpQWfoR7g01nZ1fHoY6b/AehaVmL0ZZ7u84WCZoB6pvYaxr+gOFnIIAuNkT12kxG2Htje9fBw0sF2ZrGooaGj+zXhG8EvIylm57F3ogIBcmyc7a8NNYXRLpk0LVBFJJBtdcIDvlf2njiSoij7sSm8ewL6DMQYj8hD34Ymoe2Cly9OXwrr3ECPCDF0Ozb/0QZr4QImCBHTRShBeai5cLnke0z0fhof0o99foo/D18lDMFTpNL0HE4RnokRJnnJQQM5XbFL2K/0zDOQgDCyeFx3VbrXJ9JHGh5Dbzp/BOAinLP/myriw==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=fIxu8aOrXU+drewKzxNyFlOQXP6+fdNzSEoBP9CHENIER9EVCm0EhB/n+XqwkMuVq/vBeJ1atCgcWlTjdiCD10ciA4P696yQqyaQYB+7G+c5YFfOlnhZ0Ym/q+0798vL8hvVTvR2aLMEPqQfYe1lKwdH9sEzttE+TI2rTelMvRK+jw0XBRdgs+dTytnGlCarpGMWsaJaoQsERLac74TyYmwMrsr5QlXg/BHLSk7ZZPwjSK0597ggaJCNzNR7zDuuaqOW5DtxMOCelcPezCXdf62hhj42ygX7oZoPUkffnGWmJ7Jl4rq6VRhhTEH3qFFWR5HxxCSuVhDFqXf5pCOn0A==
- Authentication-results-original: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com;
- Cc: Ayan Kumar Halder <ayankuma@xxxxxxx>, 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:33:25 +0000
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
- Nodisclaimer: true
- Original-authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com;
- Thread-index: AQHbCDKnNzyGC8DY7ki21+yQsaede7JfBtYAgAacA4CAAO+VgIAAEQKAgAAErIA=
- Thread-topic: [PATCH v3] docs: fusa: Add Assumption of Use (AoU)
Hi Andrew,
> 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.
>
> 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.
Cheers
Bertrand
>
> ~Andrew
|