diff options
| author | Jonathan Maw <jonathan.maw@codethink.co.uk> | 2018-06-27 14:27:25 +0100 |
|---|---|---|
| committer | Jonathan Maw <jonathan.maw@codethink.co.uk> | 2018-07-27 12:24:56 +0000 |
| commit | 1cbc2e17f782d8765b33c092c42ebdd98510ae62 (patch) | |
| tree | 1ae91499ae1f7da6b672c0325bd0bc076c44127a /doc/source/using_config.rst | |
| parent | 909120abc32fe3b132f71a13ea94b1f9f929c05c (diff) | |
| download | buildstream-1cbc2e17f782d8765b33c092c42ebdd98510ae62.tar.gz | |
doc: Add documentation for source mirroring
Diffstat (limited to 'doc/source/using_config.rst')
| -rw-r--r-- | doc/source/using_config.rst | 21 |
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: |