summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-12-08 10:25:59 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-12-18 10:41:21 +0000
commit01e5d22507e57c66452f14610ee8eb3d66ac9d71 (patch)
tree7241fa93a3a0d11db32d042e5d70a750132ab0a1 /documentation/sdk-manual
parent8b812b29c4b13ba028c0d66f73a6599a988486d5 (diff)
downloadpoky-01e5d22507e57c66452f14610ee8eb3d66ac9d71.tar.gz
manuals: fix double colons
Fixing double colons appearing alone on a line, while they could be put at the end of the previous line. Sometimes placing a note after the quoted text to avoid such a situation. It's more natural too not to have a note between the introduction text and the quoted section. (From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/sdk-manual')
-rw-r--r--documentation/sdk-manual/appendix-obtain.rst3
-rw-r--r--documentation/sdk-manual/extensible.rst27
-rw-r--r--documentation/sdk-manual/using.rst21
-rw-r--r--documentation/sdk-manual/working-projects.rst15
4 files changed, 26 insertions, 40 deletions
diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
index b90247d2e0..fa82af5c22 100644
--- a/documentation/sdk-manual/appendix-obtain.rst
+++ b/documentation/sdk-manual/appendix-obtain.rst
@@ -111,8 +111,7 @@ build the SDK installer. Follow these steps:
111 the Source Directory (i.e. ``poky``), run the 111 the Source Directory (i.e. ``poky``), run the
112 :ref:`structure-core-script` environment 112 :ref:`structure-core-script` environment
113 setup script to define the OpenEmbedded build environment on your 113 setup script to define the OpenEmbedded build environment on your
114 build host. 114 build host::
115 ::
116 115
117 $ source oe-init-build-env 116 $ source oe-init-build-env
118 117
diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
index 4d36270e64..7ab43e0a9d 100644
--- a/documentation/sdk-manual/extensible.rst
+++ b/documentation/sdk-manual/extensible.rst
@@ -138,16 +138,7 @@ must be writable for whichever users need to use the SDK.
138The following command shows how to run the installer given a toolchain 138The following command shows how to run the installer given a toolchain
139tarball for a 64-bit x86 development host system and a 64-bit x86 target 139tarball for a 64-bit x86 development host system and a 64-bit x86 target
140architecture. The example assumes the SDK installer is located in 140architecture. The example assumes the SDK installer is located in
141``~/Downloads/`` and has execution rights. 141``~/Downloads/`` and has execution rights::
142
143.. note::
144
145 If you do not have write permissions for the directory into which you
146 are installing the SDK, the installer notifies you and exits. For
147 that case, set up the proper permissions in the directory and run the
148 installer again.
149
150::
151 142
152 $ ./Downloads/poky-glibc-x86_64-core-image-minimal-core2-64-toolchain-ext-2.5.sh 143 $ ./Downloads/poky-glibc-x86_64-core-image-minimal-core2-64-toolchain-ext-2.5.sh
153 Poky (Yocto Project Reference Distro) Extensible SDK installer version 2.5 144 Poky (Yocto Project Reference Distro) Extensible SDK installer version 2.5
@@ -168,6 +159,13 @@ architecture. The example assumes the SDK installer is located in
168 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. 159 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
169 $ . /home/scottrif/poky_sdk/environment-setup-core2-64-poky-linux 160 $ . /home/scottrif/poky_sdk/environment-setup-core2-64-poky-linux
170 161
162.. note::
163
164 If you do not have write permissions for the directory into which you
165 are installing the SDK, the installer notifies you and exits. For
166 that case, set up the proper permissions in the directory and run the
167 installer again.
168
171Running the Extensible SDK Environment Setup Script 169Running the Extensible SDK Environment Setup Script
172=================================================== 170===================================================
173 171
@@ -406,8 +404,7 @@ command:
406 creates any patches corresponding to commits in the local Git 404 creates any patches corresponding to commits in the local Git
407 repository, moves the new recipe to a more permanent layer, and then 405 repository, moves the new recipe to a more permanent layer, and then
408 resets the recipe so that the recipe is built normally rather than 406 resets the recipe so that the recipe is built normally rather than
409 from the workspace. 407 from the workspace::
410 ::
411 408
412 $ devtool finish recipe layer 409 $ devtool finish recipe layer
413 410
@@ -605,8 +602,7 @@ command:
605 repository, updates the recipe to point to them (or creates a 602 repository, updates the recipe to point to them (or creates a
606 ``.bbappend`` file to do so, depending on the specified destination 603 ``.bbappend`` file to do so, depending on the specified destination
607 layer), and then resets the recipe so that the recipe is built 604 layer), and then resets the recipe so that the recipe is built
608 normally rather than from the workspace. 605 normally rather than from the workspace::
609 ::
610 606
611 $ devtool finish recipe layer 607 $ devtool finish recipe layer
612 608
@@ -780,8 +776,7 @@ The following diagram shows the common development flow used with the
780 776
781 If you specify a destination layer that is the same as the original 777 If you specify a destination layer that is the same as the original
782 source, then the old version of the recipe and associated files are 778 source, then the old version of the recipe and associated files are
783 removed prior to adding the new version. 779 removed prior to adding the new version::
784 ::
785 780
786 $ devtool finish recipe layer 781 $ devtool finish recipe layer
787 782
diff --git a/documentation/sdk-manual/using.rst b/documentation/sdk-manual/using.rst
index 301627812c..f1ff0c76ca 100644
--- a/documentation/sdk-manual/using.rst
+++ b/documentation/sdk-manual/using.rst
@@ -52,8 +52,7 @@ libraries appropriate for developing against the corresponding image.
52 52
53The names of the tarball installer scripts are such that a string 53The names of the tarball installer scripts are such that a string
54representing the host system appears first in the filename and then is 54representing the host system appears first in the filename and then is
55immediately followed by a string representing the target architecture. 55immediately followed by a string representing the target architecture::
56::
57 56
58 poky-glibc-host_system-image_type-arch-toolchain-release_version.sh 57 poky-glibc-host_system-image_type-arch-toolchain-release_version.sh
59 58
@@ -97,16 +96,7 @@ must be writable for whichever users need to use the SDK.
97The following command shows how to run the installer given a toolchain 96The following command shows how to run the installer given a toolchain
98tarball for a 64-bit x86 development host system and a 64-bit x86 target 97tarball for a 64-bit x86 development host system and a 64-bit x86 target
99architecture. The example assumes the SDK installer is located in 98architecture. The example assumes the SDK installer is located in
100``~/Downloads/`` and has execution rights. 99``~/Downloads/`` and has execution rights::
101
102.. note::
103
104 If you do not have write permissions for the directory into which you
105 are installing the SDK, the installer notifies you and exits. For
106 that case, set up the proper permissions in the directory and run the
107 installer again.
108
109::
110 100
111 $ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh 101 $ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh
112 Poky (Yocto Project Reference Distro) SDK installer version &DISTRO; 102 Poky (Yocto Project Reference Distro) SDK installer version &DISTRO;
@@ -119,6 +109,13 @@ architecture. The example assumes the SDK installer is located in
119 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. 109 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
120 $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux 110 $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
121 111
112.. note::
113
114 If you do not have write permissions for the directory into which you
115 are installing the SDK, the installer notifies you and exits. For
116 that case, set up the proper permissions in the directory and run the
117 installer again.
118
122Again, reference the 119Again, reference the
123":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`" 120":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`"
124section for more details on the resulting directory structure of the installed 121section for more details on the resulting directory structure of the installed
diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst
index 0eddee08e3..beec1dd09a 100644
--- a/documentation/sdk-manual/working-projects.rst
+++ b/documentation/sdk-manual/working-projects.rst
@@ -33,8 +33,7 @@ project:
33 33
341. *Create a Working Directory and Populate It:* Create a clean 341. *Create a Working Directory and Populate It:* Create a clean
35 directory for your project and then make that directory your working 35 directory for your project and then make that directory your working
36 location. 36 location::
37 ::
38 37
39 $ mkdir $HOME/helloworld 38 $ mkdir $HOME/helloworld
40 $ cd $HOME/helloworld 39 $ cd $HOME/helloworld
@@ -146,8 +145,7 @@ project:
146 This next command is a simple way to verify the installation of your 145 This next command is a simple way to verify the installation of your
147 project. Running the command prints the architecture on which the 146 project. Running the command prints the architecture on which the
148 binary file can run. This architecture should be the same 147 binary file can run. This architecture should be the same
149 architecture that the installed cross-toolchain supports. 148 architecture that the installed cross-toolchain supports::
150 ::
151 149
152 $ file ./tmp/usr/local/bin/hello 150 $ file ./tmp/usr/local/bin/hello
153 151
@@ -210,8 +208,7 @@ demonstrates these variable behaviors.
210In a new shell environment variables are not established for the SDK 208In a new shell environment variables are not established for the SDK
211until you run the setup script. For example, the following commands show 209until you run the setup script. For example, the following commands show
212a null value for the compiler variable (i.e. 210a null value for the compiler variable (i.e.
213:term:`CC`). 211:term:`CC`)::
214::
215 212
216 $ echo ${CC} 213 $ echo ${CC}
217 214
@@ -232,8 +229,7 @@ example:
232 229
2331. *Create a Working Directory and Populate It:* Create a clean 2301. *Create a Working Directory and Populate It:* Create a clean
234 directory for your project and then make that directory your working 231 directory for your project and then make that directory your working
235 location. 232 location::
236 ::
237 233
238 $ mkdir $HOME/helloworld 234 $ mkdir $HOME/helloworld
239 $ cd $HOME/helloworld 235 $ cd $HOME/helloworld
@@ -322,8 +318,7 @@ example:
322 318
323 You can override the :term:`CC` environment variable with the same 319 You can override the :term:`CC` environment variable with the same
324 variable as set from the Makefile by uncommenting the line in the 320 variable as set from the Makefile by uncommenting the line in the
325 Makefile and running ``make`` again. 321 Makefile and running ``make`` again::
326 ::
327 322
328 $ make clean 323 $ make clean
329 rm -rf *.o 324 rm -rf *.o