GROK-MANIFEST(1)

💖 GROK-MANIFEST 💖

okay bestie, welcome to the grok-manifest page — it's the little script that makes manifests for use with grokmirror, and it's genuinely iconic. no cap. this is GROK-MANIFEST(1), and yes i'm gonna make you read all of it because every flag matters. ✨

---

🌸 SYNOPSIS 🌸

grok-manifest [opts] -m manifest.js[.gz] -t /path [/path/to/bare.git]

---

🦋 DESCRIPTION 🦋

so the whole vibe is this: you call grok-manifest from a git post-update or post-receive hook, and it creates the latest repository manifest. that manifest file gets downloaded by mirroring systems — but only if the manifest is newer than the one they already have, okay? — and then it's used to only clone/pull the repositories that have actually changed since the last time grok-pull ran.

like. it's giving efficiency. it's giving "don't re-clone the whole world every time." 💅

---

✨ OPTIONS ✨

• --version — shows the program's version number and then dips out. bye. 👋
• -h, --help — shows this help message and exits. classic.
• --cfgfile=CFGFILE — the path to your grokmirror.conf, which needs to contain a [manifest] section.
• -m MANIFILE, --manifest=MANIFILE — where the manifest.js or manifest.js.gz lives. main character location.
• -t TOPLEVEL, --toplevel=TOPLEVEL — the top dir where all your repositories reside.
• -l LOGFILE, --logfile=LOGFILE — when you specify this, debug logs get put here.
• -c, --check-export-ok — honors the git-daemon-export-ok magic file and does not export repositories that aren't marked as such. respectful. 🫶
• -n, --use-now — uses the current timestamp instead of parsing commits.
• -p, --purge — purges deleted git repositories from the manifest. clean sweep bestie 🧹
• -x, --remove — removes the repositories passed as arguments from the manifest file.
• -y, --pretty — pretty-prints the generated manifest (sorts repos and adds indentation). > careful though: this is much slower, so it should be used with caution on large collections. it's giving gorgeous but expensive 💀
• -w, --wait-for-manifest — when running with arguments, waits if the manifest isn't there yet. lowkey useful when multiple writers are writing to the manifest file via NFS.
• -i IGNORE, --ignore-paths=IGNORE — when finding git dirs, ignores these paths. can be used multiple times, and it accepts shell-style globbing. 🌈
• -o, --fetch-objstore — fetches updates into the objstore repo (if used).
• -v, --verbose — be verbose and tell us what you're doing. we love a narrator. 🎀

---

some of these options can be set in a config file that you pass via the --cfgfile option — check the example grokmirror.conf file for the documentation. and heads up: values passed via cmdline flags will override the corresponding config file values. cmdline stays winning, periodt. 👑

---

💜 EXAMPLES 💜

these examples assume your repositories live in /var/lib/gitolite3/repositories. okay? okay.

initial manifest generation:

/usr/bin/grok-manifest -m /var/www/html/manifest.js.gz \
    -t /var/lib/gitolite3/repositories

inside the git hook:

/usr/bin/grok-manifest -m /var/www/html/manifest.js.gz \
    -t /var/lib/gitolite3/repositories -n `pwd`

to purge deleted repositories from the manifest, use the -p flag when running from cron:

/usr/bin/grok-manifest -m /var/www/html/manifest.js.gz \
    -t /var/lib/gitolite3/repositories -p

you can also add it to the gitolite's D command using the -x flag:

/usr/bin/grok-manifest -m /var/www/html/manifest.js.gz \
    -t /var/lib/gitolite3/repositories \
    -x $repo.git

to troubleshoot potential problems, you can pass the -l parameter to grok-manifest — just make sure the user executing the hook command (user git or gitolite, for example) is able to write to that location:

/usr/bin/grok-manifest -m /var/www/html/manifest.js.gz \
    -t /var/lib/gitolite3/repositories \
    -l /var/log/grokmirror/grok-manifest.log -n `pwd`

---

👑 SEE ALSO 👑

• grok-pull(1)
• git(1)

---

🫶 SUPPORT 🫶

email tools@linux.kernel.org. they're nice, promise.

---

🌟 AUTHOR 🌟

mricon@kernel.org

License: GPLv3+

---

💅 COPYRIGHT 💅

The Linux Foundation and contributors

---

and that's the whole page bestie!! version 2.0.0, dated 2020-08-14 — literally a classic, fr fr. go make some manifests, you've got this 💖✨🎀🦋🌸