some doc updates (plus CHANGELOG)

This commit is contained in:
Sitaram Chamarty 2010-06-15 23:01:22 +05:30
parent 517786572d
commit 97b094bccb
4 changed files with 69 additions and 4 deletions

View file

@ -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)

View file

@ -12,6 +12,7 @@ In this document:
* <a href="#specifying_gitweb_and_daemon_access">specifying gitweb and daemon access</a>
* <a href="#custom_hooks">custom hooks</a>
* <a href="#hook_chaining">hook chaining</a>
* <a href="#environment_variables_available_to_hooks">environment variables available to hooks</a>
* <a href="#custom_git_config">custom git config</a>
----
@ -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.
<a name="environment_variables_available_to_hooks"></a>
#### 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
<a name="custom_git_config"></a>
#### custom git config

View file

@ -27,6 +27,8 @@ In this document:
* <a href="#support_for_git_installed_outside_default_PATH">support for git installed outside default PATH</a>
* <a href="#personal_branches">"personal" branches</a>
* <a href="#custom_hooks_and_custom_git_config">custom hooks and custom git config</a>
* <a href="#INconvenience_features">INconvenience features</a>
* <a href="#deleting_a_repo">deleting a repo</a>
* <a href="#helping_with_gitweb">helping with gitweb</a>
* <a href="#easier_to_specify_gitweb_description_and_gitweb_daemon_access">easier to specify gitweb "description" and gitweb/daemon access</a>
* <a href="#easier_to_link_gitweb_authorisation_with_gitolite">easier to link gitweb authorisation with gitolite</a>
@ -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.
<a name="INconvenience_features"></a>
#### INconvenience features
<a name="deleting_a_repo"></a>
##### 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`)
<a name="helping_with_gitweb"></a>
#### helping with gitweb

View file

@ -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