docs: Fix SUPPORT matrix generation after a5968a553f6a

[PATCH] docs: Fix SUPPORT matrix generation after a5968a553f6a

Posted by Julien Grall 1 year, 11 months ago

From: Julien Grall <jgrall@amazon.com>

Commit a5968a553f6a "SUPPORT.MD: Correct the amount of physical memory
supported for Arm" added a support statement split over two lines.

Unfortunately, docs/support-matrix-generate throw an error for it:

    Generating support matrix (origin/stable-NN )
    + docs/support-matrix-generate HEAD https://xenbits.xen.org/docs/unstable/SUPPORT.html origin/stable-NN https://xenbits.xen.org/docs/NN-testing/SUPPORT.html
    Status, x86: Supported up to 8 TiB. Hosts with more memory are
                 supported, but not security supported.
    Status, Arm32: Supported up to 12 GiB
    Status, Arm64: Supported up to 2 TiB
    ^ cannot parse status codeblock line:
                 supported, but not security supported.
     ? at docs/parse-support-md line 172, <F> chunk 1.

It would be good to allow split support statement (to keep lines below
80 characters) but my knowledge of the script is very limited.

Therefore, workaround the error by describing the support statement
in one long line.

Fixes: a5968a553f6a "SUPPORT.MD: Correct the amount of physical memory supported for Arm"
Signed-off-by: Julien Grall <jgrall@amazon.com>
---
 SUPPORT.md | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/SUPPORT.md b/SUPPORT.md
index cdf93181cf65..ee2cd319e2f8 100644
--- a/SUPPORT.md
+++ b/SUPPORT.md
@@ -50,8 +50,7 @@ For the Cortex A57 r0p0 - r1p1, see Errata 832075.
 
 ### Physical Memory
 
-    Status, x86: Supported up to 8 TiB. Hosts with more memory are
-                 supported, but not security supported.
+    Status, x86: Supported up to 8 TiB. Hosts with more memory are supported, but not security supported.
     Status, Arm32: Supported up to 12 GiB
     Status, Arm64: Supported up to 2 TiB
 
-- 
2.32.0

Re: [PATCH] docs: Fix SUPPORT matrix generation after a5968a553f6a

Posted by George Dunlap 1 year, 11 months ago


> On May 9, 2022, at 9:07 AM, Julien Grall <julien@xen.org> wrote:
> 
> From: Julien Grall <jgrall@amazon.com>
> 
> Commit a5968a553f6a "SUPPORT.MD: Correct the amount of physical memory
> supported for Arm" added a support statement split over two lines.
> 
> Unfortunately, docs/support-matrix-generate throw an error for it:
> 
>    Generating support matrix (origin/stable-NN )
>    + docs/support-matrix-generate HEAD https://xenbits.xen.org/docs/unstable/SUPPORT.html origin/stable-NN https://xenbits.xen.org/docs/NN-testing/SUPPORT.html
>    Status, x86: Supported up to 8 TiB. Hosts with more memory are
>                 supported, but not security supported.
>    Status, Arm32: Supported up to 12 GiB
>    Status, Arm64: Supported up to 2 TiB
>    ^ cannot parse status codeblock line:
>                 supported, but not security supported.
>     ? at docs/parse-support-md line 172, <F> chunk 1.
> 
> It would be good to allow split support statement (to keep lines below
> 80 characters) but my knowledge of the script is very limited.
> 
> Therefore, workaround the error by describing the support statement
> in one long line.
> 
> Fixes: a5968a553f6a "SUPPORT.MD: Correct the amount of physical memory supported for Arm"
> Signed-off-by: Julien Grall <jgrall@amazon.com>

Acked-by: George Dunlap <george.dunlap@citrix.com>

Re: [PATCH] docs: Fix SUPPORT matrix generation after a5968a553f6a

Posted by Julien Grall 1 year, 11 months ago

Hi,

On 09/05/2022 09:42, George Dunlap wrote:
> 
> 
>> On May 9, 2022, at 9:07 AM, Julien Grall <julien@xen.org> wrote:
>>
>> From: Julien Grall <jgrall@amazon.com>
>>
>> Commit a5968a553f6a "SUPPORT.MD: Correct the amount of physical memory
>> supported for Arm" added a support statement split over two lines.
>>
>> Unfortunately, docs/support-matrix-generate throw an error for it:
>>
>>     Generating support matrix (origin/stable-NN )
>>     + docs/support-matrix-generate HEAD https://xenbits.xen.org/docs/unstable/SUPPORT.html origin/stable-NN https://xenbits.xen.org/docs/NN-testing/SUPPORT.html
>>     Status, x86: Supported up to 8 TiB. Hosts with more memory are
>>                  supported, but not security supported.
>>     Status, Arm32: Supported up to 12 GiB
>>     Status, Arm64: Supported up to 2 TiB
>>     ^ cannot parse status codeblock line:
>>                  supported, but not security supported.
>>      ? at docs/parse-support-md line 172, <F> chunk 1.
>>
>> It would be good to allow split support statement (to keep lines below
>> 80 characters) but my knowledge of the script is very limited.
>>
>> Therefore, workaround the error by describing the support statement
>> in one long line.
>>
>> Fixes: a5968a553f6a "SUPPORT.MD: Correct the amount of physical memory supported for Arm"
>> Signed-off-by: Julien Grall <jgrall@amazon.com>
> 
> Acked-by: George Dunlap <george.dunlap@citrix.com>

Thanks! I have committed it.

Cheers,

-- 
Julien Grall