Build system: OS image file naming no longer matches the built images
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- documentation
Research direction
Read the “OS image file naming” section in docs/cpu-software/Build-system.md, especially lines 47–59, and compare its examples with the current image name given in the issue. Update the listed naming details and picture alt text; check the follow-up issue and linked commit for the UFS guidance. Done when the section accurately describes current image names and resolves the open questions about UFS images.
Written by the indexing model from the issue text.
Description
The "OS image file naming" section breaks down debian-4096-nanopi-m5-build-1034.img.gz, the name shown in its picture. Current images are named like debian-512-nanopi-m5-2407.img.zst: no 4096 variant, no build keyword, and .img.zst instead of .img.gz.
Suggested changes:
- Line 49: give the picture its own alt text instead of the one copied from line 21.
- Line 54: describe 512 as the sector size in bytes, and say that images are only built for 512-byte sectors (SD card and eMMC).
- Line 56: drop the bullet for the
buildkeyword. - Line 57: use 2407 instead of 1034.
- Line 59: use
.img.zstinstead of.img.gz.
Could the picture be redrawn with a current name? Are 4096-byte (UFS) images planned again? If not, should this section point UFS users to the Flipper OS Installer, as commit 4150eb7 suggests?
Follow-up to #453.
- Dominant language
- Python
- Stars
- 141
- Forks
- 57
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from flipperdevices/flipperone-docs
-
docs: update tools and CI documentation in READMEPossibly taken @izmalk claimed this 11 days ago. Open
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
flipperdevices/flipperone-docs#464 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 20/100
flipperdevices/flipperone-docs#470 · 6 comments · 13 reactions ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
flipperdevices/flipperone-docs#469 · 1 reaction ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
flipperdevices/flipperone-docs#457 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 1-2 days Newbie friendliness 35/100
flipperdevices/flipperone-docs#454 ·
Maintainers usually reply within 1 day
All issues in flipperdevices/flipperone-docs
Similar issues
-
needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
gke-labs/kube-agents#6778 · 1 comment ·
Maintainers usually reply within 1 day
-
Declare the CMS schema library in the optional recipients extraPossibly taken A pull request linked to this issue is open or already merged. Openarea:python in-progress
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
yhay81/pyropdf#1005 · 2 comments ·
Maintainers usually reply within 1 day
-
area/build-framework kind/enhancement priority/low
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
yugabyte/yugabyte-db#38826 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 72/100
sususweet/midea_auto_cloud#306 ·
Maintainers usually reply within 9 days