bootloader docs inconsistent
- Dominant language
- C
- Stars
- 891
- Forks
- 381
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 14
Description
There are two locations in the docs that discuss the nature of the images to be run by the bootloader.
./boot/bootutil/design.txt: * Build to run from a fixed location (i.e., not position-independent).
./docs/os/modules/bootloader/bootloader.rst:- Build to run from a fixed location (i.e., position-independent).
I believe that the first one (bootutil/design.txt) is the correct statement (well, at least it's internally self-consistent).
Contributor guide
No contributing guide indexed for this repository
Research direction
Compare boot/bootutil/design.txt with docs/os/modules/bootloader/bootloader.rst, focusing on the conflicting statements about whether images run from a fixed location. Update the inconsistent documentation so both locations state the same correct behavior, then verify the two passages match.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100