docutils.__version_details__ renamed from .__version_suffix__

git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3417 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

6 files changed, 24 insertions, 10 deletions

diff --git a/docutils/HISTORY.txt b/docutils/HISTORY.txt
index 3e6282d19..1fe8b1092 100644
--- a/docutils/HISTORY.txt
+++ b/docutils/HISTORY.txt
@@ -14,6 +14,11 @@
 Changes Since 0.3.9
 ===================
 
+* docutils/__init__.py:
+
+  - Added ``__version_details__`` attribute to describe code source
+    (repository/snapshot/release).
+
 * docutils/parsers/rst/__init__.py:
 
   - Added validator to tab_width setting, with test.  Closes SF bug
diff --git a/docutils/docs/dev/release.txt b/docutils/docs/dev/release.txt
index fd941e5d3..b242720d0 100644
--- a/docutils/docs/dev/release.txt
+++ b/docutils/docs/dev/release.txt
@@ -24,6 +24,9 @@ updated to reflect the recent move to Subversion!)
   (e.g. CHANGES.txt) to have it at hand when you need it for posting
   announcements or pasting it into forms.**
 
+* Change ``__version_details__`` in docutils/docutils/__init__.py to
+  "release" (from "repository").
+
 * Bump the _`version number` in the following files:
 
   + docutils/setup.py
@@ -126,6 +129,9 @@ updated to reflect the recent move to Subversion!)
 
 * Register with PyPI (``python setup.py register``).
 
+* Restore ``__version_details__`` in docutils/docutils/__init__.py to
+  "repository" (from "release").
+
 * Bump the `version number`_ again.
 
 * Add a new empty section "Changes Since ..." in HISTORY.txt.
diff --git a/docutils/docutils/__init__.py b/docutils/docutils/__init__.py
index fbac8caad..eeb54a413 100644
--- a/docutils/docutils/__init__.py
+++ b/docutils/docutils/__init__.py
@@ -13,7 +13,7 @@ Package Structure
 Modules:
 
 - __init__.py: Contains component base classes, exception classes, and
-  Docutils `__version__`.
+  Docutils version information.
 
 - core.py: Contains the ``Publisher`` class and ``publish_*()`` convenience
   functions.
@@ -58,8 +58,9 @@ number is bumped whenever there is a significant project release.  The major
 number will be bumped when the project is feature-complete, and perhaps if
 there is a major change in the design."""
 
-__version_suffix__ = ''
-"""Version suffix for snapshots (e.g. ', 2005-05-29, r3410')."""
+__version_details__ = 'repository'
+"""Extra version details (e.g. 'snapshot 2005-05-29, r3410' or 'release'),
+modified automatically."""
 
 class ApplicationError(StandardError): pass
 class DataError(ApplicationError): pass
diff --git a/docutils/docutils/core.py b/docutils/docutils/core.py
index f31c3011a..302c39eb2 100644
--- a/docutils/docutils/core.py
+++ b/docutils/docutils/core.py
@@ -18,7 +18,7 @@ __docformat__ = 'reStructuredText'
 
 import sys
 import pprint
-from docutils import __version__, SettingsSpec
+from docutils import __version__, __version_details__, SettingsSpec
 from docutils import frontend, io, utils, readers, writers
 from docutils.frontend import OptionParser
 
@@ -237,9 +237,10 @@ class Publisher:
             print >>sys.stderr, ("""\
 Exiting due to error.  Use "--traceback" to diagnose.
 Please report errors to <docutils-users@lists.sf.net>.
-Include "--traceback" output, Docutils version (%s),
+Include "--traceback" output, Docutils version (%s [%s]),
 Python version (%s), your OS type & version, and the
-command line used.""" % (__version__, sys.version.split()[0]))
+command line used.""" % (__version__, __version_details__,
+                         sys.version.split()[0]))
 
     def report_SystemMessage(self, error):
         print >>sys.stderr, ('Exiting due to level-%s (%s) system message.'
diff --git a/docutils/docutils/frontend.py b/docutils/docutils/frontend.py
index 39ca62b85..8a85133e7 100644
--- a/docutils/docutils/frontend.py
+++ b/docutils/docutils/frontend.py
@@ -462,8 +462,8 @@ class OptionParser(optparse.OptionParser, docutils.SettingsSpec):
 
     config_section = 'general'
 
-    version_template = ('%%prog (Docutils %s%s)'
-                        % (docutils.__version__, docutils.__version_suffix__))
+    version_template = ('%%prog (Docutils %s [%s])'
+                        % (docutils.__version__, docutils.__version_details__))
     """Default version message."""
 
     def __init__(self, components=(), defaults=None, read_config_files=None,
diff --git a/docutils/test/alltests.py b/docutils/test/alltests.py
index 4092d38a6..03c85e4ce 100755
--- a/docutils/test/alltests.py
+++ b/docutils/test/alltests.py
@@ -74,8 +74,9 @@ sys.stdout = sys.stderr = Tee('alltests.out')
 
 import package_unittest
 
-print ('Testing Docutils %s with Python %s on %s at %s'
-       % (docutils.__version__, sys.version.split()[0],
+print ('Testing Docutils %s %s with Python %s on %s at %s'
+       % (docutils.__version__, docutils.__version_details__,
+          sys.version.split()[0],
           time.strftime('%Y-%m-%d'), time.strftime('%H:%M:%S')))
 sys.stdout.flush()