diff mbox series

SUPPORT.MD: Fix matrix generation after 43c416d0d819 and 77c39a53cf5b

Message ID 20240314173929.12040-1-julien@xen.org (mailing list archive)
State New
Headers show
Series SUPPORT.MD: Fix matrix generation after 43c416d0d819 and 77c39a53cf5b | expand

Commit Message

Julien Grall March 14, 2024, 5:39 p.m. UTC
From: Julien Grall <jgrall@amazon.com>

The script docs/support-matrix-generate throw the following error on the
latest staging.

MDCCSR_EL0
DBGDTR_EL0
DBGDTRTX_EL0
DBGDTRRX_EL0
DBGDSCRINT
DBGDTRTXINT
DBGDTRRXINT
^ cannot parse status codeblock line:
MDCCSR_EL0
 ? at docs/parse-support-md line 172, <F> chunk 1.

With the current indentation, it looks like the script thinks this is
a status code block.

Solve the issue by switching to a bullet list.

Fixes: 43c416d0d819 ("xen/arm: arm64: Add emulation of Debug Data Transfer Registers")
Fixes: 77c39a53cf5b ("xen/arm: arm32: Add emulation of Debug Data Transfer Registers")
---
 SUPPORT.md | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

Comments

Andrew Cooper March 14, 2024, 5:41 p.m. UTC | #1
On 14/03/2024 5:39 pm, Julien Grall wrote:
> From: Julien Grall <jgrall@amazon.com>
>
> The script docs/support-matrix-generate throw the following error on the
> latest staging.
>
> MDCCSR_EL0
> DBGDTR_EL0
> DBGDTRTX_EL0
> DBGDTRRX_EL0
> DBGDSCRINT
> DBGDTRTXINT
> DBGDTRRXINT
> ^ cannot parse status codeblock line:
> MDCCSR_EL0
>  ? at docs/parse-support-md line 172, <F> chunk 1.
>
> With the current indentation, it looks like the script thinks this is
> a status code block.
>
> Solve the issue by switching to a bullet list.
>
> Fixes: 43c416d0d819 ("xen/arm: arm64: Add emulation of Debug Data Transfer Registers")
> Fixes: 77c39a53cf5b ("xen/arm: arm32: Add emulation of Debug Data Transfer Registers")
> ---

You need a SoB somewhere, but Acked-by: Andrew Cooper
<andrew.cooper3@citrix.com>
Julien Grall March 14, 2024, 5:42 p.m. UTC | #2
On 14/03/2024 17:41, Andrew Cooper wrote:
> On 14/03/2024 5:39 pm, Julien Grall wrote:
>> From: Julien Grall <jgrall@amazon.com>
>>
>> The script docs/support-matrix-generate throw the following error on the
>> latest staging.
>>
>> MDCCSR_EL0
>> DBGDTR_EL0
>> DBGDTRTX_EL0
>> DBGDTRRX_EL0
>> DBGDSCRINT
>> DBGDTRTXINT
>> DBGDTRRXINT
>> ^ cannot parse status codeblock line:
>> MDCCSR_EL0
>>   ? at docs/parse-support-md line 172, <F> chunk 1.
>>
>> With the current indentation, it looks like the script thinks this is
>> a status code block.
>>
>> Solve the issue by switching to a bullet list.
>>
>> Fixes: 43c416d0d819 ("xen/arm: arm64: Add emulation of Debug Data Transfer Registers")
>> Fixes: 77c39a53cf5b ("xen/arm: arm32: Add emulation of Debug Data Transfer Registers")
>> ---
> 
> You need a SoB somewhere, but Acked-by: Andrew Cooper
> <andrew.cooper3@citrix.com>

Whoops yes:

Signed-off-by: Julien Grall <jgrall@amazon.com>

Cheers,
George Dunlap March 15, 2024, 10:05 a.m. UTC | #3
On Thu, Mar 14, 2024 at 5:39 PM Julien Grall <julien@xen.org> wrote:
>
> From: Julien Grall <jgrall@amazon.com>
>
> The script docs/support-matrix-generate throw the following error on the
> latest staging.

I wonder if it would be worth adding a follow-up patch to run that
script, maybe only when debug=y, so it catches errors in development.

 -George
Andrew Cooper March 15, 2024, 10:35 a.m. UTC | #4
On 15/03/2024 10:05 am, George Dunlap wrote:
> On Thu, Mar 14, 2024 at 5:39 PM Julien Grall <julien@xen.org> wrote:
>> From: Julien Grall <jgrall@amazon.com>
>>
>> The script docs/support-matrix-generate throw the following error on the
>> latest staging.
> I wonder if it would be worth adding a follow-up patch to run that
> script, maybe only when debug=y, so it catches errors in development.

I have a second docs thing which needs doing in some copious free
never.  The Sphinx build is getting broken occasionally and I'm the only
one who notices.

I was intending to have a Gitlab run specifically for docs, although the
container for it is going to need to be giant to get all of our ad-hoc
dependencies.

~Andrew
diff mbox series

Patch

diff --git a/SUPPORT.md b/SUPPORT.md
index 58f075538f73..e10d46d924a4 100644
--- a/SUPPORT.md
+++ b/SUPPORT.md
@@ -111,13 +111,13 @@  that would normally trigger a fault injection.
 
 Only the following system registers are security supported:
 
-    MDCCSR_EL0
-    DBGDTR_EL0
-    DBGDTRTX_EL0
-    DBGDTRRX_EL0
-    DBGDSCRINT
-    DBGDTRTXINT
-    DBGDTRRXINT
+  * MDCCSR_EL0
+  * DBGDTR_EL0
+  * DBGDTRTX_EL0
+  * DBGDTRRX_EL0
+  * DBGDSCRINT
+  * DBGDTRTXINT
+  * DBGDTRRXINT
 
 ### ARM Scalable Vector Extension (SVE/SVE2)