docs: add '(overlay)' to the `organize` key description
Metadata
Current evaluation
Merged documentation update adding the overlay pseudo-partition mention to the organize key description. Approved by two reviewers and passed CI checks, clarifying a load-bearing rootfs copy feature.
Suggested action: —
No scores available.
Issue body
Add mention of the `(overlay)` pseudo-partition to the `organize` key description. This is a load-bearing feature, as it's how we currently copy the rootfs to the overlay filesystem.
---
- [X] I've followed the [contribution guidelines](https://github.com/canonical/imagecraft/blob/main/CONTRIBUTING.md).
- [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
~~I've successfully run `make lint && make test`.~~ (unrelated failures)
~~I've added or updated any relevant documentation.~~
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding the overlay pseudo-partition mention to the organize key description. Approved by two reviewers and passed CI checks, clarifying a load-bearing rootfs copy feature. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding the (overlay) pseudo-partition to the organize key description. This clarifies how the rootfs copies to the overlay filesystem, documenting a load-bearing feature. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding the (overlay) pseudo-partition to the organize key description, clarifying how the rootfs is copied to the overlay filesystem. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1254 feat: allow parts to organize to overlay | craft-parts | merged | Merged. Introduces an overlay target for file organization, moving part build files to the mounted overlay stack. Approved by three reviewers and passed all CI checks. Documentation will be added later when the base creation feature is complete. | |
| #1473 docs: add override-overlay | craft-parts | merged | Merged documentation update adding override-overlay. Approved by three reviewers and passed CI checks despite two failing edge tests. Changes span six files with 20 additions and 8 deletions. | |
| #1602 fix(organize): make organize to overlay behavior consistent | craft-parts | merged | Merged fix correcting glob-key organize behavior to overlay. Glob keys previously merged contents instead of nesting. Update restores expected nesting for consistency. Approved by three reviewers and passed CI checks. | |
| #322 docs: enable inclusion of overlay document | rockcraft | merged | Merged documentation changes enabling overlay document inclusion. Approved by three reviewers, passed CI checks, and implemented via a single-line configuration update. | |
| #1541 fix(organize): make organizing to the overlay idempotent | craft-parts | merged | Merged to fix overlay organization idempotency and resolve #1488. Copilot automatically resolved merge conflicts in commit 4282caa6, reverting BUILD_PARTITION while preserving OVERLAY_PARTITION logic. All tests pass. | |
| #1590 inconsistency in organize to overlay | craft-parts | closed | Inconsistent directory organization to overlay partitions was fixed in commit 139cbce6 via PR #1602. The change normalizes overlay handling in organize_files() to ensure consistent nesting for glob keys across all destinations. | |
| #111 overlay: add overlayfs helpers (CRAFT-462) | craft-parts | merged | Merged. Added overlayfs mount and unmount helpers, plus utilities to identify special files and directories for filesystem layering. Approved by two reviewers, passed CI, and introduced 420 lines across six files. | |
| #1586 fix(organize): allow merging directories in overlay with metadata differences | craft-parts | merged | Merged. Resolves #1487 by permitting overlay directories with differing permissions or ownership to merge without raising FileOrganizeError. Review feedback was incorporated via automated commits, CI passed, and the change was successfully merged. |