1
0
Fork 0
mirror of https://git.tukaani.org/xz.git synced 2024-04-04 12:36:23 +02:00

liblzma: Reword a comment in index.h.

This commit is contained in:
Jia Tan 2023-02-08 20:35:32 +08:00
parent b675394849
commit 421f2f2e16

View file

@ -307,13 +307,13 @@ typedef enum {
* \brief Calculate memory usage of lzma_index * \brief Calculate memory usage of lzma_index
* *
* On disk, the size of the Index field depends on both the number of Records * On disk, the size of the Index field depends on both the number of Records
* stored and how big values the Records store (due to variable-length integer * stored and the size of the Records (due to variable-length integer
* encoding). When the Index is kept in lzma_index structure, the memory usage * encoding). When the Index is kept in lzma_index structure, the memory usage
* depends only on the number of Records/Blocks stored in the Index(es), and * depends only on the number of Records/Blocks stored in the Index(es), and
* in case of concatenated lzma_indexes, the number of Streams. The size in * in case of concatenated lzma_indexes, the number of Streams. The size in
* RAM is almost always significantly bigger than in the encoded form on disk. * RAM is almost always significantly bigger than in the encoded form on disk.
* *
* This function calculates an approximate amount of memory needed hold * This function calculates an approximate amount of memory needed to hold
* the given number of Streams and Blocks in lzma_index structure. This * the given number of Streams and Blocks in lzma_index structure. This
* value may vary between CPU architectures and also between liblzma versions * value may vary between CPU architectures and also between liblzma versions
* if the internal implementation is modified. * if the internal implementation is modified.