changeset 13962:258a09b6449b

Change AUTHORS, CHANGELOG, and README file from HTML to Markdown.
author Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
date Thu, 06 Feb 2014 14:50:36 +0100
parents 4c2f5b7deb6c
children dff4ff4d40c8
files AUTHORS.html AUTHORS.md CHANGELOG.html CHANGELOG.md README.html README.md
diffstat 6 files changed, 126 insertions(+), 142 deletions(-) [+]
line wrap: on
line diff
--- a/AUTHORS.html	Wed Feb 05 14:59:55 2014 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,27 +0,0 @@
-<h2>Graal Authors</h2>
-
-The GraalVM is based on the source code of HotSpot. The following authors have contributed to the Graal-specific part of the source base:
-
-<ul>
-<li>Tom Deneau (tdeneau)</li>
-<li>Gilles Duboscq (gdub)</li>
-<li>Matthias Grimmer (mgrimmer)</li>
-<li>Peter Hofer</li>
-<li>Christian Haeubl (chaeubl)</li>
-<li>Michael Haupt (mhaupt)</li>
-<li>Christian Humer (chumer)</li>
-<li>Morris Meyer (morris)</li>
-<li>Roland Schatz</li>
-<li>Doug Simon (dnsimon)</li>
-<li>Lukas Stadler (lstadler)</li>
-<li>Roland Schatz (rschatz)</li>
-<li>Alexander Stipsits</li>
-<li>Katrin Strassl</li>
-<li>Christian Thalinger (twisti)</li>
-<li>Vasanth Venkatachalam (vvenkat)</li>
-<li>Christian Wimmer (cwimmer)</li>
-<li>Christian Wirth (cwirth)</li>
-<li>Andreas Woess (aw)</li>
-<li>Thomas Wuerthinger (thomaswue)</li>
-<li>Bharadwaj Yadavalli (bharadwaj)</li>	
-</ul>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/AUTHORS.md	Thu Feb 06 14:50:36 2014 +0100
@@ -0,0 +1,25 @@
+# Graal Authors
+
+The GraalVM is based on the source code of HotSpot. The following authors have contributed to the Graal-specific part of the source base:
+
+* Tom Deneau (tdeneau)
+* Gilles Duboscq (gdub)
+* Matthias Grimmer (mgrimmer)
+* Peter Hofer
+* Christian Haeubl (chaeubl)
+* Michael Haupt (mhaupt)
+* Christian Humer (chumer)
+* Morris Meyer (morris)
+* Roland Schatz
+* Doug Simon (dnsimon)
+* Lukas Stadler (lstadler)
+* Roland Schatz (rschatz)
+* Alexander Stipsits
+* Katrin Strassl
+* Christian Thalinger (twisti)
+* Vasanth Venkatachalam (vvenkat)
+* Christian Wimmer (cwimmer)
+* Christian Wirth (cwirth)
+* Andreas Woess (aw)
+* Thomas Wuerthinger (thomaswue)
+* Bharadwaj Yadavalli (bharadwaj)
--- a/CHANGELOG.html	Wed Feb 05 14:59:55 2014 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,34 +0,0 @@
-<h1>GraalVM Changelog</h1>
-
-<h2>Tip</h2>
-<ul>
-<li>
-<b>Graal</b>
-<ul>
-<li>...</li>
-</ul>
-</li>
-<li>
-<b>Truffle</b>
-<ul>
-<li>...</li>
-</ul>
-</li></ul>
-<h2>Version 0.1</h2>
-<ul>
-<li>
-<b>Graal</b>
-<ul>
-<li>Initial version of a dynamic Java compiler written in Java.</li>
-<li>Support for multiple co-existing GPU backends (<a href="https://bugs.openjdk.java.net/browse/GRAAL-1">GRAAL-1</a>).</li>
-<li>Fixed a compiler bug when running RuneScape (<a href="https://bugs.openjdk.java.net/browse/GRAAL-7">GRAAL-7</a>).</li>
-<li>Bug fixes (<a href="https://bugs.openjdk.java.net/browse/GRAAL-4">GRAAL-4</a>, <a href="https://bugs.openjdk.java.net/browse/GRAAL-5">GRAAL-5</a>).</li>
-</ul>
-</li>
-<li>
-<b>Truffle</b>
-<ul>
-<li>Initial version of a multi-language framework on top of Graal. </li>
-<li>Update of the <a href="http://mail.openjdk.java.net/pipermail/graal-dev/2014-January/001516.html">Truffle inlining API</a>.</li>
-</ul>
-</li></ul>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/CHANGELOG.md	Thu Feb 06 14:50:36 2014 +0100
@@ -0,0 +1,19 @@
+# GraalVM Changelog
+
+## Tip
+
+* Graal
+  * ...
+* Truffle
+  * ...
+
+## Version 0.1
+5-Feb-2014, [Repository Revision](http://hg.openjdk.java.net/graal/graal/rev/b124e22eb772)
+* Graal
+  * Initial version of a dynamic Java compiler written in Java.
+  * Support for multiple co-existing GPU backends ([GRAAL-1](https://bugs.openjdk.java.net/browse/GRAAL-1)).
+  * Fixed a compiler bug when running RuneScape ([Graal-7](https://bugs.openjdk.java.net/browse/GRAAL-7)).
+  * Bug fixes ([GRAAL-4](https://bugs.openjdk.java.net/browse/GRAAL-4), [GRAAL-5](https://bugs.openjdk.java.net/browse/GRAAL-5)).
+* Truffle
+  * Initial version of a multi-language framework on top of Graal.
+  * Update of the [Truffle inlining API](http://mail.openjdk.java.net/pipermail/graal-dev/2014-January/001516.html).
--- a/README.html	Wed Feb 05 14:59:55 2014 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,81 +0,0 @@
-<h2>Building Graal</h2>
-<p>There is a Python script in mxtool/mx.py that simplifies working with the code
-base. It requires Python 2.7. While you can run this script by using an absolute path,
-it's more convenient to add graal/mxtool to your PATH environment variable so that the
-'mx' helper script can be used. The following instructions in this file assume this
-setup.</p>
-
-<p>Building both the Java and C++ source code comprising the Graal VM
-can be done with the following simple command.</p>
-
-<pre>
-% mx build
-</pre>
-
-<p>There are a number of VM configurations supported by mx which can
-be explicitly specified using the --vm option. However, you'll typically
-want one of these VM configurations:</p>
-
-<ol>
-<li> The 'server' configuration is a standard HotSpot VM that includes the
-   runtime support for Graal but uses the existing compilers for normal
-   compilation (e.g., when the interpreter threshold is hit for a method).
-   Compilation with Graal is only done by explicit requests to the
-   Graal API. This is how Truffle uses Graal.</li>
-   
-<li> The 'graal' configuration is a VM where all compilation is performed
-   by Graal and no other compilers are built into the VM binary. This
-   VM will bootstrap Graal itself at startup unless the -XX:-BootstrapGraal
-   VM option is given.   </li>
-</ol>
-
-<p>Unless you use the --vm option with the build command, you will be presented
-with a dialogue to choose one of the above VM configurations for the build
-as well as have the option to make it your default for subsequent commands
-that need a VM specified.</p>
-
-<p>To build the debug or fastdebug builds:</p>
-
-<pre>
-% mx --vmbuild debug build
-% mx --vmbuild fastdebug build
-</pre>
-
-<h2>Running Graal</h2>
-
-<p>To run the VM, use 'mx vm' in place of the standard 'java' command:</p>
-
-<pre>
-% mx vm ...
-</pre>
-
-<p>To select the fastdebug or debug builds of the VM:</p>
-
-<pre>
-% mx --vmbuild fastdebug vm ...
-% mx --vmbuild debug vm ...
-</pre>
-
-<h2>Other VM Configurations</h2>
-
-<p>In addition to the VM configurations described above, there are
-VM configurations that omit all VM support for Graal:</p>
-
-<pre>
-% mx --vm server-nograal build
-% mx --vm server-nograal vm -version
-java version "1.7.0_25"
-Java(TM) SE Runtime Environment (build 1.7.0_25-b15)
-OpenJDK 64-Bit Server VM (build 25.0-b43-internal, mixed mode)
-</pre>
-
-<pre>
-% mx --vm client-nograal build
-% mx --vm client-nograal vm -version
-java version "1.7.0_25"
-Java(TM) SE Runtime Environment (build 1.7.0_25-b15)
-OpenJDK 64-Bit Cleint VM (build 25.0-b43-internal, mixed mode)
-</pre>
-
-<p>These configurations aim to match as closely as possible the
-VM(s) included in the OpenJDK binaries one can download.</p>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Thu Feb 06 14:50:36 2014 +0100
@@ -0,0 +1,82 @@
+## Building Graal
+
+There is a Python script in mxtool/mx.py that simplifies working with the code
+base. It requires Python 2.7. While you can run this script by using an absolute path,
+it's more convenient to add graal/mxtool to your PATH environment variable so that the
+'mx' helper script can be used. The following instructions in this file assume this
+setup.
+
+Building both the Java and C++ source code comprising the Graal VM
+can be done with the following simple command.
+
+```
+% mx build
+```
+
+There are a number of VM configurations supported by mx which can
+be explicitly specified using the --vm option. However, you'll typically
+want one of these VM configurations:
+
+1. The 'server' configuration is a standard HotSpot VM that includes the
+   runtime support for Graal but uses the existing compilers for normal
+   compilation (e.g., when the interpreter threshold is hit for a method).
+   Compilation with Graal is only done by explicit requests to the
+   Graal API. This is how Truffle uses Graal.
+   
+2. The 'graal' configuration is a VM where all compilation is performed
+   by Graal and no other compilers are built into the VM binary. This
+   VM will bootstrap Graal itself at startup unless the -XX:-BootstrapGraal
+   VM option is given.   
+
+Unless you use the --vm option with the build command, you will be presented
+with a dialogue to choose one of the above VM configurations for the build
+as well as have the option to make it your default for subsequent commands
+that need a VM specified.
+
+To build the debug or fastdebug builds:
+
+```
+% mx --vmbuild debug build
+% mx --vmbuild fastdebug build
+```
+
+## Running Graal
+
+To run the VM, use 'mx vm' in place of the standard 'java' command:
+
+```
+% mx vm ...
+```
+
+To select the fastdebug or debug builds of the VM:
+
+```
+% mx --vmbuild fastdebug vm ...
+% mx --vmbuild debug vm ...
+```
+
+## Other VM Configurations
+
+In addition to the VM configurations described above, there are
+VM configurations that omit all VM support for Graal:
+
+```
+% mx --vm server-nograal build
+% mx --vm server-nograal vm -version
+java version "1.7.0_25"
+Java(TM) SE Runtime Environment (build 1.7.0_25-b15)
+OpenJDK 64-Bit Server VM (build 25.0-b43-internal, mixed mode)
+```
+
+```
+% mx --vm client-nograal build
+% mx --vm client-nograal vm -version
+java version "1.7.0_25"
+Java(TM) SE Runtime Environment (build 1.7.0_25-b15)
+OpenJDK 64-Bit Cleint VM (build 25.0-b43-internal, mixed mode)
+```
+
+These configurations aim to match as closely as possible the
+VM(s) included in the OpenJDK binaries one can download.
+ No newline at end of file
+