diff options
| author | Angelos Evripiotis <jevripiotis@bloomberg.net> | 2018-02-11 15:50:00 +0000 |
|---|---|---|
| committer | Angelos Evripiotis <jevripiotis@bloomberg.net> | 2018-02-11 15:50:00 +0000 |
| commit | 4f3251a56cfbc51861458532124db9d858b63fe3 (patch) | |
| tree | e783b96020ceb9eba8d1d2c2b5142c3e6e80f0ef | |
| parent | d95c98bc7a1b0c3d59ac86820195063aaa0e54e7 (diff) | |
| download | buildstream-4f3251a56cfbc51861458532124db9d858b63fe3.tar.gz | |
doc: consistent source staging dir doc
All source plugins respond to the 'directory' key, so add the doc for it
to those that didn't have it.
| -rw-r--r-- | buildstream/plugins/sources/bzr.py | 3 | ||||
| -rw-r--r-- | buildstream/plugins/sources/tar.py | 3 | ||||
| -rw-r--r-- | buildstream/plugins/sources/zip.py | 3 |
3 files changed, 9 insertions, 0 deletions
diff --git a/buildstream/plugins/sources/bzr.py b/buildstream/plugins/sources/bzr.py index cb7cbb040..ba3d1545e 100644 --- a/buildstream/plugins/sources/bzr.py +++ b/buildstream/plugins/sources/bzr.py @@ -26,6 +26,9 @@ # Specify the bzr source kind kind: bzr + # Optionally specify a relative staging directory + # directory: path/to/stage + # Specify the bzr url. Bazaar URLs come in many forms, see # `bzr help urlspec` for more information. Using an alias defined # in your project configuration is encouraged. diff --git a/buildstream/plugins/sources/tar.py b/buildstream/plugins/sources/tar.py index c5f8a7d31..284554fe1 100644 --- a/buildstream/plugins/sources/tar.py +++ b/buildstream/plugins/sources/tar.py @@ -26,6 +26,9 @@ # Specify the tar source kind kind: tar + # Optionally specify a relative staging directory + # directory: path/to/stage + # Specify the tar url. Using an alias defined in your project # configuration is encouraged. 'bst track' will update the # sha256sum in 'ref' to the downloaded file's sha256sum. diff --git a/buildstream/plugins/sources/zip.py b/buildstream/plugins/sources/zip.py index b39923df5..dd7fcd0ad 100644 --- a/buildstream/plugins/sources/zip.py +++ b/buildstream/plugins/sources/zip.py @@ -27,6 +27,9 @@ # Specify the zip source kind kind: zip + # Optionally specify a relative staging directory + # directory: path/to/stage + # Specify the zip url. Using an alias defined in your project # configuration is encouraged. 'bst track' will update the # sha256sum in 'ref' to the downloaded file's sha256sum. |