From 9e1cb5936c984a28b7363c0491ea4cd81de93604 Mon Sep 17 00:00:00 2001 From: Sitaram Chamarty Date: Sun, 22 Apr 2012 09:33:57 +0530 Subject: [PATCH] (some docfixes) --- doc/g2migr.mkd | 10 ++++++++++ doc/install.mkd | 5 ++++- doc/non-core.mkd | 2 +- doc/progit.mkd | 1 + doc/qi.mkd | 4 ++-- doc/rc.mkd | 17 +++++++++++++++++ doc/sskm.mkd | 10 +++++----- 7 files changed, 40 insertions(+), 9 deletions(-) diff --git a/doc/g2migr.mkd b/doc/g2migr.mkd index aba2961..46079a8 100644 --- a/doc/g2migr.mkd +++ b/doc/g2migr.mkd @@ -116,6 +116,16 @@ Some of them have links where there is more detail than I want to put here. (ancillary, non-core, or minor functionality lost) + * Built-in command `expand` -- **dropped**. The 'info' command shows you + both normal and wild repos now. The output format is also much simpler. + + * Built-in commands 'getperms', 'setperms' -- **merged** into external + command 'perms'. Run `ssh git@host perms -h` for details. + + Similarly, 'getdesc' and 'setdesc' have been merged into 'desc'. + + * Several 'ADC's -- see the [dev-status][] page for more on this. + * [gl-time][g2i-gl-time]: the CpuTime module replaces gl-time. * `BIG_INFO_CAP` -- **dropped**. If you think you must have this, try it diff --git a/doc/install.mkd b/doc/install.mkd index e3e925f..65697ab 100644 --- a/doc/install.mkd +++ b/doc/install.mkd @@ -99,10 +99,13 @@ you can run the 'install' command in 3 different ways: # option 2 gitolite/install -ln - # defaults to $HOME/bin, or use a specific directory: + # defaults to $HOME/bin (which is assumed to exist) + # ** or ** + # or use a specific directory (please supply full path): gitolite/install -ln /usr/local/bin # option 3 + # (again, please supply a full path) gitolite/install -to /usr/local/gitolite/bin Creating a symlink doesn't need a separate program but 'install' also runs diff --git a/doc/non-core.mkd b/doc/non-core.mkd index eb0e7aa..e6f9eab 100644 --- a/doc/non-core.mkd +++ b/doc/non-core.mkd @@ -22,7 +22,7 @@ Here's a list of remote commands that are shipped: * 'info' -- already documented [here][info] * 'mirror' -- documented [here][sync] * 'perms' -- get/set the gl-perms file; see [perms][] for more - * 'sskm' -- self-service key management + * 'sskm' -- self-service key management, see [sskm][] for more * 'writable' -- disabling pushes to take backups etc * 'D' -- deleting user-created repos diff --git a/doc/progit.mkd b/doc/progit.mkd index 1e7856d..fe4e304 100644 --- a/doc/progit.mkd +++ b/doc/progit.mkd @@ -20,6 +20,7 @@ To begin, create a user called `git` on your server and login to this user. Cop git clone git://github.com/sitaramc/gitolite gitolite/install -ln + # assumes $HOME/bin exists and is in your $PATH gitolite setup -pk $HOME/YourName.pub # for example, I would run 'gitolite setup -pk $HOME/sitaram.pub' diff --git a/doc/qi.mkd b/doc/qi.mkd index 563071b..2ac9470 100644 --- a/doc/qi.mkd +++ b/doc/qi.mkd @@ -23,8 +23,8 @@ On your workstation: * This is a fresh install, not a migration from the old gitolite (v1.x, v2.x). - * On the server, your `$PATH` contains `$HOME/bin`. If you don't like that, - there are [other install methods][install]. + * On the server, `$HOME/bin` exists and is in your `$PATH`. If you don't + like that, there are [other install methods][install]. * "your-name.pub" is your public key from your workstation. * Also, this key does not already have shell access to this gitolite diff --git a/doc/rc.mkd b/doc/rc.mkd index 04c88f1..2c84d88 100644 --- a/doc/rc.mkd +++ b/doc/rc.mkd @@ -80,3 +80,20 @@ information. with regular expressions) is to allow anything and everything: `$GIT_CONFIG_KEYS = '.*';` + * `DEFAULT_ROLE_PERMS`, string, default undef + + This sets default wildcard permissions for newly created wildcard repos. + + If set, this value will be used as the default role permissions for new + wildcard repositories. The user can change this value with the perms + command as desired after repository creation; it is only a default. + + Please be aware this is potentially a multi-line variable. In most + setups, it will be left undefined. Some installations may benefit from + setting it to `READERS @all`. + + If you want multiple roles to be assigned by default, here is how. Note + double quotes this time, due to the embedded newline, which in turn + require the '@' to be escaped: + + DEFAULT_ROLE_PERMS => "READERS \@all\nWRITERS \@senior_devs", diff --git a/doc/sskm.mkd b/doc/sskm.mkd index e9ce302..4ac908d 100644 --- a/doc/sskm.mkd +++ b/doc/sskm.mkd @@ -221,12 +221,12 @@ Listing the keys shows that that new key is now marked active again: ## important notes for the admin -These are the things that can break if you allows your users to use this command: +These are the things that can break if you allow your users to use this +command: - * If you, as the gitolite admin, are in the habit of force-pushing changes - to the admin repo instead of doing a `git pull` (or, even better, a `git - pull --rebase`) then you had better not enable this command. Your users - will eventually come after you with pitchforks ;-) + * "sskm" clones, changes, and pushes back the gitolite-admin repo. This + means, even if you're the only administrator, you should never 'git push + -f', in case you end up overwriting something sskm did. * There is no way to distinguish `foo/alice.pub` from `bar/alice.pub` using this command. You can distinguish `foo/alice.pub` from