InfiniTimeOrg / InfiniTimeOrg/InfiniTime
Documentation for flashing with OpenOCD seems outdated
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 3.4k
- Forks
- 1.1k
- PR merge metrics
- No merged PRs in 30d
Description
Verification
- I searched for similar issues (including closed issues) and found none was relevant.
Introduce the issue
The documentation for how to flash with OpenOCD and STLink seems outdated. It is many years old and cannot be followed as-written.
The ocd steps reference build artifacts that I can't find matching names for:
<build_dir>/image-<version>.bin and <build_dir>/pinetime-graphics-<version>.bin. The bootloader file referenced by that document does exist in build/output
I am able to build infinitime, but these are the only bin files I find afterwards:
- ./bootloader/bootloader-5.0.4.bin
- ./bootloader/mynewt_nosemi_4.1.7.elf.bin
- ./build/CMakeFiles/3.22.1/CMakeDetermineCompilerABI_C.bin
- ./build/CMakeFiles/3.22.1/CMakeDetermineCompilerABI_CXX.bin
- ./build/src/resources/7segments_40.bin
- ./build/src/resources/lv_font_dots_40.bin
- ./build/src/resources/teko.bin
- ./build/src/resources/bebas.bin
- ./build/src/resources/7segments_115.bin
- ./build/src/resources/pine_small.bin
- ./build/src/resources/navigation1.bin
- ./build/src/resources/navigation0.bin
- ./build/src/pinetime-recovery-loader-1.15.0.bin
- ./build/src/pinetime-mcuboot-recovery-loader-1.15.0.bin
- ./build/src/pinetime-mcuboot-recovery-loader-image-1.15.0.bin
- ./build/src/pinetime-mcuboot-app-image-1.15.0.bin
- ./build/src/pinetime-recovery-1.15.0.bin
- ./build/src/pinetime-mcuboot-recovery-1.15.0.bin
- ./build/src/pinetime-mcuboot-recovery-image-1.15.0.bin
- ./build/src/pinetime-mcuboot-app-1.15.0.bin
- ./build/src/pinetime-app-1.15.0.bin
- ./build/output/bootloader.bin
- ./build/output/pinetime-mcuboot-app-image-1.15.0.bin
- ./build/output/pinetime-mcuboot-recovery-loader-image-1.15.0.bin
- ./build/output/src/pinetime-app-1.15.0.bin
- ./build/output/src/pinetime-mcuboot-app-1.15.0.bin
- ./build/output/src/pinetime-mcuboot-app-image-1.15.0.bin
- ./build/output/src/pinetime-mcuboot-recovery-1.15.0.bin
- ./build/output/src/pinetime-mcuboot-recovery-image-1.15.0.bin
- ./build/output/src/pinetime-mcuboot-recovery-loader-1.15.0.bin
- ./build/output/src/pinetime-mcuboot-recovery-loader-image-1.15.0.bin
- ./build/output/src/pinetime-recovery-1.15.0.bin
- ./build/output/src/pinetime-recovery-loader-1.15.0.bin
Preferred solution
Update documentation to match the names of build artifacts
Version
main branch build
Contributor guide
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.
Research direction
Start with doc/openOCD.md and compare its referenced image and graphics filenames with the artifacts listed under build/output and build/src. Update the documentation to use the current build artifact names, then verify that the OpenOCD and STLink flashing steps can be followed using the main branch build outputs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- build-system, documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100