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