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

liblzma: Change quoting style from `...' to '...'.

Browse source 
This was done for both internal and API headers.
This commit is contained in:
Jia Tan 2023-09-24 22:09:47 +08:00
parent be012b8097
commit f6667702bf
7 changed files with 24 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/liblzma/api/lzma/base.h
View file

@ -21,8 +21,8 @@
* *
* This is here because C89 doesn't have stdbool.h. To set a value for * This is here because C89 doesn't have stdbool.h. To set a value for
* variables having type lzma_bool, you can use * variables having type lzma_bool, you can use
* - C99's `true' and `false' from stdbool.h; * - C99's 'true' and 'false' from stdbool.h;
* - C++'s internal `true' and `false'; or * - C++'s internal 'true' and 'false'; or
* - integers one (true) and zero (false). * - integers one (true) and zero (false).
*/ */
typedef unsigned char lzma_bool; typedef unsigned char lzma_bool;
@ -273,13 +273,13 @@ typedef enum {
/** /**
* \brief The `action' argument for lzma_code() * \brief The 'action' argument for lzma_code()
* *
* After the first use of LZMA_SYNC_FLUSH, LZMA_FULL_FLUSH, LZMA_FULL_BARRIER, * After the first use of LZMA_SYNC_FLUSH, LZMA_FULL_FLUSH, LZMA_FULL_BARRIER,
* or LZMA_FINISH, the same `action' must be used until lzma_code() returns * or LZMA_FINISH, the same 'action' must be used until lzma_code() returns
* LZMA_STREAM_END. Also, the amount of input (that is, strm->avail_in) must * LZMA_STREAM_END. Also, the amount of input (that is, strm->avail_in) must
* not be modified by the application until lzma_code() returns * not be modified by the application until lzma_code() returns
* LZMA_STREAM_END. Changing the `action' or modifying the amount of input * LZMA_STREAM_END. Changing the 'action' or modifying the amount of input
* will make lzma_code() return LZMA_PROG_ERROR. * will make lzma_code() return LZMA_PROG_ERROR.
*/ */
typedef enum { typedef enum {
@ -393,8 +393,8 @@ typedef enum {
* Single-threaded mode only: liblzma doesn't make an internal copy of * Single-threaded mode only: liblzma doesn't make an internal copy of
* lzma_allocator. Thus, it is OK to change these function pointers in * lzma_allocator. Thus, it is OK to change these function pointers in
* the middle of the coding process, but obviously it must be done * the middle of the coding process, but obviously it must be done
* carefully to make sure that the replacement `free' can deallocate * carefully to make sure that the replacement 'free' can deallocate
* memory allocated by the earlier `alloc' function(s). * memory allocated by the earlier 'alloc' function(s).
* *
* Multithreaded mode: liblzma might internally store pointers to the * Multithreaded mode: liblzma might internally store pointers to the
* lzma_allocator given via the lzma_stream structure. The application * lzma_allocator given via the lzma_stream structure. The application
@ -422,7 +422,7 @@ typedef struct {
* liblzma never sets this to zero. * liblzma never sets this to zero.
* *
* \return Pointer to the beginning of a memory block of * \return Pointer to the beginning of a memory block of
* `size' bytes, or NULL if allocation fails * 'size' bytes, or NULL if allocation fails
* for some reason. When allocation fails, functions * for some reason. When allocation fails, functions
* of liblzma return LZMA_MEM_ERROR. * of liblzma return LZMA_MEM_ERROR.
* *
@ -622,7 +622,7 @@ typedef struct {
* to and get output from liblzma. * to and get output from liblzma.
* *
* See the description of the coder-specific initialization function to find * See the description of the coder-specific initialization function to find
* out what `action' values are supported by the coder. * out what 'action' values are supported by the coder.
* *
* \param strm Pointer to lzma_stream that is at least initialized * \param strm Pointer to lzma_stream that is at least initialized
* with LZMA_STREAM_INIT. * with LZMA_STREAM_INIT.

10
src/liblzma/api/lzma/container.h
View file

@ -297,7 +297,7 @@ extern LZMA_API(uint64_t) lzma_easy_decoder_memusage(uint32_t preset)
* to call lzma_end() after failed initialization. * to call lzma_end() after failed initialization.
* *
* If initialization succeeds, use lzma_code() to do the actual encoding. * If initialization succeeds, use lzma_code() to do the actual encoding.
* Valid values for `action' (the second argument of lzma_code()) are * Valid values for 'action' (the second argument of lzma_code()) are
* LZMA_RUN, LZMA_SYNC_FLUSH, LZMA_FULL_FLUSH, and LZMA_FINISH. In future, * LZMA_RUN, LZMA_SYNC_FLUSH, LZMA_FULL_FLUSH, and LZMA_FINISH. In future,
* there may be compression levels or flags that don't support LZMA_SYNC_FLUSH. * there may be compression levels or flags that don't support LZMA_SYNC_FLUSH.
* *
@ -679,13 +679,13 @@ extern LZMA_API(lzma_ret) lzma_microlzma_encoder(
* supported by liblzma, only the .xz and .lz formats allow concatenated * supported by liblzma, only the .xz and .lz formats allow concatenated
* files. Concatenated files are not allowed with the legacy .lzma format. * files. Concatenated files are not allowed with the legacy .lzma format.
* *
* This flag also affects the usage of the `action' argument for lzma_code(). * This flag also affects the usage of the 'action' argument for lzma_code().
* When LZMA_CONCATENATED is used, lzma_code() won't return LZMA_STREAM_END * When LZMA_CONCATENATED is used, lzma_code() won't return LZMA_STREAM_END
* unless LZMA_FINISH is used as `action'. Thus, the application has to set * unless LZMA_FINISH is used as 'action'. Thus, the application has to set
* LZMA_FINISH in the same way as it does when encoding. * LZMA_FINISH in the same way as it does when encoding.
* *
* If LZMA_CONCATENATED is not used, the decoders still accept LZMA_FINISH * If LZMA_CONCATENATED is not used, the decoders still accept LZMA_FINISH
* as `action' for lzma_code(), but the usage of LZMA_FINISH isn't required. * as 'action' for lzma_code(), but the usage of LZMA_FINISH isn't required.
*/ */
#define LZMA_CONCATENATED UINT32_C(0x08) #define LZMA_CONCATENATED UINT32_C(0x08)
@ -819,7 +819,7 @@ extern LZMA_API(lzma_ret) lzma_auto_decoder(
/** /**
* \brief Initialize .lzma decoder (legacy file format) * \brief Initialize .lzma decoder (legacy file format)
* *
* Valid `action' arguments to lzma_code() are LZMA_RUN and LZMA_FINISH. * Valid 'action' arguments to lzma_code() are LZMA_RUN and LZMA_FINISH.
* There is no need to use LZMA_FINISH, but it's allowed because it may * There is no need to use LZMA_FINISH, but it's allowed because it may
* simplify certain types of applications. * simplify certain types of applications.
* *

6
src/liblzma/api/lzma/filter.h
View file

@ -43,7 +43,7 @@ typedef struct {
/** /**
* \brief Filter ID * \brief Filter ID
* *
* Use constants whose name begin with `LZMA_FILTER_' to specify * Use constants whose name begin with 'LZMA_FILTER_' to specify
* different filters. In an array of lzma_filter structures, use * different filters. In an array of lzma_filter structures, use
* LZMA_VLI_UNKNOWN to indicate end of filters. * LZMA_VLI_UNKNOWN to indicate end of filters.
* *
@ -199,7 +199,7 @@ extern LZMA_API(uint64_t) lzma_raw_decoder_memusage(const lzma_filter *filters)
* *
* This function may be useful when implementing custom file formats. * This function may be useful when implementing custom file formats.
* *
* The `action' with lzma_code() can be LZMA_RUN, LZMA_SYNC_FLUSH (if the * The 'action' with lzma_code() can be LZMA_RUN, LZMA_SYNC_FLUSH (if the
* filter chain supports it), or LZMA_FINISH. * filter chain supports it), or LZMA_FINISH.
* *
* \param strm Pointer to lzma_stream that is at least * \param strm Pointer to lzma_stream that is at least
@ -223,7 +223,7 @@ extern LZMA_API(lzma_ret) lzma_raw_encoder(
* *
* The initialization of raw decoder goes similarly to raw encoder. * The initialization of raw decoder goes similarly to raw encoder.
* *
* The `action' with lzma_code() can be LZMA_RUN or LZMA_FINISH. Using * The 'action' with lzma_code() can be LZMA_RUN or LZMA_FINISH. Using
* LZMA_FINISH is not required, it is supported just for convenience. * LZMA_FINISH is not required, it is supported just for convenience.
* *
* \param strm Pointer to lzma_stream that is at least * \param strm Pointer to lzma_stream that is at least

8
src/liblzma/api/lzma/index.h
View file

@ -709,7 +709,7 @@ extern LZMA_API(lzma_index *) lzma_index_dup(
* \param strm Pointer to properly prepared lzma_stream * \param strm Pointer to properly prepared lzma_stream
* \param i Pointer to lzma_index which should be encoded. * \param i Pointer to lzma_index which should be encoded.
* *
* The valid `action' values for lzma_code() are LZMA_RUN and LZMA_FINISH. * The valid 'action' values for lzma_code() are LZMA_RUN and LZMA_FINISH.
* It is enough to use only one of them (you can choose freely). * It is enough to use only one of them (you can choose freely).
* *
* \return Possible lzma_ret values: * \return Possible lzma_ret values:
@ -738,7 +738,7 @@ extern LZMA_API(lzma_ret) lzma_index_encoder(
* don't allow 0 here and return LZMA_PROG_ERROR; * don't allow 0 here and return LZMA_PROG_ERROR;
* later versions treat 0 as if 1 had been specified. * later versions treat 0 as if 1 had been specified.
* *
* Valid `action' arguments to lzma_code() are LZMA_RUN and LZMA_FINISH. * Valid 'action' arguments to lzma_code() are LZMA_RUN and LZMA_FINISH.
* There is no need to use LZMA_FINISH, but it's allowed because it may * There is no need to use LZMA_FINISH, but it's allowed because it may
* simplify certain types of applications. * simplify certain types of applications.
* *
@ -842,10 +842,10 @@ extern LZMA_API(lzma_ret) lzma_index_buffer_decode(lzma_index **i,
* expect to see the same exact value for the same file if you change the * expect to see the same exact value for the same file if you change the
* input buffer size or switch to a different liblzma version. * input buffer size or switch to a different liblzma version.
* *
* Valid `action' arguments to lzma_code() are LZMA_RUN and LZMA_FINISH. * Valid 'action' arguments to lzma_code() are LZMA_RUN and LZMA_FINISH.
* You only need to use LZMA_RUN; LZMA_FINISH is only supported because it * You only need to use LZMA_RUN; LZMA_FINISH is only supported because it
* might be convenient for some applications. If you use LZMA_FINISH and if * might be convenient for some applications. If you use LZMA_FINISH and if
* lzma_code() asks the application to seek, remember to reset `action' back * lzma_code() asks the application to seek, remember to reset 'action' back
* to LZMA_RUN unless you hit the end of the file again. * to LZMA_RUN unless you hit the end of the file again.
* *
* Possible return values from lzma_code(): * Possible return values from lzma_code():

2
src/liblzma/api/lzma/lzma12.h
View file

@ -289,7 +289,7 @@ typedef struct {
* \brief Number of literal context bits * \brief Number of literal context bits
* *
* How many of the highest bits of the previous uncompressed * How many of the highest bits of the previous uncompressed
* eight-bit byte (also known as `literal') are taken into * eight-bit byte (also known as 'literal') are taken into
* account when predicting the bits of the next literal. * account when predicting the bits of the next literal.
* *
* E.g. in typical English text, an upper-case letter is * E.g. in typical English text, an upper-case letter is

2
src/liblzma/lz/lz_encoder.h
View file

@ -225,7 +225,7 @@ typedef struct {
// 3. The literals and matches are encoded using e.g. LZMA. // 3. The literals and matches are encoded using e.g. LZMA.
// //
// The bytes that have been ran through the match finder, but not encoded yet, // The bytes that have been ran through the match finder, but not encoded yet,
// are called `read ahead'. // are called 'read ahead'.
/// Get how many bytes the match finder hashes in its initial step. /// Get how many bytes the match finder hashes in its initial step.

2
src/liblzma/rangecoder/range_decoder.h
View file

@ -50,7 +50,7 @@ rc_read_init(lzma_range_decoder *rc, const uint8_t *restrict in,
/// Makes local copies of range decoder and *in_pos variables. Doing this /// Makes local copies of range decoder and *in_pos variables. Doing this
/// improves speed significantly. The range decoder macros expect also /// improves speed significantly. The range decoder macros expect also
/// variables `in' and `in_size' to be defined. /// variables 'in' and 'in_size' to be defined.
#define rc_to_local(range_decoder, in_pos) \ #define rc_to_local(range_decoder, in_pos) \
lzma_range_decoder rc = range_decoder; \ lzma_range_decoder rc = range_decoder; \
size_t rc_in_pos = (in_pos); \ size_t rc_in_pos = (in_pos); \