# HG changeset patch
# User osimons
# Date 1272295933 0
# Node ID 025b3e889321da2b375c1b81fa8b14926a50414d
# Parent  d1d67d5920fe6ea370f7d185c6fb0098bcad09da
Doc fixes. Making docs compile without errors + some minor tweaks to output.

diff --git a/bitten/upgrades.py b/bitten/upgrades.py
--- a/bitten/upgrades.py
+++ b/bitten/upgrades.py
@@ -9,7 +9,9 @@
 # are also available at http://bitten.edgewall.org/wiki/License.
 
 """Automated upgrades for the Bitten database tables, and other data stored
-in the Trac environment."""
+in the Trac environment.
+
+**Do not import and call directly!**"""
 
 import os
 import sys
@@ -432,7 +434,7 @@
     env.log.warning("We have dropped the bitten_log_message table - you may want to vaccuum/compress your database to save space")
 
 def fix_log_levels_misnaming(env, db):
-    """Renames or removes *.log.level files created by older versions of migrate_logs_to_files."""
+    """Renames or removes \*.log.level files created by older versions of migrate_logs_to_files."""
     logs_dir = env.config.get("bitten", "logs_dir", "log/bitten")
     if not os.path.isabs(logs_dir):
         logs_dir = os.path.join(env.path, logs_dir)
@@ -480,7 +482,8 @@
     env.log.info("Deleted %d stray log level (%d errors)", delete_count, delete_error_count)
 
 def remove_stray_log_levels_files(env, db):
-    """Remove *.log.levels files without a matching *.log file (old Bitten versions did not delete .log.levels files when builds were deleted)"""
+    """Remove \*.log.levels files without a matching \*.log file (old Bitten
+    versions did not delete .log.levels files when builds were deleted)"""
     logs_dir = env.config.get("bitten", "logs_dir", "log/bitten")
     if not os.path.isabs(logs_dir):
         logs_dir = os.path.join(env.path, logs_dir)
diff --git a/doc/recipes.txt b/doc/recipes.txt
--- a/doc/recipes.txt
+++ b/doc/recipes.txt
@@ -20,10 +20,6 @@
 execute. In addition, build steps help organize the build results for a more
 structured presentation.
 
-.. contents:: Contents
-   :depth: 2
-.. sectnum::
-
 
 File Format
 ===========
@@ -40,12 +36,15 @@
 The ``<build>`` element can optionally have an ``onerror`` attribute that
 dictates how a build should proceed after the failure of a step. Allowable
 values are:
-  ``fail``: failure of a step causes the build to terminate. (default)
-  ``continue``: builds continue after step failures. Failing steps
-                contribute to the overall build status.
-  ``ignore``: builds continue after step failures. Builds are marked
-              as successful even in the presence of failed steps with
-	      onerror='ignore'
+
+- ``fail``: failure of a step causes the build to terminate. (default)
+
+- ``continue``: builds continue after step failures. Failing steps
+  contribute to the overall build status.
+
+- ``ignore``: builds continue after step failures. Builds are marked
+  as successful even in the presence of failed steps with
+  onerror='ignore'
 
 ``<step>`` elements can override the ``<build>`` ``onerror`` attribute with
 their own ``onerror`` attributes.