From 4e71ddd1c6500108908d5691987f26a91bffa541 Mon Sep 17 00:00:00 2001
From: lmamane
Date: Wed, 25 Jul 2007 13:57:12 +0000
Subject: Add glob.dump to Makefile the recommended way and document the
 recommended way more explicitly.

git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/coq/trunk@10050 85f007b7-540e-0410-9357-904b9bb8a0f7
---
 dev/doc/build-system.txt | 29 ++++++++++++++++++++++++-----
 1 file changed, 24 insertions(+), 5 deletions(-)

(limited to 'dev/doc')

diff --git a/dev/doc/build-system.txt b/dev/doc/build-system.txt
index c79a561542..516664720c 100644
--- a/dev/doc/build-system.txt
+++ b/dev/doc/build-system.txt
@@ -123,13 +123,27 @@ Exceptions are:
    RECTYPESML in Makefile.common. If it is a .ml4 file, implement
    RECTYPESML4 or '(*i ocamlflags i*)'; see TODO.
 
-New PHONY targets
------------------
+ - the file needs a specific Makefile entry; add it to Makefile.build
 
-If you want to add a new PHONY target to the build system, that is a
-target that is not the name of the file it creates, then:
+ - the files produced from the added file do not match an existing
+   pattern or entry in "Makefile". (All the common cases of
+   .ml{,i,l,y,4}, .v, .c, ... files that produces (respectively)
+   .cm[iox], .vo, .glob, .o, ... files with the same basename are
+   already covered.) In this case, see section "New targets".
 
- - add its rule to Makefile.build
+New targets
+-----------
+
+If you want to add:
+
+ - a new PHONY target to the build system, that is a target that is
+   not the name of the file it creates,
+
+ - a normal target is not already mapped to a stage by "Makefile"
+
+ then:
+
+ - add the necessary rule to Makefile.build, if any
  - add the target to STAGEn_TARGETS, with n being the smallest stage
    it can be built at, that is:
    * 1 for OCaml code that doesn't use any Coq camlp4 grammar extension
@@ -138,6 +152,11 @@ target that is not the name of the file it creates, then:
        does.
    * 3 for Coq (.v) code.
 
+   *or*
+
+   add a pattern matching the target to the pattern lists for the
+   smallest stage it can be built at in "Makefile".
+
 TODO
 ----
 
-- 
cgit v1.2.3