Skip to content

Commit bf87d54

Browse files
committed
[GR-44721] [GR-44635] Documentation: Replace GraalVM Enterprise with Oracle GraalVM.
PullRequest: truffleruby/3689
2 parents c7760e6 + 2c55eb5 commit bf87d54

File tree

11 files changed

+37
-28
lines changed

11 files changed

+37
-28
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ If you find any performance issue, please see [this guide](doc/user/reporting-pe
131131

132132
TruffleRuby has the same version and is released at the same time as GraalVM.
133133
See the [release roadmap](https://www.graalvm.org/release-notes/version-roadmap/) for the release dates and information about how long releases are supported.
134-
GraalVM CE releases are supported at most one year.
135-
[Longer support](https://docs.oracle.com/en/graalvm/enterprise/22/docs/release-calendar/) is available for GraalVM EE.
134+
GraalVM Community Edition releases are supported at most one year.
135+
[Longer support](https://docs.oracle.com/en/graalvm/enterprise/22/docs/release-calendar/) is available for Oracle GraalVM.
136136

137137
## Migration from MRI
138138

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Reporting Security Vulnerabilities
22

3-
The GraalVM team values the independent security research community and believes that responsible disclosure of security vulnerabilities in GraalVM Community Edition as well as GraalVM Enterprise Edition helps us ensure the security and privacy of all our users.
3+
The GraalVM team values the independent security research community and believes that responsible disclosure of security vulnerabilities in GraalVM helps us ensure the security and privacy of all our users.
44

55
If you believe you have found a security vulnerability, please submit a report to secalert_us@oracle.com preferably with a proof of concept. Please refer to [Reporting Vulnerabilities](https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html) for additional information including our public encryption key for secure email. We ask that you do not contact project contributors directly or through other channels about a report.
66

77
### Security Updates, Alerts and Bulletins
88

9-
GraalVM Community Edition security updates will be released on a quarterly basis in conjunction withe GraalVM Enterprise Edition security updates that are part of the Oracle Critical Patch Update program. Security updates are released on the Tuesday closest to the 17th day of January, April, July and October. A pre-release announcement will be published on the Thursday preceding each Critical Patch Update release. For additional information including past advisories, please refer to [Security Alerts](https://www.oracle.com/security-alerts/).
9+
GraalVM Community Edition security updates will be released on a quarterly basis in conjunction with Oracle GraalVM security updates that are part of the Oracle Critical Patch Update program. Security updates are released on the Tuesday closest to the 17th day of January, April, July and October. A pre-release announcement will be published on the Thursday preceding each Critical Patch Update release. For additional information including past advisories, please refer to [Security Alerts](https://www.oracle.com/security-alerts/).
1010

1111
### Security-Related Information
1212

ci.jsonnet

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@ local part_definitions = {
208208
host_inlining_log: {
209209
# Same as in mx.truffleruby/native-host-inlining
210210
mx_options+:: [
211+
"--extra-image-builder-argument=env.EXTRA_IMAGE_BUILDER_ARGUMENTS",
211212
"--extra-image-builder-argument=rubyvm:-H:Log=HostInliningPhase,~CanonicalizerPhase,~GraphBuilderPhase",
212213
"--extra-image-builder-argument=rubyvm:-H:+TruffleHostInliningPrintExplored",
213214
"--extra-image-builder-argument=rubyvm:-Dgraal.LogFile=host-inlining.txt",

doc/user/benchmarking.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ This document lists the most important points to consider when benchmarking Truf
1212

1313
We expect anyone publishing benchmark numbers about TruffleRuby to follow these guidelines.
1414

15-
### Use TruffleRuby EE
15+
### Use Oracle GraalVM
1616

17-
Use TruffleRuby EE, it is faster than CE overall and represents what TruffleRuby is capable of.
17+
Use [Oracle GraalVM](installing-graalvm.md) (before 23.0: GraalVM EE), it is faster than GraalVM CE overall and represents what TruffleRuby is capable of.
18+
19+
Use `ruby --version` to ensure that you are running Oracle GraalVM.
1820

1921
### Use the Latest Release
2022

doc/user/faq.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,23 @@ See the Contact section of this [README](../../README.md#contact) page.
7171

7272
### How do I know if I'm using a VM that has the GraalVM compiler?
7373

74-
`ruby --version` will report `GraalVM CE` or `EE`.
74+
`ruby --version` will report `GraalVM CE` or `Oracle GraalVM`.
75+
TruffleRuby versions before 23.0 report `GraalVM EE` instead of `Oracle GraalVM`.
7576

7677
Also, `TruffleRuby.jit?` will tell you if you are running with the GraalVM compiler.
7778

79+
### What is Oracle GraalVM?
80+
81+
Oracle GraalVM is the new GraalVM distribution from Oracle and the successor of GraalVM Enterprise Edition, which used to be reported as `GraalVM EE`.
82+
7883
### How do I know that I'm using the Community Edition of GraalVM?
7984

8085
`ruby --version` will report `GraalVM CE`.
8186

82-
### How do I know that I'm using the Enterprise Edition of GraalVM?
87+
### How do I know that I'm using Oracle GraalVM?
8388

84-
`ruby --version` will report `GraalVM EE`.
89+
`ruby --version` will report `Oracle GraalVM`.
90+
TruffleRuby versions before 23.0 report `GraalVM EE` instead.
8591

8692
### How do I know that I'm using the native version of TruffleRuby?
8793

@@ -114,7 +120,7 @@ Benchmarks that we haven't looked at yet may require new code paths to be specia
114120
Currently we've added specialization for the code paths in the benchmarks and applications that we've been using.
115121
Adding them is generally not complicated and over time we will have specializations to cover a broad range of applications.
116122

117-
Make sure that you are using the [Enterprise Edition of GraalVM, and have rebuilt the executable images](installing-graalvm.md) for the best performance.
123+
Make sure that you are using [Oracle GraalVM, and have rebuilt the executable images](installing-graalvm.md) for the best performance.
118124

119125
### How is this related to `invokedynamic`?
120126

doc/user/installing-graalvm.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Installing GraalVM enables you to run TruffleRuby both in the `--native` and `--
1414

1515
[TruffleRuby's dependencies](../../README.md#dependencies) need to be installed for TruffleRuby to run correctly.
1616

17-
## Community Edition and Enterprise Edition
17+
## GraalVM Community Edition and Oracle GraalVM
1818

19-
GraalVM is available in a Community Edition, which is open-source, and an Enterprise Edition which has better performance and scalability.
19+
GraalVM is available in a Community Edition, which is open-source, and [Oracle GraalVM](https://www.oracle.com/graalvm/) which has better performance, footprint and scalability.
2020
See [the website](https://www.graalvm.org/downloads) for a comparison.
2121

2222
## Installing the Base Image
@@ -25,9 +25,9 @@ GraalVM starts with a base image which provides the platform for high-performanc
2525

2626
The Community Edition base image can be installed [from GitHub](https://www.graalvm.org/downloads), under an open source licence.
2727

28-
The Enterprise Edition base image can be installed from [Oracle Downloads](https://www.oracle.com/downloads/graalvm-downloads.html) page by accepting the Oracle License Agreement.
28+
Install the Oracle GraalVM base image from the [Oracle Downloads](https://www.oracle.com/downloads/graalvm-downloads.html) page by accepting the Oracle License Agreement.
2929

30-
Nightly builds of the GraalVM Community Edition are [also available](https://github.com/graalvm/graalvm-ce-dev-builds/releases).
30+
GraalVM Community Developer Builds are [also available](https://github.com/graalvm/graalvm-ce-dev-builds/releases).
3131

3232
Whichever edition you choose, you will obtain a tarball which you can extract.
3333
There will be a `bin` directory (`Contents/Home/bin` on macOS) which you can add to your `$PATH` if you want to.
@@ -54,8 +54,8 @@ The path of the script will be:
5454
languages/ruby/lib/truffle/post_install_hook.sh
5555
```
5656

57-
You can also download the latest Ruby component (`ruby-installable-...`) manually from [GitHub](https://github.com/oracle/truffleruby/releases/latest) (CE)
58-
or from [Oracle Downloads](https://www.oracle.com/downloads/graalvm-downloads.html) (EE).
57+
You can also download the latest Ruby component (`ruby-installable-...`) manually from [GitHub](https://github.com/oracle/truffleruby/releases/latest) for GraalVM CE
58+
or from [Oracle Downloads](https://www.oracle.com/downloads/graalvm-downloads.html) for Oracle GraalVM.
5959
Then install it with `gu install --file path/to/ruby-installable-...`.
6060

6161
## Using a Ruby Manager

doc/user/reporting-performance-problems.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ are not needed or loops that contain no work.
2323

2424
All of these issues make it hard to benchmark TruffleRuby. This is not a problem that is unique to us - it applies to many sophisticated virtual machines - but most Ruby implementations are not yet performing optimizations powerful enough to show these problems, so they may be new to some people in the Ruby community.
2525

26-
## Using the Enterprise Edition of GraalVM
26+
## Using Oracle GraalVM
2727

28-
To experiment with how fast TruffleRuby can be, we recommend using the [Enterprise Edition of GraalVM](installing-graalvm.md).
28+
To experiment with how fast TruffleRuby can be, use [Oracle GraalVM](installing-graalvm.md).
2929

3030
## Using the JVM Configuration
3131

mx.truffleruby/env_files.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Here is how the various env files relate to each other:
22
* `jvm`
3-
* `jvm-ce`: + Graal CE
3+
* `jvm-ce`: + GraalVM CE Compiler
44
* `jvm-ce-ntl`: + native toolchain launchers
55
* `jvm-ce-libgraal`: + libgraal
66
* `native`: + librubyvm
7-
* `jvm-ee`: + Graal EE
7+
* `jvm-ee`: + Oracle GraalVM Compiler
88
* `jvm-ee-ntl`: + native toolchain launchers
99
* `jvm-ee-libgraal`: + libgraal
1010
* `native-ee`: + librubyvm

spec/truffle/identity_spec.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@
3838

3939
guard -> { !TruffleRuby.native? } do
4040
it "RUBY_DESCRIPTION indicates which VM TruffleRuby runs on and which edition" do
41-
RUBY_DESCRIPTION.should =~ /\b(Interpreted|GraalVM CE|GraalVM EE|Oracle GraalVM) JVM\b/
41+
RUBY_DESCRIPTION.should =~ /\b(Interpreted|GraalVM CE|Oracle GraalVM) JVM\b/
4242
RUBY_DESCRIPTION.should_not include("Native")
4343
RUBY_DESCRIPTION.should_not include("native")
4444
end
4545
end
4646

4747
guard -> { TruffleRuby.native? } do
4848
it "RUBY_DESCRIPTION indicates TruffleRuby runs on SVM and which edition" do
49-
RUBY_DESCRIPTION.should =~ /\b(GraalVM CE|GraalVM EE|Oracle GraalVM) Native\b/
49+
RUBY_DESCRIPTION.should =~ /\b(GraalVM CE|Oracle GraalVM) Native\b/
5050
RUBY_DESCRIPTION.should_not include("JVM")
5151
end
5252
end

spec/truffle/launcher_spec.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -440,29 +440,29 @@ def should_print_full_java_command(options, env: {})
440440
out = ruby_exe('puts RUBY_DESCRIPTION; puts Truffle::System.get_java_property("foo")', env: env, args: @redirect)
441441
check_status_and_empty_stderr
442442
out = out.lines.map(&:chomp)
443-
out[0].should =~ /(GraalVM CE|GraalVM EE|Oracle GraalVM) JVM/
443+
out[0].should =~ /(GraalVM CE|Oracle GraalVM) JVM/
444444
out[1].should == 'bar'
445445
end
446446
end
447447

448448
it "uses --native by default" do
449449
out = ruby_exe(nil, options: "--version", args: @redirect)
450450
check_status_and_empty_stderr
451-
out.should =~ /(GraalVM CE|GraalVM EE|Oracle GraalVM) Native/
451+
out.should =~ /(GraalVM CE|Oracle GraalVM) Native/
452452
end
453453

454454
it "switches to JVM with --jvm as a Ruby argument" do
455455
out = ruby_exe(nil, options: "--jvm #{@ignore_jvm_thread_warnings} --version", args: @redirect)
456456
check_status_and_empty_stderr
457-
out.should =~ /(GraalVM CE|GraalVM EE|Oracle GraalVM) JVM/
457+
out.should =~ /(GraalVM CE|Oracle GraalVM) JVM/
458458
end
459459

460460
it "keeps --jvm as an application argument if given as an application argument" do
461461
script = fixture(__FILE__, "argv.rb")
462462
out = ruby_exe(nil, options: "-v", args: "#{script} --jvm 1 2 #{@redirect}")
463463
check_status_and_empty_stderr
464464
out = out.lines.map(&:chomp)
465-
out[0].should =~ /(GraalVM CE|GraalVM EE|Oracle GraalVM) Native/
465+
out[0].should =~ /(GraalVM CE|Oracle GraalVM) Native/
466466
out.should.include?('["--jvm", "1", "2"]')
467467
end
468468
end

0 commit comments

Comments
 (0)