infer_clone/infer/src/README.md

The OCaml source files for infer live here. The Makefile is
responsible for building them, together with jbuild.in.
[make] s/ocamlbuild/jbuilder/g Summary: Use jbuilder to build infer instead of ocamlbuild. This is mainly to get faster builds: ``` times in 10ms, ±differences measured in speedups, 4 cores \| \| ocb total \| jb \| ±total \| ocb user \| jb \| ±user \| ocb cpu \| jb \| ±cpu \| ocb sys \| jb \| ±sys \| \|-----------------------------------+-----------+------+--------+----------+------+-------+---------+-----+------+---------+------+------\| \| byte from scratch \| 6428 \| 2456 \| 2.62 \| 7743 \| 6662 \| 1.16 \| 138 \| 331 \| 2.40 \| 1184 \| 1477 \| 0.80 \| \| native from scratch \| 9841 \| 4289 \| 2.29 \| 9530 \| 8834 \| 1.08 \| 110 \| 245 \| 2.23 \| 1373 \| 1712 \| 0.80 \| \| byte after native \| 29578 \| 1602 \| 18.46 \| 4514 \| 4640 \| 0.97 \| 170 \| 325 \| 1.91 \| 543 \| 576 \| 0.94 \| \| change infer.ml byte \| 344 \| 282 \| 1.22 \| 292 \| 215 \| 1.36 \| 96 \| 99 \| 1.03 \| 040 \| 066 \| 0.61 \| \| change infer.ml native \| 837 \| 223 \| 3.75 \| 789 \| 174 \| 4.53 \| 98 \| 99 \| 1.01 \| 036 \| 47 \| 0.77 \| \| change Config.ml byte \| 451 \| 339 \| 1.33 \| 382 \| 336 \| 1.14 \| 97 \| 122 \| 1.26 \| 056 \| 80 \| 0.70 \| \| change Config.ml native \| 4024 \| 1760 \| 2.29 \| 4585 \| 4225 \| 1.09 \| 127 \| 276 \| 2.17 \| 559 \| 644 \| 0.87 \| \| change cFrontend_config.ml byte \| 348 \| 643 \| 0.54 \| 297 \| 330 \| 0.90 \| 96 \| 67 \| 0.70 \| 038 \| 102 \| 0.37 \| \| change cFrontend_config.ml native \| 1480 \| 584 \| 2.53 \| 1435 \| 906 \| 1.58 \| 106 \| 185 \| 1.75 \| 136 \| 178 \| 0.76 \| #+TBLFM: $4=$2/$3;f2::$7=$5/$6;f2::$10=$9/$8;f2::$13=$11/$12;f2 50 cores \| \| ocb total \| jb \| ±total \| ocb user \| jb \| ±user \| ocb cpu \| jb \| ±cpu \| ocb sys \| jb \| ±sys \| \|---------------------+-----------+------+--------+----------+------+-------+---------+----+------+---------+------+------\| \| byte from scratch \| 9114 \| 2061 \| 4.42 \| 9334 \| 5133 \| 1.82 \| \| \| 0/0 \| 2566 \| 1726 \| 1.49 \| \| native from scratch \| 13481 \| 3967 \| 3.40 \| 12291 \| 7608 \| 1.62 \| \| \| 0/0 \| 3003 \| 2100 \| 1.43 \| \| byte after native \| 3467 \| 1476 \| 2.35 \| 5067 \| 3912 \| 1.30 \| \| \| 0/0 \| 971 \| 801 \| 1.21 \| #+TBLFM: $4=$2/$3;f2::$7=$5/$6;f2::$10=$9/$8;f2::$13=$11/$12;f2 ``` Menu: 1. Write a jbuild file, autogenerated from jbuild.in because we need to fill in some information at build-time (really, at configure time, but TODO), such as whether or not clang is enabled. 2. Nuke lots of stuff from infer/src/Makefile that is now in the jbuild file 3. The jbuild file lives in infer/src/ so it can see all the sources. If we put it somewhere else, eg, infer/, then `jbuilder` scans too many files (all irrelevant) and takes 2.5s to start instead of .8s. Adding irrelevant directories to jbuild-ignore does not help. 4. jbuilder does not support subdirectories, so resort to listing all the source files in the generated jbuild (only source directories need to be manually listed in jbuild.in though). Still, the generated .merlin is wrong and makes merlin find source files in _build, so manually tune it to get good merlin support. We also lose some of merlin for unit tests as it cannot see their build artefacts anymore. 5. checkCopyright gets its own jbuild because it's standalone. Also, remove some deprecation warnings in checkCopyright due to the new version of Core from a while ago. 6. Drop less-used Makefile features (they had regressed anyway) such as building individual modules. Also, building mod_dep.pdf now takes all the source files available so they better build (before, it would only take the source files from the config, eg with or without clang) (that's pretty minor). 7. The toplevel is now built as a custom toplevel because that was easier. It should soon be even easier: https://github.com/janestreet/jbuilder/issues/210 8. Move BUILTINS.mli to BUILTINS.ml because jbuilder is not happy about interface files without implementations. In particular, I did not try to migrate too much of the Makefile logic to jbuilder, more can be done in the future. Reviewed By: jberdine Differential Revision: D5573661 fbshipit-source-id: 4ca6d8f 7 years ago			`The OCaml source files for infer live here. The Makefile is`
			`responsible for building them, together with jbuild.in.`