summaryrefslogtreecommitdiff
path: root/doc/source/using_config.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/using_config.rst')
-rw-r--r--doc/source/using_config.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/source/using_config.rst b/doc/source/using_config.rst
index d02aaf3d4..c707cd04b 100644
--- a/doc/source/using_config.rst
+++ b/doc/source/using_config.rst
@@ -89,6 +89,27 @@ modifying some low level component.
the ``--strict`` and ``--no-strict`` command line options.
+.. _config_default_mirror:
+
+Default Mirror
+~~~~~~~~~~~~~~
+When using :ref:`mirrors <project_essentials_mirrors>`, a default mirror can
+be defined to be fetched first.
+The default mirror is defined by its name, e.g.
+
+.. code:: yaml
+
+ projects:
+ project-name:
+ default-mirror: oz
+
+
+.. note::
+
+ It is possible to override this at invocation time using the
+ ``--default-mirror`` command-line option.
+
+
Default configuration
---------------------
The default BuildStream configuration is specified here for reference: