diff options
| author |   André Erdmann <dywi@mailerd.de> | 2013-08-02 16:27:53 +0200 |
|---|---|---|
| committer | André Erdmann <dywi@mailerd.de> | 2013-08-02 16:27:53 +0200 |
| commit | da72a7ccfbf7b54d11ed50e554cd92dd8430f787 (patch) | |
| tree | 91d872c03b8e602677a50fbc543d3cd809c9d0ce /doc | |
| parent | roverlay/hook: set initial directory (diff) | |
| download | R_overlay-da72a7ccfbf7b54d11ed50e554cd92dd8430f787.tar.gz R_overlay-da72a7ccfbf7b54d11ed50e554cd92dd8430f787.tar.bz2 R_overlay-da72a7ccfbf7b54d11ed50e554cd92dd8430f787.zip | |
doc/rst: hook env, OVERLAY_MASTERS config option
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rst/usage.rst | 38 |
1 files changed, 27 insertions, 11 deletions
diff --git a/doc/rst/usage.rst b/doc/rst/usage.rst index 68b8e40..dab9b8c 100644 --- a/doc/rst/usage.rst +++ b/doc/rst/usage.rst @@ -2113,13 +2113,20 @@ the config file. An empty string sets the policy to *deny all*. +----------------+-------------------+-----------------------------------------+ | ROVERLAY_PHASE | event | event that caused the script to run | +----------------+-------------------+-----------------------------------------+ + | HAS_CHANGES | *internal* | a shbool (``y`` or ``n``) that | + | | | indicates whether the overlay has | + | | | any changes | + +----------------+-------------------+-----------------------------------------+ | OVERLAY_NAME | config | name of the overlay | +----------------+-------------------+-----------------------------------------+ | OVERLAY | config | overlay directory (`OVERLAY_DIR`_), | - +----------------+-------------------+ initial working directory | - | S | *$OVERLAY* | | +----------------+-------------------+ | - | PWD | *$OVERLAY* | | + | S | *$OVERLAY* | | + +----------------+-------------------+-----------------------------------------+ + | PWD | *$OVERLAY* | initial working directory | + | | *$ROVERLAY_PHASE* | | + | | | depends on $ROVERLAY_PHASE (usually set | + | | | to $OVERLAY or left unchanged) | +----------------+-------------------+-----------------------------------------+ | DISTROOT | config | package mirror directory | | | | (`OVERLAY_DISTDIR_ROOT`_) | @@ -2337,17 +2344,19 @@ Shell function files should be put into ``<ADDITIONS_DIR>/shlib``. Hook event table ------------------ -The following table lists all known events: +The following table lists all known events (``ROVERLAY_PHASE``): .. table:: - +-------------------+-------------+----------------------------------------+ - | name | conditional | description | - +===================+=============+========================================+ - | overlay_success | yes | overlay creation succeeded | - +-------------------+-------------+----------------------------------------+ - | db_written | yes | stats database file written | - +-------------------+-------------+----------------------------------------+ + +-------------------+---------------------------+------------------------------+ + | name | initial working directory | description | + +===================+===========================+==============================+ + | overlay_success | *$OVERLAY* | overlay creation succeeded | + +-------------------+---------------------------+------------------------------+ + | db_written | *$OVERLAY* | stats database file written | + +-------------------+---------------------------+------------------------------+ + | user | unchanged | user-triggered event | + +-------------------+---------------------------+------------------------------+ --------------------- @@ -2688,6 +2697,13 @@ OVERLAY_MANIFEST_IMPLEMENTATION Use the '--no-manifest' command line option to disable manifest writing. +.. _OVERLAY_MASTERS: + +OVERLAY_MASTERS + A list of repo names that are used as 'masters' attribute when generating + ``<overlay>/metadata/layout.conf``. + + Defaults to "gentoo". .. _OVERLAY_NAME: |