(some docfixes)

This commit is contained in:
Sitaram Chamarty 2012-04-22 09:33:57 +05:30
parent 5d366b5c0e
commit 9e1cb5936c
7 changed files with 40 additions and 9 deletions

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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