Changeset 2340 for trunk/kBuild/doc/QuickReference-kmk.txt

Timestamp:

Apr 18, 2009, 2:05:47 PM (16 years ago)

Author:

bird

Message:

quickref: Added recipes.

File:

• trunk/kBuild/doc/QuickReference-kmk.txt (modified) (1 diff)

trunk/kBuild/doc/QuickReference-kmk.txt

@@ -974 +974 @@
 
 
+Recipes
+-------
+
+    A typical recipe takes one of the two following forms::
+
+        targets : normal-prerequisites | order-only-prerequisites
+                command
+                ...
+
+        targets : normal-prerequisites | order-only-prerequisites ; command
+                command
+                ...
+
+    Specifying more than one file in the ``targets`` lists is the same as
+    repeating the recipe for each of the files.
+
+    Use ``+`` and ``+|`` in the list of ``targets`` to tell ``kmk`` that the
+    recipe has more than one output. [1]_ The files after a ``+`` will
+    always be remade, while the files after a ``+|`` don't have to be remade.
+    The latter is frequently employed to update files which prerequisites
+    change wihtout the output files necessarily changing. See also
+    ``kmk_cp --changed``.
+
+
+Double colon recipes
+
+    Double colon recipes are written with ``::`` instead of ``:`` and are
+    handled differently from ordinary recipes if the target appears in more
+    than one recipe. First, all the recipes must be of the double colon type.
+    Second, the recipes are executed individually and may be omitted depending
+    on the state of their prerequisites. Double colon recipes without any
+    prerequisites will always be executed.
+
+
+Pattern rules
+
+    A couple of examples::
+
+        %.o : %.c
+                gcc -o $@ $<
+        %.tab.c %.tab.h : %.y
+                bison -d $<
+
+    The latter has two outputs.
+
+
 -----