diff options
| author | Thomas De Schampheleire <patrickdepinguin@gmail.com> | 2013-11-07 11:41:24 +0100 |
|---|---|---|
| committer | Peter Korsgaard <peter@korsgaard.com> | 2013-11-11 00:12:05 +0100 |
| commit | fcdbeba035796c019348a7ac4ffdd32825ad4669 (patch) | |
| tree | fd968c4e8dcf554c6314ea3ae7d5b2ca442964b1 /docs | |
| parent | 7ae2b8ef88fd526c3908ca4e764b79e0657b2632 (diff) | |
manual: add some info on the POST_RSYNC hook
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Acked-by: "Samuel Martin" <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manual/adding-packages-hooks.txt | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/manual/adding-packages-hooks.txt b/docs/manual/adding-packages-hooks.txt index 8ab3f5698..d96c991cb 100644 --- a/docs/manual/adding-packages-hooks.txt +++ b/docs/manual/adding-packages-hooks.txt @@ -39,3 +39,23 @@ endef LIBFOO_POST_PATCH_HOOKS += LIBFOO_POST_PATCH_FIXUP ---------------------- + +Using the +POST_RSYNC+ hook +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The +POST_RSYNC+ hook is run only for packages that use a local source, +either through the +local+ site method or the +OVERRIDE_SRCDIR+ +mechanism. In this case, package sources are copied using +rsync+ from +the local location into the buildroot build directory. The +rsync+ +command does not copy all files from the source directory, though. +Files belonging to a version control system, like the directories ++.git+, +.hg+, etc. are not copied. For most packages this is +sufficient, but a given package can perform additional actions using +the +POST_RSYNC+ hook. + +In principle, the hook can contain any command you want. One specific +use case, though, is the intentional copying of the version control +directory using +rsync+. The +rsync+ command you use in the hook can, among +others, use the following variables: + +* +$(SRCDIR)+: the path to the overridden source directory +* +$(@D)+: the path to the build directory |