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

[Andrew Cooper <andrew.cooper3@xxxxxxxxxx>]

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.

~Andrew