documentation: poky-ref-manual, dev-manual - deveshell handling
Fixes [YOCTO #2909] Updated the "Using a Development Shell" in the dev-manual to note that the OE_TERMINAL variable is the thing that controls what terminal is spawned. Added a reference into the new variable description. In the poky-ref-manual, I created a new glossary description for the OE_TERMINAL variable. (From yocto-docs rev: 25001eba312c4109b4aaa79b334d27e144ef0d3f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
6e17ba9cc3
commit
429ce39f75
|
@ -1862,33 +1862,6 @@ directory.</para></listitem>
|
|||
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>
|
||||
|
|
|
@ -1948,20 +1948,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
|
|||
<glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
Controls how the OpenEmbedded build system spawns terminals
|
||||
on the host development system.
|
||||
Because the build system needs to account for parallelism
|
||||
during the build, concurrently running processes might require
|
||||
attention (e.g. build cannot resove a patch).
|
||||
For such a case, the host system needs to spawn and launch
|
||||
an interactive shell.
|
||||
Controls how the OpenEmbedded build system spawns
|
||||
interactive terminals on the host development system
|
||||
(e.g. using the BitBake command with the
|
||||
<filename>-c devshell</filename> command-line option).
|
||||
For more information, see the
|
||||
"<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section
|
||||
in the Yocto Project Development Manual.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You can use the following values for the
|
||||
<filename>OE_TERMINAL</filename> variable in the
|
||||
<filename>conf/local.conf</filename> configuration file, which is found in
|
||||
the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
|
||||
<filename>OE_TERMINAL</filename> variable:
|
||||
<literallayout class='monospaced'>
|
||||
auto
|
||||
gnome
|
||||
|
@ -1972,7 +1970,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
|
|||
none
|
||||
</literallayout>
|
||||
<note>Konsole support only works for KDE 3.x.
|
||||
Also, "none" is the default behavior for
|
||||
Also, "auto" is the default behavior for
|
||||
<filename>OE_TERMINAL</filename></note>
|
||||
</para>
|
||||
</glossdef>
|
||||
|
|
Loading…
Reference in New Issue