diff options
| author | Mike McCallister <mike@mccllstr.com> | 2011-07-12 17:03:13 -0500 |
|---|---|---|
| committer | Mike McCallister <mike@mccllstr.com> | 2011-07-12 17:03:13 -0500 |
| commit | d1352fc4a15536090758e4654324a792264cf327 (patch) | |
| tree | dd9d909c9fa302f0087d1a994e8cd7c39b31e9cc /doc | |
| parent | 5c7e54e7edd7f14522398c31b13b10ddb0f8eb17 (diff) | |
| download | bcfg2-d1352fc4a15536090758e4654324a792264cf327.tar.gz bcfg2-d1352fc4a15536090758e4654324a792264cf327.tar.bz2 bcfg2-d1352fc4a15536090758e4654324a792264cf327.zip | |
Minor change to better use Sphinx syntax for environment variables.
Has the benefit that environment variable names will now be visible in
the documentation index.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/appendix/guides/gentoo.txt | 2 | ||||
| -rw-r--r-- | doc/development/setup.txt | 6 | ||||
| -rw-r--r-- | doc/server/plugins/probes/index.txt | 6 |
3 files changed, 7 insertions, 7 deletions
diff --git a/doc/appendix/guides/gentoo.txt b/doc/appendix/guides/gentoo.txt index e818364ce..d635e310b 100644 --- a/doc/appendix/guides/gentoo.txt +++ b/doc/appendix/guides/gentoo.txt @@ -39,7 +39,7 @@ Package Repository You’ll need (to make) at least one archive of binary packages. The Portage driver calls ``emerge`` with the ``-getbinpkgonly`` option. See :manpage:`make.conf(5)` and :manpage:`emerge(1)` manpages, specifically -the *PORTAGE_BINHOST* environment variable. +the :envvar:`PORTAGE_BINHOST` environment variable. Time Saver: quickpkg -------------------- diff --git a/doc/development/setup.txt b/doc/development/setup.txt index 8729ee76e..ad53e5da2 100644 --- a/doc/development/setup.txt +++ b/doc/development/setup.txt @@ -10,10 +10,10 @@ Environment setup for development git clone git://git.mcs.anl.gov/bcfg2.git -* Create link to ``src/lib``:: +* Create link to :file:`src/lib`:: cd bcfg2 ln -s src/lib Bcfg2 -* Add ``bcfg2/src/sbin`` to your PATH environment variable -* Add ``bcfg2`` to your PYTHONPATH environment variable +* Add :file:`bcfg2/src/sbin` to your :envvar:`PATH` environment variable +* Add :file:`bcfg2` to your :envvar:`PYTHONPATH` environment variable diff --git a/doc/server/plugins/probes/index.txt b/doc/server/plugins/probes/index.txt index 5b1f9e259..f22f405c1 100644 --- a/doc/server/plugins/probes/index.txt +++ b/doc/server/plugins/probes/index.txt @@ -37,9 +37,9 @@ interpreter. Bcfg2 uses python mkstemp to create the Probe scripts on the client. If your /tmp directory is mounted **noexec**, you will - likely need to modify the TMPDIR environment variable so that the - bcfg2 client creates the temporary files in a directory from which - it can execute. + likely need to modify the :envvar:`TMPDIR` environment variable so + that the bcfg2 client creates the temporary files in a directory + from which it can execute. Now we need to figure out what exactly we want to do. In this case, we want to hand out an ``/etc/auto.master`` file that looks like:: |