Update doc
This commit is contained in:
parent
ed55ca9efe
commit
8466924a73
|
@ -843,6 +843,10 @@ syntax:
|
||||||
- ``(file <filename>)`` or simply ``<filename>``: depend on this file
|
- ``(file <filename>)`` or simply ``<filename>``: depend on this file
|
||||||
- ``(alias <alias-name>)``: depend on the construction of this alias, for
|
- ``(alias <alias-name>)``: depend on the construction of this alias, for
|
||||||
instance: ``(alias src/runtest)``
|
instance: ``(alias src/runtest)``
|
||||||
|
- ``(alias_rec <alias-name>)``: depend on the construction of this
|
||||||
|
alias recursively in all children directories wherever it is
|
||||||
|
defined. For instance: ``(alias_rec src/runtest)`` might depend on
|
||||||
|
``(alias src/runtest)``, ``(alias src/foo/bar/runtest)``, ...
|
||||||
- ``(glob_files <glob>)``: depend on all files matched by ``<glob>``, see the
|
- ``(glob_files <glob>)``: depend on all files matched by ``<glob>``, see the
|
||||||
:ref:`glob <glob>` for details
|
:ref:`glob <glob>` for details
|
||||||
- ``(files_recursively_in <dir>)``: depend on all files in the subtree with root
|
- ``(files_recursively_in <dir>)``: depend on all files in the subtree with root
|
||||||
|
|
|
@ -43,11 +43,12 @@ Terminology
|
||||||
- **build context root**: the root of a build context named ``foo`` is
|
- **build context root**: the root of a build context named ``foo`` is
|
||||||
``<root>/_build/<foo>``
|
``<root>/_build/<foo>``
|
||||||
|
|
||||||
- **alias**: an alias is a build target that doesn't produce any file
|
- **alias**: an alias is a build target that doesn't produce any file
|
||||||
and has configurable dependencies. Alias are per-directory and some
|
and has configurable dependencies. Aliases are
|
||||||
are recursive; asking an alias to be built in a given directory will
|
per-directory. However, on the command line, asking for an alias to
|
||||||
trigger the construction of the alias in all children directories
|
be built in a given directory will trigger the construction of the
|
||||||
recursively. The most interesting ones are:
|
alias in all children directories recursively. Jbuilder defines the
|
||||||
|
following standard aliases:
|
||||||
|
|
||||||
- ``runtest`` which runs user defined tests
|
- ``runtest`` which runs user defined tests
|
||||||
- ``install`` which depends on everything that should be installed
|
- ``install`` which depends on everything that should be installed
|
||||||
|
|
|
@ -125,8 +125,9 @@ Aliases
|
||||||
-------
|
-------
|
||||||
|
|
||||||
Targets starting with a ``@`` are interpreted as aliases. For instance
|
Targets starting with a ``@`` are interpreted as aliases. For instance
|
||||||
``@src/runtest`` means the alias ``src/runtest``. If you want to refer
|
``@src/runtest`` means the alias ``runtest`` in all descendant of
|
||||||
to a target starting with a ``@``, simply write: ``./@foo``.
|
``src`` where it is defined. If you want to refer to a target starting
|
||||||
|
with a ``@``, simply write: ``./@foo``.
|
||||||
|
|
||||||
Note that an alias not pointing to the ``_build`` directory always
|
Note that an alias not pointing to the ``_build`` directory always
|
||||||
depends on all the corresponding aliases in build contexts.
|
depends on all the corresponding aliases in build contexts.
|
||||||
|
|
Loading…
Reference in New Issue