Skip to content

Documentation: document lzf command.#18982

Merged
xiaoxiang781216 merged 1 commit into
apache:masterfrom
Zepp-Hanzj:docs/lzf
May 28, 2026
Merged

Documentation: document lzf command.#18982
xiaoxiang781216 merged 1 commit into
apache:masterfrom
Zepp-Hanzj:docs/lzf

Conversation

@Zepp-Hanzj
Copy link
Copy Markdown
Contributor

Summary

  • Add documentation for the lzf compression/decompression command, which currently has a blank documentation page.
  • The lzf tool uses the liblzf library to compress and decompress files using the lightweight LZF algorithm.
  • The documentation covers: overview, file format, configuration (CONFIG_SYSTEM_LZF and 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.
  • Refs Documentation: blank pages in documentation #11081

Impact

  • Is new feature added? Is existing feature changed? NO
  • Impact on user (will user need to adapt to change)? NO
  • Impact on build (will build process change)? NO
  • Impact on hardware (will arch(s) / board(s) / driver(s) change)? NO
  • Impact on documentation (is update required / provided)? YES — this PR is the documentation update itself.
  • Impact on security (any sort of implications)? NO
  • Impact on compatibility (backward/forward/interoperability)? NO

Testing

  • Build Host(s): Linux (WSL Ubuntu), x86_64
  • Verification: python3 -m docutils RST syntax check — no warnings. make html in Documentation/ — build succeeded with no errors.
  • ./tools/checkpatch.sh -g HEAD — all checks pass.
  • Source evidence: documentation content derived from apps/system/lzf/lzf_main.c (578 lines) and apps/system/lzf/Kconfig, cross-referenced with include/lzf.h for file format constants.

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>
@github-actions github-actions Bot added Area: Documentation Improvements or additions to documentation Size: M The size of the change in this PR is medium labels May 28, 2026
@xiaoxiang781216 xiaoxiang781216 merged commit f031dc5 into apache:master May 28, 2026
3 checks passed
@Zepp-Hanzj Zepp-Hanzj deleted the docs/lzf branch May 29, 2026 01:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Documentation Improvements or additions to documentation Size: M The size of the change in this PR is medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants