aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIgor Pashev <igor.pashev@nexenta.com>2012-10-02 22:20:32 +0400
committerIgor Pashev <igor.pashev@nexenta.com>2012-10-02 22:20:32 +0400
commit5c3ab096b102872ceba3548499cc6e7f1b1de162 (patch)
treec54cab827036ed8b0e2f256d638db3f5055422bf /README.md
parent0e65b379a1d8eb1f629fa24361900ccc70a8a27f (diff)
downloadcibs-5c3ab096b102872ceba3548499cc6e7f1b1de162.tar.gz
Describe targets in common.mk
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 19 insertions, 7 deletions
diff --git a/README.md b/README.md
index 4f62eb3..4e2eb7f 100644
--- a/README.md
+++ b/README.md
@@ -31,17 +31,29 @@ and it should not be included directly, unless you are doing something really sp
### Targets provided by common.mk
-All targets provided by this module are abstract and do nothing. Other modules extend
-these targets. Each target (but `clean`) has its annex `target-stamp` which does
+All targets (but `clean`) provided by this module are abstract and do nothing. Other modules extend
+these targets. Each target has its annex `target-stamp` which does
the real job. Each `*-stamp` is a file created with `touch` command. All internal
dependencies are implemented through these "stamps", but developer can use only basename
for target, e. g. `make unpack` instead of `make unpack-stamp`.
-* `unpack` -
-* `patch` -
-* `configure` -
-* `build` -
-* `install` -
+Meaning of these targets depends on other included modules:
+
+* `unpack` - put sources into the source directory (`./work/source` by default),
+* `patch` - modify sources,
+* `configure` - configure sources, e. g. execute GNU configure or CMake,
+* `build` - build sources, e. g. compile with C compiler,
+* `install` - install files into proto directory.
+* `clean` - remove all stamps and working directory (`./work` by default)
+
+
+`clean` has [double-colon rule](http://www.gnu.org/software/make/manual/html_node/Double_002dColon.html)
+and by default it is:
+
+ clean::
+ rm -f *-stamp
+ rm -rf $(workdir)
+
## ips.mk