+14 -14

HACKING.adoc

reviewed

··· 248 248 https://editorconfig.org/#download[plugins]. 249 249 250 250 [#opam-switch] 251 251 - === Testing with `opam` 251 251 + === Testing with opam 252 252 253 253 If you are working on a development version of the compiler, you can create an 254 254 opam switch from it by running the following from the development repository: ··· 267 267 opam pin add ocaml-variants git+https://$REPO#branch 268 268 ---- 269 269 270 270 - ==== Incremental builds with `opam` 270 270 + ==== Incremental builds with opam 271 271 272 272 This section documents some tips to speed up your workflow when you need to 273 273 alternate between testing your branch and patching the compiler. ··· 276 276 ===== Initial setup 277 277 278 278 For the rest of the section to work, you'll need your compiler to be 279 279 - configured in the same way as `opam` would have configured it. The simplest 279 279 + configured in the same way as opam would have configured it. The simplest 280 280 way is to run the normal commands for the switch initialization, with the extra 281 281 `--inplace-build` flag: 282 282 ··· 287 287 288 288 However, if you need specific configuration options, you can also configure it 289 289 manually, as long as you make sure that the configuration prefix is the one 290 290 - where `opam` would install the compiler. 290 290 + where opam would install the compiler. 291 291 You will then need to install the compiler, either from the working directory 292 292 (that you must build yourself) or using the regular sandboxed builds. 293 293 ··· 309 309 ===== Basic workflow 310 310 311 311 We will assume that the workflow alternates between work on the compiler and 312 312 - external (`opam`-related) commands. 312 312 + external (opam-related) commands. 313 313 As an example, debugging an issue in the compiler can be done by a first step 314 314 - that triggers the issue (by installing a given `opam` package), then adding 314 314 + that triggers the issue (by installing a given opam package), then adding 315 315 some logging to the compiler, re-trigger the issue, and based on the logs either 316 316 add more logging, or try a patch, and so on. 317 317 ··· 328 328 329 329 In our case, we need to build the compiler, and when we've built everything 330 330 that we need then we run `opam custom-install ocaml-variants -- make install`. 331 331 - This will make `opam` remove the previously installed version of the compiler 331 331 + This will make opam remove the previously installed version of the compiler 332 332 (if any), then install the new one in its stead. 333 333 334 334 ----- ··· 336 336 opam custom-install ocaml-variants -- make install 337 337 ----- 338 338 339 339 - Since most `opam` packages depend on the compiler, this will trigger a 339 339 + Since most opam packages depend on the compiler, this will trigger a 340 340 reinstallation of all the packages in the switch. 341 341 If you want to avoid that (for instance, your patch only adds some logging 342 342 so you expect the core libraries and all the already compiled packages to be ··· 352 352 353 353 Note about the first installation: 354 354 When you start from an empty switch, and install a compiler (in our case, 355 355 - the `ocaml-variants` package provided by the compiler's `opam` file), then 355 355 + the `ocaml-variants` package provided by the compiler's opam file), then 356 356 a number of additional packages are installed to ensure that the switch 357 357 will work correctly. Mainly, the `ocaml` package needs to be installed, 358 358 - and while it's done automatically when using regular `opam` commands, the 358 358 + and while it's done automatically when using regular opam commands, the 359 359 `custom-install` plugin will not force installation of dependencies. 360 360 Moreover, if you try to fix the problem by manually installing the `ocaml` 361 361 - package, `opam` will try to recompile `ocaml-variants`, using the default 361 361 + package, opam will try to recompile `ocaml-variants`, using the default 362 362 instructions. You can get around this by running 363 363 `opam reinstall --forget-pending` just after the `opam custom-install` command 364 364 and just before the `opam install ocaml command`. ··· 381 381 bytecode tools are installed, whereas with a raw `make install` you will have 382 382 stale native binaries remaining in your switch. 383 383 Since it's significantly faster to build the bytecode version of the tools, 384 384 - and many `opam` packages will pick the native version of the compilers if 384 384 + and many opam packages will pick the native version of the compilers if 385 385 present and the bytecode version otherwise, you can build your initial switch 386 386 with the native versions (to get quickly to a state where a bug appears), 387 387 then clean your working directory and start building bytecode tools only ··· 389 389 390 390 ===== Without `opam-custom-install` 391 391 392 392 - You can achieve some improvements using built-in `opam` commands. 392 392 + You can achieve some improvements using built-in opam commands. 393 393 394 394 Using `opam install . --assume-built` will simply remove the 395 395 package for the compiler, then run the installation instructions ··· 400 400 401 401 You can also run `make install` manually, which will not trigger a 402 402 recompilation, but will not remove the previous version either and can 403 403 - mess with `opam`'s tracking of installed files. 403 403 + mess with opam's tracking of installed files. 404 404 405 405 === Useful Makefile targets and options 406 406

+1 -1

INSTALL.adoc

reviewed

··· 205 205 generates code for a different machine, named the _target_. To build a cross 206 206 compiler you first need to have a non-cross compiler of the same version 207 207 installed in your `$PATH`. You can install that standard non-cross compiler by 208 208 - any means, for instance using `opam` or compiling it manually from source. Note 208 208 + any means, for instance using opam or compiling it manually from source. Note 209 209 though that the version of the non-cross compiler must match the version of the 210 210 cross compiler since the cross compiler will be compiled by the non-cross 211 211 compiler: the cross compiler will combine code compiled from source with the

+2 -2

README.adoc

reviewed

··· 152 152 == Separately maintained components 153 153 154 154 Some libraries and tools which used to be part of the OCaml distribution are 155 155 - now maintained separately and distributed as OPAM packages. 155 155 + now maintained separately and distributed as opam packages. 156 156 Please use the issue trackers at their respective new homes: 157 157 158 158 |==== 159 159 - | Library | Removed since | OPAM package 159 159 + | Library | Removed since | opam package 160 160 161 161 | https://github.com/ocaml/camlp-streams/issues[The Stream and Genlex standard library modules] | OCaml 5.0 | `camlp-streams` 162 162 | https://github.com/ocaml/graphics/issues[The Graphics library] | OCaml 4.09 | `graphics`