sdk-manual: fix broken formatting of sample command

Submitted by Robert P. J. Day on April 30, 2021, 10:03 a.m. | Patch ID: 179718

Details

Message ID 53696327-b187-808d-29cb-0d007ef27@crashcourse.ca
State New
Headers show

Commit Message

Robert P. J. Day April 30, 2021, 10:03 a.m.
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

Patch hide | download patch | download mbox

diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
index 0ce828aa2..0d1422ed4 100644
--- a/documentation/sdk-manual/appendix-obtain.rst
+++ b/documentation/sdk-manual/appendix-obtain.rst
@@ -138,9 +138,11 @@  build the SDK installer. Follow these steps:

 6. *Build the SDK Installer:* To build the SDK installer for a standard
    SDK and populate the SDK image, use the following command form. Be
-   sure to replace image with an image (e.g. "core-image-sato"): $
-   bitbake image -c populate_sdk You can do the same for the extensible
-   SDK using this command form::
+   sure to replace image with an image (e.g. "core-image-sato")::
+
+      $ bitbake image -c populate_sdk
+
+   You can do the same for the extensible SDK using this command form::

       $ bitbake image -c populate_sdk_ext


Comments

Michael Opdenacker April 30, 2021, 5:52 p.m.
Hi Robert

On 4/30/21 12:03 PM, Robert P. J. Day wrote:
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>
> ---
>
> diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
> index 0ce828aa2..0d1422ed4 100644
> --- a/documentation/sdk-manual/appendix-obtain.rst
> +++ b/documentation/sdk-manual/appendix-obtain.rst
> @@ -138,9 +138,11 @@ build the SDK installer. Follow these steps:
>
>  6. *Build the SDK Installer:* To build the SDK installer for a standard
>     SDK and populate the SDK image, use the following command form. Be
> -   sure to replace image with an image (e.g. "core-image-sato"): $
> -   bitbake image -c populate_sdk You can do the same for the extensible
> -   SDK using this command form::
> +   sure to replace image with an image (e.g. "core-image-sato")::
> +
> +      $ bitbake image -c populate_sdk
> +
> +   You can do the same for the extensible SDK using this command form::
>
>        $ bitbake image -c populate_sdk_ext


Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>

I also took the opportunity to add quotes around the first instance of
the "image" word.

Merged in master-next:
http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/commit/?h=master-next&id=a0fc2e1b4bdc8411b97d02d34bfecfc888b6eb0c

Many thanks!

Michael.