Bug 1255450 - mach settings documentation fix, DONTBUILD, r=me
authorAndrew Halberstadt <ahalberstadt@mozilla.com>
Tue, 12 Apr 2016 21:03:36 -0400
changeset 316800 18e8a39074a8b35de64b4b1a8f403f6e1883dc59
parent 316799 009ffacae51adc5d234a7fdde48c82970de097f8
child 316801 6e11636c6aa2193cdf842e6fd00442e0342ce6f3
push id9480
push userjlund@mozilla.com
push dateMon, 25 Apr 2016 17:12:58 +0000
treeherdermozilla-aurora@0d6a91c76a9e [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
Bug 1255450 - mach settings documentation fix, DONTBUILD, r=me MozReview-Commit-ID: AQ3w2oCPQeN
--- a/python/mach/docs/settings.rst
+++ b/python/mach/docs/settings.rst
@@ -1,16 +1,16 @@
 .. _mach_settings:
 Mach can read settings in from a set of configuration files. These
-configuration files are either named ``mach.ini`` or ``.machrc`` and
+configuration files are either named ``machrc`` or ``.machrc`` and
 are specified by the bootstrap script. In mozilla-central, these files
 can live in ``~/.mozbuild`` and/or ``topsrcdir``.
 Settings can be specified anywhere, and used both by mach core or
 individual commands.
 Core Settings
@@ -26,17 +26,17 @@ These settings are implemented by mach c
     mochitest = mochitest -f browser
     browser-test = mochitest -f browser
 Defining Settings
 Settings need to be explicitly defined, along with their type,
-otherwise mach will throw when loading the configuration files.
+otherwise mach will throw when trying to access them.
 To define settings, use the :func:`~decorators.SettingsProvider`
 decorator in an existing mach command module. E.g:
 .. code-block:: python
     from mach.decorators import SettingsProvider