Skip to content

docs: Update development documentation#202

Open
antonykamp wants to merge 3 commits intohpi-swa:mainfrom
antonykamp:antonykamp/update-development-documentation
Open

docs: Update development documentation#202
antonykamp wants to merge 3 commits intohpi-swa:mainfrom
antonykamp:antonykamp/update-development-documentation

Conversation

@antonykamp
Copy link

This change includes updates to the development documentation:

  • Graal Update no longer exists
  • Add reference to mx fetch
  • Add hints that would help us getting started

Copy link

@Olliwehr Olliwehr left a comment

Choose a reason for hiding this comment

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

LGTM, got 2 minor suggestions 🚀

cd graal/vm # Change to the GraalVM folder
mx --dy trufflesqueak,/graal-nodejs,/compiler build
mx --dy trufflesqueak,/graal-nodejs,/compiler graalvm-home # print path to $GRAALVM_HOME
export GRAALVM_HOME=$(mx --dy trufflesqueak,/graal-nodejs,/compiler graalvm-home)

Choose a reason for hiding this comment

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

When trying out GraalPy we had issues with differing BouncyCastle library versions, which (at least) I fixed by locally changing the BouncyCastle related stuff in mx.trufflesqueak/suite.py. @antonykamp is this also sth. we should add here? 🙂

Copy link
Author

Choose a reason for hiding this comment

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

I remember that issue! There was a version mismatch.
As far as I remember, @fniephaus wanted to resolve the issue by aligning the version BouncyCastle version.
I don't see a reason to add this here 🙃 Maybe we should add an issue instead.

4. Run `$GRAALVM_HOME/bin/trufflesqueak`

Or second, you can build other languages from source. For this, please refer to the [instructions for building custom GraalVM distributions][graalvm_vm_readme]. As an example, here is how to build a GraalVM with the Graal compiler, TruffleSqueak, the GraalVM Updater, and GraalVM's Node.js runtime:
You build TruffleSqueak and other languages from source. For this, please refer to the [instructions for building custom GraalVM distributions][graalvm_vm_readme]. As an example, here is how to build a GraalVM with the Graal compiler, TruffleSqueak and GraalVM's Node.js runtime:

Choose a reason for hiding this comment

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

I think we should add that it is important that all Truffle languages should be built with the same underlying graal branch (e.g. origin/github/patches/24.2.0) in order to avoid inconsistencies and compatibility issues.

Copy link
Author

Choose a reason for hiding this comment

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

Great idea! I guess it depends wether the patch is permanent or intermediate.
@fniephaus Is the patch permanent?

Copy link
Member

Choose a reason for hiding this comment

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

The patch is unfortunately permanent (we most likely have one per graal branch).

antonykamp and others added 2 commits July 29, 2025 13:57
Co-authored-by: Oliver Heß <68427341+Olliwehr@users.noreply.github.com>
@javaman-dev
Copy link

TruffleSqueak is now compiled as an unchained standalone. GraalVM has to be used as JDK.
TruffleSqueak home is in the TRUFFLESQUEAK_JVM_STANDALONE folder. Additional languages can be installed using the trufflesqueak-polyglot-get utility, specifying one of the artifacts from https://repo1.maven.org/maven2/org/graalvm/polyglot/ as an argument, you can also specify the version.

@fniephaus fniephaus force-pushed the main branch 2 times, most recently from b0f0548 to 750c1b6 Compare October 31, 2025 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants