fixed typo

[wxWidgets.git] / BuildCVS.txt

diff --git a/BuildCVS.txt b/BuildCVS.txt
index 777c8e3586f68f2b6c889adc1ae6c033b67d32a5..7c14fd12cec91ddb4bfc4f3fc6a73cc7904a5958 100644 (file)
--- a/BuildCVS.txt
+++ b/BuildCVS.txt
@@ -2,70 +2,168 @@
                 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
 ----------------------------------------
 

-No idea, never did it.
-
-
-II) Unix using plain makefiles.
-----------------------------------------
+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.
+
+Continue with item c) below.
+
+
+b) If using the GNU Mingw32 or GNU Cygwin32 compilers
+
+You can get Mingw32 from  http://www.mingw.org
+
+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
+
+-> 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
+-> 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
+   most features are enabled (i.e. defined to 1), for example:
+   #define wxUSE_ODBC          0
+   #define wxUSE_SOCKETS       1
+   #define wxUSE_HTML          1
+   #define wxUSE_THREADS       1
+   #define wxUSE_FS_INET       0
+   #define wxUSE_FS_ZIP        1
+   #define wxUSE_BUSYINFO      1
+   #define wxUSE_DYNLIB_CLASS  1
+   #define wxUSE_ZIPSTREAM     1
+   #define wxUSE_LIBJPEG       1
+   #define wxUSE_LIBPNG        1
+
+   and std iostreams are disabled with
+   #define wxUSE_STD_IOSTREAM   0
+ 
+-> type: cd c:\wxWin\src\msw
+-> type: make -f makefile.g95  (if using GNU tools)
+or type: nmake -f makefile.vc   (if using MS VC++)
+
+d) Borland (including free command line tools)
+   Download tools from http://www.borland.com/downloads/
+   
+   See docs/msw/install.txt for details; in brief
+
+-> type set WXWIN=c:\wxwindows
+-> type set BCCDIR=c:\progra~1\borland\cb4
+-> type cd %WXWIN%\include\wx
+-> type copy msw\setup0.h setup.h
+-> type cd %WXWIN%\src\msw
+-> type make -f makefile.b32
+
+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
+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
+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).

 
 Set WXWIN environment variable to the base directory such
 
 Set WXWIN environment variable to the base directory such

-as ~/wxWindows
+as ~/wxWindows (this is actually not really needed).

 
 -> type: export WXWIN=~/wxWindows
 
 -> type: export WXWIN=~/wxWindows

-
-Edit ~/wxWindows/src/make.env as you wish.
--> type: cd ~/wxWindows/src/gtk
--> type: cp ./setup0.h setup.h
--> type: make -f makefile.unx gtk
--> pray
+-> type: md mybuild
+-> type: cd mybuild
+-> type: ../configure --with-motif
+or type: ../configure --with-gtk
+-> type: make
+-> type: su <type root password>
+-> type: make install
+-> type: ldconfig
+-> type: exit
+
+Call configure with --disable-shared to create a static
+library. Calling "make uninstall" will remove the installed
+library and "make dist" will create a distribution (not
+yet complete).

 
 III) Windows using configure
 ----------------------------------------
 
 
 III) Windows using configure
 ----------------------------------------
 

-No idea.., but take a look at Unix->Windows cross compiling. With minor
+Take a look at Unix->Windows cross compiling. With minor

 modifications, this should work in Windows if you've got the cygnus
 modifications, this should work in Windows if you've got the cygnus

-utilities (bash, GNU make, etc) and either mingw32 or cygwin32 installed. 
-See http://www.cygnus.com for these programs.
+utilities (bash, GNU make, etc) and either mingw32 or cygwin32 installed.
+See http://www.cygnus.com for these programs, or go straight to their
+ftp server at ftp://sourceware.cygnus.com/pub/cygwin/.

 
 

-IV) Unix using configure
+Of course, you can also build the library using plain makefiles (see
+section I).
+
+IV) Classic MacOS using CodeWarrior (eg MacOS 8.x/9.x)

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

-a) You have all the newest and greatest GNU tools installed on your system 
-and in the same directory hierachy (e.g. either all tools in /usr or all 
-in /usr/local), these tools are:
-- GNU libtool 1.2e (1.3 doesn't work here)
-- GNU autoconf 2.13 (including autoheader 2.13)
-- GNU automake 1.4 (including aclocal 1.4)
-and possibly but not forcibly
-- GNU make 3.76.1
-- GNU C++ (EGCS)
+Refer to the readme.txt and install.txt files in docs/mac to build
+wxWindows under Classic Mac OS using CodeWarrior.

 
 

--> Go to the base directory
--> type: ./autogen.sh
+If you are checking out the CVS sources using cvs under Mac OS X and
+compiling under Classic Mac OS:

 
 

-b) You don't know what autos are and have no driver's licence anyway:
+- 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 compilation
+  errors under CodeWarrior which are hard to track down.

 
 

--> Go to the testconf directory
--> type: ./apply
+- convert the xml files to CodeWarrior binary projects using the supplied
+  AppleScript in docs/mac (M5xml2mcp.applescript for CodeWarrior 5.3)

 
 

-a+b) Then proceed in either case with:
+V) MacOS X using configure and the Developer Tools
+----------------------------------------

 
 

--> Choose a directory name that seems fit for building wxWindows, e.g. mybuild
--> Go the base directory
--> type: mkdir mybuild
--> type: cd mybuild
--> type: ../configure --with-gtk   
-or type: ../configure --with-motif
-or type: ../configure --with-wine
--> type make
--> drink lots of coffee and go shopping
+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).

 
 

-V) MacOS
-----------------------------------------
+-> type: mkdir macbuild
+-> type: cd macbuild
+-> type: ../configure --with-mac
+or type: ../configure
+-> type: make

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


@@ -75,8 +173,10 @@ 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 
-compile one yourself. Check the relevant FAQs.
+ftp://ftp.objsw.com/pub/crossgcc/linux-x-win32. Alternative binaries,
+based on the latest MinGW release can be found at
+http://members.telering.at/jessich/mingw/mingwcross/mingw_cross.html 
+Otherwise you can compile one yourself.

 
 [ A Note about cygwin32 and mingw32: the main difference is that cygwin32
 binaries are always linked against cygwin.dll. This dll encapsulates most
 
 [ A Note about cygwin32 and mingw32: the main difference is that cygwin32
 binaries are always linked against cygwin.dll. This dll encapsulates most


@@ -94,41 +194,73 @@ 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
+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
+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 \
 -> CC=i586-mingw32-gcc CXX=i586-mingw32-g++ RANLIB=i586-mingw32-ranlib \
    DLLTOOL=i586-mingw32-dlltool LD=i586-mingw32-ld NM=i586-mingw32-nm \

-   ../configure --host=i586-mingw32 --with-mingw --enable-dnd=no
+   ../configure --host=i586-mingw32 --with-mingw

 
 

-(assuming you're using mingw32)
+(all assuming you're using mingw32)
+By default this will compile a DLL, if you want a static library,
+specify --disable-shared.

 
 

-The important thing to notice here is that we suply configure with the names
-of all the non-default binutils (make sure they're in the PATH!), and that 
-we tell configure to build for the host platform i586-mingw32. 
-Drag'n'drop is disabled because mingw32 lacks (AFAIK) OLE headers.
+Type
+-> make
+and wait, wait, wait. Don't leave the room, because the minute you do there
+will be a compile error :-)

 
 

-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.
+NB: if you are using a very old compiler 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 upgrading your compier,
+    otherwise you might edit the file

 
 

-When configure is finished, examine setup.h in the win32 directory. Search for
-wxUSE_DYNLIB_CLASS, it will be defined twice. Remove the second define (0).
-If your cross-compiler is egcs-based, you might want to add #define __EGCS__
-in setup.h (only used by common/timercmn.cpp).
+    ${install_prefix}/lib/gcc-lib/i586-mingw32/egcs-2.91.57/include/stdarg.h

 
 

-Type 
--> make -C src
-and wait, wait, wait. Don't leave the room, because the minute you do there
-will be a compile error :-)
+    (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 wx23_2.dll/libwx23_2.a in win32/lib
+( or just libwx_msw.a if you opted for a static build ).
+Now try building the minimal sample:

 
 

-If this is successful, 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.
 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
+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 ]
+- static executables are HUGE -- there must be room for improvement.
+