diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/poky-ref-manual/development.xml | 78 |
1 files changed, 0 insertions, 78 deletions
diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml index f7e67a6545..af8a59cb0c 100644 --- a/documentation/poky-ref-manual/development.xml +++ b/documentation/poky-ref-manual/development.xml | |||
| @@ -15,84 +15,6 @@ | |||
| 15 | This chapter describes each development method. | 15 | This chapter describes each development method. |
| 16 | </para> | 16 | </para> |
| 17 | 17 | ||
| 18 | <section id="platdev-appdev-devshell"> | ||
| 19 | <title>Development Within a Development Shell</title> | ||
| 20 | |||
| 21 | <para> | ||
| 22 | When debugging certain commands or even when just editing packages, | ||
| 23 | <filename>devshell</filename> can be a useful tool. | ||
| 24 | Using <filename>devshell</filename> differs from the example shown in the previous | ||
| 25 | section in that when you invoke <filename>devshell</filename> source files are | ||
| 26 | extracted into your working directory and patches are applied. | ||
| 27 | Then, a new terminal is opened and you are placed in the working directory. | ||
| 28 | In the new terminal, all the OpenEmbedded build-related environment variables are | ||
| 29 | still defined so you can use commands such as <filename>configure</filename> and | ||
| 30 | <filename>make</filename>. | ||
| 31 | The commands execute just as if the OpenEmbedded build system were executing them. | ||
| 32 | Consequently, working this way can be helpful when debugging a build or preparing | ||
| 33 | software to be used with the OpenEmbedded build system. | ||
| 34 | </para> | ||
| 35 | |||
| 36 | <para> | ||
| 37 | Following is an example that uses <filename>devshell</filename> on a target named | ||
| 38 | <filename>matchbox-desktop</filename>: | ||
| 39 | </para> | ||
| 40 | |||
| 41 | <para> | ||
| 42 | <literallayout class='monospaced'> | ||
| 43 | $ bitbake matchbox-desktop -c devshell | ||
| 44 | </literallayout> | ||
| 45 | </para> | ||
| 46 | |||
| 47 | <para> | ||
| 48 | This command opens a terminal with a shell prompt within the OpenEmbedded build environment. | ||
| 49 | The following occurs: | ||
| 50 | <itemizedlist> | ||
| 51 | <listitem><para>The <filename>PATH</filename> variable includes the | ||
| 52 | cross-toolchain.</para></listitem> | ||
| 53 | <listitem><para>The <filename>pkgconfig</filename> variables find the correct | ||
| 54 | <filename>.pc</filename> files.</para></listitem> | ||
| 55 | <listitem><para>The <filename>configure</filename> command finds the | ||
| 56 | Yocto Project site files as well as any other necessary files.</para></listitem> | ||
| 57 | </itemizedlist> | ||
| 58 | Within this environment, you can run <filename>configure</filename> | ||
| 59 | or <filename>compile</filename> commands as if they were being run by | ||
| 60 | the OpenEmbedded build system itself. | ||
| 61 | As noted earlier, the working directory also automatically changes to the | ||
| 62 | source directory (<filename><link linkend='var-S'>S</link></filename>). | ||
| 63 | </para> | ||
| 64 | |||
| 65 | <para> | ||
| 66 | When you are finished, you just exit the shell or close the terminal window. | ||
| 67 | </para> | ||
| 68 | |||
| 69 | <para> | ||
| 70 | The default shell used by <filename>devshell</filename> is xterm. | ||
| 71 | For examples of available options, see the "UI/Interaction Configuration" | ||
| 72 | section of the | ||
| 73 | <filename>meta/conf/bitbake.conf</filename> configuration file in the | ||
| 74 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. | ||
| 75 | </para> | ||
| 76 | |||
| 77 | <para> | ||
| 78 | Because an external shell is launched rather than opening directly into the | ||
| 79 | original terminal window, it allows easier interaction with BitBake's multiple | ||
| 80 | threads as well as accomodates a future client/server split. | ||
| 81 | </para> | ||
| 82 | |||
| 83 | <note> | ||
| 84 | <para>It is worth remembering that when using <filename>devshell</filename> | ||
| 85 | you need to use the full compiler name such as <filename>arm-poky-linux-gnueabi-gcc</filename> | ||
| 86 | instead of just using <filename>gcc</filename>. | ||
| 87 | The same applies to other applications such as <filename>binutils</filename>, | ||
| 88 | <filename>libtool</filename> and so forth. | ||
| 89 | BitBake sets up environment variables such as <filename>CC</filename> | ||
| 90 | to assist applications, such as <filename>make</filename> to find the correct tools.</para> | ||
| 91 | <para>It is also worth noting that <filename>devshell</filename> still works over | ||
| 92 | X11 forwarding and similar situations</para> | ||
| 93 | </note> | ||
| 94 | </section> | ||
| 95 | |||
| 96 | <section id="platdev-appdev-srcrev"> | 18 | <section id="platdev-appdev-srcrev"> |
| 97 | <title>Development Within Yocto Project for a Package that Uses an External SCM</title> | 19 | <title>Development Within Yocto Project for a Package that Uses an External SCM</title> |
| 98 | 20 | ||