Documentation: security, JTAG/SWD locking
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 560
- Avg merge
- 1h 41m
- Merged PRs (30d)
- 3
Description
The documentation in https://github.com/pyocd/pyOCD/blob/main/docs/security.md does a great job of describing how to unlock a chip if it is locked (although it seems a little out of date, some of the sample commands returned errors). But security.md fails to describe how to lock a chip if it is unlocked.
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 docs/security.md and review the existing unlock instructions, including which sample commands are now outdated. Add clear documentation for locking an unlocked chip through the relevant JTAG/SWD workflow, and verify that the documented commands and expected results are accurate.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, embedded-iot, security
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100