doc: add missing 'Asset' type in function test doc

[PATCH] doc: add missing 'Asset' type in function test doc

Posted by Aditya Gupta 3 weeks, 5 days ago

Seems 'Asset' got missed in the documentation by mistake.

Also fix the one spellcheck issue pointed by spellcheck

Signed-off-by: Aditya Gupta <adityag@linux.ibm.com>
---
 docs/devel/testing/functional.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/docs/devel/testing/functional.rst b/docs/devel/testing/functional.rst
index ecc738922b7c..50fca2a0291e 100644
--- a/docs/devel/testing/functional.rst
+++ b/docs/devel/testing/functional.rst
@@ -251,7 +251,7 @@ Many functional tests download assets (e.g. Linux kernels, initrds,
 firmware images, etc.) from the internet to be able to run tests with
 them. This imposes additional challenges to the test framework.
 
-First there is the the problem that some people might not have an
+First there is the problem that some people might not have an
 unconstrained internet connection, so such tests should not be run by
 default when running ``make check``. To accomplish this situation,
 the tests that download files should only be added to the "thorough"
@@ -274,7 +274,9 @@ the tests are run. This pre-caching is done with the qemu_test.Asset
 class. To use it in your test, declare an asset in your test class with
 its URL and SHA256 checksum like this::
 
-    ASSET_somename = (
+    from qemu_test import Asset
+
+    ASSET_somename = Asset(
         ('https://www.qemu.org/assets/images/qemu_head_200.png'),
         '34b74cad46ea28a2966c1d04e102510daf1fd73e6582b6b74523940d5da029dd')
 
-- 
2.48.1

Re: [PATCH] doc: add missing 'Asset' type in function test doc

Posted by Philippe Mathieu-Daudé 3 weeks, 5 days ago

On 6/3/25 07:07, Aditya Gupta wrote:
> Seems 'Asset' got missed in the documentation by mistake.
> 
> Also fix the one spellcheck issue pointed by spellcheck
> 
> Signed-off-by: Aditya Gupta <adityag@linux.ibm.com>
> ---
>   docs/devel/testing/functional.rst | 6 ++++--
>   1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/devel/testing/functional.rst b/docs/devel/testing/functional.rst
> index ecc738922b7c..50fca2a0291e 100644
> --- a/docs/devel/testing/functional.rst
> +++ b/docs/devel/testing/functional.rst
> @@ -251,7 +251,7 @@ Many functional tests download assets (e.g. Linux kernels, initrds,
>   firmware images, etc.) from the internet to be able to run tests with
>   them. This imposes additional challenges to the test framework.
>   
> -First there is the the problem that some people might not have an
> +First there is the problem that some people might not have an
>   unconstrained internet connection, so such tests should not be run by
>   default when running ``make check``. To accomplish this situation,
>   the tests that download files should only be added to the "thorough"
> @@ -274,7 +274,9 @@ the tests are run. This pre-caching is done with the qemu_test.Asset
>   class. To use it in your test, declare an asset in your test class with
>   its URL and SHA256 checksum like this::
>   
> -    ASSET_somename = (
> +    from qemu_test import Asset
> +
> +    ASSET_somename = Asset(
>           ('https://www.qemu.org/assets/images/qemu_head_200.png'),
>           '34b74cad46ea28a2966c1d04e102510daf1fd73e6582b6b74523940d5da029dd')
>   

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>

Re: [PATCH] doc: add missing 'Asset' type in function test doc

Posted by Thomas Huth 3 weeks, 5 days ago

On 06/03/2025 07.44, Philippe Mathieu-Daudé wrote:
> On 6/3/25 07:07, Aditya Gupta wrote:
>> Seems 'Asset' got missed in the documentation by mistake.
>>
>> Also fix the one spellcheck issue pointed by spellcheck
>>
>> Signed-off-by: Aditya Gupta <adityag@linux.ibm.com>
>> ---
>>   docs/devel/testing/functional.rst | 6 ++++--
>>   1 file changed, 4 insertions(+), 2 deletions(-)
>>
>> diff --git a/docs/devel/testing/functional.rst b/docs/devel/testing/ 
>> functional.rst
>> index ecc738922b7c..50fca2a0291e 100644
>> --- a/docs/devel/testing/functional.rst
>> +++ b/docs/devel/testing/functional.rst
>> @@ -251,7 +251,7 @@ Many functional tests download assets (e.g. Linux 
>> kernels, initrds,
>>   firmware images, etc.) from the internet to be able to run tests with
>>   them. This imposes additional challenges to the test framework.
>> -First there is the the problem that some people might not have an
>> +First there is the problem that some people might not have an
>>   unconstrained internet connection, so such tests should not be run by
>>   default when running ``make check``. To accomplish this situation,
>>   the tests that download files should only be added to the "thorough"
>> @@ -274,7 +274,9 @@ the tests are run. This pre-caching is done with the 
>> qemu_test.Asset
>>   class. To use it in your test, declare an asset in your test class with
>>   its URL and SHA256 checksum like this::
>> -    ASSET_somename = (
>> +    from qemu_test import Asset
>> +
>> +    ASSET_somename = Asset(
>>           ('https://www.qemu.org/assets/images/qemu_head_200.png'),
>>           '34b74cad46ea28a2966c1d04e102510daf1fd73e6582b6b74523940d5da029dd')
> 
> Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>

Thanks, queued!

  Thomas