diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 40 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 39 |
2 files changed, 73 insertions, 6 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> | |||
1859 | </para> | 1859 | </para> |
1860 | 1860 | ||
1861 | <para> | 1861 | <para> |
1862 | This command opens a terminal with a shell prompt within the OpenEmbedded build environment. | 1862 | This command spawns a terminal with a shell prompt within the OpenEmbedded build environment. |
1863 | The default shell is xterm. | 1863 | The <ulink url='&YOCTO_DOCS_REF_URL;#var-OE_TERMINAL'><filename>OE_TERMINAL</filename></ulink> |
1864 | The following occurs: | 1864 | controls what type of shell is opened. |
1865 | You can define the variable in the <filename>conf/local.conf</filename> | ||
1866 | configuration file in the <link linkend='build-directory'>Build Directory</link>. | ||
1867 | </para> | ||
1868 | |||
1869 | <para> | ||
1870 | Current available terminals are: | ||
1871 | <literallayout class='monospaced'> | ||
1872 | auto | ||
1873 | gnome | ||
1874 | xfce | ||
1875 | rxvt | ||
1876 | screen | ||
1877 | konsole (KDE 3.x only) | ||
1878 | none | ||
1879 | </literallayout> | ||
1880 | The default terminal type is "auto" and causes | ||
1881 | the OpenEmbedded build system to attempt to spawn terminals in a | ||
1882 | priority order until one is found that is available on the host | ||
1883 | development system. | ||
1884 | For the case of an X terminal, <filename>DISPLAY</filename> must also | ||
1885 | be defined. | ||
1886 | </para> | ||
1887 | |||
1888 | <para> | ||
1889 | If <filename>OE_TERMINAL</filename> is set to "none", the system | ||
1890 | never spawns a terminal under any circumstances. | ||
1891 | Use this setting when you are doing automated builds. | ||
1892 | </para> | ||
1893 | |||
1894 | <para> | ||
1895 | For spawned terminals, the following occurs: | ||
1865 | <itemizedlist> | 1896 | <itemizedlist> |
1866 | <listitem><para>The <filename>PATH</filename> variable includes the | 1897 | <listitem><para>The <filename>PATH</filename> variable includes the |
1867 | cross-toolchain.</para></listitem> | 1898 | cross-toolchain.</para></listitem> |
@@ -1870,6 +1901,9 @@ directory.</para></listitem> | |||
1870 | <listitem><para>The <filename>configure</filename> command finds the | 1901 | <listitem><para>The <filename>configure</filename> command finds the |
1871 | Yocto Project site files as well as any other necessary files.</para></listitem> | 1902 | Yocto Project site files as well as any other necessary files.</para></listitem> |
1872 | </itemizedlist> | 1903 | </itemizedlist> |
1904 | </para> | ||
1905 | |||
1906 | <para> | ||
1873 | Within this environment, you can run <filename>configure</filename> | 1907 | Within this environment, you can run <filename>configure</filename> |
1874 | or <filename>compile</filename> commands as if they were being run by | 1908 | or <filename>compile</filename> commands as if they were being run by |
1875 | the OpenEmbedded build system itself. | 1909 | the OpenEmbedded build system itself. |
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 869ff550d4..289057eaa3 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml | |||
@@ -30,7 +30,7 @@ | |||
30 | <link linkend='var-LAYERDIR'>L</link> | 30 | <link linkend='var-LAYERDIR'>L</link> |
31 | <link linkend='var-MACHINE'>M</link> | 31 | <link linkend='var-MACHINE'>M</link> |
32 | <!-- <link linkend='var-glossary-n'>N</link> --> | 32 | <!-- <link linkend='var-glossary-n'>N</link> --> |
33 | <!-- <link linkend='var-glossary-o'>O</link> --> | 33 | <link linkend='var-OE_TERMINAL'>O</link> |
34 | <link linkend='var-P'>P</link> | 34 | <link linkend='var-P'>P</link> |
35 | <!-- <link linkend='var-glossary-q'>Q</link> --> | 35 | <!-- <link linkend='var-glossary-q'>Q</link> --> |
36 | <link linkend='var-RCONFLICTS'>R</link> | 36 | <link linkend='var-RCONFLICTS'>R</link> |
@@ -1943,8 +1943,41 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1943 | <!-- <glossdiv id='var-glossary-n'><title>N</title>--> | 1943 | <!-- <glossdiv id='var-glossary-n'><title>N</title>--> |
1944 | <!-- </glossdiv>--> | 1944 | <!-- </glossdiv>--> |
1945 | 1945 | ||
1946 | <!-- <glossdiv id='var-glossary-o'><title>O</title>--> | 1946 | <glossdiv id='var-glossary-o'><title>O</title> |
1947 | <!-- </glossdiv>--> | 1947 | |
1948 | <glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm> | ||
1949 | <glossdef> | ||
1950 | <para> | ||
1951 | Controls how the OpenEmbedded build system spawns terminals | ||
1952 | on the host development system. | ||
1953 | Because the build system needs to account for parallelism | ||
1954 | during the build, concurrently running processes might require | ||
1955 | attention (e.g. build cannot resove a patch). | ||
1956 | For such a case, the host system needs to spawn and launch | ||
1957 | an interactive shell. | ||
1958 | </para> | ||
1959 | |||
1960 | <para> | ||
1961 | You can use the following values for the | ||
1962 | <filename>OE_TERMINAL</filename> variable in the | ||
1963 | <filename>conf/local.conf</filename> configuration file, which is found in | ||
1964 | the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: | ||
1965 | <literallayout class='monospaced'> | ||
1966 | auto | ||
1967 | gnome | ||
1968 | xfce | ||
1969 | rxvt | ||
1970 | screen | ||
1971 | konsole | ||
1972 | none | ||
1973 | </literallayout> | ||
1974 | <note>Konsole support only works for KDE 3.x. | ||
1975 | Also, "none" is the default behavior for | ||
1976 | <filename>OE_TERMINAL</filename></note> | ||
1977 | </para> | ||
1978 | </glossdef> | ||
1979 | </glossentry> | ||
1980 | </glossdiv> | ||
1948 | 1981 | ||
1949 | <glossdiv id='var-glossary-p'><title>P</title> | 1982 | <glossdiv id='var-glossary-p'><title>P</title> |
1950 | 1983 | ||