Resolve bug 7847 by including documentation for -J, -U, and -X under "Options

you shouldn't use".
This commit is contained in:
Barry Warsaw 2010-02-05 18:45:25 +00:00
parent bb445a1f22
commit b1e66ee651
2 changed files with 28 additions and 7 deletions

View File

@ -285,8 +285,6 @@ Miscellaneous options
See also :envvar:`PYTHONUNBUFFERED`. See also :envvar:`PYTHONUNBUFFERED`.
.. XXX should the -U option be documented?
.. cmdoption:: -v .. cmdoption:: -v
Print a message each time a module is initialized, showing the place Print a message each time a module is initialized, showing the place
@ -362,9 +360,6 @@ Miscellaneous options
.. note:: The line numbers in error messages will be off by one. .. note:: The line numbers in error messages will be off by one.
.. XXX document -X?
.. cmdoption:: -3 .. cmdoption:: -3
Warn about Python 3.x incompatibilities which cannot be fixed trivially by Warn about Python 3.x incompatibilities which cannot be fixed trivially by
@ -382,7 +377,30 @@ Miscellaneous options
.. versionadded:: 2.6 .. versionadded:: 2.6
Options you shouldn't use
~~~~~~~~~~~~~~~~~~~~~~~~~
.. cmdoption:: -J
Reserved for use by Jython_.
.. _Jython: http://jython.org
.. cmdoption:: -U
Turns all string literals into unicodes globally. Do not be tempted to use
this option as it will probably break your world. It also produces
``.pyc`` files with a different magic number than normal. Instead, you can
enable unicode literals on a per-module basis by using::
from __future__ import unicode_literals
at the top of the file. See :mod:`__future__` for details.
.. cmdoption:: -X
Reserved for alternative implementations of Python to use for their own
purposes.
.. _using-on-envvars: .. _using-on-envvars:

View File

@ -17,8 +17,8 @@ Core and Builtins
library would return a bogus result; on Solaris, it was possible to crash library would return a bogus result; on Solaris, it was possible to crash
the interpreter. Patch by Stefan Krah. the interpreter. Patch by Stefan Krah.
- Issue #7853: Normalize exceptions before they are passed to a context managers - Issue #7853: Normalize exceptions before they are passed to a context
__exit__ method. managers __exit__ method.
- Issue #7385: Fix a crash in `MemoryView_FromObject` when - Issue #7385: Fix a crash in `MemoryView_FromObject` when
`PyObject_GetBuffer` fails. Patch by Florent Xicluna. `PyObject_GetBuffer` fails. Patch by Florent Xicluna.
@ -153,6 +153,9 @@ Tools/Demos
Documentation Documentation
------------- -------------
- Updating `Using Python` documentation to include description of CPython's
-J, -U and -X options.
- Update python manual page (options -B, -O0, -s, environment variables - Update python manual page (options -B, -O0, -s, environment variables
PYTHONDONTWRITEBYTECODE, PYTHONNOUSERSITE). PYTHONDONTWRITEBYTECODE, PYTHONNOUSERSITE).