Skip to content

Commit df2d4ef

Browse files
ScalaWilliammuuki88
authored andcommitted
Improve the GraalVM native-image documentation (#1168)
1. I was unable to see the documentatoin in the table of contents 2. GraalVM native-image plugin should be in the diagram 3. Added quickstart steps for GraalVM by reusing our Travis installer.
1 parent 8743788 commit df2d4ef

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

src/sphinx/formats/graalvm-native-image.rst

+11
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,17 @@ Requirements
1212

1313
You must have ``native-image`` of GraalVM in your ``PATH``.
1414

15+
Quick installation
16+
~~~~~~~~~~~~~~~~~~
17+
18+
To get started quickly, eg make ``native-image`` available in your ``PATH``,
19+
you may reuse the script that is used for sbt-native-packager's continuous integration.
20+
To do so, run the following. It will install GraalVM 1.0.0-rc8.
21+
22+
.. code-block:: bash
23+
24+
source <(curl -o - https://raw.githubusercontent.com/sbt/sbt-native-packager/6e1ee230350ce86c37b39c75f35718ac4a7f0a26/.travis/download-graalvm)
25+
1526
Build
1627
-----
1728

src/sphinx/formats/index.rst

+7-6
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ existing functionality. Currently the autoplugin hierarchy looks like this ::
1010
+
1111
|
1212
|
13-
+-------+ Universal +--------+-------------+
14-
| + | |
15-
| | | |
16-
| | | |
17-
+ + + +
18-
Docker +-+ Linux +-+ Windows JDKPackager
13+
+-------+ Universal +--------+-------------+----------------+
14+
| + | | |
15+
| | | | |
16+
| | | | |
17+
+ + + + +
18+
Docker +-+ Linux +-+ Windows JDKPackager GraalVM native-image
1919
| |
2020
| |
2121
+ +
@@ -49,3 +49,4 @@ To learn more about a specific plugin, read the appropriate doc.
4949
docker.rst
5050
windows.rst
5151
jdkpackager.rst
52+
graalvm-native-image.rst

0 commit comments

Comments
 (0)