diff options
author | Jonathan Maw <jonathan.maw@codethink.co.uk> | 2018-06-27 14:27:25 +0100 |
---|---|---|
committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-07-29 17:12:42 +0900 |
commit | f63e53d0cd5c5d8964037f6df3955b567731b949 (patch) | |
tree | 71075b547af2f0d545d3225145d03f994297a10b /buildstream/source.py | |
parent | 56c855fa4923b2dae8fba1e2a6dfeb7bc23fd23f (diff) | |
download | buildstream-f63e53d0cd5c5d8964037f6df3955b567731b949.tar.gz |
doc: Add documentation for source mirroring
Diffstat (limited to 'buildstream/source.py')
-rw-r--r-- | buildstream/source.py | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/buildstream/source.py b/buildstream/source.py index 548692cf4..25632c57e 100644 --- a/buildstream/source.py +++ b/buildstream/source.py @@ -65,6 +65,33 @@ these methods are mandatory to implement. **Optional**: If left unimplemented, this will default to calling :func:`Source.stage() <buildstream.source.Source.stage>` + +* :func:`Source.get_source_fetchers() <buildstream.source.Source.get_source_fetchers>` + + Get the objects that are used for fetching. + + **Optional**: This only needs to be implemented for sources that need to + download from multiple URLs while fetching (e.g. a git repo and its + submodules). For details on how to define a SourceFetcher, see + :ref:`SourceFetcher <core_source_fetcher>`. + + +.. _core_source_fetcher: + +SourceFetcher - Object for fetching individual URLs +=================================================== + + +Abstract Methods +---------------- +SourceFetchers expose the following abstract methods. Unless explicitly +mentioned, these methods are mandatory to implement. + +* :func:`SourceFetcher.fetch() <buildstream.source.SourceFetcher.fetch>` + + Fetches the URL associated with this SourceFetcher, optionally taking an + alias override. + """ import os |