From 97b094bccb2df43d6d24c2e224038efba8a395da Mon Sep 17 00:00:00 2001 From: Sitaram Chamarty Date: Tue, 15 Jun 2010 23:01:22 +0530 Subject: [PATCH] some doc updates (plus CHANGELOG) --- conf/example.conf | 5 +++++ doc/2-admin.mkd | 21 ++++++++++++++++++++- doc/3-faq-tips-etc.mkd | 25 +++++++++++++++++++++++++ doc/CHANGELOG | 22 +++++++++++++++++++--- 4 files changed, 69 insertions(+), 4 deletions(-) diff --git a/conf/example.conf b/conf/example.conf index 5a5b36a..cde1130 100644 --- a/conf/example.conf +++ b/conf/example.conf @@ -42,6 +42,11 @@ # ...or a group of repos @oss_repos = gitolite linux git perl rakudo entrans vkc + # ...or even a group of refexes +@important = master$ QA_done refs/tags/v[0-9] + # (see later for what "refex"s are; I'm only mentioning it + # here to emphasise that you can group them too) + # even sliced and diced differently @admins = sitaram admin2 # notice that sitaram is in 2 groups (staff and admins) diff --git a/doc/2-admin.mkd b/doc/2-admin.mkd index 35bff40..6c0b036 100644 --- a/doc/2-admin.mkd +++ b/doc/2-admin.mkd @@ -12,6 +12,7 @@ In this document: * specifying gitweb and daemon access * custom hooks * hook chaining + * environment variables available to hooks * custom git config ---- @@ -42,7 +43,9 @@ Once you've cloned it, you're ready to add users and repos. extension, like `sitaram.pub` or `john-smith.pub`. You can also use periods and underscores - * copy all these `*.pub` files to `keydir` in your gitolite-admin repo clone + * copy all these `*.pub` files to `keydir` in your gitolite-admin repo + clone. You can also organise them into various subdirectories of `keydir` + if you wish, since the entire tree is searched. * edit the config file (`conf/gitolite.conf` in your admin repo clone). See `conf/example.conf` in the gitolite source for details on what goes in @@ -159,6 +162,22 @@ Finally, these names (`update.secondary` and `post-update.secondary`) are merely the defaults. You can change them to anything you want; look in conf/example.gitolite.rc for details. + + +#### environment variables available to hooks + +The following environment variables are set, and may be useful for any custom +processing you wish to do in your hook code: + + * `GL_USER` -- the user doing the push + * `GL_REPO` -- the reponame + * `GL_REPO_BASE_ABS` -- the absolute base path where all the repos are kept + +The following variables are also set, but are generally less useful: + + * `GL_BINDIR` -- where all the binaries live + * `GL_ADMINDIR` -- common directory for many gitolite things + #### custom git config diff --git a/doc/3-faq-tips-etc.mkd b/doc/3-faq-tips-etc.mkd index fc8663f..3ad27fd 100644 --- a/doc/3-faq-tips-etc.mkd +++ b/doc/3-faq-tips-etc.mkd @@ -27,6 +27,8 @@ In this document: * support for git installed outside default PATH * "personal" branches * custom hooks and custom git config + * INconvenience features + * deleting a repo * helping with gitweb * easier to specify gitweb "description" and gitweb/daemon access * easier to link gitweb authorisation with gitolite @@ -545,6 +547,29 @@ You can specify hooks that you want to propagate to all repos, as well as per-repo "gitconfig" settings. Please see `doc/2-admin.mkd` and `conf/example.conf` for details. + + +#### INconvenience features + + + +##### deleting a repo + +By design, there is no code in gitolite to *delete* a repo if the repo was +specified by name in the config file. (Wildcard repos *can* be deleted by the +user; see [here][rmrepo] for details). + +[rmrepo]: http://github.com/sitaramc/gitolite/blob/pu/doc/admin-defined-commands.mkd#rmrepo + +If you *do* want to permanently delete a *non*-wildcard repo, here's what you +do: + + * remove the repo from the gitolite-admin repo clone's `conf/gitolite.conf` + file. "add" the change, commit, and push. + + * *then* remove the repo from `~/repositories` on the server (or whatever + you set `$GL_REPO_BASE` to in the `~/.gitolite.rc`) + #### helping with gitweb diff --git a/doc/CHANGELOG b/doc/CHANGELOG index fdfd39f..60b1f61 100644 --- a/doc/CHANGELOG +++ b/doc/CHANGELOG @@ -2,8 +2,24 @@ Major changes to gitolite, master branch only, most recent first, no dates but the tags can help you position stuff approximately [NYD = not yet documented due to lack of time...] - - v1.5.1 -- tries to eliminate the need to run gl-setup on data version - change, thus hopefully obsoleting the upgrade note for v1.5 (just below). + - some small but important doc updates + - adc "fork" now much faster (uses git clone -l) + + - v1.5.2 + + - added test suite + + - v1.5.1 + + - disallow creation of new refs if you want (while allowing push of the + same) + + - adc "able" command added to contrib + - easy-install now takes a host-nickname parameter for convenience in + installing more than one gitolite server + - major doc revamp; contrib/autotoc added to make docs look nicer + - eliminate the need to run gl-setup on data version change, thus hopefully + obsoleting the upgrade note for v1.5 (just below). - v1.5 -- IMPORTANT UPGRADE NOTES below @@ -61,7 +77,7 @@ the tags can help you position stuff approximately - contrib directory added - expand now lists non-wildcard repos also - - refs also have groups now (NYD) + - refs also have groups now - allow admins to get "info" for other users - wildrepos merged