Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gh-115988: Add missing ARM64 and RISCV filter in lzma module #115989

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

gh-115988: Add missing ARM64 and RISCV filter in lzma module #115989

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
68979bc
Add missing ARM64 and RISCV filter in lzma module
ivq Feb 27, 2024
3fa0c17
Suppress doc warning "py:const reference target not found"
ivq Feb 28, 2024
c1e166a
Add lzma version
ivq Mar 17, 2024
ea51476
Add ARM64, RISC-V filter test case
ivq Mar 17, 2024
6189ceb
Update lzma doc
ivq Mar 17, 2024
0f6fd63
Add NEWS entry
ivq Mar 17, 2024
9731225
Optimise NEWS
ivq Mar 18, 2024
40e9d34
Move version doc section
ivq Mar 19, 2024
8c922f7
Add WHATSNEW entry
ivq Mar 19, 2024
9cd4cb8
Fix filter chain specs position
ivq Mar 19, 2024
8a85c48
Suppress doc warning
ivq Mar 22, 2024
32725a7
Elide upstream binary data from the test.
gpshead Mar 30, 2024
6d94a08
Clarify the documentation a bit.
gpshead Mar 30, 2024
c62ca63
Clarifying comment, docs accuracy.
gpshead Mar 30, 2024
045aa40
Expose the version as a number.
gpshead Mar 30, 2024
8f49f69
Merge branch 'main' into xz_bcj_filters
gpshead Mar 30, 2024
832335d
minor version explanation tweak.
gpshead Mar 30, 2024
728f286
Adjust the whats new text.
gpshead Mar 30, 2024
61c4adf
NEWS wording and formatting tweak.
gpshead Mar 30, 2024
98adeee
line length
gpshead Mar 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
43 changes: 37 additions & 6 deletions Doc/library/lzma.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,12 +343,23 @@ options. Valid filter IDs are as follows:

* Branch-Call-Jump (BCJ) filters:

* :const:`FILTER_X86`
* :const:`FILTER_IA64`
* :const:`FILTER_ARM`
* :const:`FILTER_ARMTHUMB`
* :const:`FILTER_POWERPC`
* :const:`FILTER_SPARC`
* :const:`!FILTER_X86`
* :const:`!FILTER_IA64`
* :const:`!FILTER_ARM`
* :const:`!FILTER_ARMTHUMB`
* :const:`!FILTER_POWERPC`
* :const:`!FILTER_SPARC`
* :const:`!FILTER_ARM64`

Only works if lzma runtime library version is 5.4.0 or later.

.. versionadded:: 3.13

* :const:`!FILTER_RISCV`

Only works if lzma runtime library version is 5.6.0 or later.

.. versionadded:: 3.13

A filter chain can consist of up to 4 filters, and cannot be empty. The last
filter in the chain must be a compression filter, and any other filters must be
Expand Down Expand Up @@ -385,6 +396,26 @@ These filters support one option, ``start_offset``. This specifies the address
that should be mapped to the beginning of the input data. The default is 0.


Information about the version of the lzma library in use is available through
gpshead marked this conversation as resolved.
Show resolved Hide resolved
the following constants:


.. data:: LZMA_VERSION

The version string of the lzma library that was used for building the module.
This may be different from the lzma library actually used at runtime, which
is available as :const:`LZMA_RUNTIME_VERSION`.

.. versionadded:: 3.13


.. data:: LZMA_RUNTIME_VERSION

The version string of the lzma library actually loaded by the interpreter.

.. versionadded:: 3.13


Examples
--------

Expand Down
1 change: 1 addition & 0 deletions Lib/lzma.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"CHECK_ID_MAX", "CHECK_UNKNOWN",
"FILTER_LZMA1", "FILTER_LZMA2", "FILTER_DELTA", "FILTER_X86", "FILTER_IA64",
"FILTER_ARM", "FILTER_ARMTHUMB", "FILTER_POWERPC", "FILTER_SPARC",
"FILTER_ARM64", "FILTER_RISCV",
"FORMAT_AUTO", "FORMAT_XZ", "FORMAT_ALONE", "FORMAT_RAW",
"MF_HC3", "MF_HC4", "MF_BT2", "MF_BT3", "MF_BT4",
"MODE_FAST", "MODE_NORMAL", "PRESET_DEFAULT", "PRESET_EXTREME",
Expand Down