[regtool] remove unused empty line from `-d` output
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 60/100
Research direction
Start in util/regtool.py and reproduce the issue with ./util/regtool.py -d hw/ip/ascon/data/ascon.hjson > hw/ip/ascon/doc/registers.md. Trace how the generated markdown is terminated, then verify that the output no longer contains the duplicate empty line and passes the whitespace check without util/fix_trailing_whitespace.py.
Written by the indexing model from the issue text.
Description
Description
Problem
If regtool is used to generate the register-documentation, for example ./util/regtool.py -d hw/ip/ascon/data/ascon.hjson > hw/ip/ascon/doc/registers.md The markdown file ends with two empty lines. However, this is triggers the Lint in the CI:
Would have fixed 1 files.
Fixing file: "hw/ip/ascon/doc/registers.md"
##vso[task.logissue type=error]Whitespace check failed. Please run util/fix_trailing_whitespace.py on the above files.
Running this command then removes one of the empty lines.
Solution
Regtool shouldn't add this duplicate empty line in the first place
- Dominant language
- SystemVerilog
- Stars
- 3.7k
- Forks
- 1.1k
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 149
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.
More from lowRISC/opentitan
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
IP:otp_ctrl
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
All issues in lowRISC/opentitan
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
from:qa priority:P2 reliability tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
spec-kitty/spec-kitty#4874 ·
-
0. Needs triage bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
nextcloud/fulltextsearch#1011 ·
-
automation code-quality cookie deep-report documentation improvement quick-win task-mining
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100