chipsalliance / chipsalliance/rocket-chip
Debugging section of README.md leads nowhere
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 3.9k
- Forks
- 1.3k
- Avg merge
- 5d 13m
- Merged PRs (30d)
- 1
Description
Type of issue: bug report
Impact: no functional change
Development Phase: request
Other information
The table of contents of the README has a section "Debugging with GDB". However, the actual section with the contents doesn't exist. It would be good if it could be added back into the documentation at this point.
If the current behavior is a bug, please provide the steps to reproduce the problem:
What is the current behavior?
What is the expected behavior?
Please tell us about your environment:
What is the use case for changing the behavior?
Document how to debug the hardware design using GDB
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 in README.md at the table of contents entry for “Debugging with GDB” and inspect the surrounding documentation structure. Determine the missing section’s appropriate placement and content, then update the README so the link leads to an actual GDB debugging guide for the hardware design.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100