Skip to content

Commit dedf65c

Browse files
committed
Add documentation about needing to mx sforceimports
1 parent b47c1c7 commit dedf65c

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

doc/contributor/workflow.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,25 @@ Note that build information such as the date and Git revision hash will not be
8484
updated when you build for a second time. Releases should always be built from
8585
scratch.
8686

87+
### Using the correct version of the graal repository
88+
89+
TruffleRuby needs the `truffle` and `sulong` suites from the `graal` repository.
90+
`jt build` will automatically clone the repository but not enforce a specific version (commit).
91+
When running `jt build`, you might see an early warning:
92+
```
93+
$ jt build
94+
$ mx --env jvm scheckimports --ignore-uncommitted --warn-only
95+
WARNING: imported version of sulong in truffleruby (89aaf87268) does not match parent (aa6d8e07a6)
96+
You might want to run "mx sforceimports" to use the imported version or update the import with "mx scheckimports"
97+
```
98+
99+
This warning is important.
100+
If you did not create new commits in `graal`, you will typically need to run `jt mx sforceimports`
101+
so that a known compatible commit of `graal` is used (that commit is recorded in `mx.truffleruby/suite.py`).
102+
103+
This is not done automatically, because sometimes you might want to have changes in `graal`,
104+
and because developers of the Truffle or Sulong team typically want to use a different commit of `graal` to test their changes.
105+
87106
### Building C Extensions more quickly
88107

89108
To speed up compilation of bundled C extensions, it is possible to use

0 commit comments

Comments
 (0)