VirtualBox

Changeset 2169 in kBuild for trunk


Ignore:
Timestamp:
Dec 30, 2008 5:07:09 PM (16 years ago)
Author:
bird
Message:

kmk-qr: started marking kmk specific features.

Location:
trunk/kBuild/doc
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/kBuild/doc/QuickReference-kmk.html

    r2168 r2169  
    297297Since <em>all</em> the features are included, the quickness of this reference can be
    298298disputed. ;-)</p>
     299<p>Features that are</p>
    299300<div class="section">
    300301<h1><a id="directives" name="directives">Directives</a></h1>
    … …  
    316317ifneq &quot;a&quot; &quot;b&quot;
    317318ifneq 'a' 'b'
    318 if1of (set-a,set-b)
    319 ifn1of (set-a,set-b)
    320 if expression
     319if1of (set-a,set-b)             [1]
     320ifn1of (set-a,set-b)            [1]
     321if expression                   [1]
    321322else
    322323endif
    … …  
    328329sinclude file
    329330</pre>
    330 <p>Include another dependency file:</p>
     331<p>Include another dependency file <a class="footnote-reference" href="#id15" id="id1" name="id1">[1]</a>:</p>
    331332<pre class="literal-block">
    332333includedep file
    … …  
    338339override variable := value
    339340override variable += value
    340 override variable &lt;= value
     341override variable &lt;= value      [1]
    341342override variable ?= value
    342343override define variable
    … …  
    354355export variable := value
    355356export variable += value
    356 export variable &lt;= value
     357export variable &lt;= value        [1]
    357358export variable ?= value
    358359unexport variable
    359360</pre>
    360 <p>Define a variable in the local context instead of the global one:</p>
     361<p>Define a variable in the local context instead of the global one <a class="footnote-reference" href="#id15" id="id2" name="id2">[1]</a>:</p>
    361362<pre class="literal-block">
    362363local variable = value
    … …  
    509510<tt class="docutils literal"><span class="pre">KBUILD_KMK_REVISION</span></tt></td>
    510511<td>The kBuild version string and the break down
    511 into individual components.</td>
    512 </tr>
    513 <tr><td><tt class="docutils literal"><span class="pre">KBUILD_HOST</span></tt></td>
     512into individual components. <a class="footnote-reference" href="#id15" id="id3" name="id3">[1]</a></td>
     513</tr>
     514<tr><td><tt class="docutils literal"><span class="pre">KBUILD_HOST</span></tt> <a class="footnote-reference" href="#id15" id="id4" name="id4">[1]</a></td>
    514515<td>The host operating system.</td>
    515516</tr>
    516 <tr><td><tt class="docutils literal"><span class="pre">KBUILD_HOST_ARCH</span></tt></td>
     517<tr><td><tt class="docutils literal"><span class="pre">KBUILD_HOST_ARCH</span></tt> <a class="footnote-reference" href="#id15" id="id5" name="id5">[1]</a></td>
    517518<td>The host architecture.</td>
    518519</tr>
    519 <tr><td><tt class="docutils literal"><span class="pre">KBUILD_HOST_CPU</span></tt></td>
     520<tr><td><tt class="docutils literal"><span class="pre">KBUILD_HOST_CPU</span></tt> <a class="footnote-reference" href="#id15" id="id6" name="id6">[1]</a></td>
    520521<td>The host CPU <tt class="docutils literal"><span class="pre">kmk</span></tt> is built for, set to
    521522<tt class="docutils literal"><span class="pre">blend</span></tt> if not any particular CPU.</td>
    522523</tr>
    523 <tr><td><tt class="docutils literal"><span class="pre">KBUILD_PATH</span></tt></td>
     524<tr><td><tt class="docutils literal"><span class="pre">KBUILD_PATH</span></tt> <a class="footnote-reference" href="#id15" id="id7" name="id7">[1]</a></td>
    524525<td>Where the kBuild scripts are.</td>
    525526</tr>
    526 <tr><td><tt class="docutils literal"><span class="pre">KBUILD_BIN_PATH</span></tt></td>
     527<tr><td><tt class="docutils literal"><span class="pre">KBUILD_BIN_PATH</span></tt> <a class="footnote-reference" href="#id15" id="id8" name="id8">[1]</a></td>
    527528<td>Where the host specific kBuild binaries are.</td>
    528529</tr>
    529 <tr><td><tt class="docutils literal"><span class="pre">KMK</span></tt>,
     530<tr><td><tt class="docutils literal"><span class="pre">KMK</span></tt> <a class="footnote-reference" href="#id15" id="id9" name="id9">[1]</a>,
    530531<tt class="docutils literal"><span class="pre">MAKE</span></tt></td>
    531532<td>The name with which <tt class="docutils literal"><span class="pre">kmk</span></tt> was invoked. Using
    532533this variable in recipes has special meaning.</td>
    533534</tr>
    534 <tr><td><tt class="docutils literal"><span class="pre">KMK_BUILTIN</span></tt></td>
     535<tr><td><tt class="docutils literal"><span class="pre">KMK_BUILTIN</span></tt> <a class="footnote-reference" href="#id15" id="id10" name="id10">[1]</a></td>
    535536<td>List of built-in commands.</td>
    536537</tr>
    537 <tr><td><tt class="docutils literal"><span class="pre">KMK_FEATURES</span></tt></td>
     538<tr><td><tt class="docutils literal"><span class="pre">KMK_FEATURES</span></tt> <a class="footnote-reference" href="#id15" id="id11" name="id11">[1]</a></td>
    538539<td>List of <tt class="docutils literal"><span class="pre">kmk</span></tt> specific features.</td>
    539540</tr>
    540 <tr><td><tt class="docutils literal"><span class="pre">KMK_FLAGS</span></tt></td>
     541<tr><td><tt class="docutils literal"><span class="pre">KMK_FLAGS</span></tt> <a class="footnote-reference" href="#id15" id="id12" name="id12">[1]</a></td>
    541542<td><p class="first">The flags given to <tt class="docutils literal"><span class="pre">kmk</span></tt>. You can set this in
    542543the environment or a makefile to set flags.</p>
    … …  
    548549</td>
    549550</tr>
    550 <tr><td><tt class="docutils literal"><span class="pre">KMK_LEVEL</span></tt></td>
     551<tr><td><tt class="docutils literal"><span class="pre">KMK_LEVEL</span></tt> <a class="footnote-reference" href="#id15" id="id13" name="id13">[1]</a></td>
    551552<td>The number of levels of recursion (sub-makes).</td>
    552553</tr>
    553 <tr><td><tt class="docutils literal"><span class="pre">KMK_VERSION</span></tt></td>
     554<tr><td><tt class="docutils literal"><span class="pre">KMK_VERSION</span></tt> <a class="footnote-reference" href="#id15" id="id14" name="id14">[1]</a></td>
    554555<td>The GNU <tt class="docutils literal"><span class="pre">make</span></tt> version number.</td>
    555556</tr>
    … …  
    13421343</blockquote>
    13431344<hr class="docutils" />
     1345<table class="docutils footnote" frame="void" id="id15" rules="none">
     1346<colgroup><col class="label" /><col /></colgroup>
     1347<tbody valign="top">
     1348<tr><td class="label"><a name="id15">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>, <a class="fn-backref" href="#id3">3</a>, <a class="fn-backref" href="#id4">4</a>, <a class="fn-backref" href="#id5">5</a>, <a class="fn-backref" href="#id6">6</a>, <a class="fn-backref" href="#id7">7</a>, <a class="fn-backref" href="#id8">8</a>, <a class="fn-backref" href="#id9">9</a>, <a class="fn-backref" href="#id10">10</a>, <a class="fn-backref" href="#id11">11</a>, <a class="fn-backref" href="#id12">12</a>, <a class="fn-backref" href="#id13">13</a>, <a class="fn-backref" href="#id14">14</a>)</em> <tt class="docutils literal"><span class="pre">kmk</span></tt> only feature.</td></tr>
     1349</tbody>
     1350</table>
     1351<hr class="docutils" />
    13441352<table class="docutils field-list" frame="void" rules="none">
    13451353<col class="field-name" />

  • trunk/kBuild/doc/QuickReference-kmk.txt

    r2168 r2169  
    88disputed. ;-)
    99
     10Features that are
    1011
    1112Directives
    … …  
    2930        ifneq "a" "b"
    3031        ifneq 'a' 'b'
    31         if1of (set-a,set-b)
    32         ifn1of (set-a,set-b)
    33         if expression
     32        if1of (set-a,set-b)             [1]
     33        ifn1of (set-a,set-b)            [1]
     34        if expression                   [1]
    3435        else
    3536        endif
    … …  
    4142        sinclude file
    4243
    43     Include another dependency file::
     44    Include another dependency file [1]_::
    4445
    4546        includedep file
    … …  
    5152        override variable := value
    5253        override variable += value
    53         override variable <= value
     54        override variable <= value      [1]
    5455        override variable ?= value
    5556        override define variable
    … …  
    6768        export variable := value
    6869        export variable += value
    69         export variable <= value
     70        export variable <= value        [1]
    7071        export variable ?= value
    7172        unexport variable
    7273
    73     Define a variable in the local context instead of the global one::
     74    Define a variable in the local context instead of the global one [1]_::
    7475
    7576        local variable = value
    … …  
    178179+--------------------------+--------------------------------------------------+
    179180| ``KBUILD_VERSION``,      | The kBuild version string and the break down     |
    180 | ``KBUILD_VERSION_MAJOR``,| into individual components.                      |
     181| ``KBUILD_VERSION_MAJOR``,| into individual components. [1]_                 |
    181182| ``KBUILD_VERSION_MINOR``,|                                                  |
    182183| ``KBUILD_VERSION_PATCH``,|                                                  |
    183184| ``KBUILD_KMK_REVISION``  |                                                  |
    184185+--------------------------+--------------------------------------------------+
    185 | ``KBUILD_HOST``          | The host operating system.                       |
    186 +--------------------------+--------------------------------------------------+
    187 | ``KBUILD_HOST_ARCH``     | The host architecture.                           |
    188 +--------------------------+--------------------------------------------------+
    189 | ``KBUILD_HOST_CPU``     | The host CPU ``kmk`` is built for, set to        |
     186| ``KBUILD_HOST`` [1]_     | The host operating system.                       |
     187+--------------------------+--------------------------------------------------+
     188| ``KBUILD_HOST_ARCH`` [1]_| The host architecture.                           |
     189+--------------------------+--------------------------------------------------+
     190| ``KBUILD_HOST_CPU`` [1]_ | The host CPU ``kmk`` is built for, set to        |
    190191|                          | ``blend`` if not any particular CPU.             |
    191192+--------------------------+--------------------------------------------------+
    192 | ``KBUILD_PATH``          | Where the kBuild scripts are.                    |
    193 +--------------------------+--------------------------------------------------+
    194 | ``KBUILD_BIN_PATH``     | Where the host specific kBuild binaries are.     |
    195 +--------------------------+--------------------------------------------------+
    196 | ``KMK``,                 | The name with which ``kmk`` was invoked. Using   |
     193| ``KBUILD_PATH`` [1]_     | Where the kBuild scripts are.                    |
     194+--------------------------+--------------------------------------------------+
     195| ``KBUILD_BIN_PATH`` [1]_ | Where the host specific kBuild binaries are.     |
     196+--------------------------+--------------------------------------------------+
     197| ``KMK`` [1]_,            | The name with which ``kmk`` was invoked. Using   |
    197198| ``MAKE``                 | this variable in recipes has special meaning.    |
    198199+--------------------------+--------------------------------------------------+
    199 | ``KMK_BUILTIN``          | List of built-in commands.                       |
    200 +--------------------------+--------------------------------------------------+
    201 | ``KMK_FEATURES``         | List of ``kmk`` specific features.               |
    202 +--------------------------+--------------------------------------------------+
    203 | ``KMK_FLAGS``            | The flags given to ``kmk``. You can set this in  |
     200| ``KMK_BUILTIN`` [1]_     | List of built-in commands.                       |
     201+--------------------------+--------------------------------------------------+
     202| ``KMK_FEATURES`` [1]_    | List of ``kmk`` specific features.               |
     203+--------------------------+--------------------------------------------------+
     204| ``KMK_FLAGS`` [1]_       | The flags given to ``kmk``. You can set this in  |
    204205|                          | the environment or a makefile to set flags.      |
    205206|                          |                                                  |
    … …  
    210211|                          | through the environment from its parent.         |
    211212+--------------------------+--------------------------------------------------+
    212 | ``KMK_LEVEL``            | The number of levels of recursion (sub-makes).   |
    213 +--------------------------+--------------------------------------------------+
    214 | ``KMK_VERSION``          | The GNU ``make`` version number.                 |
     213| ``KMK_LEVEL`` [1]_       | The number of levels of recursion (sub-makes).   |
     214+--------------------------+--------------------------------------------------+
     215| ``KMK_VERSION`` [1]_     | The GNU ``make`` version number.                 |
    215216+--------------------------+--------------------------------------------------+
    216217| ``MAKECMDGOALS``         | The targets given to ``kmk`` on the command line.|
    … …  
    904905-----
    905906
     907.. [1] ``kmk`` only feature.
     908
     909-----
     910
    906911:Status: $Id$
    907912:Copyright: Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette