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-06-27 14:27:25 +0100 |
commit | d858089520bcbd59a858e57ad6a4ae015b249d17 (patch) | |
tree | e49936cac33ba8a49679ad5d3b0fbe70368a4b64 | |
parent | 28c2e1be8cfa35fdb38cb9005b3ddeae4c5b229b (diff) | |
download | buildstream-d858089520bcbd59a858e57ad6a4ae015b249d17.tar.gz |
doc: Add documentation for source mirroring
-rw-r--r-- | doc/source/format_project.rst | 33 | ||||
-rw-r--r-- | doc/source/using_config.rst | 14 |
2 files changed, 47 insertions, 0 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst index 6174ee728..be2a6937a 100644 --- a/doc/source/format_project.rst +++ b/doc/source/format_project.rst @@ -198,6 +198,39 @@ You can also specify a list of caches here; earlier entries in the list will have higher priority than later ones. +.. _project_essentials_mirrors: + +Mirrors +~~~~~~~ + +A list of mirrors can be defined that couple a location to a mapping of aliases to a +list of URIs, e.g. + +.. code:: yaml + + mirrors: + - location-name: middle-earth + aliases: + foo: + - http://www.middle-earth.com/foo/1 + - http://www.middle-earth.com/foo/2 + bar: + - http://www.middle-earth.com/bar/1 + - http://www.middle-earth.com/bar/2 + - location-name: oz + aliases: + foo: + - http://www.oz.com/foo + bar: + - http://www.oz.com/bar + +The order that the mirrors (and the URIs therein) are consulted is in the order +they are defined when fetching, and in reverse-order when tracking. + +A default mirror to consult first can be defined via +:ref:`user config <config_default_mirror>`, or the command-line argument +:ref:`--default-mirror <invoking_bst>`. + .. _project_plugins: External plugins diff --git a/doc/source/using_config.rst b/doc/source/using_config.rst index d02aaf3d4..931e27692 100644 --- a/doc/source/using_config.rst +++ b/doc/source/using_config.rst @@ -89,6 +89,20 @@ 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 location-name, e.g. + +.. code:: yaml + + default-mirror: oz + + Default configuration --------------------- The default BuildStream configuration is specified here for reference: |