ref-manual: Added terminal class.

(From yocto-docs rev: 756d44806d82963775e604dc01aeec5e9e4fe812)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 26 insertions, 0 deletions

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index fa3d8d7df1..39fd5cf696 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -2583,6 +2583,32 @@
     </para>
 </section>
 
+<section id='ref-classes-terminal'>
+    <title><filename>terminal.bbclass</filename></title>
+
+    <para>
+        The <filename>terminal</filename> class provides support for starting
+        a terminal session.
+        The
+        <link linkend='var-OE_TERMINAL'><filename>OE_TERMINAL</filename></link>
+        variable controls which terminal emulator is used for the session.
+    </para>
+
+    <para>
+        You can use this class anywhere a separate terminal session needs to
+        be started.
+        To use the class, include the
+        <link linkend='ref-classes-patch'><filename>patch</filename></link>
+        class if
+        <link linkend='var-PATCHRESOLVE'><filename>PATCHRESOLVE</filename></link>
+        is set to "user", include the
+        <link linkend='ref-classes-cml1'><filename>cml1</filename></link>
+        class, and include the
+        <link linkend='ref-classes-devshell'><filename>devshell</filename></link>
+        class.
+    </para>
+</section>
+
 <section id='ref-classes-useradd'>
     <title>Adding Users - <filename>useradd.bbclass</filename></title>