| 1 |
commit: da72a7ccfbf7b54d11ed50e554cd92dd8430f787 |
| 2 |
Author: André Erdmann <dywi <AT> mailerd <DOT> de> |
| 3 |
AuthorDate: Fri Aug 2 14:27:53 2013 +0000 |
| 4 |
Commit: André Erdmann <dywi <AT> mailerd <DOT> de> |
| 5 |
CommitDate: Fri Aug 2 14:27:53 2013 +0000 |
| 6 |
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=da72a7cc |
| 7 |
|
| 8 |
doc/rst: hook env, OVERLAY_MASTERS config option |
| 9 |
|
| 10 |
--- |
| 11 |
doc/rst/usage.rst | 38 +++++++++++++++++++++++++++----------- |
| 12 |
1 file changed, 27 insertions(+), 11 deletions(-) |
| 13 |
|
| 14 |
diff --git a/doc/rst/usage.rst b/doc/rst/usage.rst |
| 15 |
index 68b8e40..dab9b8c 100644 |
| 16 |
--- a/doc/rst/usage.rst |
| 17 |
+++ b/doc/rst/usage.rst |
| 18 |
@@ -2113,13 +2113,20 @@ the config file. An empty string sets the policy to *deny all*. |
| 19 |
+----------------+-------------------+-----------------------------------------+ |
| 20 |
| ROVERLAY_PHASE | event | event that caused the script to run | |
| 21 |
+----------------+-------------------+-----------------------------------------+ |
| 22 |
+ | HAS_CHANGES | *internal* | a shbool (``y`` or ``n``) that | |
| 23 |
+ | | | indicates whether the overlay has | |
| 24 |
+ | | | any changes | |
| 25 |
+ +----------------+-------------------+-----------------------------------------+ |
| 26 |
| OVERLAY_NAME | config | name of the overlay | |
| 27 |
+----------------+-------------------+-----------------------------------------+ |
| 28 |
| OVERLAY | config | overlay directory (`OVERLAY_DIR`_), | |
| 29 |
- +----------------+-------------------+ initial working directory | |
| 30 |
- | S | *$OVERLAY* | | |
| 31 |
+----------------+-------------------+ | |
| 32 |
- | PWD | *$OVERLAY* | | |
| 33 |
+ | S | *$OVERLAY* | | |
| 34 |
+ +----------------+-------------------+-----------------------------------------+ |
| 35 |
+ | PWD | *$OVERLAY* | initial working directory | |
| 36 |
+ | | *$ROVERLAY_PHASE* | | |
| 37 |
+ | | | depends on $ROVERLAY_PHASE (usually set | |
| 38 |
+ | | | to $OVERLAY or left unchanged) | |
| 39 |
+----------------+-------------------+-----------------------------------------+ |
| 40 |
| DISTROOT | config | package mirror directory | |
| 41 |
| | | (`OVERLAY_DISTDIR_ROOT`_) | |
| 42 |
@@ -2337,17 +2344,19 @@ Shell function files should be put into ``<ADDITIONS_DIR>/shlib``. |
| 43 |
Hook event table |
| 44 |
------------------ |
| 45 |
|
| 46 |
-The following table lists all known events: |
| 47 |
+The following table lists all known events (``ROVERLAY_PHASE``): |
| 48 |
|
| 49 |
.. table:: |
| 50 |
|
| 51 |
- +-------------------+-------------+----------------------------------------+ |
| 52 |
- | name | conditional | description | |
| 53 |
- +===================+=============+========================================+ |
| 54 |
- | overlay_success | yes | overlay creation succeeded | |
| 55 |
- +-------------------+-------------+----------------------------------------+ |
| 56 |
- | db_written | yes | stats database file written | |
| 57 |
- +-------------------+-------------+----------------------------------------+ |
| 58 |
+ +-------------------+---------------------------+------------------------------+ |
| 59 |
+ | name | initial working directory | description | |
| 60 |
+ +===================+===========================+==============================+ |
| 61 |
+ | overlay_success | *$OVERLAY* | overlay creation succeeded | |
| 62 |
+ +-------------------+---------------------------+------------------------------+ |
| 63 |
+ | db_written | *$OVERLAY* | stats database file written | |
| 64 |
+ +-------------------+---------------------------+------------------------------+ |
| 65 |
+ | user | unchanged | user-triggered event | |
| 66 |
+ +-------------------+---------------------------+------------------------------+ |
| 67 |
|
| 68 |
|
| 69 |
--------------------- |
| 70 |
@@ -2688,6 +2697,13 @@ OVERLAY_MANIFEST_IMPLEMENTATION |
| 71 |
Use the '--no-manifest' command line option to disable manifest |
| 72 |
writing. |
| 73 |
|
| 74 |
+.. _OVERLAY_MASTERS: |
| 75 |
+ |
| 76 |
+OVERLAY_MASTERS |
| 77 |
+ A list of repo names that are used as 'masters' attribute when generating |
| 78 |
+ ``<overlay>/metadata/layout.conf``. |
| 79 |
+ |
| 80 |
+ Defaults to "gentoo". |
| 81 |
|
| 82 |
.. _OVERLAY_NAME: |
Archives