Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update FireSim docs #1795

Merged
merged 1 commit into from
Feb 25, 2024
Merged

docs: Update FireSim docs #1795

merged 1 commit into from
Feb 25, 2024

Conversation

geekLucian
Copy link
Contributor

@geekLucian geekLucian commented Feb 22, 2024

Some docs about FireSim is a bit out-dated:

  1. After source sourceme-manager.sh, we need firesim managerinit --platform f1 to do some extra prep work before continuing.
  2. sims/firesim/deploy/deploy/config_build_recipes.ini doesn't exist, it was refactored into sims/firesim/deploy/config_build_recipes.yaml
  3. Fix some broken links to FireSim docs

Also, I added a reference to FireSim docs on how to build custom hardware design with FireSim, should be beneficial to include that.

Related PRs / Issues:

Type of change:

  • Bug fix
  • New feature
  • Other enhancement

Impact:

  • RTL change
  • Software change (RISC-V software)
  • Build system change
  • Other

Contributor Checklist:

  • Did you set main as the base branch?
  • Is this PR's title suitable for inclusion in the changelog and have you added a changelog:<topic> label?
  • Did you state the type-of-change/impact?
  • Did you delete any extraneous prints/debugging code?
  • Did you mark the PR with a changelog: label?
  • (If applicable) Did you update the conda .conda-lock.yml file if you updated the conda requirements file?
  • (If applicable) Did you add documentation for the feature?
  • (If applicable) Did you add a test demonstrating the PR?
  • (If applicable) Did you mark the PR as Please Backport?

@jerryz123
Copy link
Contributor

Re: 2).. that file should appear after managerinit has been executed. The user should not reference or modify sample_backup_configs. We could add a clarifying note on this though.

@geekLucian
Copy link
Contributor Author

Re: 2).. that file should appear after managerinit has been executed. The user should not reference or modify sample_backup_configs. We could add a clarifying note on this though.

Yeah, I added manager-init in the previous setup commands already, so that file should appear by that stage

@geekLucian
Copy link
Contributor Author

Re: 2).. that file should appear after managerinit has been executed. The user should not reference or modify sample_backup_configs. We could add a clarifying note on this though.

Oh that's a typo in the description, that's not what was there in the modification

Copy link
Contributor

@jerryz123 jerryz123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jerryz123 jerryz123 merged commit 11ad33e into ucb-bar:main Feb 25, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants