From 284afaf66f438bf0051937210ad8d058e49953dc Mon Sep 17 00:00:00 2001 From: Alexander Sulfrian Date: Mon, 13 Oct 2014 18:00:40 +0200 Subject: doc: fix incorrect format for :ref: --- doc/server/plugins/probes/index.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/server/plugins/probes/index.txt b/doc/server/plugins/probes/index.txt index 091c85e63..434ce20a8 100644 --- a/doc/server/plugins/probes/index.txt +++ b/doc/server/plugins/probes/index.txt @@ -15,7 +15,7 @@ generate an `/etc/auto.master` autofs config file for each type. Here we will look at how to do this. Probes also allow dynamic group assignment for clients, see -:ref:`_server-plugins-probes-dynamic-groups`. +:ref:`server-plugins-probes-dynamic-groups`. First, create a ``Probes`` directory in our toplevel repository location:: -- cgit v1.2.3-1-g7c22 From 21cc1f84e3b6d7c93d6d6cf94f28829f694864ea Mon Sep 17 00:00:00 2001 From: Alexander Sulfrian Date: Mon, 13 Oct 2014 18:04:21 +0200 Subject: doc: fix option list There should be at least two spaces between the option and the description. --- doc/man/bcfg2-server.txt | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/man/bcfg2-server.txt b/doc/man/bcfg2-server.txt index f85964ae7..33d0df6cf 100644 --- a/doc/man/bcfg2-server.txt +++ b/doc/man/bcfg2-server.txt @@ -22,18 +22,18 @@ configurations to clients based on the data in its repository. Options ------- --C configfile Specify alternate bcfg2.conf location. --D pidfile Daemonize, placing the program pid in *pidfile*. --E encoding Specify the encoding of config files. --Q path Specify the path to the server repository. --S server Manually specify the server location (as opposed to - using the value in bcfg2.conf). This should be in - the format "https://server:port" --d Enable debugging output. --v Run in verbose mode. --h Print usage information. ---ssl-key=key Specify the path to the SSL key. ---no-fam-blocking Synonym for fam_blocking = False in bcfg2.conf +-C configfile Specify alternate bcfg2.conf location. +-D pidfile Daemonize, placing the program pid in *pidfile*. +-E encoding Specify the encoding of config files. +-Q path Specify the path to the server repository. +-S server Manually specify the server location (as opposed to + using the value in bcfg2.conf). This should be in + the format "https://server:port" +-d Enable debugging output. +-v Run in verbose mode. +-h Print usage information. +--ssl-key=key Specify the path to the SSL key. +--no-fam-blocking Synonym for fam_blocking = False in bcfg2.conf See Also -------- -- cgit v1.2.3-1-g7c22 From 51e6550454e32d5073d538eb1d8f671f39e1a7b7 Mon Sep 17 00:00:00 2001 From: Alexander Sulfrian Date: Mon, 13 Oct 2014 18:26:14 +0200 Subject: doc: release announcements as toctree --- doc/releases/index.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/releases/index.txt b/doc/releases/index.txt index 42a2306f6..479aa19de 100644 --- a/doc/releases/index.txt +++ b/doc/releases/index.txt @@ -7,4 +7,7 @@ Release Announcements ===================== -.. include:: 1.3.4.txt +.. toctree:: + + 1.4.0pre1 + 1.3.4 -- cgit v1.2.3-1-g7c22 From d50d8c1c176f88073387121adc0c340540bc833c Mon Sep 17 00:00:00 2001 From: Alexander Sulfrian Date: Mon, 13 Oct 2014 18:50:42 +0200 Subject: doc: display platform-specific quickstart notes as toc --- doc/getting_started/index.txt | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/getting_started/index.txt b/doc/getting_started/index.txt index 62e804553..f619447e2 100644 --- a/doc/getting_started/index.txt +++ b/doc/getting_started/index.txt @@ -255,6 +255,10 @@ Once you have the server setup, you may be interested in Platform-specific Quickstart Notes ================================== -* :ref:`appendix-guides-centos` -* :ref:`appendix-guides-ubuntu` -* :ref:`getting_started-macosx-notes` +.. toctree:: + :maxdepth: 1 + + CentOS + Ubuntu + Gentoo + Mac OS X -- cgit v1.2.3-1-g7c22