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

Timestamp:

Dec 30, 2008, 6:07:09 PM (17 years ago)

Author:

bird

Message:

kmk-qr: started marking kmk specific features.

File:

• trunk/kBuild/doc/QuickReference-kmk.txt (modified) (8 diffs)

trunk/kBuild/doc/QuickReference-kmk.txt

@@ -8 +8 @@
 disputed. ;-)
 
+Features that are
 
 Directives
@@ -29 +30 @@
         ifneq "a" "b"
         ifneq 'a' 'b'
-        if1of (set-a,set-b)
-        ifn1of (set-a,set-b)
-        if expression
+        if1of (set-a,set-b)             [1]
+        ifn1of (set-a,set-b)            [1]
+        if expression                   [1]
         else
         endif
@@ -41 +42 @@
         sinclude file
 
-    Include another dependency file::
+    Include another dependency file [1]_::
 
         includedep file
@@ -51 +52 @@
         override variable := value
         override variable += value
-        override variable <= value
+        override variable <= value      [1]
         override variable ?= value
         override define variable
@@ -67 +68 @@
         export variable := value
         export variable += value
-        export variable <= value
+        export variable <= value        [1]
         export variable ?= value
         unexport variable
 
-    Define a variable in the local context instead of the global one::
+    Define a variable in the local context instead of the global one [1]_::
 
         local variable = value
@@ -178 +179 @@
 +--------------------------+--------------------------------------------------+
 | ``KBUILD_VERSION``,      | The kBuild version string and the break down     |
-| ``KBUILD_VERSION_MAJOR``,| into individual components.                      |
+| ``KBUILD_VERSION_MAJOR``,| into individual components. [1]_                 |
 | ``KBUILD_VERSION_MINOR``,|                                                  |
 | ``KBUILD_VERSION_PATCH``,|                                                  |
 | ``KBUILD_KMK_REVISION``  |                                                  |
 +--------------------------+--------------------------------------------------+
-| ``KBUILD_HOST``          | The host operating system.                       |
-+--------------------------+--------------------------------------------------+
-| ``KBUILD_HOST_ARCH``     | The host architecture.                           |
-+--------------------------+--------------------------------------------------+
-| ``KBUILD_HOST_CPU``      | The host CPU ``kmk`` is built for, set to        |
+| ``KBUILD_HOST`` [1]_     | The host operating system.                       |
++--------------------------+--------------------------------------------------+
+| ``KBUILD_HOST_ARCH`` [1]_| The host architecture.                           |
++--------------------------+--------------------------------------------------+
+| ``KBUILD_HOST_CPU`` [1]_ | The host CPU ``kmk`` is built for, set to        |
 |                          | ``blend`` if not any particular CPU.             |
 +--------------------------+--------------------------------------------------+
-| ``KBUILD_PATH``          | Where the kBuild scripts are.                    |
-+--------------------------+--------------------------------------------------+
-| ``KBUILD_BIN_PATH``      | Where the host specific kBuild binaries are.     |
-+--------------------------+--------------------------------------------------+
-| ``KMK``,                 | The name with which ``kmk`` was invoked. Using   |
+| ``KBUILD_PATH`` [1]_     | Where the kBuild scripts are.                    |
++--------------------------+--------------------------------------------------+
+| ``KBUILD_BIN_PATH`` [1]_ | Where the host specific kBuild binaries are.     |
++--------------------------+--------------------------------------------------+
+| ``KMK`` [1]_,            | The name with which ``kmk`` was invoked. Using   |
 | ``MAKE``                 | this variable in recipes has special meaning.    |
 +--------------------------+--------------------------------------------------+
-| ``KMK_BUILTIN``          | List of built-in commands.                       |
-+--------------------------+--------------------------------------------------+
-| ``KMK_FEATURES``         | List of ``kmk`` specific features.               |
-+--------------------------+--------------------------------------------------+
-| ``KMK_FLAGS``            | The flags given to ``kmk``. You can set this in  |
+| ``KMK_BUILTIN`` [1]_     | List of built-in commands.                       |
++--------------------------+--------------------------------------------------+
+| ``KMK_FEATURES`` [1]_    | List of ``kmk`` specific features.               |
++--------------------------+--------------------------------------------------+
+| ``KMK_FLAGS`` [1]_       | The flags given to ``kmk``. You can set this in  |
 |                          | the environment or a makefile to set flags.      |
 |                          |                                                  |
@@ -210 +211 @@
 |                          | through the environment from its parent.         |
 +--------------------------+--------------------------------------------------+
-| ``KMK_LEVEL``            | The number of levels of recursion (sub-makes).   |
-+--------------------------+--------------------------------------------------+
-| ``KMK_VERSION``          | The GNU ``make`` version number.                 |
+| ``KMK_LEVEL`` [1]_       | The number of levels of recursion (sub-makes).   |
++--------------------------+--------------------------------------------------+
+| ``KMK_VERSION`` [1]_     | The GNU ``make`` version number.                 |
 +--------------------------+--------------------------------------------------+
 | ``MAKECMDGOALS``         | The targets given to ``kmk`` on the command line.|
@@ -904 +905 @@
 -----
 
+.. [1] ``kmk`` only feature.
+
+-----
+
 :Status: $Id$
 :Copyright: Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,