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

Timestamp:

Dec 30, 2008, 5:09:46 PM (17 years ago)

Author:

bird

Message:

kmk-qr: built-in and external commands. rewrote the introduction.

File:

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

trunk/kBuild/doc/QuickReference-kmk.txt

@@ -3 +3 @@
 ===================
 
-This appendix summarizes the directives, text manipulation functions, and
-special variables which ``kmk`` understands.
-
-.. See section Special Built-in Target Names and Summary of Options, for other
-   summaries.
+This is an attempt at summarizing all directives, functions, special variables,
+special targets, built-in commands, external commands, and ``kmk`` expressions.
+Since *all* the features are included, the quickness of this reference can be
+disputed. ;-)
 
 
@@ -756 +755 @@
 
 
-Built-in Commands
------------------
-
-todo
-
+Commands
+--------
+
+Builtin commands all start with ``kmk_builtin_``, so in order to save space
+this prefix has been omitted in the table below. All commands comes in an
+external edition that can be used by/in the shell, these are prefixed ``kmk_``.
+
++---------------+-------------------------------------------------------------+
+| Command       | Description                                                 |
++===============+=============================================================+
+| ``append``    | Append text to a file. The builtin version can output the   |
+|               | value of a variable or the commands of a target.            |
++---------------+-------------------------------------------------------------+
+| ``cat``       | The BSD ``cat`` command.                                    |
++---------------+-------------------------------------------------------------+
+| ``chmod``     | The BSD ``chmod`` command.                                  |
++---------------+-------------------------------------------------------------+
+| ``cmp``       | The BSD ``cmp`` command.                                    |
++---------------+-------------------------------------------------------------+
+| ``cp``        | The BSD ``cp`` command with some twaking.                   |
++---------------+-------------------------------------------------------------+
+| ``echo``      | The BSD ``echo`` command.                                   |
++---------------+-------------------------------------------------------------+
+| ``expr``      | The BSD ``expr`` command.                                   |
++---------------+-------------------------------------------------------------+
+| ``install``   | The BSD ``install`` command with some tweaking.             |
++---------------+-------------------------------------------------------------+
+| ``kDepIDB``   | Extract dependencies from a Visual C++ .IDB file.           |
++---------------+-------------------------------------------------------------+
+| ``ln``        | The BSD ``ln`` command.                                     |
++---------------+-------------------------------------------------------------+
+| ``md5sum``    | Typical MD5 sum program, custom kBuild version.             |
++---------------+-------------------------------------------------------------+
+| ``mkdir``     | The BSD ``mkdir`` command.                                  |
++---------------+-------------------------------------------------------------+
+| ``mv``        | The BSD ``mv`` command with some tweaking.                  |
++---------------+-------------------------------------------------------------+
+| ``printf``    | The BSD ``printf`` command.                                 |
++---------------+-------------------------------------------------------------+
+| ``rm``        | The BSD ``rm`` command with some tweaking.                  |
++---------------+-------------------------------------------------------------+
+| ``rmdir``     | The BSD ``rmdir`` command with some tweaking.               |
++---------------+-------------------------------------------------------------+
+| ``sleep``     | Typical ``sleep`` program, custom kBuild version.           |
++---------------+-------------------------------------------------------------+
+| ``test``      | The BSD ``test`` program with some tweaking.                |
++---------------+-------------------------------------------------------------+
+
+Some additional external commands are available in the ``kmk`` / ``kBuild``
+environment (``kSomething`` command are not prefixed with ``kmk_``):
+
++---------------+-------------------------------------------------------------+
+| Command       | Description                                                 |
++===============+=============================================================+
+| ``kDepPre``   | Extract dependencies from the C/C++ preprocessor output.    |
++---------------+-------------------------------------------------------------+
+| ``kObjCache`` | Simple object file cache program.                           |
++---------------+-------------------------------------------------------------+
+| ``ash``       | Almquist's shell (NetBSD variant).                          |
++---------------+-------------------------------------------------------------+
+| ``gmake``     | Vanilla GNU ``make`` from same sources as ``kmk``.          |
++---------------+-------------------------------------------------------------+
+| ``redirect``  | Shell avoidance tool. Sets up file descriptors, environment |
+|               | variables and current directory before kicking of program.  |
++---------------+-------------------------------------------------------------+
+| ``sed``       | GNU ``sed`` with some tweaks to avoid involving the shell.  |
++---------------+-------------------------------------------------------------+
+| ``time``      | Stopwatch utility for measuring program execution time(s).  |
++---------------+-------------------------------------------------------------+