diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-12-09 19:01:55 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-12-18 10:41:21 +0000 |
commit | 6846d4d00bc3a9d4e188ad9c8cfdf6e45cd1ba06 (patch) | |
tree | 6a59e9936ac9f2ca063d4fc8a5c4d9ecc9492769 /documentation/sdk-manual/working-projects.rst | |
parent | 474e071608c7c1c97e9dafde810aef5630c716e7 (diff) | |
download | poky-6846d4d00bc3a9d4e188ad9c8cfdf6e45cd1ba06.tar.gz |
manuals: define proper numbered lists
Using "#." instead of "1.", "2.", "3.", etc.
(From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/sdk-manual/working-projects.rst')
-rw-r--r-- | documentation/sdk-manual/working-projects.rst | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst index beec1dd09a..9a0db0099d 100644 --- a/documentation/sdk-manual/working-projects.rst +++ b/documentation/sdk-manual/working-projects.rst | |||
@@ -31,7 +31,7 @@ project: | |||
31 | GNOME Developer | 31 | GNOME Developer |
32 | site. | 32 | site. |
33 | 33 | ||
34 | 1. *Create a Working Directory and Populate It:* Create a clean | 34 | #. *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 | 37 | ||
@@ -74,7 +74,7 @@ project: | |||
74 | bin_PROGRAMS = hello | 74 | bin_PROGRAMS = hello |
75 | hello_SOURCES = hello.c | 75 | hello_SOURCES = hello.c |
76 | 76 | ||
77 | 2. *Source the Cross-Toolchain Environment Setup File:* As described | 77 | #. *Source the Cross-Toolchain Environment Setup File:* As described |
78 | earlier in the manual, installing the cross-toolchain creates a | 78 | earlier in the manual, installing the cross-toolchain creates a |
79 | cross-toolchain environment setup script in the directory that the | 79 | cross-toolchain environment setup script in the directory that the |
80 | SDK was installed. Before you can use the tools to develop your | 80 | SDK was installed. Before you can use the tools to develop your |
@@ -92,7 +92,7 @@ project: | |||
92 | 92 | ||
93 | $ source tmp/deploy/images/qemux86-64/environment-setup-core2-64-poky-linux | 93 | $ source tmp/deploy/images/qemux86-64/environment-setup-core2-64-poky-linux |
94 | 94 | ||
95 | 3. *Create the configure Script:* Use the ``autoreconf`` command to | 95 | #. *Create the configure Script:* Use the ``autoreconf`` command to |
96 | generate the ``configure`` script:: | 96 | generate the ``configure`` script:: |
97 | 97 | ||
98 | $ autoreconf | 98 | $ autoreconf |
@@ -108,7 +108,7 @@ project: | |||
108 | which ensures missing auxiliary files are copied to the build | 108 | which ensures missing auxiliary files are copied to the build |
109 | host. | 109 | host. |
110 | 110 | ||
111 | 4. *Cross-Compile the Project:* This command compiles the project using | 111 | #. *Cross-Compile the Project:* This command compiles the project using |
112 | the cross-compiler. The | 112 | the cross-compiler. The |
113 | :term:`CONFIGURE_FLAGS` | 113 | :term:`CONFIGURE_FLAGS` |
114 | environment variable provides the minimal arguments for GNU | 114 | environment variable provides the minimal arguments for GNU |
@@ -129,7 +129,7 @@ project: | |||
129 | 129 | ||
130 | $ ./configure --host=armv5te-poky-linux-gnueabi --with-libtool-sysroot=sysroot_dir | 130 | $ ./configure --host=armv5te-poky-linux-gnueabi --with-libtool-sysroot=sysroot_dir |
131 | 131 | ||
132 | 5. *Make and Install the Project:* These two commands generate and | 132 | #. *Make and Install the Project:* These two commands generate and |
133 | install the project into the destination directory:: | 133 | install the project into the destination directory:: |
134 | 134 | ||
135 | $ make | 135 | $ make |
@@ -149,7 +149,7 @@ project: | |||
149 | 149 | ||
150 | $ file ./tmp/usr/local/bin/hello | 150 | $ file ./tmp/usr/local/bin/hello |
151 | 151 | ||
152 | 6. *Execute Your Project:* To execute the project, you would need to run | 152 | #. *Execute Your Project:* To execute the project, you would need to run |
153 | it on your target hardware. If your target hardware happens to be | 153 | it on your target hardware. If your target hardware happens to be |
154 | your build host, you could run the project as follows:: | 154 | your build host, you could run the project as follows:: |
155 | 155 | ||
@@ -227,7 +227,7 @@ established through the script:: | |||
227 | To illustrate variable use, work through this simple "Hello World!" | 227 | To illustrate variable use, work through this simple "Hello World!" |
228 | example: | 228 | example: |
229 | 229 | ||
230 | 1. *Create a Working Directory and Populate It:* Create a clean | 230 | #. *Create a Working Directory and Populate It:* Create a clean |
231 | directory for your project and then make that directory your working | 231 | directory for your project and then make that directory your working |
232 | location:: | 232 | location:: |
233 | 233 | ||
@@ -266,7 +266,7 @@ example: | |||
266 | printf("\n"); | 266 | printf("\n"); |
267 | } | 267 | } |
268 | 268 | ||
269 | 2. *Source the Cross-Toolchain Environment Setup File:* As described | 269 | #. *Source the Cross-Toolchain Environment Setup File:* As described |
270 | earlier in the manual, installing the cross-toolchain creates a | 270 | earlier in the manual, installing the cross-toolchain creates a |
271 | cross-toolchain environment setup script in the directory that the | 271 | cross-toolchain environment setup script in the directory that the |
272 | SDK was installed. Before you can use the tools to develop your | 272 | SDK was installed. Before you can use the tools to develop your |
@@ -284,7 +284,7 @@ example: | |||
284 | 284 | ||
285 | $ source tmp/deploy/images/qemux86-64/environment-setup-core2-64-poky-linux | 285 | $ source tmp/deploy/images/qemux86-64/environment-setup-core2-64-poky-linux |
286 | 286 | ||
287 | 3. *Create the Makefile:* For this example, the Makefile contains | 287 | #. *Create the Makefile:* For this example, the Makefile contains |
288 | two lines that can be used to set the :term:`CC` variable. One line is | 288 | two lines that can be used to set the :term:`CC` variable. One line is |
289 | identical to the value that is set when you run the SDK environment | 289 | identical to the value that is set when you run the SDK environment |
290 | setup script, and the other line sets :term:`CC` to "gcc", the default | 290 | setup script, and the other line sets :term:`CC` to "gcc", the default |
@@ -302,7 +302,7 @@ example: | |||
302 | rm -rf *.o | 302 | rm -rf *.o |
303 | rm target_bin | 303 | rm target_bin |
304 | 304 | ||
305 | 4. *Make the Project:* Use the ``make`` command to create the binary | 305 | #. *Make the Project:* Use the ``make`` command to create the binary |
306 | output file. Because variables are commented out in the Makefile, the | 306 | output file. Because variables are commented out in the Makefile, the |
307 | value used for :term:`CC` is the value set when the SDK environment setup | 307 | value used for :term:`CC` is the value set when the SDK environment setup |
308 | file was run:: | 308 | file was run:: |
@@ -387,7 +387,7 @@ example: | |||
387 | use the SDK environment variables regardless of the values in the | 387 | use the SDK environment variables regardless of the values in the |
388 | Makefile. | 388 | Makefile. |
389 | 389 | ||
390 | 5. *Execute Your Project:* To execute the project (i.e. ``target_bin``), | 390 | #. *Execute Your Project:* To execute the project (i.e. ``target_bin``), |
391 | use the following command:: | 391 | use the following command:: |
392 | 392 | ||
393 | $ ./target_bin | 393 | $ ./target_bin |