The unpac monorepo manager self-hosting as a monorepo using unpac
INSTALL.adoc: more info, fix typos
+18
-16
+18
-16
INSTALL.adoc
+18
-16
INSTALL.adoc
···
7
7
** For GNU/Linux +
8
8
The GNU C Compiler (`gcc`) is recommended as the bytecode interpreter takes
9
9
advantage of GCC-specific features to enhance performance. GCC is the standard
10
-
compiler under Linux and many other systems.
10
+
compiler under Linux and many other systems. Clang (`clang`) should also be a
11
+
safe choice.
11
12
12
13
** For BSDs +
13
-
`clang` is the default C compiler on BSDs - also works fine.
14
+
Clang (`clang`) is the default C compiler on BSDs - also works fine.
14
15
15
16
** For macOS +
16
-
`clang` is the default C compiler under macOS. If macOS complains
17
-
no C compiler was installed while OCaml is building, please run
18
-
command `xcode-select --install` to install command-line tools and
19
-
required libraries and header files.
17
+
Apple Clang (`clang`) is the default C compiler under macOS. If macOS
18
+
complains that no C compiler is installed while OCaml is building, run
19
+
command `xcode-select --install` to install command-line tools, required
20
+
libraries, and header files.
20
21
21
22
** For other Unix-like systems +
22
23
It is recommended to use `gcc` or `clang` instead of the C compiler
···
26
27
To produce native Windows executables from OCaml sources, you need to use
27
28
the MSVC or MinGW-w64 ports of OCaml, described in file
28
29
xref:README.win32.adoc[]. +
29
-
For a more Unix-like experience, you can use WSL, the
30
-
https://aka.ms/wsl[Windows Subsystem for Linux], or the
31
-
https://www.cygwin.com/[Cygwin environment]. You will need the
30
+
For a more Unix-like experience, you can use the
31
+
https://aka.ms/wsl[Windows Subsystem for Linux] (WSL), or the
32
+
https://www.cygwin.com/[Cygwin environment]. With Cygwin, you will need the
32
33
GCC compiler (package `gcc-core` or `gcc`).
33
34
34
-
* GNU `make`, as well as POSIX-compatible `awk` and `sed` are required.
35
+
* GNU Make (`make` or `gmake`), as well as POSIX-compatible `awk` and `sed` are
36
+
required.
35
37
36
38
* A POSIX-compatible `diff` is necessary to run the test suite.
37
39
···
68
70
./configure --help
69
71
----
70
72
71
-
Some options or variables like LDLIBS may not be taken into account
73
+
Some options or variables like `LDLIBS` may not be taken into account
72
74
by the OCaml build system at the moment. Please report an issue if you
73
75
discover such a variable or option and this causes troubles to you.
74
76
···
95
97
./configure CC=xlc
96
98
----
97
99
+
98
-
By default, build is 32-bit. For 64-bit build, please set environment variable `OBJECT_MODE=64`
100
+
By default, the build is 32-bit. For the 64-bit build, set the environment variable `OBJECT_MODE=64`
99
101
for _both_ `configure` and `make world` phases. Note, if this variable is set for only one phase,
100
102
your build will break (`ocamlrun` segfaults).
101
103
···
107
109
----
108
110
./configure CC="cc -m64"
109
111
----
110
-
+
112
+
111
113
If something goes wrong during the automatic configuration, or if the generated
112
114
files cause errors later on, then look at the template files:
113
-
+
115
+
114
116
----
115
117
Makefile.config.in
116
118
Makefile.build_config.in
117
119
runtime/caml/m.h.in
118
120
runtime/caml/s.h.in
119
121
----
120
-
+
122
+
121
123
for guidance on how to edit the generated files by hand.
122
124
123
125
== Building the compiler
···
195
197
this file.
196
198
197
199
Check the files `m.h` and `s.h` in `runtime/caml/`.
198
-
Wrong endianness or alignment constraints in `machine.h` will
200
+
Wrong endianness or alignment constraints in `m.h` will
199
201
immediately crash the bytecode interpreter.
200
202
201
203
If you get a "segmentation violation" signal, check the limits on the stack size