diff options
Diffstat (limited to 'documentation/sdk-manual')
-rw-r--r-- | documentation/sdk-manual/appendix-customizing.rst | 14 | ||||
-rw-r--r-- | documentation/sdk-manual/appendix-obtain.rst | 28 | ||||
-rw-r--r-- | documentation/sdk-manual/extensible.rst | 58 | ||||
-rw-r--r-- | documentation/sdk-manual/intro.rst | 6 | ||||
-rw-r--r-- | documentation/sdk-manual/working-projects.rst | 22 |
5 files changed, 64 insertions, 64 deletions
diff --git a/documentation/sdk-manual/appendix-customizing.rst b/documentation/sdk-manual/appendix-customizing.rst index 45ad54fd76..c1a36c471d 100644 --- a/documentation/sdk-manual/appendix-customizing.rst +++ b/documentation/sdk-manual/appendix-customizing.rst | |||
@@ -173,12 +173,12 @@ perform additional steps. These steps make it possible for anyone using | |||
173 | the installed SDKs to update the installed SDKs by using the | 173 | the installed SDKs to update the installed SDKs by using the |
174 | ``devtool sdk-update`` command: | 174 | ``devtool sdk-update`` command: |
175 | 175 | ||
176 | 1. Create a directory that can be shared over HTTP or HTTPS. You can do | 176 | #. Create a directory that can be shared over HTTP or HTTPS. You can do |
177 | this by setting up a web server such as an :wikipedia:`Apache HTTP Server | 177 | this by setting up a web server such as an :wikipedia:`Apache HTTP Server |
178 | <Apache_HTTP_Server>` or :wikipedia:`Nginx <Nginx>` server in the cloud | 178 | <Apache_HTTP_Server>` or :wikipedia:`Nginx <Nginx>` server in the cloud |
179 | to host the directory. This directory must contain the published SDK. | 179 | to host the directory. This directory must contain the published SDK. |
180 | 180 | ||
181 | 2. Set the | 181 | #. Set the |
182 | :term:`SDK_UPDATE_URL` | 182 | :term:`SDK_UPDATE_URL` |
183 | variable to point to the corresponding HTTP or HTTPS URL. Setting | 183 | variable to point to the corresponding HTTP or HTTPS URL. Setting |
184 | this variable causes any SDK built to default to that URL and thus, | 184 | this variable causes any SDK built to default to that URL and thus, |
@@ -187,10 +187,10 @@ the installed SDKs to update the installed SDKs by using the | |||
187 | ":ref:`sdk-manual/extensible:applying updates to an installed extensible sdk`" | 187 | ":ref:`sdk-manual/extensible:applying updates to an installed extensible sdk`" |
188 | section. | 188 | section. |
189 | 189 | ||
190 | 3. Build the extensible SDK normally (i.e., use the | 190 | #. Build the extensible SDK normally (i.e., use the |
191 | ``bitbake -c populate_sdk_ext`` imagename command). | 191 | ``bitbake -c populate_sdk_ext`` imagename command). |
192 | 192 | ||
193 | 4. Publish the SDK using the following command:: | 193 | #. Publish the SDK using the following command:: |
194 | 194 | ||
195 | $ oe-publish-sdk some_path/sdk-installer.sh path_to_shared_http_directory | 195 | $ oe-publish-sdk some_path/sdk-installer.sh path_to_shared_http_directory |
196 | 196 | ||
@@ -245,7 +245,7 @@ If you want the users of an extensible SDK you build to be able to add | |||
245 | items to the SDK without requiring the users to build the items from | 245 | items to the SDK without requiring the users to build the items from |
246 | source, you need to do a number of things: | 246 | source, you need to do a number of things: |
247 | 247 | ||
248 | 1. Ensure the additional items you want the user to be able to install | 248 | #. Ensure the additional items you want the user to be able to install |
249 | are already built: | 249 | are already built: |
250 | 250 | ||
251 | - Build the items explicitly. You could use one or more "meta" | 251 | - Build the items explicitly. You could use one or more "meta" |
@@ -257,12 +257,12 @@ source, you need to do a number of things: | |||
257 | :term:`EXCLUDE_FROM_WORLD` | 257 | :term:`EXCLUDE_FROM_WORLD` |
258 | variable for additional information. | 258 | variable for additional information. |
259 | 259 | ||
260 | 2. Expose the ``sstate-cache`` directory produced by the build. | 260 | #. Expose the ``sstate-cache`` directory produced by the build. |
261 | Typically, you expose this directory by making it available through | 261 | Typically, you expose this directory by making it available through |
262 | an :wikipedia:`Apache HTTP Server <Apache_HTTP_Server>` or | 262 | an :wikipedia:`Apache HTTP Server <Apache_HTTP_Server>` or |
263 | :wikipedia:`Nginx <Nginx>` server. | 263 | :wikipedia:`Nginx <Nginx>` server. |
264 | 264 | ||
265 | 3. Set the appropriate configuration so that the produced SDK knows how | 265 | #. Set the appropriate configuration so that the produced SDK knows how |
266 | to find the configuration. The variable you need to set is | 266 | to find the configuration. The variable you need to set is |
267 | :term:`SSTATE_MIRRORS`:: | 267 | :term:`SSTATE_MIRRORS`:: |
268 | 268 | ||
diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst index fa82af5c22..ba844507d3 100644 --- a/documentation/sdk-manual/appendix-obtain.rst +++ b/documentation/sdk-manual/appendix-obtain.rst | |||
@@ -28,14 +28,14 @@ and then run the script to hand-install the toolchain. | |||
28 | 28 | ||
29 | Follow these steps to locate and hand-install the toolchain: | 29 | Follow these steps to locate and hand-install the toolchain: |
30 | 30 | ||
31 | 1. *Go to the Installers Directory:* Go to | 31 | #. *Go to the Installers Directory:* Go to |
32 | :yocto_dl:`/releases/yocto/yocto-&DISTRO;/toolchain/` | 32 | :yocto_dl:`/releases/yocto/yocto-&DISTRO;/toolchain/` |
33 | 33 | ||
34 | 2. *Open the Folder for Your Build Host:* Open the folder that matches | 34 | #. *Open the Folder for Your Build Host:* Open the folder that matches |
35 | your :term:`Build Host` (i.e. | 35 | your :term:`Build Host` (i.e. |
36 | ``i686`` for 32-bit machines or ``x86_64`` for 64-bit machines). | 36 | ``i686`` for 32-bit machines or ``x86_64`` for 64-bit machines). |
37 | 37 | ||
38 | 3. *Locate and Download the SDK Installer:* You need to find and | 38 | #. *Locate and Download the SDK Installer:* You need to find and |
39 | download the installer appropriate for your build host, target | 39 | download the installer appropriate for your build host, target |
40 | hardware, and image type. | 40 | hardware, and image type. |
41 | 41 | ||
@@ -72,7 +72,7 @@ Follow these steps to locate and hand-install the toolchain: | |||
72 | 72 | ||
73 | poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh | 73 | poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh |
74 | 74 | ||
75 | 4. *Run the Installer:* Be sure you have execution privileges and run | 75 | #. *Run the Installer:* Be sure you have execution privileges and run |
76 | the installer. Following is an example from the ``Downloads`` | 76 | the installer. Following is an example from the ``Downloads`` |
77 | directory:: | 77 | directory:: |
78 | 78 | ||
@@ -91,13 +91,13 @@ Building an SDK Installer | |||
91 | As an alternative to locating and downloading an SDK installer, you can | 91 | As an alternative to locating and downloading an SDK installer, you can |
92 | build the SDK installer. Follow these steps: | 92 | build the SDK installer. Follow these steps: |
93 | 93 | ||
94 | 1. *Set Up the Build Environment:* Be sure you are set up to use BitBake | 94 | #. *Set Up the Build Environment:* Be sure you are set up to use BitBake |
95 | in a shell. See the ":ref:`dev-manual/start:preparing the build host`" section | 95 | in a shell. See the ":ref:`dev-manual/start:preparing the build host`" section |
96 | in the Yocto Project Development Tasks Manual for information on how | 96 | in the Yocto Project Development Tasks Manual for information on how |
97 | to get a build host ready that is either a native Linux machine or a | 97 | to get a build host ready that is either a native Linux machine or a |
98 | machine that uses CROPS. | 98 | machine that uses CROPS. |
99 | 99 | ||
100 | 2. *Clone the ``poky`` Repository:* You need to have a local copy of the | 100 | #. *Clone the ``poky`` Repository:* You need to have a local copy of the |
101 | Yocto Project :term:`Source Directory` | 101 | Yocto Project :term:`Source Directory` |
102 | (i.e. a local | 102 | (i.e. a local |
103 | ``poky`` repository). See the ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" and | 103 | ``poky`` repository). See the ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" and |
@@ -107,7 +107,7 @@ build the SDK installer. Follow these steps: | |||
107 | how to clone the ``poky`` repository and check out the appropriate | 107 | how to clone the ``poky`` repository and check out the appropriate |
108 | branch for your work. | 108 | branch for your work. |
109 | 109 | ||
110 | 3. *Initialize the Build Environment:* While in the root directory of | 110 | #. *Initialize the Build Environment:* While in the root directory of |
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 |
@@ -120,12 +120,12 @@ build the SDK installer. Follow these steps: | |||
120 | the script runs, your current working directory is set to the ``build`` | 120 | the script runs, your current working directory is set to the ``build`` |
121 | directory. | 121 | directory. |
122 | 122 | ||
123 | 4. *Make Sure You Are Building an Installer for the Correct Machine:* | 123 | #. *Make Sure You Are Building an Installer for the Correct Machine:* |
124 | Check to be sure that your :term:`MACHINE` variable in the ``local.conf`` | 124 | Check to be sure that your :term:`MACHINE` variable in the ``local.conf`` |
125 | file in your :term:`Build Directory` matches the architecture | 125 | file in your :term:`Build Directory` matches the architecture |
126 | for which you are building. | 126 | for which you are building. |
127 | 127 | ||
128 | 5. *Make Sure Your SDK Machine is Correctly Set:* If you are building a | 128 | #. *Make Sure Your SDK Machine is Correctly Set:* If you are building a |
129 | toolchain designed to run on an architecture that differs from your | 129 | toolchain designed to run on an architecture that differs from your |
130 | current development host machine (i.e. the build host), be sure that | 130 | current development host machine (i.e. the build host), be sure that |
131 | the :term:`SDKMACHINE` variable in the ``local.conf`` file in your | 131 | the :term:`SDKMACHINE` variable in the ``local.conf`` file in your |
@@ -145,7 +145,7 @@ build the SDK installer. Follow these steps: | |||
145 | different from the architecture of the build machine (``x86_64``). | 145 | different from the architecture of the build machine (``x86_64``). |
146 | 146 | ||
147 | 147 | ||
148 | 6. *Build the SDK Installer:* To build the SDK installer for a standard | 148 | #. *Build the SDK Installer:* To build the SDK installer for a standard |
149 | SDK and populate the SDK image, use the following command form. Be | 149 | SDK and populate the SDK image, use the following command form. Be |
150 | sure to replace ``image`` with an image (e.g. "core-image-sato"):: | 150 | sure to replace ``image`` with an image (e.g. "core-image-sato"):: |
151 | 151 | ||
@@ -175,7 +175,7 @@ build the SDK installer. Follow these steps: | |||
175 | static development libraries: TOOLCHAIN_TARGET_TASK:append = " | 175 | static development libraries: TOOLCHAIN_TARGET_TASK:append = " |
176 | libc-staticdev" | 176 | libc-staticdev" |
177 | 177 | ||
178 | 7. *Run the Installer:* You can now run the SDK installer from | 178 | #. *Run the Installer:* You can now run the SDK installer from |
179 | ``tmp/deploy/sdk`` in the :term:`Build Directory`. Following is an example:: | 179 | ``tmp/deploy/sdk`` in the :term:`Build Directory`. Following is an example:: |
180 | 180 | ||
181 | $ cd poky/build/tmp/deploy/sdk | 181 | $ cd poky/build/tmp/deploy/sdk |
@@ -203,7 +203,7 @@ separately extract a root filesystem: | |||
203 | 203 | ||
204 | Follow these steps to extract the root filesystem: | 204 | Follow these steps to extract the root filesystem: |
205 | 205 | ||
206 | 1. *Locate and Download the Tarball for the Pre-Built Root Filesystem | 206 | #. *Locate and Download the Tarball for the Pre-Built Root Filesystem |
207 | Image File:* You need to find and download the root filesystem image | 207 | Image File:* You need to find and download the root filesystem image |
208 | file that is appropriate for your target system. These files are kept | 208 | file that is appropriate for your target system. These files are kept |
209 | in machine-specific folders in the | 209 | in machine-specific folders in the |
@@ -241,7 +241,7 @@ Follow these steps to extract the root filesystem: | |||
241 | 241 | ||
242 | core-image-sato-sdk-beaglebone-yocto.tar.bz2 | 242 | core-image-sato-sdk-beaglebone-yocto.tar.bz2 |
243 | 243 | ||
244 | 2. *Initialize the Cross-Development Environment:* You must ``source`` | 244 | #. *Initialize the Cross-Development Environment:* You must ``source`` |
245 | the cross-development environment setup script to establish necessary | 245 | the cross-development environment setup script to establish necessary |
246 | environment variables. | 246 | environment variables. |
247 | 247 | ||
@@ -253,7 +253,7 @@ Follow these steps to extract the root filesystem: | |||
253 | 253 | ||
254 | $ source poky_sdk/environment-setup-core2-64-poky-linux | 254 | $ source poky_sdk/environment-setup-core2-64-poky-linux |
255 | 255 | ||
256 | 3. *Extract the Root Filesystem:* Use the ``runqemu-extract-sdk`` | 256 | #. *Extract the Root Filesystem:* Use the ``runqemu-extract-sdk`` |
257 | command and provide the root filesystem image. | 257 | command and provide the root filesystem image. |
258 | 258 | ||
259 | Following is an example command that extracts the root filesystem | 259 | Following is an example command that extracts the root filesystem |
diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst index 7ab43e0a9d..e8a0a5b3ce 100644 --- a/documentation/sdk-manual/extensible.rst +++ b/documentation/sdk-manual/extensible.rst | |||
@@ -47,7 +47,7 @@ Two ways to install the Extensible SDK | |||
47 | Extensible SDK can be installed in two different ways, and both have | 47 | Extensible SDK can be installed in two different ways, and both have |
48 | their own pros and cons: | 48 | their own pros and cons: |
49 | 49 | ||
50 | 1. *Setting up the Extensible SDK environment directly in a Yocto build*. This | 50 | #. *Setting up the Extensible SDK environment directly in a Yocto build*. This |
51 | avoids having to produce, test, distribute and maintain separate SDK installer | 51 | avoids having to produce, test, distribute and maintain separate SDK installer |
52 | archives, which can get very large. There is only one environment for the regular | 52 | archives, which can get very large. There is only one environment for the regular |
53 | Yocto build and the SDK and less code paths where things can go not according to plan. | 53 | Yocto build and the SDK and less code paths where things can go not according to plan. |
@@ -56,7 +56,7 @@ git fetch or layer management tooling. The SDK extensibility is better than in t | |||
56 | second option: just run ``bitbake`` again to add more things to the sysroot, or add layers | 56 | second option: just run ``bitbake`` again to add more things to the sysroot, or add layers |
57 | if even more things are required. | 57 | if even more things are required. |
58 | 58 | ||
59 | 2. *Setting up the Extensible SDK from a standalone installer*. This has the benefit of | 59 | #. *Setting up the Extensible SDK from a standalone installer*. This has the benefit of |
60 | having a single, self-contained archive that includes all the needed binary artifacts. | 60 | having a single, self-contained archive that includes all the needed binary artifacts. |
61 | So nothing needs to be rebuilt, and there is no need to provide a well-functioning | 61 | So nothing needs to be rebuilt, and there is no need to provide a well-functioning |
62 | binary artefact cache over the network for developers with underpowered laptops. | 62 | binary artefact cache over the network for developers with underpowered laptops. |
@@ -64,10 +64,10 @@ binary artefact cache over the network for developers with underpowered laptops. | |||
64 | Setting up the Extensible SDK environment directly in a Yocto build | 64 | Setting up the Extensible SDK environment directly in a Yocto build |
65 | ------------------------------------------------------------------- | 65 | ------------------------------------------------------------------- |
66 | 66 | ||
67 | 1. Set up all the needed layers and a Yocto :term:`Build Directory`, e.g. a regular Yocto | 67 | #. Set up all the needed layers and a Yocto :term:`Build Directory`, e.g. a regular Yocto |
68 | build where ``bitbake`` can be executed. | 68 | build where ``bitbake`` can be executed. |
69 | 69 | ||
70 | 2. Run: | 70 | #. Run: |
71 | $ bitbake meta-ide-support | 71 | $ bitbake meta-ide-support |
72 | $ bitbake -c populate_sysroot gtk+3 | 72 | $ bitbake -c populate_sysroot gtk+3 |
73 | (or any other target or native item that the application developer would need) | 73 | (or any other target or native item that the application developer would need) |
@@ -279,7 +279,7 @@ command: | |||
279 | .. image:: figures/sdk-devtool-add-flow.png | 279 | .. image:: figures/sdk-devtool-add-flow.png |
280 | :width: 100% | 280 | :width: 100% |
281 | 281 | ||
282 | 1. *Generating the New Recipe*: The top part of the flow shows three | 282 | #. *Generating the New Recipe*: The top part of the flow shows three |
283 | scenarios by which you could use ``devtool add`` to generate a recipe | 283 | scenarios by which you could use ``devtool add`` to generate a recipe |
284 | based on existing source code. | 284 | based on existing source code. |
285 | 285 | ||
@@ -352,7 +352,7 @@ command: | |||
352 | Aside from a recipe folder, the command also creates an associated | 352 | Aside from a recipe folder, the command also creates an associated |
353 | append folder and places an initial ``*.bbappend`` file within. | 353 | append folder and places an initial ``*.bbappend`` file within. |
354 | 354 | ||
355 | 2. *Edit the Recipe*: You can use ``devtool edit-recipe`` to open up the | 355 | #. *Edit the Recipe*: You can use ``devtool edit-recipe`` to open up the |
356 | editor as defined by the ``$EDITOR`` environment variable and modify | 356 | editor as defined by the ``$EDITOR`` environment variable and modify |
357 | the file:: | 357 | the file:: |
358 | 358 | ||
@@ -362,7 +362,7 @@ command: | |||
362 | can make modifications to the recipe that take effect when you build | 362 | can make modifications to the recipe that take effect when you build |
363 | it later. | 363 | it later. |
364 | 364 | ||
365 | 3. *Build the Recipe or Rebuild the Image*: The next step you take | 365 | #. *Build the Recipe or Rebuild the Image*: The next step you take |
366 | depends on what you are going to do with the new code. | 366 | depends on what you are going to do with the new code. |
367 | 367 | ||
368 | If you need to eventually move the build output to the target | 368 | If you need to eventually move the build output to the target |
@@ -378,7 +378,7 @@ command: | |||
378 | 378 | ||
379 | $ devtool build-image image | 379 | $ devtool build-image image |
380 | 380 | ||
381 | 4. *Deploy the Build Output*: When you use the ``devtool build`` command | 381 | #. *Deploy the Build Output*: When you use the ``devtool build`` command |
382 | to build out your recipe, you probably want to see if the resulting | 382 | to build out your recipe, you probably want to see if the resulting |
383 | build output works as expected on the target hardware. | 383 | build output works as expected on the target hardware. |
384 | 384 | ||
@@ -400,7 +400,7 @@ command: | |||
400 | ``devtool`` does not provide a specific command that allows you to | 400 | ``devtool`` does not provide a specific command that allows you to |
401 | deploy the image to actual hardware. | 401 | deploy the image to actual hardware. |
402 | 402 | ||
403 | 5. *Finish Your Work With the Recipe*: The ``devtool finish`` command | 403 | #. *Finish Your Work With the Recipe*: The ``devtool finish`` command |
404 | creates any patches corresponding to commits in the local Git | 404 | creates any patches corresponding to commits in the local Git |
405 | 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 |
406 | 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 |
@@ -446,7 +446,7 @@ command: | |||
446 | .. image:: figures/sdk-devtool-modify-flow.png | 446 | .. image:: figures/sdk-devtool-modify-flow.png |
447 | :width: 100% | 447 | :width: 100% |
448 | 448 | ||
449 | 1. *Preparing to Modify the Code*: The top part of the flow shows three | 449 | #. *Preparing to Modify the Code*: The top part of the flow shows three |
450 | scenarios by which you could use ``devtool modify`` to prepare to | 450 | scenarios by which you could use ``devtool modify`` to prepare to |
451 | work on source files. Each scenario assumes the following: | 451 | work on source files. Each scenario assumes the following: |
452 | 452 | ||
@@ -555,11 +555,11 @@ command: | |||
555 | append file for the recipe in the ``devtool`` workspace. The | 555 | append file for the recipe in the ``devtool`` workspace. The |
556 | recipe and the source code remain in their original locations. | 556 | recipe and the source code remain in their original locations. |
557 | 557 | ||
558 | 2. *Edit the Source*: Once you have used the ``devtool modify`` command, | 558 | #. *Edit the Source*: Once you have used the ``devtool modify`` command, |
559 | you are free to make changes to the source files. You can use any | 559 | you are free to make changes to the source files. You can use any |
560 | editor you like to make and save your source code modifications. | 560 | editor you like to make and save your source code modifications. |
561 | 561 | ||
562 | 3. *Build the Recipe or Rebuild the Image*: The next step you take | 562 | #. *Build the Recipe or Rebuild the Image*: The next step you take |
563 | depends on what you are going to do with the new code. | 563 | depends on what you are going to do with the new code. |
564 | 564 | ||
565 | If you need to eventually move the build output to the target | 565 | If you need to eventually move the build output to the target |
@@ -572,7 +572,7 @@ command: | |||
572 | (e.g. for testing purposes), you can use the ``devtool build-image`` | 572 | (e.g. for testing purposes), you can use the ``devtool build-image`` |
573 | command: $ devtool build-image image | 573 | command: $ devtool build-image image |
574 | 574 | ||
575 | 4. *Deploy the Build Output*: When you use the ``devtool build`` command | 575 | #. *Deploy the Build Output*: When you use the ``devtool build`` command |
576 | to build out your recipe, you probably want to see if the resulting | 576 | to build out your recipe, you probably want to see if the resulting |
577 | build output works as expected on target hardware. | 577 | build output works as expected on target hardware. |
578 | 578 | ||
@@ -597,7 +597,7 @@ command: | |||
597 | ``devtool`` does not provide a specific command to deploy the image | 597 | ``devtool`` does not provide a specific command to deploy the image |
598 | to actual hardware. | 598 | to actual hardware. |
599 | 599 | ||
600 | 5. *Finish Your Work With the Recipe*: The ``devtool finish`` command | 600 | #. *Finish Your Work With the Recipe*: The ``devtool finish`` command |
601 | creates any patches corresponding to commits in the local Git | 601 | creates any patches corresponding to commits in the local Git |
602 | repository, updates the recipe to point to them (or creates a | 602 | repository, updates the recipe to point to them (or creates a |
603 | ``.bbappend`` file to do so, depending on the specified destination | 603 | ``.bbappend`` file to do so, depending on the specified destination |
@@ -664,7 +664,7 @@ The following diagram shows the common development flow used with the | |||
664 | .. image:: figures/sdk-devtool-upgrade-flow.png | 664 | .. image:: figures/sdk-devtool-upgrade-flow.png |
665 | :width: 100% | 665 | :width: 100% |
666 | 666 | ||
667 | 1. *Initiate the Upgrade*: The top part of the flow shows the typical | 667 | #. *Initiate the Upgrade*: The top part of the flow shows the typical |
668 | scenario by which you use the ``devtool upgrade`` command. The | 668 | scenario by which you use the ``devtool upgrade`` command. The |
669 | following conditions exist: | 669 | following conditions exist: |
670 | 670 | ||
@@ -716,7 +716,7 @@ The following diagram shows the common development flow used with the | |||
716 | are incorporated into the build the next time you build the software | 716 | are incorporated into the build the next time you build the software |
717 | just as are other changes you might have made to the source. | 717 | just as are other changes you might have made to the source. |
718 | 718 | ||
719 | 2. *Resolve any Conflicts created by the Upgrade*: Conflicts could happen | 719 | #. *Resolve any Conflicts created by the Upgrade*: Conflicts could happen |
720 | after upgrading the software to a new version. Conflicts occur | 720 | after upgrading the software to a new version. Conflicts occur |
721 | if your recipe specifies some patch files in :term:`SRC_URI` that | 721 | if your recipe specifies some patch files in :term:`SRC_URI` that |
722 | conflict with changes made in the new version of the software. For | 722 | conflict with changes made in the new version of the software. For |
@@ -727,7 +727,7 @@ The following diagram shows the common development flow used with the | |||
727 | conflicts created through use of a newer or different version of the | 727 | conflicts created through use of a newer or different version of the |
728 | software. | 728 | software. |
729 | 729 | ||
730 | 3. *Build the Recipe or Rebuild the Image*: The next step you take | 730 | #. *Build the Recipe or Rebuild the Image*: The next step you take |
731 | depends on what you are going to do with the new code. | 731 | depends on what you are going to do with the new code. |
732 | 732 | ||
733 | If you need to eventually move the build output to the target | 733 | If you need to eventually move the build output to the target |
@@ -742,7 +742,7 @@ The following diagram shows the common development flow used with the | |||
742 | 742 | ||
743 | $ devtool build-image image | 743 | $ devtool build-image image |
744 | 744 | ||
745 | 4. *Deploy the Build Output*: When you use the ``devtool build`` command | 745 | #. *Deploy the Build Output*: When you use the ``devtool build`` command |
746 | or ``bitbake`` to build your recipe, you probably want to see if the | 746 | or ``bitbake`` to build your recipe, you probably want to see if the |
747 | resulting build output works as expected on target hardware. | 747 | resulting build output works as expected on target hardware. |
748 | 748 | ||
@@ -764,7 +764,7 @@ The following diagram shows the common development flow used with the | |||
764 | ``devtool`` does not provide a specific command that allows you to do | 764 | ``devtool`` does not provide a specific command that allows you to do |
765 | this. | 765 | this. |
766 | 766 | ||
767 | 5. *Finish Your Work With the Recipe*: The ``devtool finish`` command | 767 | #. *Finish Your Work With the Recipe*: The ``devtool finish`` command |
768 | creates any patches corresponding to commits in the local Git | 768 | creates any patches corresponding to commits in the local Git |
769 | repository, moves the new recipe to a more permanent layer, and then | 769 | repository, moves the new recipe to a more permanent layer, and then |
770 | resets the recipe so that the recipe is built normally rather than | 770 | resets the recipe so that the recipe is built normally rather than |
@@ -1054,17 +1054,17 @@ Working With Recipes | |||
1054 | When building a recipe using the ``devtool build`` command, the typical | 1054 | When building a recipe using the ``devtool build`` command, the typical |
1055 | build progresses as follows: | 1055 | build progresses as follows: |
1056 | 1056 | ||
1057 | 1. Fetch the source | 1057 | #. Fetch the source |
1058 | 1058 | ||
1059 | 2. Unpack the source | 1059 | #. Unpack the source |
1060 | 1060 | ||
1061 | 3. Configure the source | 1061 | #. Configure the source |
1062 | 1062 | ||
1063 | 4. Compile the source | 1063 | #. Compile the source |
1064 | 1064 | ||
1065 | 5. Install the build output | 1065 | #. Install the build output |
1066 | 1066 | ||
1067 | 6. Package the installed output | 1067 | #. Package the installed output |
1068 | 1068 | ||
1069 | For recipes in the workspace, fetching and unpacking is disabled as the | 1069 | For recipes in the workspace, fetching and unpacking is disabled as the |
1070 | source tree has already been prepared and is persistent. Each of these | 1070 | source tree has already been prepared and is persistent. Each of these |
@@ -1322,15 +1322,15 @@ those customers need an SDK that has custom libraries. In such a case, | |||
1322 | you can produce a derivative SDK based on the currently installed SDK | 1322 | you can produce a derivative SDK based on the currently installed SDK |
1323 | fairly easily by following these steps: | 1323 | fairly easily by following these steps: |
1324 | 1324 | ||
1325 | 1. If necessary, install an extensible SDK that you want to use as a | 1325 | #. If necessary, install an extensible SDK that you want to use as a |
1326 | base for your derivative SDK. | 1326 | base for your derivative SDK. |
1327 | 1327 | ||
1328 | 2. Source the environment script for the SDK. | 1328 | #. Source the environment script for the SDK. |
1329 | 1329 | ||
1330 | 3. Add the extra libraries or other components you want by using the | 1330 | #. Add the extra libraries or other components you want by using the |
1331 | ``devtool add`` command. | 1331 | ``devtool add`` command. |
1332 | 1332 | ||
1333 | 4. Run the ``devtool build-sdk`` command. | 1333 | #. Run the ``devtool build-sdk`` command. |
1334 | 1334 | ||
1335 | The previous steps take the recipes added to the workspace and construct | 1335 | The previous steps take the recipes added to the workspace and construct |
1336 | a new SDK installer that contains those recipes and the resulting binary | 1336 | a new SDK installer that contains those recipes and the resulting binary |
diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst index ce00538b2a..49aa921e70 100644 --- a/documentation/sdk-manual/intro.rst +++ b/documentation/sdk-manual/intro.rst | |||
@@ -164,11 +164,11 @@ image. | |||
164 | 164 | ||
165 | You just need to follow these general steps: | 165 | You just need to follow these general steps: |
166 | 166 | ||
167 | 1. *Install the SDK for your target hardware:* For information on how to | 167 | #. *Install the SDK for your target hardware:* For information on how to |
168 | install the SDK, see the ":ref:`sdk-manual/using:installing the sdk`" | 168 | install the SDK, see the ":ref:`sdk-manual/using:installing the sdk`" |
169 | section. | 169 | section. |
170 | 170 | ||
171 | 2. *Download or Build the Target Image:* The Yocto Project supports | 171 | #. *Download or Build the Target Image:* The Yocto Project supports |
172 | several target architectures and has many pre-built kernel images and | 172 | several target architectures and has many pre-built kernel images and |
173 | root filesystem images. | 173 | root filesystem images. |
174 | 174 | ||
@@ -195,7 +195,7 @@ You just need to follow these general steps: | |||
195 | ":ref:`sdk-manual/appendix-obtain:extracting the root filesystem`" | 195 | ":ref:`sdk-manual/appendix-obtain:extracting the root filesystem`" |
196 | section for information on how to do this extraction. | 196 | section for information on how to do this extraction. |
197 | 197 | ||
198 | 3. *Develop and Test your Application:* At this point, you have the | 198 | #. *Develop and Test your Application:* At this point, you have the |
199 | tools to develop your application. If you need to separately install | 199 | tools to develop your application. If you need to separately install |
200 | and use the QEMU emulator, you can go to `QEMU Home | 200 | and use the QEMU emulator, you can go to `QEMU Home |
201 | Page <https://wiki.qemu.org/Main_Page>`__ to download and learn about | 201 | Page <https://wiki.qemu.org/Main_Page>`__ to download and learn about |
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 |