Barry Warsaw avatar Barry Warsaw committed 5e51835

Resolve bug 7847 by including documentation for -J, -U, and -X under "Options
you shouldn't use".

Comments (0)

Files changed (2)

Doc/using/cmdline.rst

    See also :envvar:`PYTHONUNBUFFERED`.
 
 
-.. XXX should the -U option be documented?
-
 .. cmdoption:: -v
 
    Print a message each time a module is initialized, showing the place
 
    .. note:: The line numbers in error messages will be off by one.
 
-.. XXX document -X?
-
-
 .. cmdoption:: -3
 
    Warn about Python 3.x incompatibilities which cannot be fixed trivially by
 
    .. 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:
 
   library would return a bogus result; on Solaris, it was possible to crash
   the interpreter.  Patch by Stefan Krah.
 
-- Issue #7853: Normalize exceptions before they are passed to a context managers
-  __exit__ method.
+- Issue #7853: Normalize exceptions before they are passed to a context
+  managers __exit__ method.
 
 - Issue #7385: Fix a crash in `MemoryView_FromObject` when
   `PyObject_GetBuffer` fails.  Patch by Florent Xicluna.
 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
   PYTHONDONTWRITEBYTECODE, PYTHONNOUSERSITE).
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.