Reporting: Fix sections for reports settings

Signed-off-by: Sol Jerome <sol.jerome@gmail.com>

13 files changed, 86 insertions, 45 deletions

diff --git a/doc/man/bcfg2.conf.txt b/doc/man/bcfg2.conf.txt
index d8f2bc3df..3a0217aef 100644
--- a/doc/man/bcfg2.conf.txt
+++ b/doc/man/bcfg2.conf.txt
@@ -729,11 +729,21 @@ control the database connection of the server.
     port
         Port for database connections. Not used for sqlite3.
 
+Reporting options
+-----------------
+
+    config
+        Specifies the location of the reporting configuration (default
+        is /etc/bcfg2-web.conf.
+
     time_zone
-        Specify a time zone other than that used on the system. (Note
+        Specifies a time zone other than that used on the system. (Note
         that this will cause the Bcfg2 server to log messages in this
         time zone as well).
 
+    web_debug
+        Turn on Django debugging.
+
 See Also
 --------
 
diff --git a/doc/reports/dynamic.txt b/doc/reports/dynamic.txt
index 19c947a71..14eff6f54 100644
--- a/doc/reports/dynamic.txt
+++ b/doc/reports/dynamic.txt
@@ -166,20 +166,22 @@ Upgrading
 2. Replace the DBStats plugin with the Reporting plugin.
 
 3. Migrate historic data.
-    Run `tools/upgrade/1.3/migrate_dbstats.py`
+    Run ``tools/upgrade/1.3/migrate_dbstats.py``
 
     The reporting schema is now managed using `South <http://south.aeracode.org>`_
     instead of a set of custom scripts. This creates the new schema and imports
     all of the historic data to the new format.
 
-.. Note:
+    .. note::
 
-    After the database is upgraded all of the old tables are left intact.  To
-    remove them any table starting with reports_ can be dropped.
+        After the database is upgraded all of the old tables are left
+        intact. To remove them any table starting with reports_ can
+        be dropped.
 
 4. `(Optional)` Run the :ref:`Report Collector <report_collector>`
-    Add "transport = LocalFilesystem" under "[reporting]" in `bcfg2.conf`.
-    Restart the bcfg2-server and start the bcfg2-report-collector.
+    Add "transport = LocalFilesystem" under "[reporting]" in
+    ``bcfg2.conf``.  Restart the bcfg2-server and start the
+    bcfg2-report-collector.
 
 Configuring
 ===========
diff --git a/man/bcfg2-admin.8 b/man/bcfg2-admin.8
index 279ee7e0b..06cbeec0b 100644
--- a/man/bcfg2-admin.8
+++ b/man/bcfg2-admin.8
@@ -1,4 +1,4 @@
-.TH "BCFG2-ADMIN" "8" "January 14, 2013" "1.3" "Bcfg2"
+.TH "BCFG2-ADMIN" "8" "March 18, 2013" "1.3" "Bcfg2"
 .SH NAME
 bcfg2-admin \- Perform repository administration tasks
 .
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
 .
 .SH SYNOPSIS
 .sp
@@ -249,5 +249,4 @@ Add a shape/color key.
 .sp
 \fIbcfg2\-info(8)\fP, \fIbcfg2\-server(8)\fP
 .\" Generated by docutils manpage writer.
-.\" 
 .
diff --git a/man/bcfg2-build-reports.8 b/man/bcfg2-build-reports.8
index 8d3d58ebb..3b4582820 100644
--- a/man/bcfg2-build-reports.8
+++ b/man/bcfg2-build-reports.8
@@ -1,4 +1,4 @@
-.TH "BCFG2-BUILD-REPORTS" "8" "January 14, 2013" "1.3" "Bcfg2"
+.TH "BCFG2-BUILD-REPORTS" "8" "March 18, 2013" "1.3" "Bcfg2"
 .SH NAME
 bcfg2-build-reports \- Generate state reports for Bcfg2 clients
 .
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
 .
 .SH SYNOPSIS
 .sp
@@ -58,5 +58,4 @@ default is \fBrepo/etc/statistics.xml\fP.
 .sp
 \fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP
 .\" Generated by docutils manpage writer.
-.\" 
 .
diff --git a/man/bcfg2-crypt.8 b/man/bcfg2-crypt.8
index 7c11eb66c..3cdef3f84 100644
--- a/man/bcfg2-crypt.8
+++ b/man/bcfg2-crypt.8
@@ -1,4 +1,4 @@
-.TH "BCFG2-CRYPT" "8" "January 14, 2013" "1.3" "Bcfg2"
+.TH "BCFG2-CRYPT" "8" "March 18, 2013" "1.3" "Bcfg2"
 .SH NAME
 bcfg2-crypt \- Bcfg2 encryption and decryption utility
 .
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
 .
 .SH SYNOPSIS
 .sp
@@ -150,5 +150,4 @@ produced and the file being encrypted or decrypted is skipped.
 .sp
 \fIbcfg2\-server(8)\fP
 .\" Generated by docutils manpage writer.
-.\" 
 .
diff --git a/man/bcfg2-info.8 b/man/bcfg2-info.8
index ee650b5da..a52194372 100644
--- a/man/bcfg2-info.8
+++ b/man/bcfg2-info.8
@@ -1,4 +1,4 @@
-.TH "BCFG2-INFO" "8" "January 14, 2013" "1.3" "Bcfg2"
+.TH "BCFG2-INFO" "8" "March 18, 2013" "1.3" "Bcfg2"
 .SH NAME
 bcfg2-info \- Creates a local version of the Bcfg2 server core for state observation
 .
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
 .
 .SH SYNOPSIS
 .sp
@@ -136,5 +136,4 @@ Print version of this tool.
 .sp
 \fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP
 .\" Generated by docutils manpage writer.
-.\" 
 .
diff --git a/man/bcfg2-lint.8 b/man/bcfg2-lint.8
index c81c305f1..22632f5dd 100644
--- a/man/bcfg2-lint.8
+++ b/man/bcfg2-lint.8
@@ -1,4 +1,4 @@
-.TH "BCFG2-LINT" "8" "January 14, 2013" "1.3" "Bcfg2"
+.TH "BCFG2-LINT" "8" "March 18, 2013" "1.3" "Bcfg2"
 .SH NAME
 bcfg2-lint \- Check Bcfg2 specification for validity, common mistakes, and style
 .
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
 .
 .SH SYNOPSIS
 .sp
@@ -143,5 +143,4 @@ than by a mix of Cfg and TGenshi or TCheetah.
 \fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP,
 \fIbcfg2\-lint.conf(5)\fP
 .\" Generated by docutils manpage writer.
-.\" 
 .
diff --git a/man/bcfg2-lint.conf.5 b/man/bcfg2-lint.conf.5
index d6d299616..a2b34e601 100644
--- a/man/bcfg2-lint.conf.5
+++ b/man/bcfg2-lint.conf.5
@@ -1,4 +1,4 @@
-.TH "BCFG2-LINT.CONF" "5" "January 14, 2013" "1.3" "Bcfg2"
+.TH "BCFG2-LINT.CONF" "5" "March 18, 2013" "1.3" "Bcfg2"
 .SH NAME
 bcfg2-lint.conf \- Configuration parameters for bcfg2-lint
 .
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
 .
 .SH DESCRIPTION
 .sp
@@ -158,5 +158,4 @@ The full path to the XML Schema files. Default is
 .sp
 \fIbcfg2\-lint(8)\fP
 .\" Generated by docutils manpage writer.
-.\" 
 .
diff --git a/man/bcfg2-reports.8 b/man/bcfg2-reports.8
index 7b1622a5e..6d0db36fa 100644
--- a/man/bcfg2-reports.8
+++ b/man/bcfg2-reports.8
@@ -1,4 +1,4 @@
-.TH "BCFG2-REPORTS" "8" "January 14, 2013" "1.3" "Bcfg2"
+.TH "BCFG2-REPORTS" "8" "March 18, 2013" "1.3" "Bcfg2"
 .SH NAME
 bcfg2-reports \- Query reporting system for client status
 .
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
 .
 .SH SYNOPSIS
 .sp
@@ -142,5 +142,4 @@ specified file instead of the command line.
 .sp
 \fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP
 .\" Generated by docutils manpage writer.
-.\" 
 .
diff --git a/man/bcfg2-server.8 b/man/bcfg2-server.8
index 8df8ebfd5..27f6a7b01 100644
--- a/man/bcfg2-server.8
+++ b/man/bcfg2-server.8
@@ -1,4 +1,4 @@
-.TH "BCFG2-SERVER" "8" "January 14, 2013" "1.3" "Bcfg2"
+.TH "BCFG2-SERVER" "8" "March 18, 2013" "1.3" "Bcfg2"
 .SH NAME
 bcfg2-server \- Server for client configuration specifications
 .
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
 .
 .SH SYNOPSIS
 .sp
@@ -76,5 +76,4 @@ Specify the path to the SSL key.
 .sp
 \fIbcfg2(1)\fP, \fIbcfg2\-lint(8)\fP
 .\" Generated by docutils manpage writer.
-.\" 
 .
diff --git a/man/bcfg2.1 b/man/bcfg2.1
index 1e0f526c8..5b9449fda 100644
--- a/man/bcfg2.1
+++ b/man/bcfg2.1
@@ -1,4 +1,4 @@
-.TH "BCFG2" "1" "January 14, 2013" "1.3" "Bcfg2"
+.TH "BCFG2" "1" "March 18, 2013" "1.3" "Bcfg2"
 .SH NAME
 bcfg2 \- Bcfg2 client tool
 .
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
 .
 .SH SYNOPSIS
 .sp
@@ -164,10 +164,13 @@ be used in safe conditions.
 .TP
 .BI \-r \ mode
 Cause bcfg2 to remove extra configuration elements
-it detects. Mode is one of "all", "Services", or
-"Packages". "all" removes all entries. Likewise,
-"Services" and "Packages" remove only the extra
+it detects. Mode is one of "all", "Services",
+"Packages", or "Users". "all" removes all extra entries.
+"Services", "Packages", and "Users" remove only the extra
 configuration elements of the respective type.
+("Services" actually just disables extra services,
+since they can\(aqt be removed, and "Users" removes
+extra POSIXUser and POSIXUser entries.)
 .TP
 .BI \-s \ servicemode
 Set bcfg2 interaction level for services. Default
@@ -206,5 +209,4 @@ Only configure independent entries, ignore bundles.
 .sp
 \fIbcfg2\-server(8)\fP, \fIbcfg2\-info(8)\fP
 .\" Generated by docutils manpage writer.
-.\" 
 .
diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5
index 0a982b8f0..b0db91a5b 100644
--- a/man/bcfg2.conf.5
+++ b/man/bcfg2.conf.5
@@ -1,4 +1,4 @@
-.TH "BCFG2.CONF" "5" "January 14, 2013" "1.3" "Bcfg2"
+.TH "BCFG2.CONF" "5" "March 18, 2013" "1.3" "Bcfg2"
 .SH NAME
 bcfg2.conf \- Configuration parameters for Bcfg2
 .
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
 .
 .SH DESCRIPTION
 .sp
@@ -62,6 +62,8 @@ the \fIbcfg2\-admin init\fP command.
 The file monitor used to watch for changes in the repository. The
 default is the best available monitor. The following values are
 valid:
+.INDENT 7.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
@@ -71,10 +73,14 @@ fam
 pseudo
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .TP
 .B ignore_files
 A comma\-separated list of globs that should be ignored by the file
 monitor. Default values are:
+.INDENT 7.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
@@ -90,6 +96,8 @@ SCCS
 \&.gitignore
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .TP
 .B listen_all
 This setting tells the server to listen on all available interfaces.
@@ -99,6 +107,8 @@ bcfg2 setting in the components section of \fBbcfg2.conf\fP.
 .B plugins
 A comma\-delimited list of enabled server plugins. Currently
 available plugins are:
+.INDENT 7.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
@@ -145,6 +155,8 @@ TGenshi
 Trigger
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 Descriptions of each plugin can be found in their respective
 sections below.
@@ -156,6 +168,8 @@ default location (e.g. \fB/usr/local\fP).
 .B backend
 Specifies which server core backend to use. Current available
 options are:
+.INDENT 7.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
@@ -164,6 +178,8 @@ builtin
 best
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 The default is \fIbest\fP, which is currently an alias for \fIbuiltin\fP.
 More details on the backends can be found in the official
@@ -725,6 +741,8 @@ control the database connection of the server.
 .B engine
 The database engine used by the statistics module. One of the
 following:
+.INDENT 7.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
@@ -734,6 +752,8 @@ sqlite3
 ado_mssql
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .TP
 .B name
 The name of the database to use for statistics data. If
@@ -751,11 +771,25 @@ Host for database connections. Not used for sqlite3.
 .TP
 .B port
 Port for database connections. Not used for sqlite3.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH REPORTING OPTIONS
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B config
+Specifies the location of the reporting configuration (default
+is /etc/bcfg2\-web.conf.
 .TP
 .B time_zone
-Specify a time zone other than that used on the system. (Note
+Specifies a time zone other than that used on the system. (Note
 that this will cause the Bcfg2 server to log messages in this
 time zone as well).
+.TP
+.B web_debug
+Turn on Django debugging.
 .UNINDENT
 .UNINDENT
 .UNINDENT
@@ -763,5 +797,4 @@ time zone as well).
 .sp
 \fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP
 .\" Generated by docutils manpage writer.
-.\" 
 .
diff --git a/src/lib/Bcfg2/Options.py b/src/lib/Bcfg2/Options.py
index fd096b75a..5f079f0b4 100644
--- a/src/lib/Bcfg2/Options.py
+++ b/src/lib/Bcfg2/Options.py
@@ -621,17 +621,19 @@ WEB_CFILE = \
            default="/etc/bcfg2-web.conf",
            cmd='-W',
            odesc='<conffile>',
-           cf=('statistics', 'config'),)
+           cf=('reporting', 'config'),
+           deprecated_cf=('statistics', 'web_prefix'),)
 DJANGO_TIME_ZONE = \
     Option('Django timezone',
            default=None,
-           cf=('statistics', 'time_zone'),)
+           cf=('reporting', 'time_zone'),
+           deprecated_cf=('statistics', 'web_prefix'),)
 DJANGO_DEBUG = \
     Option('Django debug',
            default=None,
-           cf=('statistics', 'web_debug'),
+           cf=('reporting', 'web_debug'),
+           deprecated_cf=('statistics', 'web_prefix'),
            cook=get_bool,)
-# Django options
 DJANGO_WEB_PREFIX = \
     Option('Web prefix',
            default=None,