This directory contains information and tools to help develop the Rocq system

January 13, 2025 ยท View on GitHub

Debugging and profiling (dev/)

More info on debugging: dev/doc/debugging.md

FileDescription
dev/ocamldebug-coqTo launch ocaml debugger (generated by the configure script)
dev/dbTo install pretty-printers from ocaml debugger
dev/base_dbTo install raw pretty-printers from ocaml debugger
dev/includeTo install pretty-printers from ocaml toplevel (use with the coq Drop command)
dev/base_includeTo install raw pretty-printers from ocaml toplevel
dev/vm_printers.ml, top_printers.mlML pretty-printers for debugging

Miscellaneous information about the code (dev/doc)

Beginner's guide to hacking Rocq: dev/doc/README.md

FileDescription
dev/doc/changes.md(partial) Per-version summary of the evolution of Rocq ML source
dev/doc/style.txtA few style recommendations for writing Rocq ML files
dev/doc/debugging.mdHelp for debugging or profiling
dev/doc/universes.mdHelp for debugging universes
dev/doc/econstr.mdDescribes Econstr, implementation of treatment of evar in the engine
dev/doc/primproj.mdDescribes primitive projections
dev/doc/parsing.mdGrammar and parsing overview
dev/doc/proof-engine.mdTutorial on new proof engine
dev/doc/xml-protocol.mdXML protocol that coqtop and IDEs use to communicate
dev/doc/release-process.mdProcess of creating a new Rocq release

Documentation of ML interfaces using odoc ( _build/default/_doc)

make apidoc in coq root directory.

Other development tools (dev/tools)

FileDescription
dev/tools/coqdev.elHelper customizations for everyday Rocq development, eg making compile work in subdirectories