diff options
| -rw-r--r-- | INSTALL.adoc | 6 | ||||
| -rw-r--r-- | Makefile.nt | 6 | ||||
| -rw-r--r-- | README.adoc | 12 | ||||
| -rw-r--r-- | README.win32.adoc (renamed from README.win32) | 222 |
4 files changed, 133 insertions, 113 deletions
diff --git a/INSTALL.adoc b/INSTALL.adoc index dabe8cfe17..deb95ade03 100644 --- a/INSTALL.adoc +++ b/INSTALL.adoc @@ -154,7 +154,7 @@ or: ./configure -cc "gcc -fPIC" -aspp "gcc -c -fPIC" + - On a 64-bit POWER architecture host running Linux, OCaml only operates +On a 64-bit POWER architecture host running Linux, OCaml only operates in a 32-bit environment. If your system compiler is configured as 32-bit, e.g. Red Hat 5.9, you don't need to do anything special. If that is not the case (e.g. Red Hat 6.4), then IBM's "Advance Toolchain" can @@ -235,7 +235,7 @@ or: make opt > log.opt 2>&1 # in sh make opt >& log.opt # in csh -5. Compile fast versions of the OCaml compilers, by compiling them +5. anchor:step-5[] Compile fast versions of the OCaml compilers, by compiling them with the native-code compiler (you have only compiled them to bytecode so far). Just do: @@ -274,7 +274,7 @@ autoconfiguration): ocamlprof execution count profiler ocamlcp the bytecode compiler in profiling mode + -and also, if you built them during step 5, +and also, if you built them during <<step-5,step 5>>, ocamlc.opt the batch bytecode compiler compiled with ocamlopt ocamlopt.opt the batch native-code compiler compiled with ocamlopt diff --git a/Makefile.nt b/Makefile.nt index 76a74e157a..fa247ca20f 100644 --- a/Makefile.nt +++ b/Makefile.nt @@ -16,7 +16,7 @@ include Makefile.shared # For users who don't read the INSTALL file defaultentry: - @echo "Please refer to the installation instructions in file README.win32." + @echo "Please refer to the installation instructions in file README.win32.adoc." # Recompile the system using the bootstrap compiler all: runtime ocamlc ocamllex ocamlyacc ocamltools library ocaml \ @@ -175,8 +175,8 @@ installbyt: if test -n "$(WITH_OCAMLBUILD)"; then (cd ocamlbuild; $(MAKE) install); \ else :; fi cp config/Makefile $(INSTALL_LIBDIR)/Makefile.config - cp README $(INSTALL_DISTRIB)/Readme.general.txt - cp README.win32 $(INSTALL_DISTRIB)/Readme.windows.txt + cp README.adoc $(INSTALL_DISTRIB)/Readme.general.txt + cp README.win32.adoc $(INSTALL_DISTRIB)/Readme.windows.txt cp LICENSE $(INSTALL_DISTRIB)/License.txt cp Changes $(INSTALL_DISTRIB)/Changes.txt diff --git a/README.adoc b/README.adoc index 7a3b62773a..6db54cc2cc 100644 --- a/README.adoc +++ b/README.adoc @@ -1,4 +1,4 @@ -= README += README = == OVERVIEW @@ -84,15 +84,18 @@ conditions stated in file LICENSE. == INSTALLATION See the file INSTALL for installation instructions on Unix, Linux and -MacOS X machines. For MS Windows, see README.win32. +MacOS X machines. For MS Windows, see link:README.win32.adoc[]. == DOCUMENTATION The OCaml manual is distributed in HTML, PDF, Postscript, DVI, and -Emacs Info files. It is available on the World Wide Web, at +Emacs Info files. It is available at http://caml.inria.fr/ +The community also maintains the Web site http://ocaml.org, with tutorials +and other useful informations for OCaml users. + == AVAILABILITY The complete OCaml distribution can be accessed at @@ -121,6 +124,9 @@ The Usenet news `groups comp.lang.ml` and `comp.lang.functional` also contains discussions about the ML family of programming languages, including OCaml. +The IRC channel `#ocaml` on https://freenode.net/[Freenode] also has several +hundred users and welcomes questions. + == BUG REPORTS AND USER FEEDBACK Please report bugs using the Web interface to the bug-tracking system diff --git a/README.win32 b/README.win32.adoc index 1461cc818a..fdc18da626 100644 --- a/README.win32 +++ b/README.win32.adoc @@ -1,7 +1,8 @@ - Release notes on the MS Windows ports of OCaml - ---------------------------------------------- += Release notes on the MS Windows ports of OCaml = +:toc: macro There are no less than five ports of OCaml for MS Windows available: + - a native Win32 port, built with the Microsoft development tools; - a native Win32 port, built with the 32-bit version of the gcc compiler from the mingw-w64 project, packaged in Cygwin @@ -16,43 +17,38 @@ There are no less than five ports of OCaml for MS Windows available: Here is a summary of the main differences between these ports: - Native MS Native MinGW Cygwin - -64 bits? Win32 or Win64 Win32 or Win64 Win32 only - -Third-party software required - - for base bytecode system none none none - - for ocamlc -custom MSVC Cygwin Cygwin - - for native-code generation MSVC+MASM Cygwin Cygwin - -Speed of bytecode interpreter 70% 100% 100% - -Replay debugger yes (**) yes (**) yes - -The Unix library partial partial full - -The Threads library yes yes yes - -The Graphics library yes yes no - -Restrictions on generated executables? none none yes (*) - -(*) Cygwin-generated .exe files refer to a DLL that is distributed under +|===== +| | Native MS | Native MinGW | Cygwin +|64 bits? | Win32 or Win64 | Win32 or Win64 | Win32 only +4+^| Third-party software required +| for base bytecode system | none | none | none +| for ocamlc -custom | MSVC | Cygwin | Cygwin +| for native-code generation | MSVC+MASM | Cygwin | Cygwin +| Speed of bytecode interpreter | 70% | 100% | 100% +| Replay debugger | yes <<tb2,(**)>> | yes <<tb2,(**)>> | yes +| The Unix library | partial | partial | full +| The Threads library | yes | yes | yes +| The Graphics library | yes | yes | no +| Restrictions on generated executables? | none | none | yes <<tb1,(*)>> +|===== + +[[tb1]] +(*):: Cygwin-generated .exe files refer to a DLL that is distributed under the GPL. Thus, these .exe files can only be distributed under a license that is compatible with the GPL. Executables generated by MSVC or by MinGW have no such restrictions. -(**) The debugger is supported but the "replay" functions are not enabled. +[[tb2]] +(**):: The debugger is supported but the "replay" functions are not enabled. Other functions are available (step, goto, run...). The remainder of this document gives more information on each port. ------------------------------------------------------------------------------- +toc::[] - The native Win32 port built with Microsoft Windows SDK - ------------------------------------------------------ +== The native Win32 port built with Microsoft Windows SDK -REQUIREMENTS: +=== REQUIREMENTS This port runs under MS Windows 7 (32 and 64 bits), Vista, XP, and 2000. @@ -60,52 +56,58 @@ The base bytecode system (ocamlc, ocaml, ocamllex, ocamlyacc, ...) runs without any additional tools. The native-code compiler (ocamlopt) requires the Microsoft Windows SDK -(item [1]) and the flexdll tool (item [2]). +(item <<tps1,[1]>>) and the flexdll tool (item <<tps2,[2]>>). Statically linking OCaml bytecode with C code (ocamlc -custom) also requires -items [1] and [2]. +items <<tps1,[1]>> and <<tps2,[2]>>. - -INSTALLATION: +=== INSTALLATION The binary distribution is a self-installing executable archive. Just run it and it should install OCaml automatically. -THIRD-PARTY SOFTWARE: +=== THIRD-PARTY SOFTWARE -[1] Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 Service Pack 1. +[[tps1]] +[1]:: Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 Service Pack 1. Can be downloaded for free from http://www.microsoft.com/downloads/en/default.aspx under the name "Microsoft Windows 7 SDK". -[2] flexdll version 0.31 or later. +[[tps2]] +[2]:: flexdll version 0.31 or later. Can be downloaded from http://alain.frisch.fr/flexdll.html -RECOMPILATION FROM THE SOURCES: +=== RECOMPILATION FROM THE SOURCES The command-line tools can be recompiled from the Unix source distribution (ocaml-X.YY.Z.tar.gz), which also contains the files modified for Windows. You will need the following software components to perform the recompilation: + - Windows NT, 2000, XP, Vista, or 7 (32 or 64 bits). -- Items [1] and [2] from the list of recommended software above. +- Items <<tps1,[1]>> and <<tps2,[2]>> from the list of recommended software above. - The Cygwin port of GNU tools, available from http://www.cygwin.com/ Install at least the following packages (and their dependencies): diffutils, dos2unix, gcc-core, make, ncurses. First, you need to set up your cygwin environment for using the MS -tools. The following assumes that you have installed [1], [2], and [3] +tools. The following assumes that you have installed <<tps1,[1]>>, <<tps2,[2]>>, and [3] in their default directories. If this is not the case, you will need to adjust the paths accordingly. - Open a Windows Command Prompt and enter the following command: +. Open a Windows Command Prompt and enter the following command: + set PFPATH=C:\Program Files - If you are compiling on the 64-bit version of Windows 7, enter the + +. If you are compiling on the 64-bit version of Windows 7, enter the following instead: + set PFPATH=C:\Program Files (x86) - Then enter the following commands: +. Then enter the following commands: + cd "%PFPATH%\Microsoft Visual Studio 9.0\VC\bin" set FLEXDLLDIR=%PFPATH%\flexdll vcvars32 @@ -118,7 +120,8 @@ to adjust the paths accordingly. echo export PATH LIB LIBPATH INCLUDE >>C:\cygwin\tmp\msenv echo export OCAMLBUILD_FIND=/usr/bin/find >>C:\cygwin\tmp\msenv - Open a Cygwin shell and enter the following commands: +. Open a Cygwin shell and enter the following commands: + tr -d '\r' </tmp/msenv >.msenv32 echo '. $HOME/.msenv32' >>.bashrc @@ -135,9 +138,10 @@ directory of the OCaml distribution. Then, do Then, edit config/Makefile as needed, following the comments in this file. Normally, the only variable that need to be changed is + PREFIX where to install everything -Finally, use "make -f Makefile.nt" to build the system, e.g. +Finally, use `make -f Makefile.nt` to build the system, e.g. make -f Makefile.nt world make -f Makefile.nt bootstrap @@ -145,30 +149,28 @@ Finally, use "make -f Makefile.nt" to build the system, e.g. make -f Makefile.nt opt.opt make -f Makefile.nt install -NOTES: +=== NOTES * The VC++ compiler does not implement "computed gotos", and therefore -generates inefficient code for byterun/interp.c. Consequently, the +generates inefficient code for 'byterun/interp.c'. Consequently, the performance of bytecode programs is about 2/3 of that obtained under Unix/GCC or Cygwin or Mingw on similar hardware. -* Libraries available in this port: "num", "str", "threads", "graphics", -and large parts of "unix". +* Libraries available in this port: `num`, `str`, `threads`, `graphics`, +and large parts of `unix`. * The replay debugger is partially supported (no reverse execution). -CREDITS: +=== CREDITS The initial port of Caml Special Light (the ancestor of OCaml) to Windows NT was done by Kevin Gallo at Microsoft Research, who kindly contributed his changes to the OCaml project. ------------------------------------------------------------------------------- - The native Win32 and Win64 ports built with Mingw - ------------------------------------------------- +== The native Win32 and Win64 ports built with Mingw -REQUIREMENTS: +=== REQUIREMENTS Those ports run under MS Windows Seven, Vista, XP, and 2000. @@ -194,7 +196,7 @@ and the following packages for the 64-bit: mingw64-x86_64-gcc-core mingw64-x86_64-runtime -NOTES: +=== NOTES - Do not use the Cygwin version of flexdll for this port. @@ -203,7 +205,7 @@ NOTES: It is not currently supported by flexdll and OCaml. - The standard gcc compiler shipped with Cygwin used to - support a "-mno-cygwin" option, which turned the compiler + support a `-mno-cygwin` option, which turned the compiler into a mingw compiler. This option was used by previous versions of flexdll and OCaml, but it is no longer available in recent version, hence the switch @@ -213,13 +215,13 @@ NOTES: (http://mingw-w64.org/) is not supported. Please use the version packaged in Cygwin instead. -INSTALLATION: +=== INSTALLATION The binary distribution is a self-installing executable archive. Just run it and it should install OCaml automatically. -RECOMPILATION FROM THE SOURCES: +=== RECOMPILATION FROM THE SOURCES You will need the following software components to perform the recompilation: - Windows NT, 2000, XP, Vista, or Seven. @@ -227,17 +229,20 @@ You will need the following software components to perform the recompilation: Install at least the following packages (and their dependencies, as computed by Cygwin's setup.exe): - For both flavor of OCaml (32-bit and 64-bit): + * For both flavor of OCaml (32-bit and 64-bit): + diffutils make ncurses - For the 32 bit flavor of OCaml: + * For the 32 bit flavor of OCaml: + mingw64-i686-binutils mingw64-i686-gcc-core mingw64-i686-runtime - For the 64 bit flavor of OCaml: + * For the 64 bit flavor of OCaml: + mingw64-x86_64-binutils mingw64-x86_64-gcc-core mingw64-x86_64-runtime @@ -250,23 +255,26 @@ The standalone mingw toolchain from the MinGW-w64 project version packaged in Cygwin instead. Start a new Cygwin shell and unpack the source distribution -(ocaml-X.YY.Z.tar.gz) with "tar xzf". Change to the top-level +(ocaml-X.YY.Z.tar.gz) with `tar xzf`. Change to the top-level directory of the OCaml distribution. Then, do cp config/m-nt.h config/m.h cp config/s-nt.h config/s.h For a 32 bit OCaml: + cp config/Makefile.mingw config/Makefile For a 64 bit OCaml: + cp config/Makefile.mingw64 config/Makefile Then, edit config/Makefile as needed, following the comments in this file. Normally, the only variable that need to be changed is + PREFIX where to install everything -Finally, use "make -f Makefile.nt" to build the system, e.g. +Finally, use `make -f Makefile.nt` to build the system, e.g. make -f Makefile.nt world make -f Makefile.nt bootstrap @@ -275,45 +283,43 @@ Finally, use "make -f Makefile.nt" to build the system, e.g. make -f Makefile.nt install -NOTES: +=== NOTES -* Libraries available in this port: "num", "str", "threads", "graphics", - and large parts of "unix". +* Libraries available in this port: `num`, `str`, `threads`, `graphics`, + and large parts of `unix`. * The replay debugger is partially supported (no reverse execution). -* The default Makefile.mingw and Makefile.mingw64 pass -static-libgcc to +* The default Makefile.mingw and Makefile.mingw64 pass `-static-libgcc` to the linker. For more information on this topic: - http://gcc.gnu.org/onlinedocs/gcc-4.9.1/gcc/Link-Options.html#Link-Options - http://caml.inria.fr/mantis/view.php?id=6411 + - http://gcc.gnu.org/onlinedocs/gcc-4.9.1/gcc/Link-Options.html#Link-Options + - http://caml.inria.fr/mantis/view.php?id=6411 ------------------------------------------------------------------------------- +== The Cygwin port of OCaml - The Cygwin port of OCaml - ------------------------ - -REQUIREMENTS: +=== REQUIREMENTS This port requires the Cygwin environment from Cygnus/RedHat, which is freely available at: - http://www.cygwin.com/ + +http://www.cygwin.com/ It also requires the flexdll tool, available at: - http://alain.frisch.fr/flexdll.html -This port runs under all versions of MS Windows supported by Cygwin. +http://alain.frisch.fr/flexdll.html +This port runs under all versions of MS Windows supported by Cygwin. -INSTALLATION: +=== INSTALLATION We do not distribute binaries for this port, but they can be found in the Cygwin distribution (use the Setup tool from Cygwin and select the OCaml packages). Alternatively, recompile from the source distribution. -RECOMPILATION FROM THE SOURCES: +=== RECOMPILATION FROM THE SOURCES Before starting, make sure that the gcc version installed by cygwin is not 4.5.3 (it has a bug that affects OCaml). If needed, use cygwin's @@ -328,36 +334,38 @@ In order to recompile flexdll, you first need to configure, compile, and install OCaml without flexdll support (configure with options -no-shared-libs), then modify the flexdll Makefile to change line 51 from: + LINKFLAGS = -ccopt "-link version_res.o" + to: + LINKFLAGS = -cclib version_res.o -Then "make CHAINS=cygwin" and add the flexdll directory to your PATH. -Make sure to add it before "/usr/bin" or you will get cygwin's flexlink. +Then `make CHAINS=cygwin` and add the flexdll directory to your PATH. +Make sure to add it before '/usr/bin' or you will get cygwin's flexlink. Then, in OCaml's source directory, type: + make clean make distclean + and follow the instructions for Unix machines given in the file INSTALL. -NOTES: +=== NOTES - There is a problem with cygwin's port of gcc version 4.5.3. You should use cygwin's setup program to downgrade to 4.3.4 before compiling OCaml. - The replay debugger is fully supported. - When upgrading from 3.12.0 to 3.12.1, you will need to remove - /usr/local/bin/ocamlmktop.exe before typing "make install". + '/usr/local/bin/ocamlmktop.exe' before typing `make install`. - In order to use the "graph" library, you will need to use Cygwin's setup.exe to install the xinit, and libX11-devel packages before compiling OCaml. ------------------------------------------------------------------------------- +== The native Win64 port built with Microsoft Windows SDK - The native Win64 port built with Microsoft Windows SDK - ------------------------------------------------------ - -REQUIREMENTS: +=== REQUIREMENTS This port runs under MS Windows XP 64, Windows Server 64, and Windows 7 64 on Intel64/AMD64 machines. @@ -366,47 +374,51 @@ The base bytecode system (ocamlc, ocaml, ocamllex, ocamlyacc, ...) runs without any additional tools. Statically linking OCaml bytecode with C code (ocamlc -custom) requires the -Microsoft Platform SDK compiler (item [1] in the section -"third-party software" below) and the flexdll tool (item [2]). +Microsoft Platform SDK compiler (item <<tps-native1,[1]>> in the section +"third-party software" below) and the flexdll tool (item <<tps-native2,[2]>>). The native-code compiler (ocamlopt) requires the Microsoft compiler -and the Microsoft assembler MASM64 (item [1]) and the flexdll tool (item [2]). +and the Microsoft assembler MASM64 (item link:tps-native1[(1(]) +and the flexdll tool (item <<tps-native2,[2]>>). -INSTALLATION: +=== INSTALLATION: There is no binary distribution yet. Please compile from sources as described below. -THIRD-PARTY SOFTWARE: +=== THIRD-PARTY SOFTWARE -[1] Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 Service Pack 1. +[[tps-native1]] +[1]:: Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 Service Pack 1. Can be downloaded for free from http://www.microsoft.com/downloads/en/default.aspx under the name "Microsoft Windows 7 SDK". -[2] flexdll version 0.31 or later. +[[tps-native2]] +[2]:: flexdll version 0.31 or later. Can be downloaded from http://alain.frisch.fr/flexdll.html -RECOMPILATION FROM THE SOURCES: +=== RECOMPILATION FROM THE SOURCES The command-line tools can be recompiled from the Unix source -distribution (ocaml-X.YZ.tar.gz), which also contains the files modified +distribution ('ocaml-X.YZ.tar.gz'), which also contains the files modified for Windows. You will need the following software components to perform the recompilation: - Windows XP 64, Windows Server 64, or Windows 7 64. -- Items [1] and [2] from the list of recommended software above. +- Items <<tps-native1,[1]>> and <<tps-native2,[2]>> from the list of recommended software above. - The Cygwin port of GNU tools, available from http://www.cygwin.com/ Install at least the following packages: diffutils, make, ncurses. First, you need to set up your cygwin environment for using the MS -tools. The following assumes that you have installed [1] and [2] +tools. The following assumes that you have installed <<tps-native1,[1]>> and <<tps-native2,[2]>> in their default directories. If this is not the case, you will need to adjust the paths accordingly. - Open a Windows Command Prompt and enter the following commands: +. Open a Windows Command Prompt and enter the following commands: + set PFPATH=C:\Program Files (x86) cd "%PFPATH%\Microsoft Visual Studio 9.0\VC\bin" vcvars64 @@ -419,7 +431,8 @@ to adjust the paths accordingly. echo export PATH LIB LIBPATH INCLUDE >>C:\cygwin\tmp\msenv echo export OCAMLBUILD_FIND=/usr/bin/find >>C:\cygwin\tmp\msenv - Open a Cygwin shell and enter the following commands: +. Open a Cygwin shell and enter the following commands: + tr -d '\r' </tmp/msenv >.msenv64 echo '. $HOME/.msenv64' >>.bashrc @@ -436,9 +449,10 @@ directory of the OCaml distribution. Then, do Then, edit config/Makefile as needed, following the comments in this file. Normally, the only variable that need to be changed is + PREFIX where to install everything -Finally, use "make -f Makefile.nt" to build the system, e.g. +Finally, use `make -f Makefile.nt` to build the system, e.g. make -f Makefile.nt world make -f Makefile.nt bootstrap @@ -447,10 +461,10 @@ Finally, use "make -f Makefile.nt" to build the system, e.g. make -f Makefile.nt install -NOTES: +=== NOTES -* Libraries available in this port: "num", "str", "threads", "graphics", - and large parts of "unix". +* Libraries available in this port: `num`, `str`, `threads`, `graphics`, + and large parts of `unix`. * The replay debugger is partially supported (no reverse execution). |