summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-02-23 07:53:26 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-03-03 17:40:12 +0000
commitd346c35b19d4a1b43245cf6993854b2534791de6 (patch)
treebee3be7a97604d4680d865a2fa78f62488d76d9b /documentation/dev-manual
parent3b410498fec06cd09731571800405320d7ff4096 (diff)
downloadpoky-d346c35b19d4a1b43245cf6993854b2534791de6.tar.gz
dev-manual: Applied review comments to devshell section.
Fixes [YOCTO #9114] Added a "Notes" box to address run script naming points and the fact that running a task's script is identical to what BitBake would do when it runs the task. (From yocto-docs rev: ddfba59743c977a3a3483ed9053434d3c622f698) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-model.xml44
1 files changed, 30 insertions, 14 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index cad204d3b7..d2ab2d7f41 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -2843,6 +2843,21 @@
2843 <literallayout class='monospaced'> 2843 <literallayout class='monospaced'>
2844 $ bitbake -c <replaceable>task</replaceable> 2844 $ bitbake -c <replaceable>task</replaceable>
2845 </literallayout> 2845 </literallayout>
2846 <note><title>Notes</title>
2847 <itemizedlist>
2848 <listitem><para>Execution of a task's <filename>run.*</filename>
2849 script and BitBake's execution of a task are identical.
2850 In other words, running the script re-runs the task
2851 just as it would be run using the
2852 <filename>bitbake -c</filename> command.
2853 </para></listitem>
2854 <listitem><para>Any <filename>run.*</filename> file that doe not
2855 have a <filename>.pid</filename> extension is a
2856 symbolic link (symlink) to the most recent version of that
2857 file.
2858 </para></listitem>
2859 </itemizedlist>
2860 </note>
2846 </para> 2861 </para>
2847 2862
2848 <para> 2863 <para>
@@ -2859,20 +2874,21 @@
2859 </para> 2874 </para>
2860 2875
2861 <note><title>Notes</title> 2876 <note><title>Notes</title>
2862 <para> 2877 <itemizedlist>
2863 It is worth remembering that when using <filename>devshell</filename> 2878 <listitem><para>
2864 you need to use the full compiler name such as <filename>arm-poky-linux-gnueabi-gcc</filename> 2879 It is worth remembering that when using <filename>devshell</filename>
2865 instead of just using <filename>gcc</filename>. 2880 you need to use the full compiler name such as <filename>arm-poky-linux-gnueabi-gcc</filename>
2866 The same applies to other applications such as <filename>binutils</filename>, 2881 instead of just using <filename>gcc</filename>.
2867 <filename>libtool</filename> and so forth. 2882 The same applies to other applications such as <filename>binutils</filename>,
2868 BitBake sets up environment variables such as <filename>CC</filename> 2883 <filename>libtool</filename> and so forth.
2869 to assist applications, such as <filename>make</filename> to find the correct tools. 2884 BitBake sets up environment variables such as <filename>CC</filename>
2870 </para> 2885 to assist applications, such as <filename>make</filename> to find the correct tools.
2871 2886 </para></listitem>
2872 <para> 2887 <listitem><para>
2873 It is also worth noting that <filename>devshell</filename> still works over 2888 It is also worth noting that <filename>devshell</filename> still works over
2874 X11 forwarding and similar situations. 2889 X11 forwarding and similar situations.
2875 </para> 2890 </para></listitem>
2891 </itemizedlist>
2876 </note> 2892 </note>
2877</section> 2893</section>
2878 2894