There were a whole lot of information regarding running the test suite
in the hacking file, while there are a separate tests section of the
documentation. I attempt to slim this down a bit and give a helpful
pointer to the full section in order to avoid duplicated texts.
Forthcoming will be a re-write what appears to be a new method for establishing a development environment through the use of dev_requirements_python2(6|7).txt, once I have a chance to verify
that the workflow is as expected.
This commit modifes a number of files which have command-line examples
so that the code-block directive is used. This provides more
visually-appealing syntax highlighting.
More commits like this will follow, this commit is part of an overall
documentation audit that I am performing.
Since the "pidfile" param has been added to the list of params for which
root_dir is prepended, editing the pidfile is no longer necessary when
running from a recent git checkout. Added a note to clarify this.
Running pip install -e /path/to/git/clone from within the virtualenv
does not also install salt's additional required modules, as the
document suggests. I ran into this issue last week and so did a guy I
was helping troubleshoot in #salt.
Also, I clarified the bit about using --system-site-packages in your
virtualenv.
Thanks to s0undt3ch for suggesting this. Anything to type less on the
command line :)
Also, the filenames for the master and minion templates are "master" and
"minion", not "master.template" and "minion.template". Corrected this.
Salt has a lot of Arch Linux users (after all, Arch is the best!), so
I added some information on building the docs in Arch where the python2
version of sphinx-build is called sphinx-build2
Also, when setting up a standalone development environment in a
virtualenv, unless you are running as root (and the docs explicitly
direct you not to do so) you will not have write access to /var/run in
order to create the pidfile. So, the --pid-file argument should be used
to specify a different path.
Finally, a note on running the master and minion in the foreground in
debug mode was added.