InfiniTimeOrg / InfiniTimeOrg/InfiniTime

Build directory clutter

Open
#1,647 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

maintenance
Dominant language
C
Stars
3.4k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

Verification
  • I searched for similar issues and found none was relevant.
Introduce the issue

The relevant build files are placed under src directory in the build directory. This directory includes 5 files by default, and building target pinetime-app increases this to 14, most of which aren't interesting. After also building pinetime-mcuboot-app, the file count is now 21, and the directory is quite cluttered. Now you need to look for the file you're interested in. Now if you build another version, the old files don't get replaced, and the file count increases still.

Preferred solution

I think the version number can be removed from the filename. When you build the firmware locally, it's almost never the tagged version. It could includes changes made locally, a newer main branch, a PR, etc. In almost all cases, the version number is only misleading and contributing to clutter. With shorter filenames, the files are easier to identify.

I believe the hex file was added as a superior alternative to the bin file. Creating both seems unnecessary. Can the bin files be removed?

I'm not sure what can be done about the rest of the files in the same directory.

Version

No response

Contributor guide

Open the contributing guide

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.

Research direction

Start by inspecting the build files under the src build directory and the outputs produced by pinetime-app and pinetime-mcuboot-app. Determine which generated filenames include version numbers and which artifacts are duplicated; done means the requested output naming and bin-versus-hex behavior are defined and the directory is less cluttered.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, cpp
Domain
build-system, embedded-iot
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.