From cc85e7a96ccbb1671514adb1a1b1992fd1f02461 Mon Sep 17 00:00:00 2001
From: Chris McDonough <chrism@plope.com>
Date: Thu, 23 Jun 2011 01:39:45 +0200
Subject: [PATCH] prep for 1.1a2

---
 docs/conf.py          |    2 +-
 setup.py              |    2 +-
 CHANGES.txt           |   10 +++++-----
 RELEASING.txt         |    2 +-
 docs/whatsnew-1.1.rst |   26 ++++++++++++++++++++++++++
 5 files changed, 34 insertions(+), 8 deletions(-)

diff --git a/CHANGES.txt b/CHANGES.txt
index 6522297..0bb15c3 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -1,12 +1,12 @@
-Next release
-============
+1.1a2 (2011-06-22)
+==================
 
 Bug Fixes
 ---------
 
 - 1.1a1 broke Akhet by not providing a backwards compatibility import shim
   for ``pyramid.paster.PyramidTemplate``.  Now one has been added, although a
-  deprecation warning is raised.
+  deprecation warning is emitted when Akhet imports it.
 
 - If multiple specs were provided in a single call to
   ``config.add_translation_dirs``, the directories were inserted into the
@@ -20,8 +20,8 @@
 
 - The pyramid Router attempted to set a value into the key
   ``environ['repoze.bfg.message']`` when it caught a view-related exception
-  for backwards compatibility with :mod:`repoze.bfg` during error handling.
-  It did this by using code that looked like so::
+  for backwards compatibility with applications written for ``repoze.bfg``
+  during error handling.  It did this by using code that looked like so::
 
                     # "why" is an exception object
                     try: 
diff --git a/RELEASING.txt b/RELEASING.txt
index 115edec..645083a 100644
--- a/RELEASING.txt
+++ b/RELEASING.txt
@@ -13,7 +13,7 @@
   communicate with contributors).
 
 - Copy relevant changes (delta bug fixes) from CHANGES.txt to
-  docs/whatsnew-X.X.
+  docs/whatsnew-X.X (if it's a major release).
 
 - Make sure docs render OK::
 
diff --git a/docs/conf.py b/docs/conf.py
index 65cd35b..3426219 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -93,7 +93,7 @@
 # other places throughout the built documents.
 #
 # The short X.Y version.
-version = '1.1a1'
+version = '1.1a2'
 # The full version, including alpha/beta/rc tags.
 release = version
 
diff --git a/docs/whatsnew-1.1.rst b/docs/whatsnew-1.1.rst
index faf8b8b..1803806 100644
--- a/docs/whatsnew-1.1.rst
+++ b/docs/whatsnew-1.1.rst
@@ -199,6 +199,32 @@
   pyramid.httpexceptions.HTTPFound(location='http//foo')`` (the latter will
   of course continue to work).
 
+- The pyramid Router attempted to set a value into the key
+  ``environ['repoze.bfg.message']`` when it caught a view-related exception
+  for backwards compatibility with applications written for :mod:`repoze.bfg`
+  during error handling.  It did this by using code that looked like so::
+
+                    # "why" is an exception object
+                    try: 
+                        msg = why[0]
+                    except:
+                        msg = ''
+
+                    environ['repoze.bfg.message'] = msg
+
+  Use of the value ``environ['repoze.bfg.message']`` was docs-deprecated in
+  Pyramid 1.0.  Our standing policy is to not remove features after a
+  deprecation for two full major releases, so this code was originally slated
+  to be removed in Pyramid 1.2.  However, computing the
+  ``repoze.bfg.message`` value was the source of at least one bug found in
+  the wild (https://github.com/Pylons/pyramid/issues/199), and there isn't a
+  foolproof way to both preserve backwards compatibility and to fix the bug.
+  Therefore, the code which sets the value has been removed in this release.
+  Code in exception views which relies on this value's presence in the
+  environment should now use the ``exception`` attribute of the request
+  (e.g. ``request.exception[0]``) to retrieve the message instead of relying
+  on ``request.environ['repoze.bfg.message']``.
+
 Deprecations and Behavior Differences
 -------------------------------------
 
diff --git a/setup.py b/setup.py
index f77ae93..5c3232f 100644
--- a/setup.py
+++ b/setup.py
@@ -53,7 +53,7 @@
     install_requires.append('simplejson')
     
 setup(name='pyramid',
-      version='1.1a1',
+      version='1.1a2',
       description=('The Pyramid web application development framework, a '
                    'Pylons project'),
       long_description=README + '\n\n' +  CHANGES,

--
Gitblit v1.9.3