Bug 1380833 - Document level-*-checkouts-v1's hg-store and the HG_STORE_PATH environment variable; r=dustin
authorTom Prince <mozilla@hocat.ca>
Thu, 13 Jul 2017 16:01:41 -0600
changeset 368858 d475a3bedd93
parent 368857 b972eadf54e8
child 368859 45c8fb17933b
push id32176
push userryanvm@gmail.com
push dateFri, 14 Jul 2017 13:16:13 +0000
treeherdermozilla-central@7d92f47379da [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersdustin
bugs1380833
milestone56.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
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.