From 083e6a09483871ce9bd35374915dd470d3e479e4 Mon Sep 17 00:00:00 2001 From: Tristan Van Berkom Date: Tue, 4 Dec 2018 16:30:17 +0900 Subject: 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'. --- buildstream/plugins/sources/git.py | 7 ++++--- 1 file 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 `: - ``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 ` -This plugin also utilises the following configurable core plugin warnings: +This plugin also utilises the following configurable :class:`core warnings `: -- '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 ` - The provided ref was not + found in the provided track in the element's git repository. """ import os -- cgit v1.2.1