Documentation: document lzf command.#18982
Merged
Merged
Conversation
Add documentation for the lzf compression/decompression command. The lzf tool uses the liblzf library to compress and decompress files using the lightweight LZF algorithm. Refs apache#11081 Signed-off-by: hanzj <hanzjian@zepp.com>
xiaoxiang781216
approved these changes
May 28, 2026
eren-terzioglu
approved these changes
May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
lzfcompression/decompression command, which currently has a blank documentation page.lzftool uses the liblzf library to compress and decompress files using the lightweight LZF algorithm.CONFIG_SYSTEM_LZFand related symbols), usage, all six options (-c,-d,-f,-h,-v,-b), environment variable support (LZF_BLOCKSIZE), examples for file and stdin/stdout modes, and implementation notes.Impact
Testing
python3 -m docutilsRST syntax check — no warnings.make htmlinDocumentation/— build succeeded with no errors../tools/checkpatch.sh -g HEAD— all checks pass.apps/system/lzf/lzf_main.c(578 lines) andapps/system/lzf/Kconfig, cross-referenced withinclude/lzf.hfor file format constants.