projects / mono.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
2009-05-01 Sebastien Pouliot <sebastien@ximian.com>
[mono.git] / README
diff --git a/README b/README
index 66e1bb51eef80a934fb7a2df268b7aa797edb2bf..d436e14e7936b0b22c87807cd5980c6590a4b858 100644 (file)
--- a/README
+++ b/README
@@ -52,8 +52,8 @@ This is Mono.
                make
                make install
 
                make
                make install
 
-       Mono supports a JIT engine on x86, SPARC, SPARCv9, S/390, AMD64, ARM
-       and PowerPC systems.
+       Mono supports a JIT engine on x86, SPARC, SPARCv9, S/390,
+       S/390x, AMD64, ARM and PowerPC systems.   
 
        If you obtained this as a snapshot, you will need an existing
        Mono installation.  To upgrade your installation, unpack both
 
        If you obtained this as a snapshot, you will need an existing
        Mono installation.  To upgrade your installation, unpack both
@@ -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
     ---------------------------------
 
@@ -133,7 +141,7 @@ This is Mono.
        also try passing EXTERNAL_MCS=false on the make command-line.
 
        Testing and Installation
        also try passing EXTERNAL_MCS=false on the make command-line.
 
        Testing and Installation
-        ------------------------
+       ------------------------
 
        You can run (part of) the mono and mcs testsuites with the command:
 
 
        You can run (part of) the mono and mcs testsuites with the command:
 
@@ -224,7 +232,7 @@ This is Mono.
                systems do not support this feature, or you might want
                to override the auto-detection.
 
                systems do not support this feature, or you might want
                to override the auto-detection.
 
-       --with-static-mono=yes,no
+       --with-static_mono=yes,no
 
                This controls whether `mono' should link against a
                static library (libmono.a) or a shared library
 
                This controls whether `mono' should link against a
                static library (libmono.a) or a shared library
@@ -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 libraries that are still not
-               completed (The 2.0 APIs).   It defaults to `yes'.
+               Whether you want to build the 2.x libraries (support
+               for Generics and the 2.0/3.5 APIS).
+
+               It defaults to `yes'.
 
        --with-moonlight=yes,no
 
 
        --with-moonlight=yes,no
 
@@ -271,7 +281,7 @@ 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.
 
@@ -314,42 +324,90 @@ 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
+               than Int32.MaxValue.   
+
+               By default Mono has the same limitation as .NET on
+               Win32 and Win64 and limits array indexes to 32-bit
+               values (even on 64-bit systems).
+
+               In certain scenarios where large arrays are required,
+               you can pass this flag and Mono will be built to
+               support 64-bit arrays.
+
+               This is not the default as it breaks the C embedding
+               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
+               runtime that contains DTrace probes and can
+               participate in the system profiling using DTrace.
+
+
        --disable-dev-random
 
                Mono uses /dev/random to obtain good random data for
        --disable-dev-random
 
                Mono uses /dev/random to obtain good random data for
@@ -423,6 +481,11 @@ This is Mono.
 
                Manual pages for the various Mono commands and programs.
 
 
                Manual pages for the various Mono commands and programs.
 
+       samples/
+
+               Some simple sample programs on uses of the Mono
+               runtime as an embedded library.   
+
        scripts/
 
                Scripts used to invoke Mono and the corresponding program.
        scripts/
 
                Scripts used to invoke Mono and the corresponding program.
@@ -432,3 +495,9 @@ This is Mono.
                A directory that contains the Makefiles that link the
                mono/ and mcs/ build systems.
 
                A directory that contains the Makefiles that link the
                mono/ and mcs/ build systems.
 
+       ../olive/
+
+               If the directory ../olive is present (as an
+               independent checkout) from the Mono module, that
+               directory is automatically configured to share the
+               same prefix than this module gets.
my mono mirror. check out Moved to http://github.com/mono/mono