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

index 6871d7e9fc2412da79bacfe507e73b71a64d64fe..95edac9b8fe9006ecb0e1d844ef35645d3163ff2 100644 (file)
@@ -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`::
 
index ec857acde19045bfae030bc0064764a821d71a4a..45f81c39ca761ed70c7119c2df54e6a67605200b 100644 (file)
--- 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?
 =========================