summaryrefslogtreecommitdiff
path: root/stdlib
diff options
context:
space:
mode:
authorTheAspiringHacker <theaspiringhacker@protonmail.com>2018-08-20 21:12:53 -0400
committerTheAspiringHacker <theaspiringhacker@protonmail.com>2018-08-20 21:12:53 -0400
commit00953cc221ff39429d7d77e6978c3cfe30ccf531 (patch)
tree9d7ff7e6ac6a6c3b9a512b6237b930adef3f3937 /stdlib
parent001dcf2dc6d4a3b7ac1ce867e0a8151f4545f912 (diff)
downloadocaml-00953cc221ff39429d7d77e6978c3cfe30ccf531.tar.gz
Correct wrong instructions for otherlibs/threads/Makefile; state that partialclean may be used instead of clean
Diffstat (limited to 'stdlib')
-rw-r--r--stdlib/HACKING.adoc12
1 files changed, 7 insertions, 5 deletions
diff --git a/stdlib/HACKING.adoc b/stdlib/HACKING.adoc
index 81656ccb69..407d079e34 100644
--- a/stdlib/HACKING.adoc
+++ b/stdlib/HACKING.adoc
@@ -3,11 +3,11 @@
For guidelines about standard library content, see
link:../CONTRIBUTING.md#contributing-to-the-standard-library[].
+Note: All paths are given relative to the root of the repository.
+
First, build the compiler. Run `./configure`, then `make world.opt`. See
link:../HACKING.adoc[].
-Note: All paths are given relative to the root of the repository.
-
To add a new module, you must:
* Create new `.mli` and `.ml` files for the modules, obviously.
@@ -19,8 +19,10 @@ To add a new module, you must:
aliases. Note that `otherlibs/threads/stdlib.mli` is a symbolic link to
`stdlib/stdlib.mli`.
-* Add `$(P)module_name.cmo` to the definition of `OTHERS` in `stdlib/Makefile`
- and `otherlibs/threads/Makefile`.
+* Add `$(P)module_name.cmo` to the definition of `OTHERS` in `stdlib/Makefile`.
+
+* Add `$(LIB)/$(P)module_name.cmo` to the definition of `LIB_OBJS` in
+ `otherlibs/threads/Makefile`.
* Add `$(P)module_name` to the definition of `STDLIB_MODULES` in
`stdlib/StdlibModules`. Please maintain the alphabetical order.
@@ -28,7 +30,7 @@ To add a new module, you must:
* Run `make alldepend` to update all the `.depend` files. These files are not
edited by hand.
-* Run `make clean`, then `make world.opt`.
+* Run `make clean` or `make partialclean`, then `make world.opt`.
If you are adding multiple modules, follow the steps above and rebuild the
compiler after adding each module. If you add multiple modules before