Skip to content

Commit 84aaac1

Browse files
committed
Add notes on passing --env to mx for the Eclipse setup and using MX_BUILD_EXPLODED/LINKY_LAYOUT
This enables a setup where hot code replacement in the debugger works. Signed-off-by: Stefan Marr <git@stefan-marr.de>
1 parent fd0f34e commit 84aaac1

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

doc/contributor/using-eclipse.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,23 @@ annotation processing which cause the incremental build to fail regularly and
1111
need a full rebuild. For these reason, we recommend
1212
[IntelliJ](using-intellij.md) nowadays.
1313

14-
## Build TruffleRuby
14+
## Basic Setup
15+
16+
### Build TruffleRuby
1517

1618
First, make sure the project is already built from the command line:
1719

1820
```bash
1921
jt build
2022
```
2123

22-
## Generate the Project Files
24+
### Generate the Project Files
2325

2426
```bash
2527
jt mx eclipseinit
2628
```
2729

28-
## Import the Projects
30+
### Import the Projects
2931

3032
Create a new workspace in Eclipse (>= Luna).
3133

@@ -41,9 +43,32 @@ There should be now 4 projects in your workspace:
4143
* `TRUFFLERUBY-TEST.dist`
4244
* `TRUFFLERUBY.dist`
4345

44-
## Running from the Eclipse Files Directly
46+
### Running from the Eclipse Files Directly
4547

4648
```bash
4749
jt ruby -e 'p Truffle'
4850
Truffle
4951
```
52+
53+
## Advanced Setup
54+
55+
**Note:** This setup is not widely tested.
56+
57+
When building using specific env files, with `JT_ENV` or `--env`, mx will
58+
need to be told about it explicitly. For instance:
59+
60+
```bash
61+
jt mx --env jvm-ce eclipseinit
62+
```
63+
64+
When working on the Graal/Truffle code itself, the following two lines will
65+
configure the build so that incremental compilation and even hot code
66+
replacement works:
67+
68+
```bash
69+
MX_BUILD_EXPLODED=true
70+
LINKY_LAYOUT=*.jar
71+
```
72+
73+
These settings are not recommended for producing distributable artifacts, but
74+
make development much smoother.

0 commit comments

Comments
 (0)