common/hooks/README

   1 HOOKS
   2 =====
   3
   4 This directory contains shell hooks that are processed after or before the
   5 specified phase. The shell hooks are simply shell snippets (must not be
   6 executable nor contain a shebang) that are processed lexically by xbps-src.
   7 Only files with the `.sh` extension are processed.
   8
   9 A shell hook must provide a `hook()` function which is the entry point to
  10 execute it via xbps-src.
  11
  12 The following directories are used to set the order in which the hooks
  13 should be processed by xbps-src:
  14
  15         * pre-fetch             (before running fetch phase)
  16         * do-fetch              (running fetch phase)
  17         * post-fetch            (after running fetch phase)
  18
  19         * pre-extract           (before running extract phase)
  20         * do-extract            (running extract phase)
  21         * post-extract          (after running extract phase)
  22
  23         * pre-configure         (before running configure phase)
  24         * do-configure          (running configure phase)
  25         * post-configure        (after running configure phase)
  26
  27         * pre-build             (before running build phase)
  28         * do-build              (running build phase)
  29         * post-build            (after running build phase)
  30
  31         * pre-install           (before running install phase)
  32         * do-install            (running install phase)
  33         * post-install          (after running install phase)
  34
  35         * pre-pkg               (before running pkg phase)
  36         * do-pkg                (running pkg phase)
  37         * post-pkg              (after running pkg phase)
  38
  39 NOTES
  40 ~~~~~
  41 * Symlinks can be created (relative) to make a hook available in multiple phases.
  42
  43 * The phases do-fetch, do-extract, do-configure, do-build, and do-install can
  44   be overwritten by the template file. That means if a template contains a
  45   do_install function, the hooks defined for do-install won't be executed.
  46   Note that this is only true for the do-* hooks.
  47
  48 * the pre_* function of the template will be run *after* the corresponding
  49   pre-* hooks.
  50
  51 * the post_* function of the template will be run *before* the corresponding
  52   post-* hooks.