Skip to content

Commit

Permalink
Move Truffle documentation to docs/truffle-framework
Browse files Browse the repository at this point in the history
  • Loading branch information
olyagpl committed Jun 7, 2021
1 parent 3c5a1f3 commit f3fbe8c
Show file tree
Hide file tree
Showing 28 changed files with 12 additions and 4,003 deletions.
2 changes: 1 addition & 1 deletion docs/reference-manual/native-image/BuildConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ redirect_from:
- /docs/reference-manual/native-image/Configuration/
- /reference-manual/native-image/Configuration/
next: /en/graalvm/enterprise/21/docs/reference-manual/native-image/Limitations/
previous: /en/graalvm/enterprise/21/docs/reference-manual/enterprise-native-image/
previous: /en/graalvm/enterprise/21/docs/reference-manual/native-image/
---
# Native Image Build Configuration

Expand Down
4 changes: 2 additions & 2 deletions docs/reference-manual/native-image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ permalink: /reference-manual/native-image/
redirect_from:
- /docs/reference-manual/aot-compilation/
- /docs/reference-manual/native-image/
next: /en/graalvm/enterprise/21/docs/reference-manual/native-image/SubstrateVM/
previous: /en/graalvm/enterprise/21/docs/reference-manual/graalvm-updater/
next: /en/graalvm/enterprise/21/docs/reference-manual/native-image/Configuration/
previous: /en/graalvm/enterprise/21/docs/reference-manual/
---
# Native Image

Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,6 @@
---
layout: docs
toc_group: native-image
title: Substrate VM Project
link_title: Substrate VM Project
permalink: /reference-manual/native-image/SubstrateVM/
redirect_from: /docs/reference-manual/native-image/SubstrateVM/
next: /en/graalvm/enterprise/21/docs/reference-manual/native-image/Configuration/
previous: /en/graalvm/enterprise/21/docs/reference-manual/enterprise-native-image/
---
# The Substrate VM Project

Substrate VM is an internal project
name for the technology behind [GraalVM Native Image](README.md).
Substrate VM is an internal project name for the technology behind [GraalVM Native Image](../docs/reference-manual/native-image/README.md).
This guide shows how to set up a development environment for the project.

To get started, install [mx](https://github.com/graalvm/mx).
Expand Down Expand Up @@ -77,7 +66,7 @@ mx native-image HelloWorld -H:Dump= -H:MethodFilter=HelloWorld.*

## Options

More information about options and the important distinction between hosted and runtime options is available [here](Options.md).
More information about options and the important distinction between hosted and runtime options is available [here](../docs/reference-manual/native-image/Options.md).

## Project Structure

Expand All @@ -86,7 +75,7 @@ Instead, a new project is created by adding it in `suite.py` and running `mx ide

## Code Formatting

Style rules and procedures for checking adherence are described in the [style guide](CodeStyle.md).
Style rules and procedures for checking adherence are described in the [style guide](../docs/reference-manual/native-image/CodeStyle.md).

## Troubleshooting Eclipse

Expand All @@ -103,6 +92,10 @@ following should reset everything:
* `mx ideinit`
* Import all projects into Eclipse again

## Usage Documentation

The documentation on how to use Native Image is available [here](../docs/reference-manual/native-image/README.md) or [on the website](https://www.graalvm.org/reference-manual/native-image/).

## License

The Substrate VM project is licensed under the GPL 2 with Classpath Exception.
4 changes: 1 addition & 3 deletions sulong/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ Sulong is part of [GraalVM](https://www.graalvm.org). If you are a user of Graal
to run C/C++/... programs on GraalVM, we recommend downloading a pre-built binary of
[GraalVM](https://www.graalvm.org/downloads).

See [GraalVM LLVM Runtime](docs/user/README.md) and [graalvm.org](https://www.graalvm.org) for
documentation about using the GraalVM LLVM runtime.

See [GraalVM LLVM Runtime](../docs/reference-manual/llvm/README.md) and [graalvm.org](https://www.graalvm.org/reference-manual/llvm/) for documentation about using the GraalVM LLVM runtime.

# Contributor Documentation

Expand Down
2 changes: 1 addition & 1 deletion truffle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Software of the Johannes Kepler University Linz.

## Using Truffle

If you are looking for documentation on how to use truffle, please consult the [user documentation](docs/README.md).
If you are looking for documentation on how to use Truffle, please consult the documentation [here](../docs/truffle-framework/README.md) or [on the website](https://www.graalvm.org/graalvm-as-a-platform/language-implementation-framework/).

## Hacking Truffle

Expand Down
33 changes: 0 additions & 33 deletions truffle/docs/AOT.md

This file was deleted.

88 changes: 0 additions & 88 deletions truffle/docs/AOTOverview.md

This file was deleted.

Loading

0 comments on commit f3fbe8c

Please sign in to comment.