File: HACKING.adoc

package info (click to toggle)
ocaml 5.3.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 43,124 kB
  • sloc: ml: 355,439; ansic: 51,636; sh: 25,098; asm: 5,413; makefile: 3,673; python: 919; javascript: 273; awk: 253; perl: 59; fortran: 21; cs: 9
file content (30 lines) | stat: -rw-r--r-- 1,115 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
= Contributing to the standard library

For guidelines about standard library content, see
link:CONTRIBUTING.md[].

Note: All paths are given relative to the root of the repository.

First, build the compiler. Run `./configure`, then `make`. See
link:../HACKING.adoc[].

To add a new module, you must:

* Create new `.mli` and `.ml` files for the modules, obviously.

* Define the module in `stdlib/stdlib.mli` and `stdlib/stdlib.ml` in
  the section of the code commented "MODULE_ALIASES". Please maintain
  the same style as the rest of the code, in particular the
  alphabetical ordering and whitespace alignment of module aliases.

* Add `module_name` to the definition of `STDLIB_MODULE_BASENAMES` in
  `stdlib/StdlibModules`. You must keep the list sorted in dependency order.

* Run `make alldepend` to update all the `.depend` files. These files are not
  edited by hand.

* Run `make clean` or `make partialclean`, then `make`.

If you are adding multiple modules, follow the steps above and rebuild the
compiler after adding each module. If you add multiple modules before
rebuilding, the build may fail.