| Newsgroups |
gmane.comp.gnome.mono.patches |
| Message-ID |
<0000014206acfca4-b23d8d63-fb0c-43d6-82d1-610c07fb20f3-000000@email.amazonses.com> |
Branch: refs/heads/readmeUpdate
Home: https://github.com/mono/mono
Compare: https://github.com/mono/mono/compare/dc7c8b0f0a98...eef32533b16f
Commit: eef32533b16f366b52f51e957d2ba3b7178f1f56
Author: Therzok <[email protected]> (Therzok)
Date: 2013-10-30 00:02:50 GMT
URL: https://github.com/mono/mono/commit/eef32533b16f366b52f51e957d2ba3b7178f1f56
More?
Changed paths:
M README.md
Modified: README.md
===================================================================
@@ -159,7 +159,7 @@ Mono uses Boehm, while mono-sgen uses the Simple
Generational GC.
* `--with-gc=[boehm, included, sgen, none]` - Selects the default Boehm garbage
-collector engine to use, the default is the "included" value.
+collector engine to use.
* *included*: (*slighty modified Boehm GC*)
This is the default value, and its
@@ -174,7 +174,9 @@ Boehm GC, but we do not recommend that people
use this, as it disables a few features.
* *none*:
-Disables the inclusion of a garbage collector.
+Disables the inclusion of a garbage collector.
+
+ * This defaults to `included`.
* `--with-tls=__thread,pthread`
@@ -197,7 +199,7 @@ reproduce those bugs.
* This controls whether Mono will install a special
signal handler to handle stack overflows. If set to
-"yes", it will turn stack overflows into the
+`yes`, it will turn stack overflows into the
StackOverflowException. Otherwise when a stack
overflow happens, your program will receive a
segmentation fault.
@@ -209,12 +211,12 @@ to override the auto-detection.
* `--with-static_mono=yes,no`
- * This controls whether `mono' should link against a
+ * This controls whether `mono` should link against a
static library (libmono.a) or a shared library
(libmono.so).
- * This defaults to yes, and will improve the performance
-of the `mono' program.
+ * This defaults to `yes`, and will improve the performance
+of the `mono` program.
* This only affects the `mono' binary, the shared
library libmono.so will always be produced for
@@ -230,7 +232,7 @@ faster under the Xen virtualization system.
* `--with-large-heap=yes,no` - Enable support for GC heaps larger than 3GB.
- * This value is set to `no' by default.
+ * This defaults to `no`.
* `--enable-small-config=yes,no`
@@ -241,7 +243,7 @@ maxmimum heap size is also reduced (256 MB) and other such limitations
that still make mono useful, but more suitable to embedded devices
(like mobile phones).
- * This value is set to `no' by default.
+ * This defaults to `no`.
* `--with-ikvm-native=yes,no`
@@ -249,18 +251,18 @@ that still make mono useful, but more suitable to embedded devices
built or not. This is used if you are planning on
using the IKVM Java Virtual machine with Mono.
- * This defaults to `yes'.
+ * This defaults to `yes`.
* `--with-profile4=yes,no`
* Whether you want to build the 4.x profile libraries
and runtime.
- * It defaults to `yes'.
+ * This defaults to `yes`.
* `--with-moonlight=yes,no`
- *Whether you want to generate the Silverlight/Moonlight
+ * Whether you want to generate the Silverlight/Moonlight
libraries and toolchain in addition to the default
(1.1 and 2.0 APIs).
@@ -280,14 +282,12 @@ Selects the new SGen Garbage Collector, which provides
Generational GC support, using the same flags as the
mono-sgen build.
- * This defaults to `boehm'.
-
-* `--with-libgdiplus=installed,sibling,<path>`
+ * This defaults to `boehm`.
- * This is used to configure where should Mono look for
-libgdiplus when running the System.Drawing tests.
+* `--with-libgdiplus=installed,sibling,<path>` - Configure where Mono
+searches for libgdiplus when running System.Drawing tests.
- * It defaults to `installed', which means that the
+ * It defaults to `installed`, which means that the
library is available to Mono through the regular
system setup.
@@ -317,77 +317,77 @@ require a subset of Mono functionality.
* The list is a comma-separated list of components that
should be removed, these are:
- * aot:
+ * `aot`:
Disables support for the Ahead of Time compilation.
- * attach:
+ * `attach`:
Support for the Mono.Management assembly and the
VMAttach API (allowing code to be injected into
a target VM)
- * com:
+ * `com`:
Disables COM support.
- * debug:
+ * `debug`:
Drop debugging support.
- * decimal:
+ * `decimal`:
Disables support for System.Decimal.
- * full_messages:
+ * `full_messages`:
By default Mono comes with a full table
of messages for error codes. This feature
turns off uncommon error messages and reduces
the runtime size.
- * generics:
+ * `generics`:
Generics support. Disabling this will not
allow Mono to run any 2.0 libraries or
code that contains generics.
- * jit:
+ * `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:
+ * `large_code`:
Disables support for large assemblies.
- * logging:
+ * `logging`:
Disables support for debug logging.
- * pinvoke:
+ * `pinvoke`:
Support for Platform Invocation services,
disabling this will drop support for any
libraries using DllImport.
- * portability:
+ * `portability`:
Removes support for MONO_IOMAP, the environment
variables for simplifying porting applications that
are case-insensitive and that mix the Unix and Windows path separators.
- * profiler:
+ * `profiler`:
Disables support for the default profiler.
- * reflection_emit:
+ * `reflection_emit`:
Drop System.Reflection.Emit support
- * reflection_emit_save:
+ * `reflection_emit_save`:
Drop support for saving dynamically created
assemblies (AssemblyBuilderAccess.Save) in
System.Reflection.Emit.
- * shadow_copy:
+ * `shadow_copy`:
Disables support for AppDomain's shadow copies
(you can disable this if you do not plan on
using appdomains).
- * simd:
+ * `simd`:
Disables support for the Mono.SIMD intrinsics
library.
- * ssa:
+ * `ssa`:
Disables compilation for the SSA optimization
framework, and the various SSA-based optimizations.
@@ -403,9 +403,9 @@ Just in Time and Ahead of Time compilations.
full details and up-to-date information on this feature.
* You will need to have an LLVM built that Mono can link
-against,
+against.
- * The --enable-loadedllvm variant will make the llvm backend
+ * The --enable-loadedllvm variant will make the LLVM backend
into a runtime-loadable module instead of linking it directly
into the main mono binary.
@@ -456,8 +456,7 @@ also, see the man page.
* This configures the Mono compiler to generate code
suitable to be used by Google's Native Client:
-
- * http://code.google.com/p/nativeclient/
+http://code.google.com/p/nativeclient/
* Currently this is used with Mono's AOT engine as
Native Client does not support JIT engines yet.
@@ -467,11 +466,11 @@ Using Mono
Once you have installed the software, you can run a few programs:
-* runtime engine `mono program.exe`
+* `mono program.exe` runtime engine
-* C# compiler `mcs program.cs`
+* `mcs program.cs` C# compiler
-* CIL Disassembler `monodis program.exe`
+* `monodis program.exe` CIL Disassembler
See the man pages for mono(1), mint(1), monodis(1) and mcs(2)
for further details.
@@ -479,41 +478,41 @@ for further details.
Directory Roadmap
=================
-* docs/ - Technical documents about the Mono runtime.
+* `docs/` - Technical documents about the Mono runtime.
-* data/ - Configuration files installed as part of the Mono runtime.
+* `data/` - Configuration files installed as part of the Mono runtime.
-* mono/ - The core of the Mono Runtime.
+* `mono/` - The core of the Mono Runtime.
- * metadata/ - The object system and metadata reader.
+ * `metadata/` - The object system and metadata reader.
- * mini/ - The Just in Time Compiler.
+ * `mini/` - The Just in Time Compiler.
- * dis/ - CIL executable Disassembler
+ * `dis/` - CIL executable Disassembler
- * cli/ - Common code for the JIT and the interpreter.
+ * `cli/` - Common code for the JIT and the interpreter.
- * io-layer/ - The I/O layer and system abstraction for
+ * `io-layer/` - The I/O layer and system abstraction for
emulating the .NET IO model.
- * cil/ - Common Intermediate Representation, XML
+ * `cil/` - Common Intermediate Representation, XML
definition of the CIL bytecodes.
- * interp/ - Interpreter for CLI executables (obsolete).
+ * `interp/` - Interpreter for CLI executables (obsolete).
- * arch/ - Architecture specific portions.
+ * `arch/` - Architecture specific portions.
-* man/ - Manual pages for the various Mono commands and programs.
+* `man/` - Manual pages for the various Mono commands and programs.
-* samples/ -Some simple sample programs on uses of the Mono
+* `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.
-* runtime/ -A directory that contains the Makefiles that link the
+* `runtime/` - A directory that contains the Makefiles that link the
mono/ and mcs/ build systems.
-* ../olive/
+* `../olive/`
* If the directory ../olive is present (as an
independent checkout) from the Mono module, that
_______________________________________________
Mono-patches maillist - [email protected]
http://lists.ximian.com/mailman/listinfo/mono-patches