Skip to content

Build-Switches: document SKIP_COMPRESSING - #951

Merged
igorpecovnik merged 2 commits into
mainfrom
document-skip-compressing
Aug 3, 2026
Merged

Build-Switches: document SKIP_COMPRESSING#951
igorpecovnik merged 2 commits into
mainfrom
document-skip-compressing

Conversation

@igorpecovnik

@igorpecovnik igorpecovnik commented Aug 3, 2026

Copy link
Copy Markdown
Member

Documents the SKIP_COMPRESSING build switch (from armbian/build#10323) under COMPRESS_OUTPUTIMAGE in Developer-Guide_Build-Switches.md.

It is a comma/space-separated list of file extensions to leave uncompressed even when xz/zstd is enabled (e.g. SKIP_COMPRESSING="iso,qcow2") — for formats consumed as-is (qcow2 imported into a hypervisor, iso mounted as a virtual CD). Still checksummed when sha is set; empty by default.

Create docs preview on PR

Documentation website preview will be available shortly:


 Open WWW preview 

Document the SKIP_COMPRESSING switch (armbian/build#10323) as a sub-option of
COMPRESS_OUTPUTIMAGE: a list of file extensions to leave uncompressed (e.g.
iso,qcow2), still checksummed when sha is enabled.

Signed-off-by: Igor Pecovnik <igor@armbian.com>
@github-actions github-actions Bot added size/small PR with less then 50 lines Needs review Seeking for review labels Aug 3, 2026
@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 69ff14da-b091-42a7-8552-c5c60806733e

📥 Commits

Reviewing files that changed from the base of the PR and between 6857277 and 923cbfb.

📒 Files selected for processing (1)
  • docs/Developer-Guide_Build-Switches.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/Developer-Guide_Build-Switches.md

Walkthrough

The developer guide now documents the SKIP_COMPRESSING build option. The option accepts comma- or space-separated image extensions. Matching formats remain uncompressed while SHA checksum generation remains available.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: documenting the SKIP_COMPRESSING build switch.
Description check ✅ Passed The description accurately explains the documented build switch and its behavior.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch document-skip-compressing

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

github-actions Bot pushed a commit that referenced this pull request Aug 3, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/Developer-Guide_Build-Switches.md`:
- Line 490: Move the SKIP_COMPRESSING documentation entry from the obsolete “DO
NOT USE!” section into the active build-switch documentation section above it,
preserving its existing description and placement alongside the other current
switches.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 04c07b8c-6b9c-417c-9d9d-cdd566f78408

📥 Commits

Reviewing files that changed from the base of the PR and between c09dcd6 and 6857277.

📒 Files selected for processing (1)
  • docs/Developer-Guide_Build-Switches.md

Comment thread docs/Developer-Guide_Build-Switches.md Outdated
It was added under COMPRESS_OUTPUTIMAGE, which lives below the "DO NOT USE!
Obsolete documentation" marker. Move it up into the active Advanced section as a
self-contained entry that references COMPRESS_OUTPUTIMAGE.

Signed-off-by: Igor Pecovnik <igor@armbian.com>
github-actions Bot pushed a commit that referenced this pull request Aug 3, 2026
@igorpecovnik
igorpecovnik merged commit 1b567ce into main Aug 3, 2026
5 checks passed
@igorpecovnik
igorpecovnik deleted the document-skip-compressing branch August 3, 2026 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs review Seeking for review size/small PR with less then 50 lines

Development

Successfully merging this pull request may close these issues.

1 participant