git source plugin: Fixing documentation linking and typotristan/submodule-warnings

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'.

1 files changed, 6 insertions, 5 deletions

diff --git a/buildstream/plugins/sources/git.py b/buildstream/plugins/sources/git.py
index 3c46c5d09..fad54d25e 100644
--- a/buildstream/plugins/sources/git.py
+++ b/buildstream/plugins/sources/git.py
@@ -81,13 +81,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
@@ -105,7 +106,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