[Notes] [Git][BuildStream/buildstream][tristan/submodule-warnings] git source plugin: Fixing documentation linking and typo

[Tristan Van Berkom <gitlab mg gitlab com>]

Title: GitLab

Tristan Van Berkom pushed to branch tristan/submodule-warnings at BuildStream / buildstream

Commits:

• 3d3d63ad
  by Tristan Van Berkom at 2018-12-04T07:53:10Z

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

1 changed file:

• buildstream/plugins/sources/git.py

Changes:

buildstream/plugins/sources/git.py

---

...	...	@@ -81,13 +81,14 @@ details on common configuration options for sources.
81	81
82	82	**Configurable Warnings:**
83	83
84		-This plugin provides the following configurable warnings:
	84	+This plugin provides the following :ref:`configurable warnings <configurable_warnings>`:
85	85
86		-- 'git:inconsistent-submodule' - A submodule was found to be missing from the underlying git repository.
	86	+- `git:inconsistent-submodule` - A submodule was found to be missing from the underlying git repository.
87	87
88		-This plugin also utilises the following configurable core plugin warnings:
	88	+This plugin also utilises the following configurable :class:`core warnings <buildstream.types.CoreWarnings>`:
89	89
90		-- 'ref-not-in-track' - The provided ref was not found in the provided track in the element's git repository.
	90	+- :attr:`ref-not-in-track <buildstream.types.CoreWarnings.REF_NOT_IN_TRACK>` - The provided ref was not
	91	+ found in the provided track in the element's git repository.
91	92	"""
92	93
93	94	import os
...	...	@@ -105,7 +106,7 @@ from buildstream.utils import move_atomic, DirectoryExistsError
105	106	GIT_MODULES = '.gitmodules'
106	107
107	108	# Warnings
108		-INCONSISTENT_SUBMODULE = "inconsistent-submodules"
	109	+INCONSISTENT_SUBMODULE = "inconsistent-submodule"
109	110
110	111
111	112	# Because of handling of submodules, we maintain a GitMirror

—
View it on GitLab.
You're receiving this email because of your account on gitlab.com. If you'd like to receive fewer emails, you can adjust your notification settings.