deac/gitolite
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

more doc revamp; some notes below

Browse source 
- all anchors prefixed by AUTO_ now
  - some bad links fixed (maybe still a few I didn't catch)
  - misc wording changes/additions (support section to README,
    "technical skills" section to install doc, etc).
This commit is contained in:
Sitaram Chamarty 2010-09-02 19:15:32 +05:30
parent 3559c1190e
commit 5f342c0444
18 changed files with 527 additions and 425 deletions
Download patch file Download diff file Expand all files Collapse all files

43
doc/admin-defined-commands.mkd
View file

@ -11,18 +11,18 @@ There may be other such **WARNING** sections below. **Read all of them**.
In this document:
* <a href="#background">background</a>
* <a href="#setting_it_up">setting it up</a>
* <a href="#anatomy_of_a_command">anatomy of a command</a>
* <a href="#example_uses_and_sample_commands_in_contrib">example uses and sample commands in contrib</a>
* <a href="#fork">fork</a>
* <a href="#rmrepo">rmrepo</a>
* <a href="#enable_disable_push_access_temporarily">enable/disable push access temporarily</a>
* <a href="#bonus_restricted_admin">(bonus) restricted admin</a>
* <a href="#_background">background</a>
* <a href="#_setting_it_up">setting it up</a>
* <a href="#_anatomy_of_a_command">anatomy of a command</a>
* <a href="#_example_uses_and_sample_commands_in_contrib">example uses and sample commands in contrib</a>
* <a href="#_fork">fork</a>
* <a href="#_rmrepo">rmrepo</a>
* <a href="#_enable_disable_push_access_temporarily">enable/disable push access temporarily</a>
* <a href="#_bonus_restricted_admin">(bonus) restricted admin</a>
----
<a name="background"></a>
<a name="_background"></a>
### background
@ -36,9 +36,6 @@ resisted the urge to point him to [this][xkcd224], told him that's a great
idea and he should go for it, mentally blessing him for letting me off the
hook on coding it ;-) [Laziness][lazy] *is* the first virtue you know!
[xkcd224]: http://xkcd.com/224/
[lazy]: http://c2.com/cgi/wiki?LazinessImpatienceHubris
And that was that. For a couple of days.
Soon, though, I realised that there could be a pretty big bonus in this for
@ -47,13 +44,11 @@ on "restricted admin" for what's really exciting about this for *me*.
----
It may be a good idea to read [doc/4-wildcard-repositories.mkd][wild] before
It may be a good idea to read [doc/wildcard-repositories.mkd][wild] before
you continue here though, because most of the uses of this feature also need
wildcard repos. (This also means you must set `$GL_WILDREPOS` to "1" in the
rc file).
[wild]: http://github.com/sitaramc/gitolite/blob/pu/doc/4-wildcard-repositories.mkd
The wildcard repo feature is a way to create repositories matching a pattern
(even if it as simple as `personal/CREATOR/.+`), and a way to specify two
categories of permissions for each such user-created repo.
@ -62,7 +57,7 @@ What we want now is more than that, as you'll see in the examples below. And
I'm sure if you think of more uses you'll send them to me as "contrib"
entries, right?
<a name="setting_it_up"></a>
<a name="_setting_it_up"></a>
### setting it up
@ -82,7 +77,7 @@ to inadvertently *hide* some of the "official" commands (like "info",
executable files with those names in this directory. So don't do that -- you
have been warned!**
<a name="anatomy_of_a_command"></a>
<a name="_anatomy_of_a_command"></a>
### anatomy of a command
@ -137,11 +132,11 @@ convenient. See any of the other samples for how to use it.
If you don't like this, roll your own. If you don't like bash, do the eqvt in
your language of choice.
<a name="example_uses_and_sample_commands_in_contrib"></a>
<a name="_example_uses_and_sample_commands_in_contrib"></a>
### example uses and sample commands in contrib
<a name="fork"></a>
<a name="_fork"></a>
#### fork
@ -169,6 +164,8 @@ or some such incantation.
<a name="rmrepo"></a>
<a name="_rmrepo"></a>
#### rmrepo
This is one thing that you really could not do before this setup was created.
@ -179,7 +176,7 @@ Use it like this:
The script checks to make sure that the repo being deleted was *created* by
the user invoking it.
<a name="enable_disable_push_access_temporarily"></a>
<a name="_enable_disable_push_access_temporarily"></a>
#### enable/disable push access temporarily
@ -217,7 +214,7 @@ in doc/2. You need code like this in `update.secondary` (don't forget to
exit 0
<a name="bonus_restricted_admin"></a>
<a name="_bonus_restricted_admin"></a>
#### (bonus) restricted admin
@ -239,3 +236,7 @@ script to proceed.
[Note that this particular use does not require `$GL_WILDREPOS` to be enabled,
because it's not using any wildcard repos].
[xkcd224]: http://xkcd.com/224/
[lazy]: http://c2.com/cgi/wiki?LazinessImpatienceHubris
[wild]: http://github.com/sitaramc/gitolite/blob/pu/doc/wildcard-repositories.mkd