[m-rev.] for review: improve documentation for non-C backends
Julien Fischer
jfischer at opturion.com
Fri May 24 16:49:04 AEST 2013
For review by anyone
Branches: 13.05, master
-----------------------
Documentation improvements for non-C backends.
README.CSharp:
Delete the note about the C# backend being an experimental feature.
Add a paragraph describing the situation with different versions
of the .NET libraries on Mono.
Emphasise that you must use mmc --make with the C# backend.
README.Java:
Delete the note about the Java backend being an experimental feature.
Emphasise that you must use mmc --make with the Java backend.
README.Erlang:
Emphasise that you must use mmc --make with the Erlang backend.
configure.ac:
Reword the documentation of --with-csharp-compiler.
Julien.
diff --git a/README.CSharp b/README.CSharp
index 5c73329..e97a60e 100644
--- a/README.CSharp
+++ b/README.CSharp
@@ -22,9 +22,23 @@ In order to try this system you will need
- Either Microsoft.NET or Mono 2.8 or above.
-WARNING
-Please note that the C# backend is still an experimental feature.
+VERSIONS OF THE .NET FRAMEWORK ON MONO
+
+On Mono, the C# compiler has a number of aliases: gmcs, mcs, dmcs. The alias
+with which the C# compiler is invoked controls which version of the .NET
+frameworks is used by default. For Mono 2.8, the defaults are:
+
+ gmcs - .NET version 2.0
+ dmcs - .NET version 4.0
+ mcs - .NET version 2.0
+
+You can specify what C# compiler Mercury should use at configuration time using
+configure's `--with-csharp-compiler' option. The output from the configure
+script will report which version of the .NET framework is going be used, for
+example:
+
+ checking version of .NET libraries... 4.0.0.0
-----------------------------------------------------------------------------
@@ -43,6 +57,9 @@ directory.
cd samples
mmc --make --csharp hello
+Note that when building programs using the csharp grade you *must* use
+mmc --make.
+
-----------------------------------------------------------------------------
RUNNING C# GRADE PROGRAMS ON UNIX WITH MONO
diff --git a/README.Erlang b/README.Erlang
index 0d2b242..65b8c72 100644
--- a/README.Erlang
+++ b/README.Erlang
@@ -70,6 +70,9 @@ directory.
cd samples
mmc --make --erlang hello
+Note that when building programs using the erlang grade you *must* use
+mmc --make.
+
Now you can run hello
./hello
diff --git a/README.Java b/README.Java
index 72a3b95..ac1ec51 100644
--- a/README.Java
+++ b/README.Java
@@ -21,11 +21,6 @@ In order to try this system you will need
OR any other compatible Java implementation.
-WARNING
-
-Please note that the Java backend is still an experimental feature.
-It works quite well now but is not as mature as the C backends.
-
-----------------------------------------------------------------------------
THE JAVA GRADE
@@ -43,6 +38,9 @@ directory.
cd samples
mmc --make --java hello
+Note that when building programs using the java grade you *must* use
+mmc --make.
+
Now you can run hello
./hello
diff --git a/configure.ac b/configure.ac
index 415b69f..7022638 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1158,7 +1158,7 @@ AC_SUBST(MATH_LIB)
AC_ARG_WITH(csharp-compiler,
AC_HELP_STRING([--with-csharp-compiler=<compiler>],
- [Specify which C Sharp compiler should be used (default:
+ [Specify which C Sharp compiler to use (default:
autodetect)]),
mercury_cv_with_csharp_compiler="$withval",
mercury_cv_with_csharp_compiler="")
More information about the reviews
mailing list