aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorcoqbot-app[bot]2020-08-26 03:25:56 +0000
committerGitHub2020-08-26 03:25:56 +0000
commit48bd6534edc6b3e6b9309a443fabbb869f6957f9 (patch)
tree3af3c09416a4cb818401846a13244eee643c9aab /doc
parente01f9df8aa68ecae26bce15544b7244ced1b2be5 (diff)
parent2a703ebef927b1eaab43279efef4dde8c99c6384 (diff)
Merge PR #12884: Documentation of coq_makefile: fix name of installation dir + help on using option -f
Reviewed-by: jfehrle Ack-by: herbelin
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/practical-tools/utilities.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/sphinx/practical-tools/utilities.rst b/doc/sphinx/practical-tools/utilities.rst
index d9992029ba..daae46ad11 100644
--- a/doc/sphinx/practical-tools/utilities.rst
+++ b/doc/sphinx/practical-tools/utilities.rst
@@ -89,10 +89,11 @@ invoking ``coq_makefile`` is the following one:
Such command generates the following files:
CoqMakefile
- is a generic makefile for ``GNU Make`` that provides
- targets to build the project (both ``.v`` and ``.ml*`` files), to install it
- system-wide in the ``coq-contrib`` directory (i.e. where |Coq| is installed)
- as well as to invoke coqdoc to generate HTML documentation.
+ is a makefile for ``GNU Make`` with targets to build the project
+ (e.g. generate .vo or .html files from .v or compile .ml* files)
+ and install it in the ``user-contrib`` directory where the |Coq|
+ library is installed. Run ``make`` with the ``-f CoqMakefile``
+ option to use ``CoqMakefile``.
CoqMakefile.conf
contains make variables assignments that reflect