summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-12-04 16:30:17 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-12-06 16:35:59 +0900
commite5c0f067bd114c44d58dc3dcbf251fc69bb31d43 (patch)
treeb9847eeba4eac51a7c891b2ecb437fad72f6bf36
parent3b7f8df8c6b0f69006e16f0970a124b4ff17aae0 (diff)
downloadbuildstream-e5c0f067bd114c44d58dc3dcbf251fc69bb31d43.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.py11
1 files changed, 6 insertions, 5 deletions
diff --git a/buildstream/plugins/sources/git.py b/buildstream/plugins/sources/git.py
index 112b72827..f404a8528 100644
--- a/buildstream/plugins/sources/git.py
+++ b/buildstream/plugins/sources/git.py
@@ -131,13 +131,14 @@ details on common configuration options for sources.
**Configurable Warnings:**
-This plugin provides the following configurable warnings:
+This plugin provides the following :ref:`configurable warnings <configurable_warnings>`:
-- 'git:inconsistent-submodule' - A submodule was found to be missing from the underlying git repository.
+- ``git:inconsistent-submodule`` - A submodule was found to be missing from the underlying git repository.
-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
@@ -156,7 +157,7 @@ from buildstream.utils import move_atomic, DirectoryExistsError
GIT_MODULES = '.gitmodules'
# Warnings
-INCONSISTENT_SUBMODULE = "inconsistent-submodules"
+INCONSISTENT_SUBMODULE = "inconsistent-submodule"
# Because of handling of submodules, we maintain a GitMirror