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 file export description #4520

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

towoe
Copy link

@towoe towoe commented Nov 20, 2024

Use emitSystemVerilogFile and emitCHIRRTLFile to export the corresponding files.
Fix runMain command.
Files are saved as SystemVerilog '.sv'.
Do not use (use circt.stage.ChiselStage) as this appears not to work anymore.

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Documentation or website-related

Desired Merge Strategy

  • Squash: The PR will be squashed and merged (choose this if you have no preference).

Release Notes

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

Use `emitSystemVerilogFile` and `emitCHIRRTLFile` to export the
corresponding files.
Fix `runMain` command.
Files are saved as SystemVerilog '.sv'.
Do not use `(use circt.stage.ChiselStage)` as this appears not to work
anymore.
Copy link

CLA Not Signed

@towoe
Copy link
Author

towoe commented Nov 20, 2024

Hi, I was just playing around with Chisel and tried to get some SV and FIRRTL out. Came across the description and seemed not to work for me. From the code I gathered that there have been some updates which might not be reflected in the docs. But maybe it was just me not being able to get to run as in the FAQs mentioned.

@jackkoenig jackkoenig added the Documentation Only changing documentation label Nov 20, 2024
Copy link
Contributor

@jackkoenig jackkoenig left a comment

Choose a reason for hiding this comment

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

Thank you for the contribution! The FAQ is badly in need of some updates, this is at least an improvement but it's super dated. I think I want to delete this page in favor of similar documentation under Getting Started, but need to write those docs first...

@towoe can you sign the CLA?

@towoe
Copy link
Author

towoe commented Nov 20, 2024

Thanks for the comment @jackkoenig.
I also had the feeling that this could use some more improvements, but just wanted to start where I had some touch points.

I am with Hochschule München now, which should be a member of Chips Alliance, so I marked @wallento to approve this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Only changing documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants