jjb/jenkins-job-builder
Code Issues Proposed changes

Minor fixes in the installation documentation

Browse Source 
Fix a couple of grammatical errors, and wrap long lines to fit
within 80 columns.

Change-Id: Ide46f5fdc6bb2f0b759fc6e69669097d23149791
This commit is contained in:
David Pursehouse 2014-04-08 11:06:22 +09:00
parent 1b88a66db2
commit dd36e35476
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/installation.rst
View File

@ -19,7 +19,8 @@ locally execute the command::
tox -e doc tox -e doc
The generated documentation is then available under ``doc/build/html/index.html``. The generated documentation is then available under
``doc/build/html/index.html``.
Unit Tests Unit Tests
---------- ----------
@ -39,7 +40,7 @@ Configuration File
After installation, you will need to create a configuration file. By After installation, you will need to create a configuration file. By
default, ``jenkins-jobs`` looks in default, ``jenkins-jobs`` looks in
``/etc/jenkins_jobs/jenkins_jobs.ini`` but you may specify an ``/etc/jenkins_jobs/jenkins_jobs.ini`` but you may specify an
alternate location when running ``jenkins-jobs``. The file should have alternative location when running ``jenkins-jobs``. The file should have
the following format: the following format:
.. literalinclude:: ../../etc/jenkins_jobs.ini-sample .. literalinclude:: ../../etc/jenkins_jobs.ini-sample
@ -61,8 +62,7 @@ the following format:
The base URL for your Jenkins installation. The base URL for your Jenkins installation.
**ignore_cache** **ignore_cache**
(Optional) If set to True, jenkins job builder (Optional) If set to True, Jenkins Job Builder won't use any cache.
won't be using any cache.
Running Running
@ -108,4 +108,5 @@ arguments after the configuration path. To update Foo1 and Foo2 run::
.. rubric:: Footnotes .. rubric:: Footnotes
.. [#f1] The cache default location is at ``~/.cache/jenkins_jobs``, which .. [#f1] The cache default location is at ``~/.cache/jenkins_jobs``, which
can be overridden by setting the ``XDG_CACHE_HOME`` environment variable. can be overridden by setting the ``XDG_CACHE_HOME`` environment
variable.