diff options
| author | Nick Coghlan <ncoghlan@gmail.com> | 2013-03-07 13:14:44 (GMT) |
|---|---|---|
| committer | Nick Coghlan <ncoghlan@gmail.com> | 2013-03-07 13:14:44 (GMT) |
| commit | 7d82c8621bb72035b2e36388d616533dacfc2e43 (patch) | |
| tree | 2a2e8012534e21bdafeb4e8a369f0d1f25195a65 /Doc/c-api/apiabiversion.rst | |
| parent | 4f1974496a2c718dfd8f5f5f332d24856dbce4ea (diff) | |
| download | cpython-7d82c8621bb72035b2e36388d616533dacfc2e43.zip cpython-7d82c8621bb72035b2e36388d616533dacfc2e43.tar.gz cpython-7d82c8621bb72035b2e36388d616533dacfc2e43.tar.bz2 | |
Close #15465: Document C API version macros
Mostly moving the existing macro docs over from the standard
library docs to the C API docs where they belong.
Patch by Kushal Das.
Diffstat (limited to 'Doc/c-api/apiabiversion.rst')
| -rw-r--r-- | Doc/c-api/apiabiversion.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/Doc/c-api/apiabiversion.rst b/Doc/c-api/apiabiversion.rst new file mode 100644 index 0000000..f6d52df --- /dev/null +++ b/Doc/c-api/apiabiversion.rst @@ -0,0 +1,39 @@ +.. highlightlang:: c + +.. _apiabiversion: + +*********************** +API and ABI Versioning +*********************** + +``PY_VERSION_HEX`` is the Python version number encoded in a single integer. + +For example if the ``PY_VERSION_HEX`` is set to ``0x030401a2``, the underlying +version information can be found by treating it as a 32 bit number in +the following manner: + + +-------+-------------------------+------------------------------------------------+ + | Bytes | Bits (big endian order) | Meaning | + +=======+=========================+================================================+ + | ``1`` | ``1-8`` | ``PY_MAJOR_VERSION`` (the ``3`` in | + | | | ``3.4.1a2``) | + +-------+-------------------------+------------------------------------------------+ + | ``2`` | ``9-16`` | ``PY_MINOR_VERSION`` (the ``4`` in | + | | | ``3.4.1a2``) | + +-------+-------------------------+------------------------------------------------+ + | ``3`` | ``17-24`` | ``PY_MICRO_VERSION`` (the ``1`` in | + | | | ``3.4.1a2``) | + +-------+-------------------------+------------------------------------------------+ + | ``4`` | ``25-28`` | ``PY_RELEASE_LEVEL`` (``0xA`` for alpha, | + | | | ``0xB`` for beta, ``0xC`` for release | + | | | candidate and ``0xF`` for final), in this | + | | | case it is alpha. | + | +-------------------------+------------------------------------------------+ + | | ``29-32`` | ``PY_RELEASE_SERIAL`` (the ``2`` in | + | | | ``3.4.1a2``, zero for final releases) | + +-------+-------------------------+------------------------------------------------+ + +Thus ``3.4.1a2`` is hexversion ``0x030401a2``. + +All the given macros are defined in :source:`Include/patchlevel.h`. + |