From 9cc2788cf97772b2699f731d34d0923ca9e3956a Mon Sep 17 00:00:00 2001
From: hasufell <hasufell@hasufell.de>
Date: Sat, 22 Aug 2015 00:44:48 +0200
Subject: [PATCH] Add instructions on how to egencache overlay

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index 233abdc..6d4f224 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,24 @@ necessary to set up a gentoo github mirror based sync system:
 * updates the glsa directory
 * updates herds.xml
 * updates the news directory
+
+## Notes
+
+If you want to sync all overlays additionally to the gentoo repository, you can
+add the file `/etc/paludis/hooks/sync_post/06-sync_overlay_cache.bash` with the
+following content:
+```
+#!/bin/bash
+
+source "${PALUDIS_EBUILD_DIR}/echo_functions.bash"
+source "/etc/paludis/hooks/set_portdir.bash"
+
+if [[ ${TARGET} != gentoo && $(${CAVE} print-repository-metadata --raw-name format --format "%v" ${TARGET}) == e ]] ; then
+	# Number of jobs for egencache, default is number or processors.
+	egencache_jobnum="$(nproc)"
+
+	ebegin "Cache update for repository ${TARGET}"
+	egencache --jobs=${egencache_jobnum} --repo=${TARGET} --update --update-use-local-desc
+	eend $?
+fi
+```