documentation: poky-ref-manual - added note about PATH

Added a note explaining why "PATH" is needed when using
SSTATE_MIRRORS if the shared state directory structure on
the mirror is the same as SSTATE_DIR.

(From yocto-docs rev: 94b8a45827d2bf7f16ec530de694ec5e4e6ed164)

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

1 files changed, 14 insertions, 4 deletions

diff --git a/documentation/poky-ref-manual/technical-details.xml b/documentation/poky-ref-manual/technical-details.xml
index 8ce9e5da1b..2e30df1604 100644
--- a/documentation/poky-ref-manual/technical-details.xml
+++ b/documentation/poky-ref-manual/technical-details.xml
@@ -442,14 +442,24 @@
 
         <para>
             Behind the scenes, the shared state code works by looking in 
-            <filename>SSTATE_DIR</filename> and  
-            <filename>SSTATE_MIRRORS</filename> for shared state files. 
+            <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link> and  
+            <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>
+            for shared state files. 
             Here is an example:
             <literallayout class='monospaced'>
      SSTATE_MIRRORS ?= "\
-     file://.* http://someserver.tld/share/sstate/ \n \
-     file://.* file:///some/local/dir/sstate/"
+     file://.* http://someserver.tld/share/sstate/PATH \n \
+     file://.* file:///some/local/dir/sstate/PATH"
             </literallayout>
+            <note> 
+                The shared state directory (<filename>SSTATE_DIR</filename>) is 
+                organized into two-character subdirectories, where the subdirectory 
+                names are based on the first two characters of the hash.
+                If the shared state directory structure for a mirror has the 
+                same structure as <filename>SSTATE_DIR</filename>, you must
+                specify "PATH" as part of the URI to enable the build system
+                to map to the appropriate subdirectory.
+            </note>
         </para>
 
         <para>