Build system: OS image file naming no longer matches the built images

Open
#455 0 comments 0 reactions 0 assignees View on GitHub

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.

https://github.com/flipperdevices/flipperone-docs/blob/e510c6411a3b4bf10edf91ffc4271156cf99368d/docs/cpu-software/Build-system.md?plain=1#L47-L59

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 build keyword.
  • Line 57: use 2407 instead of 1034.
  • Line 59: use .img.zst instead 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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from flipperdevices/flipperone-docs

All issues in flipperdevices/flipperone-docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.