diff options
Diffstat (limited to 'documentation/sdk-manual/using.rst')
-rw-r--r-- | documentation/sdk-manual/using.rst | 62 |
1 files changed, 28 insertions, 34 deletions
diff --git a/documentation/sdk-manual/using.rst b/documentation/sdk-manual/using.rst index 29fb50465f..f1ff0c76ca 100644 --- a/documentation/sdk-manual/using.rst +++ b/documentation/sdk-manual/using.rst | |||
@@ -11,13 +11,13 @@ standard SDK. | |||
11 | .. note:: | 11 | .. note:: |
12 | 12 | ||
13 | For a side-by-side comparison of main features supported for a | 13 | For a side-by-side comparison of main features supported for a |
14 | standard SDK as compared to an extensible SDK, see the " | 14 | standard SDK as compared to an extensible SDK, see the |
15 | Introduction | 15 | ":ref:`sdk-manual/intro:introduction`" section. |
16 | " section. | ||
17 | 16 | ||
18 | You can use a standard SDK to work on Makefile and Autotools-based | 17 | You can use a standard SDK to work on Makefile and Autotools-based |
19 | projects. See the "`Using the SDK Toolchain | 18 | projects. See the |
20 | Directly <#sdk-working-projects>`__" chapter for more information. | 19 | ":ref:`sdk-manual/working-projects:using the sdk toolchain directly`" chapter |
20 | for more information. | ||
21 | 21 | ||
22 | Why use the Standard SDK and What is in It? | 22 | Why use the Standard SDK and What is in It? |
23 | =========================================== | 23 | =========================================== |
@@ -31,9 +31,9 @@ the extensible SDK, which provides an internal build system and the | |||
31 | The installed Standard SDK consists of several files and directories. | 31 | The installed Standard SDK consists of several files and directories. |
32 | Basically, it contains an SDK environment setup script, some | 32 | Basically, it contains an SDK environment setup script, some |
33 | configuration files, and host and target root filesystems to support | 33 | configuration files, and host and target root filesystems to support |
34 | usage. You can see the directory structure in the "`Installed Standard | 34 | usage. You can see the directory structure in the |
35 | SDK Directory | 35 | ":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`" |
36 | Structure <#sdk-installed-standard-sdk-directory-structure>`__" section. | 36 | section. |
37 | 37 | ||
38 | Installing the SDK | 38 | Installing the SDK |
39 | ================== | 39 | ================== |
@@ -48,12 +48,11 @@ the Index of Releases. Toolchains are available for several 32-bit and | |||
48 | 64-bit architectures with the ``x86_64`` directories, respectively. The | 48 | 64-bit architectures with the ``x86_64`` directories, respectively. The |
49 | toolchains the Yocto Project provides are based off the | 49 | toolchains the Yocto Project provides are based off the |
50 | ``core-image-sato`` and ``core-image-minimal`` images and contain | 50 | ``core-image-sato`` and ``core-image-minimal`` images and contain |
51 | libraries appropriate for developing against that image. | 51 | libraries appropriate for developing against the corresponding image. |
52 | 52 | ||
53 | The names of the tarball installer scripts are such that a string | 53 | The names of the tarball installer scripts are such that a string |
54 | representing the host system appears first in the filename and then is | 54 | representing the host system appears first in the filename and then is |
55 | immediately followed by a string representing the target architecture. | 55 | immediately 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 | ||
@@ -76,17 +75,16 @@ immediately followed by a string representing the target architecture. | |||
76 | 75 | ||
77 | For example, the following SDK installer is for a 64-bit | 76 | For example, the following SDK installer is for a 64-bit |
78 | development host system and a i586-tuned target architecture based off | 77 | development host system and a i586-tuned target architecture based off |
79 | the SDK for ``core-image-sato`` and using the current DISTRO snapshot: | 78 | the SDK for ``core-image-sato`` and using the current DISTRO snapshot:: |
80 | :: | ||
81 | 79 | ||
82 | poky-glibc-x86_64-core-image-sato-i586-toolchain-DISTRO.sh | 80 | poky-glibc-x86_64-core-image-sato-i586-toolchain-DISTRO.sh |
83 | 81 | ||
84 | .. note:: | 82 | .. note:: |
85 | 83 | ||
86 | As an alternative to downloading an SDK, you can build the SDK | 84 | As an alternative to downloading an SDK, you can build the SDK |
87 | installer. For information on building the installer, see the " | 85 | installer. For information on building the installer, see the |
88 | Building an SDK Installer | 86 | ":ref:`sdk-manual/appendix-obtain:building an sdk installer`" |
89 | " section. | 87 | section. |
90 | 88 | ||
91 | The SDK and toolchains are self-contained and by default are installed | 89 | The SDK and toolchains are self-contained and by default are installed |
92 | into the ``poky_sdk`` folder in your home directory. You can choose to | 90 | into the ``poky_sdk`` folder in your home directory. You can choose to |
@@ -98,16 +96,7 @@ must be writable for whichever users need to use the SDK. | |||
98 | The following command shows how to run the installer given a toolchain | 96 | The following command shows how to run the installer given a toolchain |
99 | tarball for a 64-bit x86 development host system and a 64-bit x86 target | 97 | tarball for a 64-bit x86 development host system and a 64-bit x86 target |
100 | architecture. The example assumes the SDK installer is located in | 98 | architecture. The example assumes the SDK installer is located in |
101 | ``~/Downloads/`` and has execution rights. | 99 | ``~/Downloads/`` and has execution rights:: |
102 | |||
103 | .. note:: | ||
104 | |||
105 | If you do not have write permissions for the directory into which you | ||
106 | are installing the SDK, the installer notifies you and exits. For | ||
107 | that case, set up the proper permissions in the directory and run the | ||
108 | installer again. | ||
109 | |||
110 | :: | ||
111 | 100 | ||
112 | $ ./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 |
113 | Poky (Yocto Project Reference Distro) SDK installer version &DISTRO; | 102 | Poky (Yocto Project Reference Distro) SDK installer version &DISTRO; |
@@ -120,9 +109,16 @@ architecture. The example assumes the SDK installer is located in | |||
120 | 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. |
121 | $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux | 110 | $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux |
122 | 111 | ||
123 | Again, reference the "`Installed Standard SDK Directory | 112 | .. note:: |
124 | Structure <#sdk-installed-standard-sdk-directory-structure>`__" section | 113 | |
125 | for more details on the resulting directory structure of the installed | 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 | |||
119 | Again, reference the | ||
120 | ":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`" | ||
121 | section for more details on the resulting directory structure of the installed | ||
126 | SDK. | 122 | SDK. |
127 | 123 | ||
128 | Running the SDK Environment Setup Script | 124 | Running the SDK Environment Setup Script |
@@ -140,14 +136,12 @@ begin with the string "``environment-setup``" and include as part of | |||
140 | their name the tuned target architecture. As an example, the following | 136 | their name the tuned target architecture. As an example, the following |
141 | commands set the working directory to where the SDK was installed and | 137 | commands set the working directory to where the SDK was installed and |
142 | then source the environment setup script. In this example, the setup | 138 | then source the environment setup script. In this example, the setup |
143 | script is for an IA-based target machine using i586 tuning: | 139 | script is for an IA-based target machine using i586 tuning:: |
144 | :: | ||
145 | 140 | ||
146 | $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux | 141 | $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux |
147 | 142 | ||
148 | When you run the | 143 | When you run the |
149 | setup script, the same environment variables are defined as are when you | 144 | setup script, the same environment variables are defined as are when you |
150 | run the setup script for an extensible SDK. See the "`Running the | 145 | run the setup script for an extensible SDK. See the |
151 | Extensible SDK Environment Setup | 146 | ":ref:`sdk-manual/appendix-obtain:installed extensible sdk directory structure`" |
152 | Script <#sdk-running-the-extensible-sdk-environment-setup-script>`__" | ||
153 | section for more information. | 147 | section for more information. |