]> granicus.if.org Git - python/commitdiff
Backport r82456
authorBrett Cannon <bcannon@gmail.com>
Wed, 21 Jul 2010 09:50:42 +0000 (09:50 +0000)
committerBrett Cannon <bcannon@gmail.com>
Wed, 21 Jul 2010 09:50:42 +0000 (09:50 +0000)
Doc/library/dis.rst
Misc/NEWS

index a73e6b37d10c34299f2bd487255d77eaa666ecdf..e97743c17fa0c1b3fd8e37acc177563e07b41798 100644 (file)
@@ -5,12 +5,18 @@
    :synopsis: Disassembler for Python bytecode.
 
 
-The :mod:`dis` module supports the analysis of Python :term:`bytecode` by
-disassembling it.  Since there is no Python assembler, this module defines the
-Python assembly language.  The Python bytecode which this module takes as an
+The :mod:`dis` module supports the analysis of CPython :term:`bytecode` by
+disassembling it. The CPython bytecode which this module takes as an
 input is defined in the file :file:`Include/opcode.h` and used by the compiler
 and the interpreter.
 
+.. impl-detail::
+
+   Bytecode is an implementation detail of the CPython interpreter!  No
+   guarantees are made that bytecode will not be added, removed, or changed
+   between versions of Python.  Use of this module should not be considered to
+   work across Python VMs or Python releases.
+
 Example: Given the function :func:`myfunc`::
 
    def myfunc(alist):
index a2fa664751d828a32edbb696eb8fb4706eba4038..57998e371f0c1a62c29fe0b28a016177f15a9c37 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -363,6 +363,12 @@ Tests
 - Issue #8193: Fix test_zlib failure with zlib 1.2.4.
 
 
+Documentation
+-------------
+
+- Issue #7829: Document in dis that bytecode is an implementation detail.
+
+
 What's New in Python 3.1.2?
 ===========================