[Notes] [Git][BuildStream/buildstream][chandan/source-doc-directory] build elements: Add reference to BuildElement's built-in config

[Chandan Singh <gitlab mg gitlab com>]

Title: GitLab

Chandan Singh pushed to branch chandan/source-doc-directory at BuildStream / buildstream

Commits:

• db2a676e
  by Chandan Singh at 2018-10-25T15:26:39Z

  build elements: Add reference to BuildElement's built-in config
  
  For each element plugin derived from BuildElement, add reference to the
  built-in functionality documentation of BuildElement.
  
    * buildelement.py: Add anchor for built-in functionality.
    * plugins/elements/*.py: Add refence to BuildElement's built-in
      functionality for each build element.
  
  Related to #713.
  

12 changed files:

• buildstream/buildelement.py
• buildstream/plugins/elements/autotools.py
• buildstream/plugins/elements/cmake.py
• buildstream/plugins/elements/distutils.py
• buildstream/plugins/elements/import.py
• buildstream/plugins/elements/make.py
• buildstream/plugins/elements/makemaker.py
• buildstream/plugins/elements/manual.py
• buildstream/plugins/elements/meson.py
• buildstream/plugins/elements/modulebuild.py
• buildstream/plugins/elements/pip.py
• buildstream/plugins/elements/qmake.py

Changes:

buildstream/buildelement.py

---

...	...	@@ -23,6 +23,8 @@ BuildElement - Abstract class for build elements
23	23	The BuildElement class is a convenience element one can derive from for
24	24	implementing the most common case of element.
25	25
	26	+.. _core_buildelement_builtins:
	27	+
26	28	Built-in functionality
27	29	----------------------
28	30

buildstream/plugins/elements/autotools.py

---

...	...	@@ -50,6 +50,9 @@ Here is the default configuration for the ``autotools`` element in full:
50	50
51	51	.. literalinclude:: ../../../buildstream/plugins/elements/autotools.yaml
52	52	:language: yaml
	53	+
	54	+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
	55	+details on common configuration options for build elements.
53	56	"""
54	57
55	58	from buildstream import BuildElement

buildstream/plugins/elements/cmake.py

---

...	...	@@ -49,6 +49,9 @@ Here is the default configuration for the ``cmake`` element in full:
49	49
50	50	.. literalinclude:: ../../../buildstream/plugins/elements/cmake.yaml
51	51	:language: yaml
	52	+
	53	+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
	54	+details on common configuration options for build elements.
52	55	"""
53	56
54	57	from buildstream import BuildElement

buildstream/plugins/elements/distutils.py

---

...	...	@@ -26,6 +26,9 @@ python distutils
26	26	The distutils default configuration:
27	27	.. literalinclude:: ../../../buildstream/plugins/elements/distutils.yaml
28	28	:language: yaml
	29	+
	30	+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
	31	+details on common configuration options for build elements.
29	32	"""
30	33
31	34	from buildstream import BuildElement

buildstream/plugins/elements/import.py

---

...	...	@@ -28,6 +28,9 @@ some configuration data.
28	28	The empty configuration is as such:
29	29	.. literalinclude:: ../../../buildstream/plugins/elements/import.yaml
30	30	:language: yaml
	31	+
	32	+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
	33	+details on common configuration options for build elements.
31	34	"""
32	35
33	36	import os

buildstream/plugins/elements/make.py

---

...	...	@@ -31,6 +31,9 @@ Here is the default configuration for the ``make`` element in full:
31	31
32	32	.. literalinclude:: ../../../buildstream/plugins/elements/make.yaml
33	33	:language: yaml
	34	+
	35	+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
	36	+details on common configuration options for build elements.
34	37	"""
35	38
36	39	from buildstream import BuildElement

buildstream/plugins/elements/makemaker.py

---

...	...	@@ -26,6 +26,9 @@ the Perl ExtUtil::MakeMaker build system
26	26	The MakeMaker default configuration:
27	27	.. literalinclude:: ../../../buildstream/plugins/elements/makemaker.yaml
28	28	:language: yaml
	29	+
	30	+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
	31	+details on common configuration options for build elements.
29	32	"""
30	33
31	34	from buildstream import BuildElement

buildstream/plugins/elements/manual.py

---

...	...	@@ -26,6 +26,9 @@ add custom build commands to the array understood by the :mod:`BuildElement <bui
26	26	The empty configuration is as such:
27	27	.. literalinclude:: ../../../buildstream/plugins/elements/manual.yaml
28	28	:language: yaml
	29	+
	30	+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
	31	+details on common configuration options for build elements.
29	32	"""
30	33
31	34	from buildstream import BuildElement

buildstream/plugins/elements/meson.py

---

...	...	@@ -46,6 +46,9 @@ Here is the default configuration for the ``meson`` element in full:
46	46
47	47	.. literalinclude:: ../../../buildstream/plugins/elements/meson.yaml
48	48	:language: yaml
	49	+
	50	+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
	51	+details on common configuration options for build elements.
49	52	"""
50	53
51	54	from buildstream import BuildElement

buildstream/plugins/elements/modulebuild.py

---

...	...	@@ -26,6 +26,9 @@ the Perl Module::Build build system
26	26	The modulebuild default configuration:
27	27	.. literalinclude:: ../../../buildstream/plugins/elements/modulebuild.yaml
28	28	:language: yaml
	29	+
	30	+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
	31	+details on common configuration options for build elements.
29	32	"""
30	33
31	34	from buildstream import BuildElement

buildstream/plugins/elements/pip.py

---

...	...	@@ -26,6 +26,9 @@ Python modules with pip
26	26	The pip default configuration:
27	27	.. literalinclude:: ../../../buildstream/plugins/elements/pip.yaml
28	28	:language: yaml
	29	+
	30	+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
	31	+details on common configuration options for build elements.
29	32	"""
30	33
31	34	from buildstream import BuildElement

buildstream/plugins/elements/qmake.py

---

...	...	@@ -26,6 +26,9 @@ the qmake build system
26	26	The qmake default configuration:
27	27	.. literalinclude:: ../../../buildstream/plugins/elements/qmake.yaml
28	28	:language: yaml
	29	+
	30	+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
	31	+details on common configuration options for build elements.
29	32	"""
30	33
31	34	from buildstream import BuildElement

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