build elements: Add reference to BuildElement's built-in configchandan/source-doc-directory

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 files changed, 35 insertions, 0 deletions

diff --git a/buildstream/buildelement.py b/buildstream/buildelement.py
index e57ca1c79..48b7f2423 100644
--- a/buildstream/buildelement.py
+++ b/buildstream/buildelement.py
@@ -23,6 +23,8 @@ BuildElement - Abstract class for build elements
 The BuildElement class is a convenience element one can derive from for
 implementing the most common case of element.
 
+.. _core_buildelement_builtins:
+
 Built-in functionality
 ----------------------
 
diff --git a/buildstream/plugins/elements/autotools.py b/buildstream/plugins/elements/autotools.py
index cf5e85661..43fe7add4 100644
--- a/buildstream/plugins/elements/autotools.py
+++ b/buildstream/plugins/elements/autotools.py
@@ -50,6 +50,9 @@ Here is the default configuration for the ``autotools`` element in full:
 
   .. literalinclude:: ../../../buildstream/plugins/elements/autotools.yaml
      :language: yaml
+
+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
+details on common configuration options for build elements.
 """
 
 from buildstream import BuildElement
diff --git a/buildstream/plugins/elements/cmake.py b/buildstream/plugins/elements/cmake.py
index 2cb2601ae..de9aa9616 100644
--- a/buildstream/plugins/elements/cmake.py
+++ b/buildstream/plugins/elements/cmake.py
@@ -49,6 +49,9 @@ Here is the default configuration for the ``cmake`` element in full:
 
   .. literalinclude:: ../../../buildstream/plugins/elements/cmake.yaml
      :language: yaml
+
+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
+details on common configuration options for build elements.
 """
 
 from buildstream import BuildElement
diff --git a/buildstream/plugins/elements/distutils.py b/buildstream/plugins/elements/distutils.py
index 5201013c1..20a2d67ef 100644
--- a/buildstream/plugins/elements/distutils.py
+++ b/buildstream/plugins/elements/distutils.py
@@ -26,6 +26,9 @@ python distutils
 The distutils default configuration:
   .. literalinclude:: ../../../buildstream/plugins/elements/distutils.yaml
      :language: yaml
+
+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
+details on common configuration options for build elements.
 """
 
 from buildstream import BuildElement
diff --git a/buildstream/plugins/elements/import.py b/buildstream/plugins/elements/import.py
index 0eca2a902..ec491a0a5 100644
--- a/buildstream/plugins/elements/import.py
+++ b/buildstream/plugins/elements/import.py
@@ -28,6 +28,9 @@ some configuration data.
 The empty configuration is as such:
   .. literalinclude:: ../../../buildstream/plugins/elements/import.yaml
      :language: yaml
+
+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
+details on common configuration options for build elements.
 """
 
 import os
diff --git a/buildstream/plugins/elements/make.py b/buildstream/plugins/elements/make.py
index 6c500f3f9..a22de168a 100644
--- a/buildstream/plugins/elements/make.py
+++ b/buildstream/plugins/elements/make.py
@@ -31,6 +31,9 @@ Here is the default configuration for the ``make`` element in full:
 
   .. literalinclude:: ../../../buildstream/plugins/elements/make.yaml
      :language: yaml
+
+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
+details on common configuration options for build elements.
 """
 
 from buildstream import BuildElement
diff --git a/buildstream/plugins/elements/makemaker.py b/buildstream/plugins/elements/makemaker.py
index fccfaadab..8ad979984 100644
--- a/buildstream/plugins/elements/makemaker.py
+++ b/buildstream/plugins/elements/makemaker.py
@@ -26,6 +26,9 @@ the Perl ExtUtil::MakeMaker build system
 The MakeMaker default configuration:
   .. literalinclude:: ../../../buildstream/plugins/elements/makemaker.yaml
      :language: yaml
+
+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
+details on common configuration options for build elements.
 """
 
 from buildstream import BuildElement
diff --git a/buildstream/plugins/elements/manual.py b/buildstream/plugins/elements/manual.py
index c7bdba95f..3300d017a 100644
--- a/buildstream/plugins/elements/manual.py
+++ b/buildstream/plugins/elements/manual.py
@@ -26,6 +26,9 @@ add custom build commands to the array understood by the :mod:`BuildElement <bui
 The empty configuration is as such:
   .. literalinclude:: ../../../buildstream/plugins/elements/manual.yaml
      :language: yaml
+
+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
+details on common configuration options for build elements.
 """
 
 from buildstream import BuildElement
diff --git a/buildstream/plugins/elements/meson.py b/buildstream/plugins/elements/meson.py
index 9e0edf19e..0d5ca0087 100644
--- a/buildstream/plugins/elements/meson.py
+++ b/buildstream/plugins/elements/meson.py
@@ -46,6 +46,9 @@ Here is the default configuration for the ``meson`` element in full:
 
   .. literalinclude:: ../../../buildstream/plugins/elements/meson.yaml
      :language: yaml
+
+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
+details on common configuration options for build elements.
 """
 
 from buildstream import BuildElement
diff --git a/buildstream/plugins/elements/modulebuild.py b/buildstream/plugins/elements/modulebuild.py
index 5189af1a6..d619a1d01 100644
--- a/buildstream/plugins/elements/modulebuild.py
+++ b/buildstream/plugins/elements/modulebuild.py
@@ -26,6 +26,9 @@ the Perl Module::Build build system
 The modulebuild default configuration:
   .. literalinclude:: ../../../buildstream/plugins/elements/modulebuild.yaml
      :language: yaml
+
+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
+details on common configuration options for build elements.
 """
 
 from buildstream import BuildElement
diff --git a/buildstream/plugins/elements/pip.py b/buildstream/plugins/elements/pip.py
index e62f713a6..02b593af3 100644
--- a/buildstream/plugins/elements/pip.py
+++ b/buildstream/plugins/elements/pip.py
@@ -26,6 +26,9 @@ Python modules with pip
 The pip default configuration:
   .. literalinclude:: ../../../buildstream/plugins/elements/pip.yaml
      :language: yaml
+
+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
+details on common configuration options for build elements.
 """
 
 from buildstream import BuildElement
diff --git a/buildstream/plugins/elements/qmake.py b/buildstream/plugins/elements/qmake.py
index 9f5bc4018..d6776b0b2 100644
--- a/buildstream/plugins/elements/qmake.py
+++ b/buildstream/plugins/elements/qmake.py
@@ -26,6 +26,9 @@ the qmake build system
 The qmake default configuration:
   .. literalinclude:: ../../../buildstream/plugins/elements/qmake.yaml
      :language: yaml
+
+See :ref:`built-in functionality documentation <core_buildelement_builtins>` for
+details on common configuration options for build elements.
 """
 
 from buildstream import BuildElement