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

Switch to firtool-resolver (backport #3458) #3687

Open
wants to merge 1 commit into
base: 3.6.x
Choose a base branch
from

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Dec 14, 2023

This is an automatic backport of pull request #3458 done by Mergify.
Cherry-pick of 3938a46 has failed:

On branch mergify/bp/3.6.x/pr-3458
Your branch is up to date with 'origin/3.6.x'.

You are currently cherry-picking commit 3938a465e.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	new file:   project/FirtoolVersion.scala
	new file:   src/main/scala/circt/stage/phases/ScribeInterop.scala
	modified:   src/test/scala/chiselTests/ChiselSpec.scala

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   .github/workflows/build-scala-cli-template.yml
	deleted by us:   .github/workflows/ci.yml
	both modified:   .github/workflows/test.yml
	both modified:   build.sbt
	both modified:   build.sc
	deleted by us:   common.sc
	both modified:   project/plugins.sbt
	both modified:   src/main/scala/circt/stage/phases/CIRCT.scala
	both modified:   src/test/scala/chiselTests/LoadMemoryFromFileSpec.scala
	both modified:   src/test/scala/circtTests/stage/ChiselStageSpec.scala

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally


Mergify commands and options

More conditions and actions can be found in the documentation.

You can also trigger Mergify actions by commenting on this pull request:

  • @Mergifyio refresh will re-evaluate the rules
  • @Mergifyio rebase will rebase this PR on its base branch
  • @Mergifyio update will merge the base branch into this PR
  • @Mergifyio backport <destination> will backport this PR on <destination> branch

Additionally, on Mergify dashboard you can:

  • look at your merge queues
  • generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com


Original PR Body

This uses https://github.com/jackkoenig/firtool-resolver which I will transfer to be an actual chipsalliance repo once this is merged.

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

  • API modification

Desired Merge Strategy

  • Squash

Release Notes

Whereas in the past, the user was expected to provide the firtool binary
on the PATH, Chisel will now manage the firtool binary automatically.
Chisel users the following 3-step process for determining which binary
to use:

  1. If environment variable FIRTOOL_PATH is set, it will check for
    firtool in that directory
  2. It will check the classpath for firtool provided by
    chipsalliance/llvm-firtool
  3. It will download a default version of chipsalliance/llvm-firtool

Both (2) and (3) will store the firtool binary in a sensible location
depending on the user's operating system. See dirs-dev/directories-jvm
for more information. The user can override this location by setting the
FIRTOOL_CACHE environment variable.

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.5.x, 3.6.x, or 5.x depending on impact, API modification or big change: 6.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.

Whereas in the past, the user was expected to provide the firtool binary
on the PATH, Chisel will now manage the firtool binary automatically.
Chisel users the following 3-step process for determining which binary
to use:

1. If environment variable FIRTOOL_PATH is set, it will check for
   firtool in that directory
2. It will check the classpath for firtool provided by
   chipsalliance/llvm-firtool
3. It will download a default version of chipsalliance/llvm-firtool

Both (2) and (3) will store the firtool binary in a sensible location
depending on the user's operating system. See dirs-dev/directories-jvm
for more information. The user can override this location by setting the
FIRTOOL_CACHE environment variable.

(cherry picked from commit 3938a46)

# Conflicts:
#	.github/workflows/build-scala-cli-template.yml
#	.github/workflows/ci.yml
#	.github/workflows/test.yml
#	build.sbt
#	build.sc
#	common.sc
#	project/plugins.sbt
#	src/main/scala/circt/stage/phases/CIRCT.scala
#	src/test/scala/chiselTests/LoadMemoryFromFileSpec.scala
#	src/test/scala/circtTests/stage/ChiselStageSpec.scala
@mergify mergify bot added Backport Automated backport, please consider for minor release bp-conflict labels Dec 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Modification Backport Automated backport, please consider for minor release bp-conflict
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant