Properly initialize a rgctx template. Fixes bxc #1147.
[mono-project.git] / README.vsnet
blobf3a07a1d8c8f7a77b9b8d71a4618538492328963
1 README.vsnet                                    Last updated: 2006-02-01
4 SVN includes a Visual Studio .NET 2005 solution, mono.sln, and some 
5 projects files to build most of the unmanaged parts in Mono.
7 The "mono.sln" solution file contains the VC projects files for:
9         * Embedded Samples
10                 * test-invoke.vcproj
11                 * test-metadata.vcproj
12                 * teste.vcproj
13         * Libraries
14                 * libgc.vcproj
15                 * libmono.vcproj
16         * Tools
17                 * genmdesc.vcproj
18                 * monoburg.vcproj
19                 * monodiet.vcproj
20                 * monodis.vcproj
21                 * monograph.vcproj
22                 * pedump.vcproj
23         * mono.vcproj
24         
26 REQUIREMENTS
28 * A working (i.e. where you could succesfully build mono) cygwin 
29 (http://www.cygwin.com/) setup! This is required to:
30         * generate some files (via monoburg and genmdesc);
31         * build the class libraries; and
32         * test for regressions.
34 * Visual Studio .NET 2005. Previous Visual Studio versions may work or 
35 requires, hopefully minimal, changes.
36         
37 * VSDependencies.zip must be decompressed under the /mono/ directory 
38 (otherwise you will need to edit all the projects files). This file can 
39 be downloaded from http://www.go-mono.com/archive/VSDependencies.zip
42 LOCAL CHANGES
44 Sadly solution/projects files aren't easy to move from computers to
45 computers (well unless everyone follow the same naming convention) so
46 you'll likely have to changes some options in order to compile the
47 solution.
49         * each executed assembly (i.e. the EXE) must be able to find a
50         working mscorlib.dll (and all the other required assemblies).
51         This can be done in different ways. My preference is to use the
52         project "properties pages" in the "Configuration Properties
53         \Debugging\Environment" options and set MONO_PATH to the class
54         libraries directory build by cygwin (local) or on Linux
55         (remote).
56         
57         e.g. MONO_PATH=z:\svn\mcs\class\lib\default\
58         allows me to use the class libs build under Linux, while
59         MONO_PATH=C:\cygwin\opt\mono\lib\mono\1.0
60         use the one built from cygwin (after a make install)
62 Some useful informations to adapt the solution/project files...
64         * My cygwin root dir is:        c:\cygwin\
65         * My username is:               poupou
66         * My mono install prefix is:    /opt/mono
67                 
69 BUILDING
71 Once everything is installed (and edited) you can right-click on the
72 "mono" solution (in the "Solution Explorer"), select "Clean
73 Solution" (for the first time) then "Build Solution".
76 KNOWN ISSUES
78 [1] Most, BUT NOT ALL, the regressions tests pass under this build. The
79 failures seems limited to some mathematical differences and to code
80 relying on the stack walking functions. The hacks to replace the GCC
81 functions (__builtin_frame_address and __builtin_return_address) are
82 incomplete;
84 [2] The solution doesn't provide complete (i.e. from scratch) build. It
85 requires a working cygwin environment to create some files (e.g. via
86 genmdesc, monoburg). This isn't so bad as without cygwin you wouldn't be
87 able to test Mono properly (see REQUIREMENTS);
89 [3] Only the Debug target is configured properly (that would be easy to 
90 fix, but would require turning off some optimizations like omitting 
91 stack frames). Anyway there are other issues [1] to fix before switching
92 to Release and IMHO the _biggest_ advantage to VS.NET is it's debugger/
93 debugging tools;
95 [4] The C compiler emits _lots_ of warning during compilation. Some
96 warnings have been turned off for some projects (there was so much that
97 it slowed down compilation). You can bring them back (or hide more of
98 them) using the project "properties pages" windows, "Configuration
99 Properties\C/C++\Advanced\Disable Specific Warnings";
101 [5] Visual Studio 2005 should have all the latest header files required, 
102 but if not (or if you're using an older version of VS) then install MS 
103 Platform SDK (Windows Server 2003 is the latest) to ensure you have the 
104 latest Windows header files. You can download it from:
105 http://www.microsoft.com/msdownload/platformsdk/sdkupdate/psdk-full.htm
107 [6] Not everyone has VS.NET so it is possible you may have to add some
108 (new) files to the build from time to time. See "more informations" for
109 reporting those changes.
111 [7] Probably a lot more I didn't discover... or has changed since.
114 MORE INFORMATION
116 Please email <mono-devel-list@lists.ximian.com> if you have any problem
117 and/or if there's something wrong/missing in the instructions.
119 An online version of this file is available at
120 http://www.mono-project.com/Compiling_Mono_VSNET