summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-01-11 11:55:06 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2019-01-16 15:35:47 +0000
commit7022689b109a7e2bb52c76a46d76fd3760658ad0 (patch)
tree1a789c0b3b41b073d7bc9f3b02e08e3a0740dae4 /documentation
parenta5b97067220cab89738a81616eaedbd97647b199 (diff)
downloadpoky-7022689b109a7e2bb52c76a46d76fd3760658ad0.tar.gz
brief-yoctoprojectqs, dev-manual: Update tag checkout examples
Turns out I had some hard-coded stuff in these examples. Furthermore, I did not have good enough detail in the brief-yoctoprojectqs manual. I added more detail on how to get that sato example going. (From yocto-docs rev: 8d2fe4968eec9250c6bf9da530d2d7521f68b986) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml72
-rw-r--r--documentation/dev-manual/dev-manual-start.xml9
2 files changed, 67 insertions, 14 deletions
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
index f8b01ecc4c..2e7beb1644 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
@@ -144,23 +144,48 @@
144 you need to get a copy of the Poky repository on your build 144 you need to get a copy of the Poky repository on your build
145 host. 145 host.
146 Use the following commands to clone the Poky 146 Use the following commands to clone the Poky
147 repository and then checkout the &DISTRO_REL_TAG; release: 147 repository.
148 <literallayout class='monospaced'> 148 <literallayout class='monospaced'>
149 $ git clone git://git.yoctoproject.org/poky 149 $ git clone git://git.yoctoproject.org/poky
150 Cloning into 'poky'... 150 Cloning into 'poky'...
151 remote: Counting objects: 361782, done. 151 remote: Counting objects: 428632, done.
152 remote: Compressing objects: 100% (87100/87100), done. 152 remote: Compressing objects: 100% (101203/101203), done.
153 remote: Total 361782 (delta 268619), reused 361439 (delta 268277) 153 remote: Total 428632 (delta 320463), reused 428532 (delta 320363)
154 Receiving objects: 100% (361782/361782), 131.94 MiB | 6.88 MiB/s, done. 154 Receiving objects: 100% (428632/428632), 153.01 MiB | 12.40 MiB/s, done.
155 Resolving deltas: 100% (268619/268619), done. 155 Resolving deltas: 100% (320463/320463), done.
156 Checking connectivity... done. 156 Checking connectivity... done.
157 $ git checkout tags/yocto-2.5 -b my-yocto-2.5 157 </literallayout>
158 Move to the <filename>poky</filename> directory and take a look
159 at the tags:
160 <literallayout class='monospaced'>
161 $ cd poky
162 $ git fetch --tags
163 $ git tag
164 1.1_M1.final
165 1.1_M1.rc1
166 1.1_M1.rc2
167 1.1_M2.final
168 1.1_M2.rc1
169 .
170 .
171 .
172 yocto-2.5
173 yocto-2.5.1
174 yocto-2.5.2
175 yocto-2.6
176 yocto_1.5_M5.rc8
177 </literallayout>
178 For this example, check out the branch based on the
179 &DISTRO_REL_TAG; release:
180 <literallayout class='monospaced'>
181 $ git checkout tags/&DISTRO_REL_TAG; -b my-&DISTRO_REL_TAG;
182 Switched to a new branch 'my-&DISTRO_REL_TAG;'
158 </literallayout> 183 </literallayout>
159 The previous Git checkout command creates a local branch 184 The previous Git checkout command creates a local branch
160 named my-&DISTRO_REL_TAG;. The files available to you in that 185 named my-&DISTRO_REL_TAG;. The files available to you in that
161 branch exactly match the repository's files in the 186 branch exactly match the repository's files in the
162 "&DISTRO_NAME_NO_CAP;" development branch at the time of the 187 "&DISTRO_NAME_NO_CAP;" development branch at the time of the
163 Yocto Project &DISTRO; release. 188 Yocto Project &DISTRO_REL_TAG; release.
164 </para> 189 </para>
165 190
166 <para> 191 <para>
@@ -204,12 +229,41 @@
204 <orderedlist> 229 <orderedlist>
205 <listitem><para> 230 <listitem><para>
206 <emphasis>Initialize the Build Environment:</emphasis> 231 <emphasis>Initialize the Build Environment:</emphasis>
207 Run the 232 From within the <filename>poky</filename> directory, run the
208 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 233 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
209 environment setup script to define Yocto Project's 234 environment setup script to define Yocto Project's
210 build environment on your build host. 235 build environment on your build host.
211 <literallayout class='monospaced'> 236 <literallayout class='monospaced'>
237 $ cd ~/poky
212 $ source &OE_INIT_FILE; 238 $ source &OE_INIT_FILE;
239 You had no conf/local.conf file. This configuration file has therefore been
240 created for you with some default values. You may wish to edit it to, for
241 example, select a different MACHINE (target hardware). See conf/local.conf
242 for more information as common configuration options are commented.
243
244 You had no conf/bblayers.conf file. This configuration file has therefore been
245 created for you with some default values. To add additional metadata layers
246 into your configuration please add entries to conf/bblayers.conf.
247
248 The Yocto Project has extensive documentation about OE including a reference
249 manual which can be found at:
250 http://yoctoproject.org/documentation
251
252 For more information about OpenEmbedded see their website:
253 http://www.openembedded.org/
254
255
256 ### Shell environment set up for builds. ###
257
258 You can now run 'bitbake &lt;target&gt;'
259
260 Common targets are:
261 core-image-minimal
262 core-image-sato
263 meta-toolchain
264 meta-ide-support
265
266 You can also run generated qemu images with a command like 'runqemu qemux86'
213 </literallayout> 267 </literallayout>
214 Among other things, the script creates the 268 Among other things, the script creates the
215 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, 269 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 3f971ba4b0..7ad5a08171 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -1122,11 +1122,10 @@
1122 . 1122 .
1123 . 1123 .
1124 . 1124 .
1125 yocto-2.2 1125 yocto-2.5
1126 yocto-2.2.1 1126 yocto-2.5.1
1127 yocto-2.3 1127 yocto-2.5.2
1128 yocto-2.3.1 1128 yocto-2.6
1129 yocto-2.4
1130 yocto_1.5_M5.rc8 1129 yocto_1.5_M5.rc8
1131 </literallayout> 1130 </literallayout>
1132 </para></listitem> 1131 </para></listitem>