Start getting docs ready for 3.5b1

4 files changed, 93 insertions, 7 deletions

diff --git a/CHANGES.txt b/CHANGES.txt
index a4ce47c..7dfad51 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -3,8 +3,8 @@ Change history for Coverage.py
 ------------------------------
 
 
-Version 3.5
------------
+Version 3.5b1
+-------------
 
 - The HTML report now has hotkeys.  Try ``n``, ``s``, ``m``, ``x``, ``b``,
   ``p``, and ``c`` on the overview page to change the column sorting.
@@ -19,6 +19,13 @@ Version 3.5
   If it does not, it is interpreted relative to the current directory.
   Closes `issue 121`_.
 
+- Partial branch warnings can now be pragma'd away.  The configuration option
+  ``partial_branches`` is a list of regular expressions.  Lines matching any of
+  those expressions will never be marked as a partial branch.  In addition,
+  there's a built-in list of regular expressions marking statements which should
+  never be marked as partial.  This list includes ``while True:``, ``while 1:``,
+  ``if 1:``, and ``if 0:``.
+
 - The ``coverage()`` constructor accepts single strings for the ``omit=`` and
   ``include=`` arguments, adapting to a common error in programmatic use.
 
@@ -72,6 +79,7 @@ Version 3.5
 .. _issue 123: https://bitbucket.org/ned/coveragepy/issue/123/pyeval_settrace-used-in-way-that-breaks
 .. _issue 125: https://bitbucket.org/ned/coveragepy/issue/125/coverage-removes-decoratortoolss-tracing
 
+
 Version 3.4 --- 19 September 2010
 ---------------------------------
 
diff --git a/TODO.txt b/TODO.txt
index 6673328..78f0608 100644
--- a/TODO.txt
+++ b/TODO.txt
@@ -5,13 +5,22 @@ Coverage TODO
     + warn if no data was collected
     - tie --source into reporting
 
+* 3.5b1
+
+- Update changes.rst
+- Document partial branch exclusion
+- Document HTML reporting
+    - Keyboard shortcuts
+    - Delta reporting
+
+
 * Soon
 
 + Better omit handling that ignores files during measurement.
     - Deal with ~ in specified paths correctly.
-- while TRUE claims to be partial.
-    - A way to mark lines as partial branches, with a regex?
-        - Default to "while True:", "while 1:"
++ while TRUE claims to be partial.
+    + A way to mark lines as partial branches, with a regex?
+        + Default to "while True:", "while 1:"
 + HTML keyboard short cuts
 
 
diff --git a/doc/changes.rst b/doc/changes.rst
index 363b575..e98822e 100644
--- a/doc/changes.rst
+++ b/doc/changes.rst
@@ -23,6 +23,75 @@ history, see the `CHANGES.txt`_ file in the source tree.
 .. _CHANGES.txt: http://bitbucket.org/ned/coveragepy/src/tip/CHANGES.txt
 
 
+Version 3.5b1 --- ?? June 2011
+------------------------------
+
+HTML reporting:
+
+- The HTML report now has hotkeys.  Try ``n``, ``s``, ``m``, ``x``, ``b``,
+  ``p``, and ``c`` on the overview page to change the column sorting.
+  On a file page, ``r``, ``m``, ``x``, and ``p`` toggle the run, missing,
+  excluded, and partial line markings.  You can navigate the highlighted
+  sections of code by using the ``j`` and ``k`` keys for next and previous.
+  The ``1`` (one) key jumps to the first highlighted section in the file,
+  and ``0`` (zero) scrolls to the top of the file.
+
+- HTML reporting is now incremental: a record is kept of the data that
+  produced the HTML reports, and only files whose data has changed will
+  be generated.  This should make most HTML reporting faster.
+
+
+Running Python files
+
+- Modules can now be run directly using ``coverage run -m modulename``, to
+  mirror Python's ``-m`` flag.  Closes `issue 95`_, thanks, Brandon Rhodes.
+
+- ``coverage run`` didn't emulate Python accurately in one detail: the
+  current directory inserted into ``sys.path`` was relative rather than
+  absolute. This is now fixed.
+
+- Pathological code execution could disable the trace function behind our
+  backs, leading to incorrect code measurement.  Now if this happens,
+  coverage.py will issue a warning, at least alerting you to the problem.
+  Closes `issue 93`_.  Thanks to Marius Gedminas for the idea.
+
+- The C-based trace function now behaves properly when saved and restored
+  with ``sys.gettrace()`` and ``sys.settrace()``.  This fixes `issue 125`_
+  and `issue 123`_.  Thanks, Devin Jeanpierre.
+
+- Coverage.py can now be run directly from a working tree by specifying
+  the directory name to python:  ``python coverage_py_working_dir run ...``.
+  Thanks, Brett Cannon.
+
+- A little bit of Jython support: `coverage run` can now measure Jython
+  execution by adapting when $py.class files are traced. Thanks, Adi Roiban.
+
+
+Reporting
+
+- Partial branch warnings can now be pragma'd away.  The configuration option
+  ``partial_branches`` is a list of regular expressions.  Lines matching any of
+  those expressions will never be marked as a partial branch.  In addition,
+  there's a built-in list of regular expressions marking statements which should
+  never be marked as partial.  This list includes ``while True:``, ``while 1:``,
+  ``if 1:``, and ``if 0:``.
+
+- The ``--omit`` and ``--include`` switches now interpret their values more
+  usefully.  If the value starts with a wildcard character, it is used as-is.
+  If it does not, it is interpreted relative to the current directory.
+  Closes `issue 121`_.
+
+- Syntax errors in supposed Python files can now be ignored during reporting
+  with the ``-i`` switch just like other source errors.  Closes `issue 115`_.
+
+.. _issue 93: http://bitbucket.org/ned/coveragepy/issue/93/copying-a-mock-object-breaks-coverage
+.. _issue 95: https://bitbucket.org/ned/coveragepy/issue/95/run-subcommand-should-take-a-module-name
+.. _issue 115: https://bitbucket.org/ned/coveragepy/issue/115/fail-gracefully-when-reporting-on-file
+.. _issue 121: https://bitbucket.org/ned/coveragepy/issue/121/filename-patterns-are-applied-stupidly
+.. _issue 123: https://bitbucket.org/ned/coveragepy/issue/123/pyeval_settrace-used-in-way-that-breaks
+.. _issue 125: https://bitbucket.org/ned/coveragepy/issue/125/coverage-removes-decoratortoolss-tracing
+
+
 Version 3.4 --- 19 September 2010
 ---------------------------------
 
diff --git a/doc/config.rst b/doc/config.rst
index 1f4a82e..15d3874 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -31,8 +31,8 @@ A coverage.py configuration file is in classic .ini file format: sections are
 introduced by a ``[section]`` header, and contain ``name = value`` entries.
 Lines beginning with ``#`` or ``;`` are ignored as comments.
 
-Strings don't need quotes. Multi-strings can be created by indenting values on
-multiple lines.
+Strings don't need quotes. Multi-valued strings can be created by indenting
+values on multiple lines.
 
 Boolean values can be specified as ``on``, ``off``, ``true``, ``false``, ``1``,
 or ``0`` and are case-insensitive.