summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrett Cannon <bcannon@gmail.com>2010-07-21 09:52:10 (GMT)
committerBrett Cannon <bcannon@gmail.com>2010-07-21 09:52:10 (GMT)
commit8c4fa1159173b3c8dc59f4cf1e73419eb2128961 (patch)
tree451c532ce0b7dd6c684e4cc4169ee2fc6b7ed4ba
parent13b43e70e2e3659a145b2ce27d424c66d3c1e92e (diff)
downloadcpython-8c4fa1159173b3c8dc59f4cf1e73419eb2128961.zip
cpython-8c4fa1159173b3c8dc59f4cf1e73419eb2128961.tar.gz
cpython-8c4fa1159173b3c8dc59f4cf1e73419eb2128961.tar.bz2
Backport r82456.
-rw-r--r--Doc/library/dis.rst16
-rw-r--r--Misc/NEWS5
2 files changed, 16 insertions, 5 deletions
diff --git a/Doc/library/dis.rst b/Doc/library/dis.rst
index 6871d7e..95edac9 100644
--- a/Doc/library/dis.rst
+++ b/Doc/library/dis.rst
@@ -6,11 +6,17 @@
: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 input is defined
-in the file :file:`Include/opcode.h` and used by the compiler and the
-interpreter.
+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`::
diff --git a/Misc/NEWS b/Misc/NEWS
index ec857ac..45f81c3 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -59,6 +59,11 @@ Tests
- Issue #8605: Skip test_gdb if Python is compiled with optimizations.
+Documentation
+-------------
+
+- Issue 7829: Document in dis that bytecode is an implementation detail.
+
What's New in Python 2.7?
=========================