2009-05-04 Zoltan Varga <vargaz@gmail.com>
[mono.git] / README
diff --git a/README b/README
index 188ca1ad94a627139daabafe35db53b6b598516c..d436e14e7936b0b22c87807cd5980c6590a4b858 100644 (file)
--- a/README
+++ b/README
@@ -67,6 +67,14 @@ This is Mono.
                ./autogen.sh --prefix=/usr/local
                make
 
                ./autogen.sh --prefix=/usr/local
                make
 
+       The Mono build system is silent for most compilation commands.
+       To enable a more verbose compile (for example, to pinpoint
+       problems in your makefiles or your system) pass the V=1 flag to make, like this:
+
+                make V=1
+
+
+
     c. Building the software from SVN
     ---------------------------------
 
     c. Building the software from SVN
     ---------------------------------
 
@@ -259,10 +267,12 @@ This is Mono.
 
                This defaults to `yes'.
 
 
                This defaults to `yes'.
 
-       --with-preview=yes,no
+       --with-profile2=yes,no
+
+               Whether you want to build the 2.x libraries (support
+               for Generics and the 2.0/3.5 APIS).
 
 
-               Whether you want to build libraries that are still not
-               completed (The 2.0 APIs).   It defaults to `yes'.
+               It defaults to `yes'.
 
        --with-moonlight=yes,no
 
 
        --with-moonlight=yes,no
 
@@ -271,12 +281,10 @@ This is Mono.
                (1.1 and 2.0 APIs).
 
                This will produce the `smcs' compiler which will reference
                (1.1 and 2.0 APIs).
 
                This will produce the `smcs' compiler which will reference
-               the Silvelright modified assemblies (mscorlib.dll,
+               the Silverlight modified assemblies (mscorlib.dll,
                System.dll, System.Code.dll and System.Xml.Core.dll) and turn
                on the LINQ extensions for the compiler.
 
                System.dll, System.Code.dll and System.Xml.Core.dll) and turn
                on the LINQ extensions for the compiler.
 
-               This option defaults to `no' and it is considered pre-alpha.
-
        --with-libgdiplus=installed,sibling,<path>
 
                This is used to configure where should Mono look for
        --with-libgdiplus=installed,sibling,<path>
 
                This is used to configure where should Mono look for
@@ -316,42 +324,57 @@ This is Mono.
                        Disables support for the Ahead of Time
                        compilation.
 
                        Disables support for the Ahead of Time
                        compilation.
 
-               profiler:
-                       Disables support for the default profiler.
+               com:
+                       Disables COM support.
+
+               debug:
+                       Drop debugging support.
 
                decimal:
                        Disables support for System.Decimal.
 
 
                decimal:
                        Disables support for System.Decimal.
 
+               generics:
+                       Generics support.  Disabling this will not
+                       allow Mono to run any 2.0 libraries or
+                       code that contains generics.
+
+               jit:
+                       Removes the JIT engine from the build, this reduces
+                       the executable size, and requires that all code
+                       executed by the virtual machine be compiled with
+                       Full AOT before execution.
+
+               large_code:
+                       Disables support for large assemblies.
+
+               logging:
+                       Disables support for debug logging.
+
                pinvoke:
                        Support for Platform Invocation services,
                        disabling this will drop support for any
                        libraries using DllImport.
 
                pinvoke:
                        Support for Platform Invocation services,
                        disabling this will drop support for any
                        libraries using DllImport.
 
-               debug:
-                       Drop debugging support.
+               profiler:
+                       Disables support for the default profiler.
 
                reflection_emit:
                        Drop System.Reflection.Emit support
 
 
                reflection_emit:
                        Drop System.Reflection.Emit support
 
-               large_code:
-                       Disables support for large assemblies.
+               reflection_emit_save:
+                       Drop support for saving dynamically created
+                       assemblies (AssemblyBuilderAccess.Save) in
+                       System.Reflection.Emit.
 
 
-               logging:
-                       Disables support for debug logging.
-
-               com:
-                       Disables COM support.
+               simd:
+                       Disables support for the Mono.SIMD intrinsics
+                       library.
 
                ssa:
                        Disables compilation for the SSA optimization
                        framework, and the various SSA-based
                        optimizations.
 
 
                ssa:
                        Disables compilation for the SSA optimization
                        framework, and the various SSA-based
                        optimizations.
 
-               generics:
-                       Generics support.  Disabling this will not
-                       allow Mono to run any 2.0 libraries or
-                       code that contains generics.
-               
        --enable-big-arrays
 
                This enables the use arrays whose indexes are larger
        --enable-big-arrays
 
                This enables the use arrays whose indexes are larger
@@ -369,6 +392,15 @@ This is Mono.
                ABI that we have exposed through the Mono development
                cycle.
 
                ABI that we have exposed through the Mono development
                cycle.
 
+       --enable-parallel-mark
+
+               Use this option to enable the garbage collector to use
+               multiple CPUs to do its work.  This helps performance
+               on multi-CPU machines as the work is divided across CPUS.
+
+               This option is not currently the default as we have
+               not done much testing with Mono.
+
        --enable-dtrace
 
                On Solaris and MacOS X builds a version of the Mono
        --enable-dtrace
 
                On Solaris and MacOS X builds a version of the Mono