lowRISC / lowRISC/dvsim

dvsim sometimes fails with an error about relative links

Open
#227 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
13
Forks
21
Avg merge
1d 11h
Merged PRs (30d)
8

Description

I can't remember the exact error, but when it's trying to work out relative links from the summary markdown to the HTML, the markdown reporter defaults to using the CWD as the `relative_to` directory (which is a terrible default), and if that isn't a subdirectory of the other path then it fails with an exception.

Possible fix here: https://github.com/lowRISC/dvsim/commit/df68de6a4846d9b348508c88bfc629f8f7565a35

I mean it fixes it for me but may not be the best solution.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked commit and the markdown reporter's relative-link handling, then reproduce the failure when the summary and HTML paths are not nested under the current working directory. Done means relative links are resolved without an exception in that case.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.