ref-manual: Added prserv class and PRSERV_HOST variable.

(From yocto-docs rev: f0195e750f1027146545ded2e7866bbc43b25d81)

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

2 files changed, 49 insertions, 0 deletions

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index cde8f5bb9e..450501694c 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1517,6 +1517,29 @@
     </para>
 </section>
 
+<section id='ref-classes-prserv'>
+    <title><filename>prserv.bbclass</filename></title>
+
+    <para>
+        The <filename>prserv</filename> class provides functionality for
+        using a
+        <ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>PR service</ulink>
+        in order to automatically manage the incrementing of the
+        <link linkend='var-PR'><filename>PR</filename></link> variable for
+        each recipe.
+    </para>
+
+    <para>
+        This class is enabled by default because it is inherited by the
+        <link linkend='ref-classes-package'><filename>package</filename></link>
+        class.
+        However, the OpenEmbedded build system will not use this variable
+        unless
+        <link linkend='var-PRSERV_HOST'><filename>PRSERV_HOST</filename></link>
+        has been set.
+    </para>
+</section>
+
 <section id='ref-classes-distutils'>
     <title>Python Extensions - <filename>distutils.bbclass</filename></title>
 
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index dee179d393..c756512c52 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -4947,6 +4947,32 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-PRSERV_HOST'><glossterm>PRSERV_HOST</glossterm>
+            <glossdef>
+                <para>
+                    The network based
+                    <link linkend='var-PR'><filename>PR</filename></link>
+                    service host and port.
+                </para>
+
+                <para>
+                    The <filename>conf/local.conf.sample.extended</filename>
+                    configuration file in the
+                    <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
+                    shows how the <filename>PRSERV_HOST</filename> variable is
+                    set:
+                    <literallayout class='monospaced'>
+     PRSERV_HOST = "localhost:0"
+                    </literallayout>
+                    You must set the variable if you want to automatically
+                    start a local
+                    <ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>PR service</ulink>.
+                    You can set <filename>PRSERV_HOST</filename> to other
+                    values to use a remote PR service.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-PV'><glossterm>PV</glossterm>
             <glossdef>
                 <para>The version of the recipe.