Skip to content

Commit bee8b47

Browse files
Fix Sphinx reference warnings in Doc/library/lzma.rst
Change :const: to :data: for module-level constants like FORMAT_XZ, CHECK_CRC32, etc. The :const: role doesn't resolve for these in modern Sphinx. Closes #151949
1 parent ad38cf8 commit bee8b47

1 file changed

Lines changed: 33 additions & 33 deletions

File tree

Doc/library/lzma.rst

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -154,33 +154,33 @@ Compressing and decompressing data in memory
154154
The *format* argument specifies what container format should be used.
155155
Possible values are:
156156

157-
* :const:`FORMAT_XZ`: The ``.xz`` container format.
157+
* :data:`FORMAT_XZ`: The ``.xz`` container format.
158158
This is the default format.
159159

160-
* :const:`FORMAT_ALONE`: The legacy ``.lzma`` container format.
160+
* :data:`FORMAT_ALONE`: The legacy ``.lzma`` container format.
161161
This format is more limited than ``.xz`` -- it does not support integrity
162162
checks or multiple filters.
163163

164-
* :const:`FORMAT_RAW`: A raw data stream, not using any container format.
164+
* :data:`FORMAT_RAW`: A raw data stream, not using any container format.
165165
This format specifier does not support integrity checks, and requires that
166166
you always specify a custom filter chain (for both compression and
167167
decompression). Additionally, data compressed in this manner cannot be
168-
decompressed using :const:`FORMAT_AUTO` (see :class:`LZMADecompressor`).
168+
decompressed using :data:`FORMAT_AUTO` (see :class:`LZMADecompressor`).
169169

170170
The *check* argument specifies the type of integrity check to include in the
171171
compressed data. This check is used when decompressing, to ensure that the
172172
data has not been corrupted. Possible values are:
173173

174-
* :const:`CHECK_NONE`: No integrity check.
174+
* :data:`CHECK_NONE`: No integrity check.
175175
This is the default (and the only acceptable value) for
176-
:const:`FORMAT_ALONE` and :const:`FORMAT_RAW`.
176+
:data:`FORMAT_ALONE` and :data:`FORMAT_RAW`.
177177

178-
* :const:`CHECK_CRC32`: 32-bit Cyclic Redundancy Check.
178+
* :data:`CHECK_CRC32`: 32-bit Cyclic Redundancy Check.
179179

180-
* :const:`CHECK_CRC64`: 64-bit Cyclic Redundancy Check.
181-
This is the default for :const:`FORMAT_XZ`.
180+
* :data:`CHECK_CRC64`: 64-bit Cyclic Redundancy Check.
181+
This is the default for :data:`FORMAT_XZ`.
182182

183-
* :const:`CHECK_SHA256`: 256-bit Secure Hash Algorithm.
183+
* :data:`CHECK_SHA256`: 256-bit Secure Hash Algorithm.
184184

185185
If the specified check is not supported, an :class:`LZMAError` is raised.
186186

@@ -190,8 +190,8 @@ Compressing and decompressing data in memory
190190

191191
The *preset* argument (if provided) should be an integer between ``0`` and
192192
``9`` (inclusive), optionally OR-ed with the constant
193-
:const:`PRESET_EXTREME`. If neither *preset* nor *filters* are given, the
194-
default behavior is to use :const:`PRESET_DEFAULT` (preset level ``6``).
193+
:data:`PRESET_EXTREME`. If neither *preset* nor *filters* are given, the
194+
default behavior is to use :data:`PRESET_DEFAULT` (preset level ``6``).
195195
Higher presets produce smaller output, but make the compression process
196196
slower.
197197

@@ -231,9 +231,9 @@ Compressing and decompressing data in memory
231231
once, see :func:`decompress`.
232232

233233
The *format* argument specifies the container format that should be used. The
234-
default is :const:`FORMAT_AUTO`, which can decompress both ``.xz`` and
235-
``.lzma`` files. Other possible values are :const:`FORMAT_XZ`,
236-
:const:`FORMAT_ALONE`, and :const:`FORMAT_RAW`.
234+
default is :data:`FORMAT_AUTO`, which can decompress both ``.xz`` and
235+
``.lzma`` files. Other possible values are :data:`FORMAT_XZ`,
236+
:data:`FORMAT_ALONE`, and :data:`FORMAT_RAW`.
237237

238238
The *memlimit* argument specifies a limit (in bytes) on the amount of memory
239239
that the decompressor can use. When this argument is used, decompression will
@@ -242,7 +242,7 @@ Compressing and decompressing data in memory
242242

243243
The *filters* argument specifies the filter chain that was used to create
244244
the stream being decompressed. This argument is required if *format* is
245-
:const:`FORMAT_RAW`, but should not be used for other formats.
245+
:data:`FORMAT_RAW`, but should not be used for other formats.
246246
See :ref:`filter-chain-specs` for more information about filter chains.
247247

248248
.. note::
@@ -281,7 +281,7 @@ Compressing and decompressing data in memory
281281
.. attribute:: check
282282

283283
The ID of the integrity check used by the input stream. This may be
284-
:const:`CHECK_UNKNOWN` until enough of the input has been decoded to
284+
:data:`CHECK_UNKNOWN` until enough of the input has been decoded to
285285
determine what integrity check it uses.
286286

287287
.. attribute:: eof
@@ -329,8 +329,8 @@ Miscellaneous
329329

330330
Return ``True`` if the given integrity check is supported on this system.
331331

332-
:const:`CHECK_NONE` and :const:`CHECK_CRC32` are always supported.
333-
:const:`CHECK_CRC64` and :const:`CHECK_SHA256` may be unavailable if you are
332+
:data:`CHECK_NONE` and :data:`CHECK_CRC32` are always supported.
333+
:data:`CHECK_CRC64` and :data:`CHECK_SHA256` may be unavailable if you are
334334
using a version of :program:`liblzma` that was compiled with a limited
335335
feature set.
336336

@@ -347,31 +347,31 @@ options. Valid filter IDs are as follows:
347347

348348
* Compression filters:
349349

350-
* :const:`FILTER_LZMA1` (for use with :const:`FORMAT_ALONE`)
351-
* :const:`FILTER_LZMA2` (for use with :const:`FORMAT_XZ` and :const:`FORMAT_RAW`)
350+
* :data:`FILTER_LZMA1` (for use with :data:`FORMAT_ALONE`)
351+
* :data:`FILTER_LZMA2` (for use with :data:`FORMAT_XZ` and :data:`FORMAT_RAW`)
352352

353353
* Delta filter:
354354

355-
* :const:`FILTER_DELTA`
355+
* :data:`FILTER_DELTA`
356356

357357
* Branch-Call-Jump (BCJ) filters:
358358

359-
* :const:`!FILTER_X86`
360-
* :const:`!FILTER_IA64`
361-
* :const:`!FILTER_ARM`
362-
* :const:`!FILTER_ARMTHUMB`
363-
* :const:`!FILTER_POWERPC`
364-
* :const:`!FILTER_SPARC`
359+
* :data:`!FILTER_X86`
360+
* :data:`!FILTER_IA64`
361+
* :data:`!FILTER_ARM`
362+
* :data:`!FILTER_ARMTHUMB`
363+
* :data:`!FILTER_POWERPC`
364+
* :data:`!FILTER_SPARC`
365365

366366
The above work on all lzma runtime library versions.
367367

368-
* :const:`!FILTER_ARM64`
368+
* :data:`!FILTER_ARM64`
369369

370370
Only works if the lzma version is 5.4.0 or later.
371371

372372
.. versionadded:: next
373373

374-
* :const:`!FILTER_RISCV`
374+
* :data:`!FILTER_RISCV`
375375

376376
Only works if the lzma version is 5.6.0 or later.
377377

@@ -392,11 +392,11 @@ entries in the dictionary representing the filter):
392392
* ``lp``: Number of literal position bits. The sum ``lc + lp`` must be at
393393
most 4.
394394
* ``pb``: Number of position bits; must be at most 4.
395-
* ``mode``: :const:`MODE_FAST` or :const:`MODE_NORMAL`.
395+
* ``mode``: :data:`MODE_FAST` or :data:`MODE_NORMAL`.
396396
* ``nice_len``: What should be considered a "nice length" for a match.
397397
This should be 273 or less.
398-
* ``mf``: What match finder to use -- :const:`MF_HC3`, :const:`MF_HC4`,
399-
:const:`MF_BT2`, :const:`MF_BT3`, or :const:`MF_BT4`.
398+
* ``mf``: What match finder to use -- :data:`MF_HC3`, :data:`MF_HC4`,
399+
:data:`MF_BT2`, :data:`MF_BT3`, or :data:`MF_BT4`.
400400
* ``depth``: Maximum search depth used by match finder. 0 (default) means to
401401
select automatically based on other filter options.
402402

0 commit comments

Comments
 (0)