summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Ennis <james.ennis@codethink.com>2018-04-17 09:46:30 +0100
committerTristan Van Berkom <tristan.van.berkom@gmail.com>2018-04-17 16:52:27 +0000
commit58f8e6bc6de85247b4d84533036eb22a0b8ce497 (patch)
tree1902949c325b66755020068065c27b140479c7de
parent02119f198cc0ada3c8a927cb96f825a6ac519c5f (diff)
downloadbuildstream-58f8e6bc6de85247b4d84533036eb22a0b8ce497.tar.gz
Consistent titling
-rw-r--r--HACKING.rst24
-rw-r--r--doc/source/artifacts.rst6
-rw-r--r--doc/source/authoring.rst8
-rw-r--r--doc/source/cachekeys.rst8
-rw-r--r--doc/source/config.rst10
-rw-r--r--doc/source/format.rst14
-rw-r--r--doc/source/formatintro.rst12
-rw-r--r--doc/source/install.rst2
-rw-r--r--doc/source/main_core.rst2
-rw-r--r--doc/source/projectconf.rst44
-rw-r--r--doc/source/projectrefs.rst4
-rw-r--r--doc/source/public.rst6
12 files changed, 70 insertions, 70 deletions
diff --git a/HACKING.rst b/HACKING.rst
index 9c2cb1264..9f1f46d5c 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -3,7 +3,7 @@ Hacking on BuildStream
Some tips and guidelines for developers hacking on BuildStream
-Feature Additions
+Feature additions
-----------------
Major feature additions should be proposed on the
`mailing list <https://mail.gnome.org/mailman/listinfo/buildstream-list>`_
@@ -21,7 +21,7 @@ bugs which may have fell through the cracks in the review process, giving us
a reasonable timeframe for identifying these.
-Patch Submissions
+Patch submissions
-----------------
Branches must be submitted as merge requests in gitlab and should usually
be associated to an issue report on gitlab.
@@ -45,7 +45,7 @@ makes bisections more easy to perform, but is not always practical with
more complex branches.
-Commit Messages
+Commit messages
~~~~~~~~~~~~~~~
Commit messages must be formatted with a brief summary line, optionally
followed by an empty line and then a free form detailed description of
@@ -65,12 +65,12 @@ a very brief description of the change.
This fixes issue #123
-Coding Style
+Coding style
------------
Coding style details for BuildStream
-Style Guide
+Style guide
~~~~~~~~~~~
Python coding style for BuildStream is pep8, which is documented here: https://www.python.org/dev/peps/pep-0008/
@@ -145,7 +145,7 @@ public symbols. In the case of public modules where we may have a mix of
before *local private* symbols.
-Symbol Naming
+Symbol naming
'''''''''''''
Any private symbol must start with a single leading underscore for two reasons:
@@ -187,7 +187,7 @@ ambiguous.
methods declared in public scope.
-Documenting Private Symbols
+Documenting private symbols
'''''''''''''''''''''''''''
Any symbol which is *API Private* (regardless of whether it is also
*local private*), should have some documentation for developers to
@@ -215,7 +215,7 @@ Useful links:
* rst primer: http://www.sphinx-doc.org/en/stable/rest.html
-Building Docs
+Building docs
~~~~~~~~~~~~~
The documentation build is not integrated into the ``setup.py`` and is
difficult (or impossible) to do so, so there is a little bit of setup
@@ -240,7 +240,7 @@ This will give you a ``doc/build/html`` directory with the html docs which
you can view in your browser locally to test.
-Man Pages
+Man pages
~~~~~~~~~
Unfortunately it is quite difficult to integrate the man pages build
into the ``setup.py``, as such, whenever the frontend command line
@@ -261,7 +261,7 @@ the ``man/`` subdirectory, which will be automatically included
in the buildstream distribution.
-Documenting Conventions
+Documenting conventions
~~~~~~~~~~~~~~~~~~~~~~~
We use the sphinx.ext.napoleon extension for the purpose of having
a bit nicer docstrings than the default sphinx docstrings.
@@ -297,7 +297,7 @@ The elaborate documentation for pytest can be found here: http://doc.pytest.org/
Don't get lost in the docs if you don't need to, follow existing examples instead.
-Running Tests
+Running tests
~~~~~~~~~~~~~
To run the tests, just type::
@@ -336,7 +336,7 @@ with::
Alternatively, any IDE plugin that uses pytest should automatically
detect the ``.pylintrc`` in the project's root directory.
-Adding Tests
+Adding tests
~~~~~~~~~~~~
Tests are found in the tests subdirectory, inside of which
there is a separarate directory for each *domain* of tests.
diff --git a/doc/source/artifacts.rst b/doc/source/artifacts.rst
index b5003d940..9f2c31ec3 100644
--- a/doc/source/artifacts.rst
+++ b/doc/source/artifacts.rst
@@ -1,6 +1,6 @@
-.. _artifacts:
+.. _artifacts:
Installing an artifact server
=============================
@@ -180,7 +180,7 @@ E.g., create ``/etc/cron.d/artifacts`` with the following content:
*/5 * * * * artifacts ostree --repo=/home/artifacts/artifacts summary -u
-User Configuration
+User configuration
~~~~~~~~~~~~~~~~~~
The user configuration for artifacts is documented with the rest
of the :ref:`user configuration documentation <config>`.
@@ -203,7 +203,7 @@ then a user can use the following user configuration:
#push: true
-Authenticating Users
+Authenticating users
~~~~~~~~~~~~~~~~~~~~
In order to give permission to a given user to upload
artifacts, simply use the regular ``ssh`` method.
diff --git a/doc/source/authoring.rst b/doc/source/authoring.rst
index 91b83132b..0ce1d9930 100644
--- a/doc/source/authoring.rst
+++ b/doc/source/authoring.rst
@@ -2,7 +2,7 @@
.. _authoring:
-Authoring Projects
+Authoring projects
==================
This section details how to use the BuildStream YAML format to
create your own project or modify existing projects.
@@ -33,7 +33,7 @@ Elements
The following element types are provided with BuildStream:
-General Elements
+General elements
''''''''''''''''
* :mod:`stack <elements.stack>` - Symbolic Element for dependency grouping
@@ -44,7 +44,7 @@ General Elements
* :mod:`filter <elements.filter>` - Extract a subset of files from another element
-Build Elements
+Build elements
''''''''''''''
* :mod:`manual <elements.manual>` - Manual Build Element
@@ -72,7 +72,7 @@ The following source types are provided with BuildStream:
* :mod:`deb <sources.deb>` - A Source implementation for deb packages
-External Plugins
+External plugins
----------------
External plugins need to be installed separately, here is
a list of BuildStream plugin projects known to us at this time:
diff --git a/doc/source/cachekeys.rst b/doc/source/cachekeys.rst
index 4458d8883..f0df796c5 100644
--- a/doc/source/cachekeys.rst
+++ b/doc/source/cachekeys.rst
@@ -2,7 +2,7 @@
.. _cachekeys:
-Cache Keys
+Cache keys
==========
Cache keys for artifacts are generated from the inputs of the build process
@@ -19,7 +19,7 @@ includes:
* Dependencies (depending on cache key type, see below)
* Public data
-Cache Key Types
+Cache key types
---------------
There are two types of cache keys in BuildStream, ``strong`` and ``weak``.
@@ -42,7 +42,7 @@ or the environment changes but it will not change when a dependency is updated.
For elements without build dependencies the ``strong`` cache key is identical
to the ``weak`` cache key.
-Strict Build Plan
+Strict build plan
-----------------
This is the default build plan that exclusively uses ``strong`` cache keys
for the core functionality. An element's cache key can be calculated when
@@ -60,7 +60,7 @@ and non-strict build plans. If the artifact cache already contains an
artifact with the same ``weak`` cache key, it's replaced. Thus, non-strict
builds always use the latest artifact available for a given ``weak`` cache key.
-Non-strict Build Plan
+Non-strict build plan
---------------------
The non-strict build plan disables the time-consuming automatic rebuild of
reverse dependencies at the cost of dropping the reproducibility benefits.
diff --git a/doc/source/config.rst b/doc/source/config.rst
index 3787e7aa6..ee426f0ab 100644
--- a/doc/source/config.rst
+++ b/doc/source/config.rst
@@ -2,7 +2,7 @@
.. _config:
-User Configuration
+User configuration
==================
User configuration and preferences can be specified in a user provided
configuration file, and usually also on the command line.
@@ -23,14 +23,14 @@ invoking ``bst``, an attempt is made to load user specific configuration from
will be ``~/.config/buildstream.conf``
-Project Specific Value
+Project specific value
----------------------
The ``projects`` key can be used to specify project specific configurations,
the supported configurations on a project wide basis are listed here.
.. _config_artifacts:
-Artifact Server
+Artifact server
~~~~~~~~~~~~~~~
The project you build will often specify a :ref:`remote artifact cache
<artifacts>` already, but you may want to specify extra caches. There are two
@@ -65,7 +65,7 @@ by the project.
If you give a list of URLs, earlier entries in the list will have higher
priority than later ones.
-Strict Build Plan
+Strict build plan
~~~~~~~~~~~~~~~~~
The strict build plan option decides whether you want elements
to rebuild when their dependencies have changed. This is enabled
@@ -89,7 +89,7 @@ modifying some low level component.
the ``--strict`` and ``--no-strict`` command line options.
-Default Configuration
+Default configuration
---------------------
The default BuildStream configuration is specified here for reference:
diff --git a/doc/source/format.rst b/doc/source/format.rst
index a320e9963..04c458d01 100644
--- a/doc/source/format.rst
+++ b/doc/source/format.rst
@@ -1,13 +1,13 @@
.. _format:
-Element Constructs
+Element constructs
==================
.. _format_basics:
-Element Basics
+Element basics
--------------
Here is a rather complete example using the autotools element kind and git source kind:
@@ -265,7 +265,7 @@ In this section we'll quickly go over the few features BuildStream offers in its
dependency model.
-Expressing Dependencies
+Expressing dependencies
~~~~~~~~~~~~~~~~~~~~~~~
Dependencies in BuildStream are parameterizable objects, however as demonstrated
in the :ref:`above example <format_depends>`, they can also be expressed as simple
@@ -317,7 +317,7 @@ Attributes:
.. _format_dependencies_types:
-Dependency Types
+Dependency types
~~~~~~~~~~~~~~~~
The dependency ``type`` attribute defines what the dependency is required for
and is essential to how BuildStream plots a build plan.
@@ -350,13 +350,13 @@ required both at build time and runtime.
.. _format_variables:
-Using Variables
+Using variables
---------------
Variables in BuildStream are a way to make your build instructions and
element configurations more dynamic.
-Referring to Variables
+Referring to variables
~~~~~~~~~~~~~~~~~~~~~~
Variables are expressed as ``%{...}``, where ``...`` must contain only
alphanumeric characters and the separators ``_`` and ``-``. Further, the
@@ -367,7 +367,7 @@ first letter of ``...`` must be an alphabetic character.
This is release version %{version}
-Declaring and Overriding Variables
+Declaring and overriding variables
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To declare or override a variable, one need only specify a value
in the relevant *variables* section:
diff --git a/doc/source/formatintro.rst b/doc/source/formatintro.rst
index 27f48302a..9bc1051c4 100644
--- a/doc/source/formatintro.rst
+++ b/doc/source/formatintro.rst
@@ -21,7 +21,7 @@ in other sections of the documentation.
.. _format_structure:
-Directory Structure
+Directory structure
-------------------
A BuildStream project is a directory consisting of:
@@ -64,7 +64,7 @@ order in which they are applied. Configurations which are applied later have a h
priority and override configurations which precede them.
-1. Builtin Defaults
+1. Builtin defaults
~~~~~~~~~~~~~~~~~~~
The :ref:`builtin defaults <project_builtin_defaults>` provide a set of builtin
default default values for ``project.conf``.
@@ -73,7 +73,7 @@ The project wide defaults defined in the builtin project configuration, such as
*variables* or *environment* sections, form the base configuration of all elements.
-2. Project Configuration
+2. Project configuration
~~~~~~~~~~~~~~~~~~~~~~~~
The :ref:`project wide defaults <project_defaults>` specified in your
``project.conf`` are now applied on top of builtin defaults.
@@ -86,7 +86,7 @@ Note that :ref:`plugin type specific configuration <project_overrides>`
in ``project.conf`` is not applied until later.
-3. Plugin Defaults
+3. Plugin defaults
~~~~~~~~~~~~~~~~~~
Elements and Sources are all implemented as plugins.
@@ -103,7 +103,7 @@ Source plugins do not have a ``.yaml`` file, and do not have *variables* or
*environment*.
-4. Project Configuration Overrides
+4. Project configuration overrides
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ``project.conf`` now gives you :ref:`another opportunity <project_overrides>` to
override configuration on a per plugin basis.
@@ -118,7 +118,7 @@ including configuration in element specific *config* sections.
See also :ref:`project_overrides`
-5. Plugin Declarations
+5. Plugin declarations
~~~~~~~~~~~~~~~~~~~~~~~
Finally, after having resolved any :ref:`conditionals <format_directives_conditional>`
in the parsing phase of loading element declarations; the configurations specified in a
diff --git a/doc/source/install.rst b/doc/source/install.rst
index 2b844ea43..0134e3abe 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -125,7 +125,7 @@ A regular way to do this is to add the following line to the end of your ``~/.ba
You will have to restart your terminal in order for these changes to take effect.
-Bash Completions
+Bash completions
~~~~~~~~~~~~~~~~
Bash completions are supported by sourcing the ``buildstream/data/bst``
script found in the BuildStream repository. On many systems this script
diff --git a/doc/source/main_core.rst b/doc/source/main_core.rst
index 78d8cc264..608d04851 100644
--- a/doc/source/main_core.rst
+++ b/doc/source/main_core.rst
@@ -10,7 +10,7 @@ other more elaborate details about BuildStream internals.
.. _core_framework:
-Core Framework
+Core framework
--------------
The core public APIs are of interest to anyone who wishes to
implement custom :mod:`Element <buildstream.element>` or
diff --git a/doc/source/projectconf.rst b/doc/source/projectconf.rst
index 28072fac0..4fe38bcc6 100644
--- a/doc/source/projectconf.rst
+++ b/doc/source/projectconf.rst
@@ -2,7 +2,7 @@
.. _projectconf:
-Project Configuration
+Project configuration
=====================
The project configuration file should be named ``project.conf`` and
be located at the project root. It holds information such as Source
@@ -22,7 +22,7 @@ Essentials
.. _project_format_name:
-Project Name
+Project name
~~~~~~~~~~~~
The project name is a unique symbol for your project and will
be used to distinguish your project from others in user preferences,
@@ -45,7 +45,7 @@ of your project.
.. _project_format_version:
-Format Version
+Format version
~~~~~~~~~~~~~~
The BuildStream format is guaranteed to be backwards compatible
with any earlier releases. The project's minimum required format
@@ -75,7 +75,7 @@ to support a new feature.
.. _project_element_path:
-Element Path
+Element path
~~~~~~~~~~~~
To allow the user to structure their project nicely, BuildStream
allows the user to specify a project subdirectory where element
@@ -91,7 +91,7 @@ elements are referred to in a ``.bst`` file or on the command line.
.. _project_format_ref_storage:
-Ref Storage
+Ref storage
~~~~~~~~~~~
By default, BuildStream expects to read and write source references
directly in the :ref:`source declaration <format_sources>`, but this
@@ -125,7 +125,7 @@ following to your ``project.conf``:
The ``ref-storage`` configuration is available since :ref:`format version 5 <project_format_version>`
-Fail on Overlaps
+Fail on overlaps
~~~~~~~~~~~~~~~~
When multiple elements are staged, there's a possibility that different
elements will try and stage different versions of the same file.
@@ -143,7 +143,7 @@ and the order that the elements were overlapped.
fail-on-overlap: true
-Source Aliases
+Source aliases
~~~~~~~~~~~~~~
In order to abstract the download location of source code and
any assets which need to be downloaded, and also as a matter of
@@ -177,7 +177,7 @@ for more detail.
.. _project_essentials_artifacts:
-Artifact Server
+Artifact server
~~~~~~~~~~~~~~~
If you have setup an :ref:`artifact server <artifacts>` for your
project then it is convenient to configure this in your ``project.conf``
@@ -197,7 +197,7 @@ will have higher priority than later ones.
.. _project_plugins:
-External Plugins
+External plugins
----------------
If your project makes use of any custom :mod:`Element <buildstream.element>` or
:mod:`Source <buildstream.source>` plugins, then the project must inform BuildStream
@@ -206,7 +206,7 @@ of the plugins it means to make use of and the origin from which they can be loa
Note that plugins with the same name from different origins are not permitted.
-Local Plugins
+Local plugins
~~~~~~~~~~~~~
Local plugins are expected to be found in a subdirectory of the actual
BuildStream project. :mod:`Element <buildstream.element>` and
@@ -233,7 +233,7 @@ plugin.
mysource: 0
-Pip Plugins
+Pip plugins
~~~~~~~~~~~
Plugins loaded from the ``pip`` origin are expected to be installed
separately on the host operating system using python's package management
@@ -287,7 +287,7 @@ Users can configure those options when invoking BuildStream with the
underscores, and may not start with a leading digit.
-Common Properties
+Common properties
~~~~~~~~~~~~~~~~~
All option types accept the following common attributes
@@ -471,7 +471,7 @@ Architecture options can be tested with the same expressions
as other Enumeration options.
-Element Mask
+Element mask
~~~~~~~~~~~~
The ``element-mask`` option type is a special Flags option
which automatically allows only element names as values.
@@ -500,7 +500,7 @@ same syntax as other Flag options.
.. _project_defaults:
-Element Default Configuration
+Element default configuration
-----------------------------
The ``project.conf`` plays a role in defining elements by
providing default values and also by overriding values declared
@@ -549,7 +549,7 @@ the number of jobs for a given build without effecting the resulting
cache key.
-Split Rules
+Split rules
~~~~~~~~~~~
The project wide :ref:`split rules <public_split_rules>` defaults can
be specified here.
@@ -570,7 +570,7 @@ be specified here.
.. _project_overrides:
-Overriding Plugin Defaults
+Overriding plugin defaults
--------------------------
Base attributes declared by element and source plugins can be overridden
on a project wide basis. This section explains how to make project wide
@@ -579,7 +579,7 @@ statements which augment the configuration of an element or source plugin.
.. _project_element_overrides:
-Element Overrides
+Element overrides
~~~~~~~~~~~~~~~~~
The elements dictionary can be used to override variables, environments
or plugin specific configuration data as shown below.
@@ -604,7 +604,7 @@ or plugin specific configuration data as shown below.
.. _project_source_overrides:
-Source Overrides
+Source overrides
~~~~~~~~~~~~~~~~
The sources dictionary can be used to override source plugin
specific configuration data as shown below.
@@ -640,7 +640,7 @@ The ``shell`` section allows some customization of the shell environment.
The ``shell`` section is available since :ref:`format version 1 <project_format_version>`
-Interactive Shell Command
+Interactive shell command
~~~~~~~~~~~~~~~~~~~~~~~~~
By default, BuildStream will use ``sh -i`` when running an interactive
shell, unless a specific command is given to the ``bst shell`` command.
@@ -660,7 +660,7 @@ ensure that the customized prompt is not overwritten:
command: [ 'bash', '--noprofile', '--norc', '-i' ]
-Environment Assignments
+Environment assignments
~~~~~~~~~~~~~~~~~~~~~~~
In order to cooperate with your host environment, a debugging shell
sometimes needs to be configured with some extra knowledge inheriting
@@ -699,7 +699,7 @@ server with a ``bst shell`` environment:
PULSE_SERVER: 'unix:${XDG_RUNTIME_DIR}/pulse/native'
-Host Files
+Host files
~~~~~~~~~~
It can be useful to share some files on the host with a shell so that
it can integrate better with the host environment.
@@ -789,7 +789,7 @@ Host side environment variable expansion is also supported:
.. _project_builtin_defaults:
-Builtin Defaults
+Builtin defaults
----------------
BuildStream defines some default values for convenience, the default
values overridden by your project's ``project.conf`` are presented here:
diff --git a/doc/source/projectrefs.rst b/doc/source/projectrefs.rst
index a312792b8..94bf4c718 100644
--- a/doc/source/projectrefs.rst
+++ b/doc/source/projectrefs.rst
@@ -2,7 +2,7 @@
.. _projectrefs:
-The project.refs File
+The project.refs file
=====================
If one has elected to store source references in a single ``project.refs``
file, then it will be stored at the toplevel of your project directory
@@ -12,7 +12,7 @@ using the :ref:`ref-storage configuration <project_format_ref_storage>`
.. _projectrefs_basics:
-Basic Behavior
+Basic behavior
--------------
When a ``project.refs`` file is in use, any source references found
in the :ref:`inline source declarations <format_sources>` are considered
diff --git a/doc/source/public.rst b/doc/source/public.rst
index 4b3383d3d..beae53e66 100644
--- a/doc/source/public.rst
+++ b/doc/source/public.rst
@@ -2,7 +2,7 @@
.. _public:
-Builtin Public Data
+Builtin public data
===================
Elements can provide public data which can be read by other elements
@@ -18,7 +18,7 @@ In this section we will describe the public data in the ``bst`` domain.
.. _public_integration:
-Integration Commands
+Integration commands
--------------------
.. code:: yaml
@@ -47,7 +47,7 @@ any build commands.
.. _public_split_rules:
-Split Rules
+Split rules
-----------
.. code:: yaml