[m-rev.] diff: fix bug#261: building the compiler in non-C grades
Julien Fischer
jfischer at opturion.com
Mon Jan 7 16:46:07 AEDT 2013
This has already been reviewed by in-person by Ian.
(Also, I don't intend to fix the issue with Mmake.workspace for now --
I will add a new entry to Mantis for that.)
-----------------------------------------------------------------------------------------------
Fix bug #261: document how to build the compiler in non-C grades.
README.CSharp:
README.Java:
README.Erlang:
Document how to build the Mercury compiler using the non-C grades.
Julien.
diff --git a/README.CSharp b/README.CSharp
index c1a2b59..01e8561 100644
--- a/README.CSharp
+++ b/README.CSharp
@@ -125,6 +125,37 @@ Language Reference Manual, which you can find at:
-----------------------------------------------------------------------------
+BUILDING THE MERCURY COMPILER IN THE C# GRADE
+
+Building the Mercury compiler and other related tools in the C# grade
+is NOT generally supported and should be considered experimental.
+In particular, a Mercury compiler built in the C# grade may be slower than
+normal and some features may not be available.
+
+However, if you want to give it a try, the required steps are:
+
+(1) Ensure that you have an existing working Mercury compiler in your PATH
+and a clean version of the Mercury source tree.
+
+(2) Run aclocal -I m4; autoconf; ./configure as normal.
+
+(4) Add the line:
+
+ GRADE=csharp
+
+ to a file named Mmake.params at the top-level of the source tree.
+
+(5) Begin the build process using the following command:
+
+ $ mmake --use-mmc-make GRADE=csharp
+
+The C# version of the compiler MUST be built using mmake's --use-mmc-make
+option; the build will not work otherwise. Setting the variable GRADE in the
+invocation of mmake is currently necesary in order to avoid some variable
+definition ordering problems in Mmake.workspace.
+
+-----------------------------------------------------------------------------
+
FREQUENTLY ASKED QUESTIONS (FAQS)
Q. What are the advantages of using the C# back-end?
diff --git a/README.Erlang b/README.Erlang
index c968ce4..a745b78 100644
--- a/README.Erlang
+++ b/README.Erlang
@@ -101,6 +101,37 @@ Language Reference Manual, which you can find at:
-----------------------------------------------------------------------------
+BUILDING THE MERCURY COMPILER IN THE ERLANG GRADE
+
+Building the Mercury compiler and other related tools in the Erlang grade
+is NOT generally supported and should be considered experimental.
+In particular, a Mercury compiler built in the Erlang grade may be slower than
+normal and some features may not be available.
+
+However, if you want to give it a try, the required steps are:
+
+(1) Ensure that you have an existing working Mercury compiler in your PATH
+and a clean version of the Mercury source tree.
+
+(2) Run aclocal -I m4; autoconf; ./configure as normal.
+
+(4) Add the line:
+
+ GRADE=erlang
+
+ to a file named Mmake.params at the top-level of the source tree.
+
+(5) Begin the build process using the following command:
+
+ $ mmake --use-mmc-make GRADE=erlang
+
+The Erlang version of the compiler MUST be built using mmake's --use-mmc-make
+option; the build will not work otherwise. Setting the variable GRADE in the
+invocation of mmake is currently necesary in order to avoid some variable
+definition ordering problems in Mmake.workspace.
+
+-----------------------------------------------------------------------------
+
PERFORMANCE NOTES
The Erlang code generated by the Mercury compiler is designed to be compiled
diff --git a/README.Java b/README.Java
index 989633f..5f8cdf2 100644
--- a/README.Java
+++ b/README.Java
@@ -97,6 +97,37 @@ Java compiler, but we haven't tried that yet.
-----------------------------------------------------------------------------
+BUILDING THE MERCURY COMPILER IN THE JAVA GRADE
+
+Building the Mercury compiler and other related tools in the Java grade
+is NOT generally supported and should be considered experimental.
+In particular, a Mercury compiler built in the Java grade may be slower than
+normal and some features may not be available.
+
+However, if you want to give it a try, the required steps are:
+
+(1) Ensure that you have an existing working Mercury compiler in your PATH
+and a clean version of the Mercury source tree.
+
+(2) Run aclocal -I m4; autoconf; ./configure as normal.
+
+(4) Add the line:
+
+ GRADE=java
+
+ to a file named Mmake.params at the top-level of the source tree.
+
+(5) Begin the build process using the following command:
+
+ $ mmake --use-mmc-make GRADE=java
+
+The Java version of the compiler MUST be built using mmake's --use-mmc-make
+option; the build will not work otherwise. Setting the variable GRADE in the
+invocation of mmake is currently necesary in order to avoid some variable
+definition ordering problems in Mmake.workspace.
+
+-----------------------------------------------------------------------------
+
RESOURCES
You might find the following pages useful:
More information about the reviews
mailing list