dev-manual, ref-manual: Cross-references between PR Service and cache

Fixes YOCTO #3684

These changes help tie in the relationship between how the OE
build system uses checksums and such and the PR Service that
can track revision.

(From yocto-docs rev: 39a3010a3bb4b2c1d37aef60984ac16e85b56aac)

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

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 1f8dba4eb6c60e008e03a6853a739edc659bbb03..7e90eb8ef1ce5b6f47e0baf7ab801f514d92d562 100644 (file)
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -2040,7 +2040,8 @@
                 </para>
 
                 <para>
-                    Because the OpenEmbedded build system uses "signatures",
+                    Because the OpenEmbedded build system uses
+                    "<ulink url='&YOCTO_DOCS_REF_URL;#checksums'>signatures</ulink>",
                     which are unique to a given build, the build system
                     knows when to rebuild packages.
                     All the inputs into a given task are represented by a
@@ -2128,7 +2129,7 @@
                 </para>
 
                 <note>
-                    The OpenEmbedded build system does not maintain
+                    <para>The OpenEmbedded build system does not maintain
                     <filename>PR</filename> information as part of the
                     shared state (sstate) packages.
                     If you maintain an sstate feed, its expected that either
@@ -2136,7 +2137,10 @@
                     feed use a shared PR Service, or you do not run a PR
                     Service on any of your building systems.
                     Having some systems use a PR Service while others do
-                    not leads to obvious problems.
+                    not leads to obvious problems.</para>
+                    <para>For more information on shared state, see the
+                    "<ulink url='&YOCTO_DOCS_REF_URL;#shared-state-cache'>Shared State Cache</ulink>"
+                    section in the Yocto Project Reference Manual.</para>
                 </note>
             </section>
 

diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml
index a9c31c8b6e0057a98fc7c7084688fad3fb77ac62..3393e159334752a42fee1dc38f37013b9fae0084 100644 (file)
--- a/documentation/ref-manual/technical-details.xml
+++ b/documentation/ref-manual/technical-details.xml
@@ -194,6 +194,18 @@
         install them if they are deemed to be valid.
     </para>
 
+    <note>
+        The OpenEmbedded build system does not maintain
+        <link linkend='var-PR'><filename>PR</filename></link> information
+        as part of the Shared State packages.
+        Consequently, considerations exist that affect maintaining shared
+        state feeds.
+        For information on how the OpenEmbedded works with packages and can
+        track incrementing <filename>PR</filename> information, see the
+        "<ulink url='&YOCTO_DOCS_DEV_URL;#incrementing-a-package-revision-number'>Incrementing a Package Revision Number</ulink>"
+        section.
+    </note>
+
     <para>
         The rest of this section goes into detail about the overall incremental build
         architecture, the checksums (signatures), shared state, and some tips and tricks.