mcs/INSTALL.txt

   1 Basic Installation
   2 ==================
   3
   4 The Mono project has developed mono, a CLI runtime. The build process
   5 of each of these depends on nothing more than a C compiler and glib2.
   6
   7 However, to provide a working runtime environment, these programs must
   8 be supplemented by the class libraries, which are written in C#.  This
   9 package contains the components written in C#: class libraries,
  10 compilers and tools.
  11
  12 *********************************************************************
  13 *                                                                   *
  14 *                            NOTICE                                 *
  15 *                                                                   *
  16 *       Unless you are developing the class libraries, you should   *
  17 *       not need to do any build steps in this directory.           *
  18 *                                                                   *
  19 *       Go to ../mono and read the README file to compile and       *
  20 *       install.                                                    *
  21 *                                                                   *
  22 *       ../mono is where you have your `mono' source download       *
  23 *                                                                   *
  24 *********************************************************************
  25
  26 If you only want to build a snapshot or a fresh CVS checkout of the
  27 sources, you should go into the `mono' sibling directory and issue the
  28 make fullbuild command, like this:
  29
  30           cd ../mono
  31           ./autogen.sh --prefix=/usr/local
  32           make fullbuild
  33
  34 That will build and install the code in a single pass.  The
  35 compilation is bundled with the build due to dependencies on the class
  36 libraries on the runtime.
  37
  38 Build Features for Developers of Mono.
  39 ======================================
  40
  41 These instructions apply to both Linux and Windows. To build this
  42 package, you must already have a C# compiler installed.  This means
  43 that to build on Linux, you need to get a distribution of the MCS
  44 binaries; these are called monocharges. They can be found at
  45 www.go-mono.com/daily. On Windows, you can just use the
  46 Microsoft compiler. You also need GNU make to build the software (on
  47 Windows, you will need for example the Cygwin environment setup).
  48
  49 You can customize your MCS configuration by using:
  50
  51     ./configure [--prefix=PREFIX] [--profile=PROFILE]
  52
  53 If you do not run the above, the defaults are /usr/local for the
  54 prefix, and `default' for the profile.
  55
  56 To build the compiler and class libraries, run:
  57
  58     make
  59
  60 The libraries will be placed in the directory class/lib/ and the mcs
  61 compiler executable in mcs/.
  62
  63 To install them, run the following:
  64
  65     make install
  66
  67 If you get "corlib out of sync" errors, try
  68
  69     make PROFILE="atomic"
  70
  71 The difference between the two modes is explained farther down.
  72
  73 Troubleshooting
  74 ===============
  75
  76 Occasionally, something in the compiler or runtime changes enough that
  77 an existing installation cannot complete a full build from cvs.  In this case,
  78 go to http://go-mono.com/daily and download a monocharge or monolite tarball.
  79 Unpack and copy the .dlls to $prefix/lib and .exes to $prefix/bin/.  Then
  80 you should be able to complete the build normally (i.e. using make fullbuild).
  81
  82         wget http://go-mono.com/daily/monolite-20031028.tar.gz
  83         tar -zxvf monolite-20031028.tar.gz
  84         cd monolite-20031028
  85         cp *.exe /usr/local/bin/.
  86         cp *.dll /usr/local/lib/.
  87
  88 Monocharges
  89 ===========
  90
  91 If you are tracking Mono's development, you may sometimes need to share
  92 the compiled libraries with others, you can do:
  93
  94     make monocharge
  95
  96 Or a light version, which contains only the essential libraries and
  97 results in a much smaller file:
  98
  99     make monocharge-lite
 100
 101 Configuration
 102 =============
 103
 104 If you want to change the configuration options for the build process,
 105 place your configuration options in build/config.make
 106
 107 A list of variables that control the build are listed in the file
 108 build/config-default.make.
 109
 110 Build profiles? What?
 111 ======================
 112
 113 Don't worry about them too much. If you're wondering which to use:
 114 use the default if you can (that's why it's the default!) and use
 115 the atomic if you have to.
 116
 117 The default profile uses the C# compiler and class libaries as they
 118 are built. This lets you build MCS without needing to have already
 119 installed it, but can fail if the libraries change significantly.
 120 (This is the source of the dreaded "corlib out of sync" warning, most
 121 of the time.)
 122
 123 The atomic profile tries to use the system compiler and preexisting
 124 MCS libraries. New libaries are built against this constant reference
 125 point, so if a newly built library has a binary incompatibility, the
 126 rest of your build can proceed.
 127
 128 If you want to always use the atomic profile, run this command:
 129
 130        ./configure --profile=atomic
 131
 132 More About the Build System
 133 ===========================
 134
 135 More information is found in build/README.*. Here's a quick rundown
 136 of the features:
 137
 138         * Unified build system for Windows and Linux. Windows is still
 139           fairly untested, but "should work." Unfortunately I don't
 140           have a Windows machine to test on, but Gonzalo can get
 141           corlib to build I think and that's about as complicated as
 142           it gets.
 143
 144         * Profile support. 'make PROFILE=profilename' or 'export
 145           PROFILE=profilename ; make' will work. Profiles are defined
 146           in build/profiles/profilename.make ; right now there isn't
 147           too much going on. The 'bootstrap' profile will build the
 148           way makefile.gnu did on Linux, by setting MONO_PATH and
 149           using mcs/mcs.exe; the default profile will build against
 150           the existing system libraries and compile with 'mcs', which
 151           should reduce a lot of 'corlib out of sync' warnings.
 152
 153         * Important variables are shared among makefiles now; you can
 154           edit build/config.make (see build/config-default.make for a
 155           template) and give global settings, or just have a much
 156           saner time of writing new makefiles.
 157
 158         * Response files, stamps, and other build trivia now all land
 159           in build/deps/, making the library build directories
 160           cleaner.
 161
 162         * Test libraries now live in class/Library/Library_test.dll,
 163           not class/Library/Test. 'make test' will build the test DLL,
 164           'make run-test' will actually run the nunit tests. Set the
 165           variable TEST_HARNESS to run with a program other than
 166           nunit-console (for example, nunit-gtk).
 167
 168         * Standardized recursive targets: all, clean, install, test,
 169           run-test.  Read build/README.makefiles for definitions of
 170           what they should do
 171
 172         * (Relatively) sane 'make dist' target; 'make distcheck'
 173           support; cute 'make monocharge' and 'make monocharge-lite'
 174           targets. They're made possible because 'make install' now
 175           supports DESTDIR a la automake, which I'm sure someone cares
 176           about.