Applied patch [ 1202417 ] Make wxLaunchDefaultBrowser windows fallback work with...

[wxWidgets.git] / BuildCVS.txt

diff --git a/BuildCVS.txt b/BuildCVS.txt
index 11b707701dc0a714e4ec6d16e42081f34470bf83..02b057a8f7d44ce1163fb7f9b2a58e4b566498e9 100644 (file)
--- a/BuildCVS.txt
+++ b/BuildCVS.txt
@@ -2,6 +2,9 @@
                 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
 ----------------------------------------
 


@@ -9,65 +12,71 @@ 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
 
 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.
+installation there may be a batch file (commonly named VCVARS32.BAT)
+that needs to be run to set correct environment variables and PATH entries.

 
 Continue with item c) below.
 
 
 
 Continue with item c) below.
 
 

-b) If using the GNU Mingw32 or GNU Cygwin32 compilers
+b) If using the MinGW or Cygwin compilers
+
+You can get MinGW from  http://www.mingw.org/

 
 

-You can get Mingw32 from  http://www.mingw.org
+Cygwin is available at  http://www.cygwin.com/

 
 

-Cygwin32 is available at  http://www.cygwin.com
+If you are using Cygwin or MinGW together with the MSYS environment, you
+can build the library using configure (see "Unix ports" and
+"Windows using configure" below). You can also
+build wxWindows without configure using native makefile, but only with
+MinGW. Using Cygwin together with Windows makefile is no longer supported.

 
 

-The makefile might have small problems with Cygwin's tools
-so it is recommended to use Mingw32 and its toolchain instead
-if possible.
+If building with MinGW without configure:

 
 -> 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
 

--> 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.
+-> Make sure you have GNU Make installed. It must be Windows native version.
+   Download it from http://www.mingw.org, the executable will be called
+   mingw32-make.exe.
+
+-> Modern version of MinGW is required; preferably MinGW 2.0 (with gcc3),
+   but MinGW with gcc-2.95.3 will suffice. If you are using 2.95, you will
+   have to change variable GCC_VERSION in config.gcc (see msw/install.txt
+   for details).
+
+If using configure, Unix instructions apply.

 
 
 c) Build instructions
 
 
 
 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
+Assumming that you installed the wxWindows sources
+into c:\wxWindows:
+
+-> Copy c:\wxWindows\include\wx\msw\setup0.h
+   to   c:\wxWindows\include\wx\msw\setup.h
+-> Edit c:\wxWindows\include\wx\msw\setup.h to choose
+   the features you would like to compile wxWindows with[out].

 
    and std iostreams are disabled with
    #define wxUSE_STD_IOSTREAM   0
  
 
    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)
+-> type: cd c:\wxWindows\build\msw
+-> type: make -f makefile.gcc  (if using GNU tools)

 or type: nmake -f makefile.vc   (if using MS VC++)
 or type: nmake -f makefile.vc   (if using MS VC++)

+etc.
+
+   See also docs/msw/install.txt for additional compilation options.
+
+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 cd c:\wxWindows\build\msw
+-> type make -f makefile.bcc
+
+You can customize many things in the build process, detailed description is
+in docs/msw/install.txt.

 
 
 II) Unix ports
 
 
 II) Unix ports


@@ -79,10 +88,11 @@ that works without libtool and automake, using only
 configure to create what is needed.
 
 In order to create configure, you need to have the
 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
+GNU autoconf package (version > 2.54) installed

 on your system and type run "autoconf" in the base
 directory (or run the autogen.sh script in the same
 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).
+directory, which just calls autoconf). Note that you usually don't
+need to do this because configure is included in CVS.

 
 Set WXWIN environment variable to the base directory such
 as ~/wxWindows (this is actually not really needed).
 
 Set WXWIN environment variable to the base directory such
 as ~/wxWindows (this is actually not really needed).


@@ -106,11 +116,10 @@ yet complete).
 III) Windows using configure
 ----------------------------------------
 
 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
-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/.
+wxWindows can be built on Windows using MSYS (see
+http://www.mingw.org/), which is a POSIX build environment
+for Windows. With MSYS you can just ./configure && make (see also VII,
+Unix->Windows cross-compiling using configure).

 
 Of course, you can also build the library using plain makefiles (see
 section I).
 
 Of course, you can also build the library using plain makefiles (see
 section I).


@@ -122,11 +131,15 @@ 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
 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.
+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 compilation
+  errors under CodeWarrior which are hard to track down.
+
+- convert the xml files to CodeWarrior binary projects using the supplied
+  AppleScript in docs/mac (M5xml2mcp.applescript for CodeWarrior 5.3)

 
 V) MacOS X using configure and the Developer Tools
 ----------------------------------------
 
 V) MacOS X using configure and the Developer Tools
 ----------------------------------------


@@ -136,7 +149,7 @@ 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
 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
+GNU autoconf package (version >= 2.54) 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).
 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).


@@ -149,19 +162,22 @@ or type: ../configure
 
 VI) OS/2
 ----------------------------------------
 
 VI) OS/2
 ----------------------------------------

+No notes.

 
 VII) Unix->Windows cross-compiling using configure
 --------------------------------------------------
 
 
 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
-ftp://ftp.objsw.com/pub/crossgcc/linux-x-win32. Otherwise you can
-compile one yourself. Check the relevant FAQs.
+First you'll need a cross-compiler; linux glibc binaries of MinGW and
+Cygwin (both based on egcs) can be found at
+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
+[ A Note about Cygwin and MinGW: the main difference is that Cygwin

 binaries are always linked against cygwin.dll. This dll encapsulates most
 standard Unix C extensions, which is very handy if you're porting unix
 binaries are always linked against cygwin.dll. This dll encapsulates most
 standard Unix C extensions, which is very handy if you're porting unix

-software to windows. However, wxMSW doesn't need this, so mingw32 is
+software to windows. However, wxMSW doesn't need this, so MinGW is

 preferable if you write portable C(++). ]
 
 You might want to build both Unix and Windows binaries in the same source
 preferable if you write portable C(++). ]
 
 You might want to build both Unix and Windows binaries in the same source


@@ -176,8 +192,7 @@ To cross compile the windows library, do
 -> cd win32
 (or whatever you called it)
 Now run configure. There are two ways to do this
 -> 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 \
-   --enable-dnd=no --without-odbc
+-> ../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!).
 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!).


@@ -185,29 +200,22 @@ 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 \

-   ../configure --host=i586-mingw32 --with-mingw --enable-dnd=no
-
-(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 --host=i586-mingw32 --with-mingw

 
 

-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.
+(all assuming you're using MinGW)
+By default this will compile a DLL, if you want a static library,
+specify --disable-shared.

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

-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
+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)
+    MinGW headers which may be corrected by upgrading your compier,
+    otherwise you might edit the file

 
     ${install_prefix}/lib/gcc-lib/i586-mingw32/egcs-2.91.57/include/stdarg.h
 
 
     ${install_prefix}/lib/gcc-lib/i586-mingw32/egcs-2.91.57/include/stdarg.h
 


@@ -228,8 +236,9 @@ typedef void *__gnuc_va_list;
     and adding "|| defined(_WIN32)" to the list of platforms on which
     __gnuc_va_list is char *.
 
     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:
+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:

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


@@ -249,6 +258,5 @@ 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 ]
 - 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

 - static executables are HUGE -- there must be room for improvement.
 
 - static executables are HUGE -- there must be room for improvement.