Bug 1380833 - Document level-*-checkouts-v1's hg-store and the HG_STORE_PATH environment variable; r?dustin draft
authorTom Prince <mozilla@hocat.ca>
Thu, 13 Jul 2017 16:01:41 -0600
changeset 608581 22c6b6f3fae4
parent 608567 8486950bd918
child 637360 2096c407ac49
push id68339
push userbmo:mozilla@hocat.ca
push dateThu, 13 Jul 2017 22:02:17 +0000
reviewersdustin
bugs1380833
milestone56.0a1
Bug 1380833 - Document level-*-checkouts-v1's hg-store and the HG_STORE_PATH environment variable; r?dustin MozReview-Commit-ID: 9yRuKONHTvP
taskcluster/docs/caches.rst
--- a/taskcluster/docs/caches.rst
+++ b/taskcluster/docs/caches.rst
@@ -16,20 +16,27 @@ Version Control Caches
 
    Checkouts should be read-only. If a task needs to create new files from
    content of a checkout, this content should be written in a separate
    directory/cache (like a workspace).
 
    A ``version`` parameter appears in the cache name to allow
    backwards-incompatible changes to the cache's behavior.
 
+   The ``hg-store`` contains a `shared store <https://www.mercurial-scm.org/wiki/ShareExtension>`
+   that is is used by ``hg robustcheckout``. If you are using ``run-task`` you
+   should set the ``HG_STORE_PATH`` environment variable to point to this
+   directory. If you are using ``hg robustcheckout``, pass this directory to the
+   ``--sharebase`` option.
+
 ``level-{{level}}-{{project}}-tc-vcs`` (deprecated)
     This cache is used internally by ``tc-vcs``.  This tool is deprecated and
     should be replaced with ``hg robustcheckout``.
 
+
 Workspace Caches
 ================
 
 ``level-{{level}}-*-workspace``
    These caches (of various names typically ending with ``workspace``)
    contain state to be shared between task invocations. Use cases are
    dependent on the task.