Re: [PATCH v2 1/3] docs: Introduce Fusa Requirement and define maintainers

[Michal Orzel <michal.orzel@xxxxxxx>]

On 05/08/2024 14:45, Ayan Kumar Halder wrote:
> 
> On 05/08/2024 10:46, Michal Orzel wrote:
>> Hi Ayan,
> Hi Michal,
>>
>> On 02/08/2024 11:46, Ayan Kumar Halder wrote:
>>> The FUSA folder is expected to contain requirements and other documents
>>> to enable safety certification of Xen hypervisor.
>>> Added a README to explain how the requirements are categorized, written
>>> and their supported status.
>>>
>>> Added maintainers for the same.
>>>
>>> Signed-off-by: Ayan Kumar Halder <ayan.kumar.halder@xxxxxxx>
>>> Acked-by: Bertrand Marquis <bertrand.marquis@xxxxxxx>
>>> ---
>>> Changes from :-
>>>
>>> v1 - 1. Added a comment from Stefano.
>>> 2. Added Ack.
>>>
>>>   MAINTAINERS              |  9 +++++
>>>   docs/fusa/reqs/README.md | 78 ++++++++++++++++++++++++++++++++++++++++
>> I have 2 questions:
>> 1) Most of our docs are written in RST, same will be true for requirements 
>> docs. Any specific reason for using markdown?
> No specific reason as such. I am happy for this filename to be renamed 
> on commit.
If we want RST, I'm afraid it would involve more changes than it can be done on 
commit (rstcheck reports quite a few).
Also, renaming to RST would result in this file being picked up by sphinx build 
and it would report a warning too.

>> 2) In the current form of this patch, docs/fusa won't be part of the 
>> generated Xen docs. Is this intended? Don't we want to
>> include it?
> docs/fusa will become a part of the generated Xen docs when the 
> requirements (see patch 2) are added.
If you want docs/fusa to be included, why not doing this right away?

~Michal