Various tweaks, fixes, and additions

[wxWidgets.git] / BuildCVS.txt

diff --git a/BuildCVS.txt b/BuildCVS.txt
index f086d038209a921d28f9d99d4501578bac0fbb6f..2e0683e2e474714b0bcc0d3af89cfd4131cf32c1 100644 (file)
--- a/BuildCVS.txt
+++ b/BuildCVS.txt
@@ -2,35 +2,59 @@
                 How to build the sources from CVS
 ------------------------------------------------------------------------
 
                 How to build the sources from CVS
 ------------------------------------------------------------------------
 

+Please use the install.txt files in docs/gtk, docs/msw, docs/motif, docs/mac
+etc. alongside these instructions.
+

 I) Windows using plain makefiles
 ----------------------------------------
 
 I) Windows using plain makefiles
 ----------------------------------------
 

-a) Using the GNU MinGW32 or GNU CygWin32 compilers
+a) If using Microsoft Visual C++ 5.0 or 6.0
+
+Ensure that the command-line compiler and tools (including
+nmake) are installed and ready to run.  Depending on your
+installation there may be a batch file (named something like
+VCVARS32.BAT) that needs to be run to set correct environment
+varaibles and PATH entries.

 
 

-You'll need the compiler itself which is available from
+Continue with item c) below.

 
 

-  http://www.cygwin.com

 
 

-When using MingW32 you'll need GNU make which is part of
-part of the CygWin32 toolchain and is also available as
-a stand alone port without the infamous Cygwin.dll from
+b) If using the GNU Mingw32 or GNU Cygwin32 compilers

 
 

-  http://agnes.dida.physik.uni-essen.de/~janjaap/mingw32
+You can get Mingw32 from  http://www.mingw.org

 
 

-The makefile has small problems with Cygwin´s tools
-so it is recommended not to use these (but MingGW32
-and its make.exe).
+Cygwin32 is available at  http://www.cygwin.com
+
+The makefile might have small problems with Cygwin's tools
+so it is recommended to use Mingw32 and its toolchain instead
+if possible.

 
 -> Set your path so that it includes the directory
    where your compiler and tools reside
 
 -> Set your path so that it includes the directory
    where your compiler and tools reside

--> Assume that you installed the wxWindows sources
+
+-> If your are using an old Mingw32 version (gcc-2.95 or older),
+   you might need to fix some headers with the patches contained
+   in the wxWin\Mingw32-gcc295.patches file. PLEASE APPLY THESE
+   PATCHES BY HAND! There are apparently a few different versions
+   of the headers floating around. Note that these patches are
+   not needed if you are using Mingw32 gcc-2.95.2 or newer.
+  
+-> Edit wx/src/makeg95.env and set the MINGW32 variable at the top of
+   the file to either 1 (you have Mingw32) or 0 (you have Cygwin32).
+   If using MINGW32, also set the MINGW32VERSION variable
+   appropiately.
+
+
+c) Build instructions
+
+-> Assumming that you installed the wxWindows sources

    into c:\wxWin
    into c:\wxWin

--> Copy c:\wxWin\include\wx\msw\setup0.h 
+-> Copy c:\wxWin\include\wx\msw\setup0.h

    to   c:\wxWin\include\wx\msw\setup.h
 -> Edit c:\wxWin\include\wx\msw\setup.h so that
    to   c:\wxWin\include\wx\msw\setup.h
 -> Edit c:\wxWin\include\wx\msw\setup.h so that

-   most features are enabled (i.e. defined to 1) with
+   most features are enabled (i.e. defined to 1), for example:

    #define wxUSE_ODBC          0
    #define wxUSE_ODBC          0

-   #define wxUSE_SOCKETS       0
+   #define wxUSE_SOCKETS       1

    #define wxUSE_HTML          1
    #define wxUSE_THREADS       1
    #define wxUSE_FS_INET       0
    #define wxUSE_HTML          1
    #define wxUSE_THREADS       1
    #define wxUSE_FS_INET       0


@@ -41,10 +65,13 @@ and its make.exe).
    #define wxUSE_LIBJPEG       1
    #define wxUSE_LIBPNG        1
 
    #define wxUSE_LIBJPEG       1
    #define wxUSE_LIBPNG        1
 

-   and iostreams ares disabled with
+   and std iostreams are disabled with

    #define wxUSE_STD_IOSTREAM   0
    #define wxUSE_STD_IOSTREAM   0

+ 

 -> type: cd c:\wxWin\src\msw
 -> type: cd c:\wxWin\src\msw

--> type: make -f makefile.g95
+-> type: make -f makefile.g95  (if using GNU tools)
+or type: nmake -f makefile.vc   (if using MS VC++)
+

 
 II) Unix ports
 --------------
 
 II) Unix ports
 --------------


@@ -52,7 +79,7 @@ II) Unix ports
 Building wxGTK or wxMotif completely without configure
 won't ever work, but there is now a new makefile system
 that works without libtool and automake, using only
 Building wxGTK or wxMotif completely without configure
 won't ever work, but there is now a new makefile system
 that works without libtool and automake, using only

-configure to create what is needed. 
+configure to create what is needed.

 
 In order to create configure, you need to have the
 GNU autoconf package (version 2.13 or 2.14) installed
 
 In order to create configure, you need to have the
 GNU autoconf package (version 2.13 or 2.14) installed


@@ -84,16 +111,45 @@ III) Windows using configure
 
 Take a look at Unix->Windows cross compiling. With minor
 modifications, this should work in Windows if you've got the cygnus
 
 Take a look at Unix->Windows cross compiling. With minor
 modifications, this should work in Windows if you've got the cygnus

-utilities (bash, GNU make, etc) and either mingw32 or cygwin32 installed. 
+utilities (bash, GNU make, etc) and either mingw32 or cygwin32 installed.

 See http://www.cygnus.com for these programs, or go straight to their
 See http://www.cygnus.com for these programs, or go straight to their

-ftp server at ftp://sourceware.cygnus.com/pub/cygwin/. 
+ftp server at ftp://sourceware.cygnus.com/pub/cygwin/.

 
 

-Of course, you can also build the library using plain makefiles (see 
+Of course, you can also build the library using plain makefiles (see

 section I).
 
 section I).
 

-V) MacOS
+IV) Classic MacOS using CodeWarrior (eg MacOS 8.x/9.x)

 ----------------------------------------
 
 ----------------------------------------
 

+Refer to the readme.txt and install.txt files in docs/mac to build
+wxWindows under Classic Mac OS using CodeWarrior.
+
+If you are checking out the CVS sources using cvs under Mac OS X and
+compiling under Classic Mac OS, make sure that all text files have a
+Mac OS type of 'TEXT' otherwise CodeWarrior may ignore them. Checking
+out the CVS sources using cvs under Mac OS X creates untyped files
+which can lead to compialtion errors under CodeWarrior which are hard
+to track down.
+
+V) MacOS X using configure and the Developer Tools
+----------------------------------------
+
+You need to have the Developer Tools installed. If this is not the case,
+you will need to register at the Apple Developer web site (this is a free
+registration) in order to download the Developer Tools installer.
+
+In order to create configure, you need to have the
+GNU autoconf package (version 2.13 or 2.14) installed
+on your system and type run "autoconf" in the base
+directory (or run the autogen.sh script in the same
+directory, which just calls autoconf).
+
+-> type: mkdir macbuild
+-> type: cd macbuild
+-> type: ../configure --with-mac
+or type: ../configure
+-> type: make
+

 VI) OS/2
 ----------------------------------------
 
 VI) OS/2
 ----------------------------------------
 


@@ -102,7 +158,7 @@ VII) Unix->Windows cross-compiling using configure
 
 First you'll need a cross-compiler; linux glibc binaries of mingw32 and
 cygwin32 (both based on egcs) can be found at
 
 First you'll need a cross-compiler; linux glibc binaries of mingw32 and
 cygwin32 (both based on egcs) can be found at

-ftp://ftp.objsw.com/pub/crossgcc/linux-x-win32. Otherwise you can 
+ftp://ftp.objsw.com/pub/crossgcc/linux-x-win32. Otherwise you can

 compile one yourself. Check the relevant FAQs.
 
 [ A Note about cygwin32 and mingw32: the main difference is that cygwin32
 compile one yourself. Check the relevant FAQs.
 
 [ A Note about cygwin32 and mingw32: the main difference is that cygwin32


@@ -121,13 +177,14 @@ sure that your configure setup is basically sound.)
 
 To cross compile the windows library, do
 -> cd win32
 
 To cross compile the windows library, do
 -> cd win32

+(or whatever you called it)

 Now run configure. There are two ways to do this
 -> ../configure --host=i586-mingw32 --build=i586-linux --with-mingw \
 Now run configure. There are two ways to do this
 -> ../configure --host=i586-mingw32 --build=i586-linux --with-mingw \

-   --enable-dnd=no
+   --enable-dnd=no --without-odbc

 where --build= should read whatever platform you're building on. Configure
 will notice that build and host platforms differ, and automatically prepend
 where --build= should read whatever platform you're building on. Configure
 will notice that build and host platforms differ, and automatically prepend

-i586-mingw32- to gcc, ar, ld, etc (make sure they're in the PATH!). 
-The other way to run configure is by specifying the names of the binaries 
+i586-mingw32- to gcc, ar, ld, etc (make sure they're in the PATH!).
+The other way to run configure is by specifying the names of the binaries

 yourself:
 -> CC=i586-mingw32-gcc CXX=i586-mingw32-g++ RANLIB=i586-mingw32-ranlib \
    DLLTOOL=i586-mingw32-dlltool LD=i586-mingw32-ld NM=i586-mingw32-nm \
 yourself:
 -> CC=i586-mingw32-gcc CXX=i586-mingw32-g++ RANLIB=i586-mingw32-ranlib \
    DLLTOOL=i586-mingw32-dlltool LD=i586-mingw32-ld NM=i586-mingw32-nm \


@@ -136,32 +193,63 @@ yourself:
 (all assuming you're using mingw32)
 Drag'n'drop is disabled because mingw32 lacks (AFAIK) OLE headers.
 
 (all assuming you're using mingw32)
 Drag'n'drop is disabled because mingw32 lacks (AFAIK) OLE headers.
 

+[ Update: some new mingw32 versions now have a new set of windows header
+files, which apparently can handle ole. Untested at the moment ]
+
+ODBC files don't compile as of 13.10.99 - may be this will be fixed by the
+moment you're reading these lines.
+

 Configure will conclude that shared libraries are out of the question and
 opt for a static one. I haven't looked into DLL creation yet.
 
 Configure will conclude that shared libraries are out of the question and
 opt for a static one. I haven't looked into DLL creation yet.
 

-Type 
--> make -C src
+Type
+-> make

 and wait, wait, wait. Don't leave the room, because the minute you do there
 will be a compile error :-)
 
 and wait, wait, wait. Don't leave the room, because the minute you do there
 will be a compile error :-)
 

-If this is successful, try building the minimal sample:
+NB: you risk to get quite a few warnings about "ANSI C++ forbids implicit
+    conversion from 'void *'" in all places where va_arg macro is used. This
+    is due to a bug in (some versions of) mingw32 headers which may be
+    corrected by editing the file
+
+    ${install_prefix}/lib/gcc-lib/i586-mingw32/egcs-2.91.57/include/stdarg.h
+
+    (instead of egcs-2.91.57 you may have something different), searching for
+    the lines
+
+/* Define __gnuc_va_list.  */
+
+#ifndef __GNUC_VA_LIST
+#define __GNUC_VA_LIST
+#if defined(__svr4__) || defined(_AIX) || defined(_M_UNIX) || defined(__NetBSD__)
+typedef char *__gnuc_va_list;
+#else
+typedef void *__gnuc_va_list;
+#endif
+#endif
+
+    and adding "|| defined(_WIN32)" to the list of platforms on which
+    __gnuc_va_list is char *.
+
+If this is successful, you end up with a libwx_msw.a in win32/lib.  Now try
+building the minimal sample:
+

 -> cd samples/minimal
 -> make
 -> cd samples/minimal
 -> make

--> mv minimal minimal.exe

 
 

-and run it with wine, for example
+and run it with wine, for example (or copy to a Windows box)

 -> wine minimal.exe
 
 If all is well, do an install; from win32
 -> make install
 
 -> wine minimal.exe
 
 If all is well, do an install; from win32
 -> make install
 

-Native and cross-compiled installations can co-exist peacefully 
-(as long as their widget sets differ), except for wx-config. You might 
+Native and cross-compiled installations can co-exist peacefully
+(as long as their widget sets differ), except for wx-config. You might

 want to rename the cross-compiled one to i586-mingw32-wx-config, or something.
 
 Cross-compiling TODO:
 ---------------------
 want to rename the cross-compiled one to i586-mingw32-wx-config, or something.
 
 Cross-compiling TODO:
 ---------------------

-- resource compiling must be done manually for now (should/can we link the 
+- resource compiling must be done manually for now (should/can we link the

 default wx resources into libwx_msw.a?) [ No we can't; the linker won't
 link it in... you have to supply an object file ]
 - dynamic libraries
 default wx resources into libwx_msw.a?) [ No we can't; the linker won't
 link it in... you have to supply an object file ]
 - dynamic libraries