From dcf0d7279c3d2a0fa15560eef34eca4babb92437 Mon Sep 17 00:00:00 2001
From: Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
Date: Fri, 27 Oct 2017 21:19:18 +0900
Subject: Updated documentation about strict mode user configuration

---
 doc/source/config.rst      | 48 ++++++++++++++++++++++++++++++++++++++++++++++
 doc/source/projectconf.rst |  2 ++
 2 files changed, 50 insertions(+)

(limited to 'doc/source')

diff --git a/doc/source/config.rst b/doc/source/config.rst
index 4dccafcaf..2b86156bd 100644
--- a/doc/source/config.rst
+++ b/doc/source/config.rst
@@ -22,6 +22,54 @@ invoking ``bst``, an attempt is made to load user specific configuration from
 will be ``~/.config/buildstream.conf``
 
 
+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.
+
+
+Artifact Server
+~~~~~~~~~~~~~~~
+The artifact server is usually specified by the project you build, but
+it can be overridden on a per project basis using the same format
+:ref:`described here <project_essentials_artifacts>`.
+
+**Example**
+
+.. code:: yaml
+
+   projects:
+     project-name:
+       artifacts:
+         pull-url: https://artifacts.com
+         push-url: artifacts@artifacts.com:artifacts
+         push-port: 443
+
+
+Strict Build Plan
+~~~~~~~~~~~~~~~~~
+The strict build plan option decides whether you want elements
+to rebuild when their dependencies have changed. This is enabled
+by default, but recommended to turn off in developer scenarios where
+you might want to build a large system and test it quickly after
+modifying some low level component.
+
+
+**Example**
+
+.. code:: yaml
+
+   projects:
+     project-name:
+       strict: False
+
+
+.. note::
+
+   It is always possible to override this at invocation time using
+   the ``--strict`` and ``--no-strict`` command line options.
+
+
 Default Configuration
 ---------------------
 The default BuildStream configuration is specified here for reference:
diff --git a/doc/source/projectconf.rst b/doc/source/projectconf.rst
index 2a03cf538..c4997d163 100644
--- a/doc/source/projectconf.rst
+++ b/doc/source/projectconf.rst
@@ -60,6 +60,8 @@ URLs which are to be used in the individual ``.bst`` files.
      bar: http://bar.com/downloads/
 
 
+.. _project_essentials_artifacts:
+
 Artifact Server
 ~~~~~~~~~~~~~~~
 If you have setup an :ref:`artifact server <artifacts>` for your
-- 
cgit v1.2.1