Organize release notes and add highlights section.

Introduce TracebackFuture and use it where applicable.

This allows for better tracebacks when using Futures on Python 2.

When @return_future's callback is run with no args, don't pass an arg to client callback.

Allow the callback in @return_future to be run with no arguments.

Bump version to 2.4.post4

return_future and friends now pass the result, not the Future, to the callback.

Functions and decorators that take an optional callback and return
a future (return_future, gen.concurrent, and run_executor) no longer pass
the Future object to the callback.  This results in somewhat less flexible
error handling, but is more consistent with prevailing practice without
Futures.

Use autoescape in websocket chat demo.

Autoescaping is now the default, so remove the explicit setting in chatdemo.

Use distinct cookie names across all the demo apps.

Use autoescape in blog demo.

Remove embedded copy of markdown.py from blog demo.

Use autoescape in appengine blog demo.

Remove markdown support from app engine blog demo.

Modernize app engine demo: py27, non-CGI interface, get_template_namespace.

Upgrade requirement packages.

Upgrades are available for tox and virtualenv, but don't work for me
because of https://github.com/pypa/virtualenv/issues/366 (to be fixed
in virtualenv 1.9).

Release note updates

All functions that take an IOLoop default to current() instead of instance().

This means among other things that it's no longer necessary to pass
IOLoops explicitly in tests.

Add IOLoop.run_sync convenience method.

Test the IOLoop.current method and add it to TwistedIOLoop.

Make DummyFuture class private.

It's now only exposed and used when concurrent.futures is not available.

Fix twisted version check.

Merge pull request #686 from omribahumi/master

Flushing the buffer when calling IOStream.read_until_close()

Fix resolver test script.

Convert resolvers to @gen.coroutine.

This adds a requirement that there be a "current" IOLoop, which introduced
a few ripples.

Test twisted and cares resolvers in netutil_test.

Convert auth methods from return_future plus gen.engine to gen.coroutine.

Add @gen.coroutine and gen.Return for future-based (and py33-style) coroutines.

Python3 compatibility for test_streaming_callback_with_data_in_buffer

Added test_streaming_callback_with_data_in_buffer to iostream_test.py

Flushing the buffer when calling IOStream.read_until_close()

Ran into this when calling IOStream.read_until_close() after calling
IOStream.read_until("\r\n"), leaving data in the buffer.

Accumulated release note updates.

Simplify the Resolver interface.

Most callers do not need the full generality of getaddrinfo, and
most alternative resolver implementations cannot provide it.

Add a resolver test script for external queries that cannot be unittested.

Note an issue with CaresResolver (it cannot resolve www.dropbox.com when
family==AF_UNSPEC)

Add a c-ares-based resolver implementation.

Move HTTPServer's valid_ip function to netutil.

Add a test that runs TwistedIOLoop on top of TornadoReactor.

This exposed a few more small bugs.

Add TwistedResolver for non-threaded async DNS resolution.

If a @return_future function raises immediately, don't run the callback.

stack_context.wrap() the callback passed in to a @return_future function.

Move fallback exception raising in AsyncTestCase from run() to tearDown().

This allows the exception to be reported as a test failure instead of
making the test run blow up.

Add a test case for the synchronous HTTPClient.

Clean up more timeouts when shutting down HTTP clients or finishing tests.

Merge pull request #684 from vkosh/master

Remove timeout callback on errors during connect or request.

Remove timeout callback on errors during connect or request.

Test the @return_future return value assertion and move it again.

Exceptions in a @return_future function go to both the caller and the Future.

Add a test for the UnboundLocal error seen here and remove the
no-longer-needed initialization.  I'm not 100% sure we want to do both
(due to the risk of callback-doubling), but the old way where the caller
saw one error and the future resolved to a different error was clearly
incorrect, and leaving the future unresolved doesn't seem right either.

Merge pull request #683 from vkosh/master

Unshadow list built-in in httputil.HTTPHeaders.get_all()

Fix docstrings quoting.

Rename local var so it doesn't shadow the "list" built-in.

Add pypi classifiers so we'll show up on python3-compatible lists.

Ensure the result variable is initialized even when an exception is handled.

Make Resolver's callback argument optional when the Future result is used.

Make Resolver Configurable and test with a threaded resolver.

Add a future-based interface to AsyncHTTPClient.fetch.

simple_httpclient._HTTPConnection now takes a resolver directly.

This makes the "client" parameter optional for websocket connections.

Make simple_httpclient's hostname_mapping a Resolver wrapper.

Add a test for simple_httpclient's hostname_mapping.

Centralize some shared logic bewteen HTTPClient implementations.

Use the future interface internally for _oauth_get_user.

Added a new method _oauth_get_user_future because the old method was
de facto public for third-party auth plugins.

Add future interface to most of the rest of the auth module.

_oauth_get_user still uses callbacks internally, and I haven't
changed the old deprecated FacebookMixin.

Add a Future-based interface to tornado.auth's twitter_request.

This allows new clients to receive exception messages from failed
requests, without breaking compatibility with existing callback-based
clients.

Factor argument replacement logic out of @return_future

Add autobahn tests for client side of websockets.

Add a simple websocket client and unittest

Add a test for subprocess with stderr as a separate stream

Merge pull request #682 from martynsmith/patch-1

Fix typo in stream setup for stderr

Use xrange instead of range on python 2.

Closes #681.

Fix typo in stream setup for stderr

s/xrange/range/ for python 3.

Closes #681.

Add an assertion for inconsistent StackContexts when used with generators.

Add a tox config for testing with the pyuv-based IOLoop.

Document and test the ability to call remove_timeout after it has fired.

Fix a straggling reference to netutil.TCPServer in comments.

Prevent __future__ imports in tornado from leaking into user code.

This could happen with the command-line mode of autoreload or
in templates.

Remove epoll.c from MANIFEST.in

Bump version number to 2.4.post3

Fix quadratic performance in gen.engine when yielding a large list.

Make LogTrapTestCase fail more gracefully in unknown logging configurations.

This allows LogTrapTestCases to be run under nose, which does its own
log buffering.

Closes #674

Add a workaround for a bug in the latest version of libcurl

Escape non-ascii bytes in tracebacks line-by-line instead of all at once.

Previously if there were any bytes that needed escaping, the newlines
would get escaped as well, ruining the message formatting.

Closes #675 (again)

Clarify docstring of IOLoop.stop.

The mention of "after the current iteration" was meant to emphasize that the
stop was not instantaneous, but it could have also been read as a guarantee
that one more poll call would take place.

Closes #672.

Merge commit 'e3f8aa' from heynemann/master

Closes #677

Handle non-ascii data in logged exceptions like in the main message.

Closes #675

Pre-compiling regex that removes control characters.

Given that this regex might be used a lot in the lifetime of a given server (each request that uses get_argument for unicode strings) it seems sensible to store the compiled version of the regex.

Switch one last test from get_unused_port to bind_unused_port.

Closes #676.

Update pyflakes version.

The new version no longer complains about all our conditional imports.

Add a test for non-login use of twitter_request.

Add a script for setting up a windows VM for testing.

This works with the images provided by http://modern.ie.

Protect the tornado.gen import in testing.py for app engine.

Support lists of futures in @gen.engine.

Add decorator for @gen.engine-like tests.

Futures are awkward to use in stop/wait tests, and this makes it possible
to be consistent between tests and regular code.

Uses the (now-renamed) deactivate_stack_context callback
to detect when a test finishes cleanly.

Rename future_wrap to return_future.

Allow exceptions from the initial synchronous phase to pass through
to the caller.  Add docs and tests.

A couple of small 2.6-isms.

We can use namedtuple and the new 0o octal literal notation.

Centralize formatting of HTTP-style dates.

Use time.strftime, which turns out to be a bit faster than either
datetime.strftime or email.utils.formatdate.

Fix typo in next.rst.

Use httputil.HTTPHeaders for outgoing headers in RequestHandler.

It's still a bit slower, but less than the 10% noted in the old comment.
Case sensitivity here has proven more surprising and problematic than
expected as users try to overwrite headers set by the framework.

Note a performance improvement on PyPy in the release notes.

sys.exc_info() is very slow on pypy.  Commit
24c3d41748728cf4f3ea1509044b4abc7cea666e removed an unconditional
call to sys.exc_info when there is no error.  Performance on
demo/benchmark/benchmark.py went from 3k qps to 5k.

Split up next.rst by module.

Get the test suite passing on windows again.

Get twisted_test running on python 3 too.

Twisted 12.3.0 can be installed from a source checkout on python3.
Some modules, including twisted.web, are not available so skip those
tests separately.