summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-common-tasks.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-11-11 15:56:08 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-02 13:16:11 +0000
commit1e8388924219f5a99442e7dc26e82791ce304f26 (patch)
tree02ecc80e99a85b2f736798f61c00d90c933eab39 /documentation/dev-manual/dev-manual-common-tasks.xml
parent5a3296cf25399052774b7ddfbe5a70aa46bd28d4 (diff)
downloadpoky-1e8388924219f5a99442e7dc26e82791ce304f26.tar.gz
dev-manual: Some development text for fetching source
I have added some stuff to the section on fetching source in the new "Writing a Recipe" section. (From yocto-docs rev: a4b340d58888927bf648be34402670f8a7d87d8b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-common-tasks.xml')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml47
1 files changed, 38 insertions, 9 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 707d1c3ceb..762ffb2399 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1142,8 +1142,8 @@
1142 <para> 1142 <para>
1143 Recipes (<filename>.bb</filename> files) are fundamental components 1143 Recipes (<filename>.bb</filename> files) are fundamental components
1144 in the Yocto Project environment. 1144 in the Yocto Project environment.
1145 The OpenEmbedded build system parses and compiles your recipes to 1145 The OpenEmbedded build system parses and compiles your recipes and
1146 create an image. 1146 packages the output to create an image.
1147 Your project consists in part of the recipes that define it. 1147 Your project consists in part of the recipes that define it.
1148 This section describes how to create, write, and test a new 1148 This section describes how to create, write, and test a new
1149 recipe. 1149 recipe.
@@ -1168,8 +1168,8 @@
1168 best way to get started. 1168 best way to get started.
1169 Here are some points on both methods: 1169 Here are some points on both methods:
1170 <itemizedlist> 1170 <itemizedlist>
1171 <listitem><para><emphasis>Locate a recipe that is close 1171 <listitem><para><emphasis>Locate and modify a recipe that
1172 to what you want to do and use it:</emphasis> 1172 is close to what you want to do:</emphasis>
1173 This method works when you are familiar with the 1173 This method works when you are familiar with the
1174 current recipe space. 1174 current recipe space.
1175 The method does not work so well for those new to 1175 The method does not work so well for those new to
@@ -1181,7 +1181,8 @@
1181 have to add from scratch, and so forth. 1181 have to add from scratch, and so forth.
1182 All these risks stem from unfamiliarity with the 1182 All these risks stem from unfamiliarity with the
1183 existing recipe space.</para></listitem> 1183 existing recipe space.</para></listitem>
1184 <listitem><para><emphasis>Use a skeleton recipe:</emphasis> 1184 <listitem><para><emphasis>Use and modify a skeleton
1185 recipe:</emphasis>
1185 Using the skeleton recipe located at 1186 Using the skeleton recipe located at
1186 &lt;Need some path for a good recipe to use&gt; is the 1187 &lt;Need some path for a good recipe to use&gt; is the
1187 recommended method for creating a new recipe. 1188 recommended method for creating a new recipe.
@@ -1197,10 +1198,38 @@
1197 <title>Fetching Code</title> 1198 <title>Fetching Code</title>
1198 1199
1199 <para> 1200 <para>
1200 fetching: basically a matter of ensuring SRC_URI is correct, and for archives 1201 The first thing your recipe must do is fetch the source files.
1201that SRC_URI checksums are specified and correct. We should show examples of 1202 Fetching is accomplished through the
1202the error message you get when you don't, from which you can copy and paste 1203 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
1203the lines with the correct values. 1204 variable.
1205 Your recipe must have a <filename>SRC_URI</filename> variable
1206 that points to where the source is located.
1207 The <filename>do_fetch</filename> task uses the
1208 variable and its prefix to determine what fetcher to use to
1209 get your source files.
1210 It is the <filename>SRC_URI</filename> variable that triggers
1211 the fetcher.
1212 The <filename>do_patch</filename> task uses the variable after
1213 source is fetched to apply patches.
1214 The OpenEmbedded build system uses
1215 <ulink url='&YOCOT_DOCS_REF_URL;#var-FILESOVERRIDES'><filename>FILESOVERRIDES</filename></ulink>
1216 when scanning directory names for files in
1217 <filename>SRC_URI</filename>.
1218 </para>
1219
1220 <para>
1221 You need to use an instance of the <filename>SRC_URI</filename>
1222 variable for each unique location holding your source file.
1223 For example, if you need a tarball, and two patches, then you
1224 need to use three instances of the variable in your recipe.
1225 </para>
1226
1227 <para>
1228 I need some good examples here.
1229 I also need some sample error messages you get when you don't
1230 have the correct <filename>SRC_URI</filename> locations.
1231 We can describe how you can copy and past the lines from the
1232 error message and use the correct values.
1204 </para> 1233 </para>
1205 </section> 1234 </section>
1206 1235