From 5d3338b5da94a1e884ca5328bfa3df8cc2107e3b Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Wed, 24 Mar 2010 21:03:21 +0000 Subject: doc: More fixes Signed-off-by: Sol Jerome git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5792 ce84e21b-d406-0410-9b95-82705330c041 --- doc/client/tools/index.txt | 20 +++++++++++--------- doc/development/index.txt | 4 +++- doc/faq/client.txt | 3 +-- doc/faq/general.txt | 6 ++---- 4 files changed, 17 insertions(+), 16 deletions(-) diff --git a/doc/client/tools/index.txt b/doc/client/tools/index.txt index 37fcdae5c..a613b9d40 100644 --- a/doc/client/tools/index.txt +++ b/doc/client/tools/index.txt @@ -14,7 +14,7 @@ management. The POSIX tool also handles file system and permissions/groups operations. To write your own tool driver, to handle a new packaging format, or new -service architecture see WritingClientToolDrivers. +service architecture see :ref:`development-index-writingtooldrivers` When the bcfg2 client is run, it attempts to instantiate each of these drivers. The succeeding list of drivers are printed as a debug message @@ -54,8 +54,8 @@ Tool to manage services (primarily on Redhat based distros). .. note:: Start and stop are standard arguments, but the one for reload isn't consistent across services. You can specify which argument to use with the `restart` property in Service tags. Example: - `` + ```` DebInit ------- @@ -82,10 +82,10 @@ launchd ------- Mac OS X Services. To use this tool, you must maintain a standard launch -daemon .plist file in ``/Library/LaunchDaemons/`` (example ssh.plist) and -setup a `` -entry in your config to load or unload the service. Note the name is the -''Label'' specified inside of the .plist file +daemon .plist file in ``/Library/LaunchDaemons/`` (example ssh.plist) +and setup a ```` entry in your config to load or unload the service. Note the name +is the ''Label'' specified inside of the .plist file Portage ------- @@ -107,8 +107,9 @@ as Gentoo. RPM --- +.. warning:: Deprecated in favor of :ref:`RPMng ` + Executes rpm to manage packages most often on redhat based systems. -'''DEPRECATED:''' in favor of RPMng RPMng ----- @@ -143,8 +144,9 @@ Upstart service support. Uses `Upstart`_ to configure services. Yum --- +.. warning:: Deprecated in favor of :ref:`YUMng ` + Handles RPMs using the YUM package manager. -'''DEPRECATED: ''' in favor of YUMng YUMng ----- diff --git a/doc/development/index.txt b/doc/development/index.txt index 6ed00f861..bcfa2b56c 100644 --- a/doc/development/index.txt +++ b/doc/development/index.txt @@ -41,6 +41,8 @@ Environment setup for development * Add ``bcfg2/src/sbin`` to your PATH environment variable * Add ``bcfg2`` to your PYTHONPATH environment variable +.. _development-index-writingtooldrivers: + Writing A Client Tool Driver ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -312,4 +314,4 @@ One of the areas where everyone can help is with the documentation. *Insert verb .. toctree:: :maxdepth: 1 - docstyleguide \ No newline at end of file + docstyleguide diff --git a/doc/faq/client.txt b/doc/faq/client.txt index b54973a17..e196568bb 100644 --- a/doc/faq/client.txt +++ b/doc/faq/client.txt @@ -3,8 +3,7 @@ FAQ: Client =========== -*No ca is specified. Cannot authenticate the server with SSL.* is repeated multiple times during a client run -------------------------------------------------------------------------------------------------------------- +**No ca is specified. Cannot authenticate the server with SSL.** This means that the client does not have a copy of the CA for the server, so it can't verify that it is talking to the right server. To fix this diff --git a/doc/faq/general.txt b/doc/faq/general.txt index af54e9002..65db5883c 100644 --- a/doc/faq/general.txt +++ b/doc/faq/general.txt @@ -3,8 +3,7 @@ FAQ: General ============ -What does Bcfg2 stand for? --------------------------- +**What does Bcfg2 stand for?** Initially, Bcfg stood for the bundle configuration system. Bcfg2 is the second major revision. At this point, the acronym is meaningless, but @@ -12,8 +11,7 @@ the name has stuck. Luckily, Bcfg2 googles better than Bcfg does. No, seriously. Try it. All I know is that I have no interest in a billion cubic feet of gas. -What architectures does Bcfg2 support? --------------------------------------- +**What architectures does Bcfg2 support?** Bcfg2 should run on any POSIX compatible operating system, however direct support for an operating system's package and service formats are limited -- cgit v1.2.3-1-g7c22