[PATCH] docs/system/generic-loader.rst: Fix style

Axel Heider posted 1 patch 3 years ago
Test checkpatch passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/0733e356-5384-8e8f-120c-986f031df53c@gmx.de
Maintainers: Alistair Francis <alistair@alistair23.me>
There is a newer version of this series
docs/system/generic-loader.rst | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
[PATCH] docs/system/generic-loader.rst: Fix style
Posted by Axel Heider 3 years ago
Fix style to have a proper description of the parameter 'force-raw'.

Signed-off-by: Axel Heider <axelheider@gmx.de>
---
 docs/system/generic-loader.rst | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/docs/system/generic-loader.rst b/docs/system/generic-loader.rst
index 6bf8a4eb48..13457cc705 100644
--- a/docs/system/generic-loader.rst
+++ b/docs/system/generic-loader.rst
@@ -92,9 +92,12 @@ shown below:
   specified in the executable format header. This option should only
   be used for the boot image. This will also cause the image to be
   written to the specified CPU's address space. If not specified, the
-  default is CPU 0. <force-raw> - Setting force-raw=on forces the file
-  to be treated as a raw image. This can be used to load supported
-  executable formats as if they were raw.
+  default is CPU 0.
+
+``<force-raw>``
+  Setting 'force-raw=on' forces the file to be treated as a raw image.
+  This can be used to load supported executable formats as if they
+  were raw.

 All values are parsed using the standard QemuOpts parsing. This allows the user
 to specify any values in any format supported. By default the values
--
2.25.1


Re: [PATCH] docs/system/generic-loader.rst: Fix style
Posted by Alistair Francis 3 years ago
On Mon, Mar 22, 2021 at 3:40 PM Axel Heider <axelheider@gmx.de> wrote:
>
> Fix style to have a proper description of the parameter 'force-raw'.
>
> Signed-off-by: Axel Heider <axelheider@gmx.de>

Reviewed-by: Alistair Francis <alistair.francis@wdc.com>

Alistair

> ---
>  docs/system/generic-loader.rst | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
>
> diff --git a/docs/system/generic-loader.rst b/docs/system/generic-loader.rst
> index 6bf8a4eb48..13457cc705 100644
> --- a/docs/system/generic-loader.rst
> +++ b/docs/system/generic-loader.rst
> @@ -92,9 +92,12 @@ shown below:
>    specified in the executable format header. This option should only
>    be used for the boot image. This will also cause the image to be
>    written to the specified CPU's address space. If not specified, the
> -  default is CPU 0. <force-raw> - Setting force-raw=on forces the file
> -  to be treated as a raw image. This can be used to load supported
> -  executable formats as if they were raw.
> +  default is CPU 0.
> +
> +``<force-raw>``
> +  Setting 'force-raw=on' forces the file to be treated as a raw image.
> +  This can be used to load supported executable formats as if they
> +  were raw.
>
>  All values are parsed using the standard QemuOpts parsing. This allows the user
>  to specify any values in any format supported. By default the values
> --
> 2.25.1
>
>