summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/ref-manual/ref-devtool-reference.xml58
1 files changed, 46 insertions, 12 deletions
diff --git a/documentation/ref-manual/ref-devtool-reference.xml b/documentation/ref-manual/ref-devtool-reference.xml
index b7c0e334ea..a577d1a457 100644
--- a/documentation/ref-manual/ref-devtool-reference.xml
+++ b/documentation/ref-manual/ref-devtool-reference.xml
@@ -208,9 +208,9 @@
208 The following example creates and adds a new recipe named 208 The following example creates and adds a new recipe named
209 <filename>jackson</filename> to a workspace layer the tool creates. 209 <filename>jackson</filename> to a workspace layer the tool creates.
210 The source code built by the recipes resides in 210 The source code built by the recipes resides in
211 <filename>/home/scottrif/sources/jackson</filename>: 211 <filename>/home/<replaceable>user</replaceable>/sources/jackson</filename>:
212 <literallayout class='monospaced'> 212 <literallayout class='monospaced'>
213 $ devtool add jackson /home/scottrif/sources/jackson 213 $ devtool add jackson /home/<replaceable>user</replaceable>/sources/jackson
214 </literallayout> 214 </literallayout>
215 </para> 215 </para>
216 216
@@ -228,18 +228,52 @@
228 append files, and source files into the existing workspace layer. 228 append files, and source files into the existing workspace layer.
229 The <filename>.bbappend</filename> file is created to point 229 The <filename>.bbappend</filename> file is created to point
230 to the external source tree. 230 to the external source tree.
231 <note>
232 If your recipe has runtime dependencies defined, you must be sure
233 that these packages exist on the target hardware before attempting
234 to run your application.
235 If dependent packages (e.g. libraries) do not exist on the target,
236 your application, when run, will fail to find those functions.
237 For more information, see the
238 "<link linkend='devtool-deploying-your-software-on-the-target-machine'>Deploying Your Software on the Target Machine</link>"
239 section.
240 </note>
231 </para> 241 </para>
232 242
233 <note> 243 <para>
234 If your recipe has runtime dependencies defined, you must be sure 244 By default, <filename>devtool add</filename> uses the latest
235 that these packages exist on the target hardware before attempting 245 revision (i.e. master) when unpacking files from a remote URI.
236 to run your application. 246 In some cases, you might want to specify a source revision by
237 If dependent packages (e.g. libraries) do not exist on the target, 247 branch, tag, or commit hash. You can specify these options when
238 your application, when run, will fail to find those functions. 248 using the <filename>devtool add</filename> command:
239 For more information, see the 249 <itemizedlist>
240 "<link linkend='devtool-deploying-your-software-on-the-target-machine'>Deploying Your Software on the Target Machine</link>" 250 <listitem><para>
241 section. 251 To specify a source branch, use the
242 </note> 252 <filename>--srcbranch</filename> option:
253 <literallayout class='monospaced'>
254 $ devtool add --srcbranch &DISTRO_NAME_NO_CAP; jackson /home/<replaceable>user</replaceable>/sources/jackson
255 </literallayout>
256 In the previous example, you are checking out the
257 &DISTRO_NAME_NO_CAP; branch.
258 </para></listitem>
259 <listitem><para>
260 To specify a specific tag or commit hash, use the
261 <filename>--srcrev</filename> option:
262 <literallayout class='monospaced'>
263 $ devtool add --srcrev &DISTRO_REL_TAG; jackson /home/<replaceable>user</replaceable>/sources/jackson
264 $ devtool add --srcrev <replaceable>some_commit_hash</replaceable> /home/<replaceable>user</replaceable>/sources/jackson
265 </literallayout>
266 The previous examples check out the &DISTRO_REL_TAG; tag
267 and the commit associated with the
268 <replaceable>some_commit_hash</replaceable> hash.
269 </para></listitem>
270 </itemizedlist>
271 <note>
272 If you prefer to use the latest revision every time the recipe is
273 built, use the options <filename>--autorev</filename>
274 or <filename>-a</filename>.
275 </note>
276 </para>
243 </section> 277 </section>
244 278
245 <section id='devtool-extracting-the-source-for-an-existing-recipe'> 279 <section id='devtool-extracting-the-source-for-an-existing-recipe'>