diff options
| author |   Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-11-19 09:55:14 -0800 |
|---|---|---|
| committer |   Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-12-03 13:52:57 +0000 |
| commit | 6e17ba9cc3d1839008afb05aa815ed0e996ba006 (patch) | |
| tree | f53a8496eaf9c62dd17a25daa5fc0f303b6251e6 /documentation/dev-manual | |
| parent | 04cb323e66b043bbe7946faa1683f63cd046f9c1 (diff) | |
| download | openembedded-core-contrib-6e17ba9cc3d1839008afb05aa815ed0e996ba006.tar.gz | |
documentation: poky-ref-manual, dev-manual - devshell behaviour
Fixes [YOCTO #2909]
Updated the section on using a development shell
(From yocto-docs rev: 37b43dcb19dda747b7e90ac2e393dad29e9d87a5)
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')
| -rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 40 |
1 files changed, 37 insertions, 3 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index c14c524aa5..8fc0d06830 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -1859,9 +1859,40 @@ directory.</para></listitem> </para> <para> - This command opens a terminal with a shell prompt within the OpenEmbedded build environment. - The default shell is xterm. - The following occurs: + This command spawns a terminal with a shell prompt within the OpenEmbedded build environment. + The <ulink url='&YOCTO_DOCS_REF_URL;#var-OE_TERMINAL'><filename>OE_TERMINAL</filename></ulink> + controls what type of shell is opened. + You can define the variable in the <filename>conf/local.conf</filename> + configuration file in the <link linkend='build-directory'>Build Directory</link>. + </para> + + <para> + Current available terminals are: + <literallayout class='monospaced'> + auto + gnome + xfce + rxvt + screen + konsole (KDE 3.x only) + none + </literallayout> + The default terminal type is "auto" and causes + the OpenEmbedded build system to attempt to spawn terminals in a + priority order until one is found that is available on the host + development system. + For the case of an X terminal, <filename>DISPLAY</filename> must also + be defined. + </para> + + <para> + If <filename>OE_TERMINAL</filename> is set to "none", the system + never spawns a terminal under any circumstances. + Use this setting when you are doing automated builds. + </para> + + <para> + For spawned terminals, the following occurs: <itemizedlist> <listitem><para>The <filename>PATH</filename> variable includes the cross-toolchain.</para></listitem> @@ -1870,6 +1901,9 @@ directory.</para></listitem> <listitem><para>The <filename>configure</filename> command finds the Yocto Project site files as well as any other necessary files.</para></listitem> </itemizedlist> + </para> + + <para> Within this environment, you can run <filename>configure</filename> or <filename>compile</filename> commands as if they were being run by the OpenEmbedded build system itself. |