From 21c7646779302267fb02bb83a12aa601517c0523 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Mon, 22 Oct 2018 17:36:36 -0700
Subject: ref-manual: Updated SSTATE_MIRRORS variable description

Fixes [YOCTO #11107]

Updated the SSTATE_MIRRORS variable description to include
explanation of how to use regular expressions to map file locations
to server-provided URLs to share sstate information.

(From yocto-docs rev: 1357095864ee919f576de8df36f4e177b24fdd22)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/ref-manual/ref-variables.xml | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

(limited to 'documentation/ref-manual/ref-variables.xml')

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 1774ba24c0..5490bd3130 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -13657,7 +13657,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link>
                     and <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>
                     and points to the cache locations to check for the shared
-                    objects.
+                    state (sstate) objects.
                 </para>
 
                 <para>
@@ -13669,6 +13669,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     other machines.
                 </para>
 
+                <para>
+                    If you want to use native sstate artifacts that are
+                    provided by a server, you need to configure
+                    <filename>SSTATE_MIRROR</filename> regular expressions
+                    so that the local search paths get mapped to paths
+                    provided by the server.
+                    The server paths must take into account the GCC versions.
+                    For example, the following maps the local search path
+                    <filename>universal-4.9</filename> to the server-provided
+                    path <replaceable>server_url_sstate_path</replaceable>:
+                    <literallayout class='monospaced'>
+     SSTATE_MIRRORS ?= file://universal-4.9/(.*) http://<replaceable>server_url_sstate_path</replaceable>/universal-4.8/\1 \n
+                    </literallayout>
+                </para>
+
                 <para>
                     If a mirror uses the same structure as
                     <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>,
-- 
cgit v1.2.3-54-g00ecf