diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-12-04 16:30:17 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2019-08-05 03:54:44 +0000 |
| commit | 631bb336fe98688172f6ad7e15f79b7354a8eca9 (patch) | |
| tree | b1a18c57812654f54a700a74010823a6eb1fa50e | |
| parent | ad18979c28a94d9664b50ccba40d158d52d29dae (diff) | |
| download | buildstream-631bb336fe98688172f6ad7e15f79b7354a8eca9.tar.gz | |
git source plugin: Fixing documentation linking and typo
Fixes the configurable warning part of this to properly link
to the project.conf documentation describing what configurable
warnings actually are.
Also fix the plugin raise the actual configurable warning which
it advertizes that it raises; which is 'inconsistent-submodule',
not 'inconsistent-submodules'.
| -rw-r--r-- | buildstream/plugins/sources/git.py | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/buildstream/plugins/sources/git.py b/buildstream/plugins/sources/git.py index 29a148431..495246423 100644 --- a/buildstream/plugins/sources/git.py +++ b/buildstream/plugins/sources/git.py @@ -76,7 +76,7 @@ git - stage files from a git repository **Configurable Warnings:** -This plugin provides the following configurable warnings: +This plugin provides the following :ref:`configurable warnings <configurable_warnings>`: - ``git:inconsistent-submodule`` - A submodule present in the git repository's .gitmodules was never added with `git submodule add`. @@ -95,9 +95,10 @@ This plugin provides the following configurable warnings: The ``git:invalid-submodule`` warning is available since :ref:`format version 20 <project_format_version>` -This plugin also utilises the following configurable core plugin warnings: +This plugin also utilises the following configurable :class:`core warnings <buildstream.types.CoreWarnings>`: -- 'ref-not-in-track' - The provided ref was not found in the provided track in the element's git repository. +- :attr:`ref-not-in-track <buildstream.types.CoreWarnings.REF_NOT_IN_TRACK>` - The provided ref was not + found in the provided track in the element's git repository. """ import os |