summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-03-18 12:32:33 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-03-24 23:44:02 +0000
commit478c7c304351838c16ddd322aaded236ae2c0259 (patch)
tree2041b73d09368d66969c4ff401ca3b9d46639fd0 /documentation/ref-manual
parent2ad42e587ac24e69bdfb6b9c743b886116a0fe31 (diff)
downloadpoky-478c7c304351838c16ddd322aaded236ae2c0259.tar.gz
ref-manual: Added information about pre-installed dependencies
Fixes [YOCTO #10350] A situation exists where a user deploys a new application using devtool target-deploy and the new application has runtime dependencies that are not already on the target. When this situation exists, the application misbehaves if it calls a missing function. I added the explanation of this situation to the section that describes the devtool deploy-target command. Also, put a pointer in the section on devtool add for cross-reference purposes. (From yocto-docs rev: 694151e397ff40871b3ec8700c39d32a15814535) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-devtool-reference.xml45
1 files changed, 45 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-devtool-reference.xml b/documentation/ref-manual/ref-devtool-reference.xml
index 1764f0196f..90330f1a35 100644
--- a/documentation/ref-manual/ref-devtool-reference.xml
+++ b/documentation/ref-manual/ref-devtool-reference.xml
@@ -215,6 +215,17 @@
215 The <filename>.bbappend</filename> file is created to point 215 The <filename>.bbappend</filename> file is created to point
216 to the external source tree. 216 to the external source tree.
217 </para> 217 </para>
218
219 <note>
220 If your recipe has runtime dependencies defined, you must be sure
221 that these packages exist on the target hardware before attempting
222 to run your application.
223 If dependent packages (e.g. libraries) do not exist on the target,
224 your application, when run, will fail to find those functions.
225 For more information, see the
226 "<link linkend='devtool-deploying-your-software-on-the-target-machine'>Deploying Your Software on the Target Machine</link>"
227 section.
228 </note>
218 </section> 229 </section>
219 230
220 <section id='devtool-extracting-the-source-for-an-existing-recipe'> 231 <section id='devtool-extracting-the-source-for-an-existing-recipe'>
@@ -501,6 +512,40 @@
501 </para> 512 </para>
502 </note> 513 </note>
503 </para> 514 </para>
515
516 <para>
517 Some conditions exist that could prevent a deployed application
518 from behaving as expected.
519 When both of the following conditions exist, your application has
520 the potential to not behave correctly when run on the target:
521 <itemizedlist>
522 <listitem><para>
523 You are deploying a new application to the target that
524 has correctly defined runtime dependencies defined in
525 recipe you used to build the application.
526 </para></listitem>
527 <listitem><para>
528 The target does not physically have the packages on which
529 the application depends installed.
530 </para></listitem>
531 </itemizedlist>
532 If both of these conditions exist, your application will not
533 behave as expected.
534 The reason for this misbehavior is because the
535 <filename>devtool deploy-target</filename> command does not deploy
536 the packages (e.g. libraries) on which your new application
537 depends.
538 The assumption is that the packages are already on the target.
539 Consequently, when a runtime call is made in the application
540 for a dependent function (e.g. a library call), the function
541 cannot be found.
542 </para>
543
544 <para>
545 To be sure you have all the dependencies local to the target, you
546 need to be sure that the packages are pre-deployed (installed)
547 on the target before attempting to run your application.
548 </para>
504 </section> 549 </section>
505 550
506 <section id='devtool-removing-your-software-from-the-target-machine'> 551 <section id='devtool-removing-your-software-from-the-target-machine'>