Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

minor docfixes

typos, minor clarifications, removing outdated stuff that got missed,
adding some emphasis here and there, re-phrasing some places, etc.
  • Loading branch information...
commit 877c6625dcd26b5e527c98f0a3dd66fac1781cab 1 parent 200db6e
Sitaram Chamarty authored
8 contrib/adc/README.mkd
Source Rendered
@@ -25,7 +25,7 @@ this ADC are [here][dbsha]; details on RWC/RWD/RWCD etc are [here][rwcd].
25 25 sample of how to write an ADC in perl.
26 26
27 27 **git-annex-shell**: allows git-annex to store and retrieve annexed file content in
28   -repositories. To use, install in $GL_ADC_PATH/ua/git-annex-shell
  28 +repositories. To use, install in `$GL_ADC_PATH/ua/git-annex-shell`
29 29
30 30 **gl-reflog**: show a fake "reflog" from the server, and allow recovery from
31 31 deleted branches and bad force pushes; details in source.
@@ -45,12 +45,6 @@ itself. This ADC displays site-local help, if the site admin enabled it.
45 45
46 46 [rddoc]: http://sitaramc.github.com/gitolite/contrib/adc/repo-deletion.html
47 47
48   -**restrict-admin**: sample program to show how you can allow the admin to run
49   -pre-specified shell commands (without actually having full shell access).
50   -Details [here][ra].
51   -
52   -[ra]: http://sitaramc.github.com/gitolite/doc/admin-defined-commands.html#_bonus_restricted_admin
53   -
54 48 **sudo**: allow admin to run ADCs on behalf of a user. Useful in support
55 49 situations I guess. Details in source.
56 50
12 doc/2-admin.mkd
Source Rendered
@@ -413,19 +413,21 @@ permission to the special user "daemon". Similarly, give read permission to
413 413 This gives you a quick way to offer multiple repos up for gitweb and/or daemon
414 414 access.
415 415
416   -However, setting a description for the project also enables gitweb permissions
417   -so you can do it that way if you want. Of course in this case you have to
418   -deal with each repo separately. Add lines like this to gitolite.conf:
  416 +However, **setting a description** for the project also enables gitweb
  417 +permissions so you can do it that way if you want. Of course in this case you
  418 +have to deal with each repo separately. Add lines like this to gitolite.conf:
419 419
420 420 foo = "some description"
421 421 bar = "some other description"
422 422 baz = "yet another description"
423 423
424   -You can also specify an owner for gitweb to show, if you like; for example I
425   -might use:
  424 +You can also **specify an owner** for gitweb to show, if you like; for example
  425 +I might use:
426 426
427 427 gitolite "Sitaram Chamarty" = "fast, secure, fine-grained, access control for git"
428 428
  429 +These lines are standalone, so you can add them anywhere in the conf file.
  430 +
429 431 Note that gitolite does **not** install or configure gitweb/git-daemon -- that
430 432 is a one-time setup you must do separately. All gitolite does is:
431 433
4 doc/3-faq-tips-etc.mkd
Source Rendered
@@ -430,8 +430,8 @@ Although gitweb is a completely separate program, gitolite can do quite a
430 430 lot to help you manage gitweb access as well; once the initial setup is
431 431 complete, you can do it all from within the gitolite config file!
432 432
433   -If you just want gitweb to show some repositories, see [gwd] for how to
434   -specify which repos to show. Other advanced uses are described here.
  433 +If you just want gitweb to show some repositories, see [here][gwd] for how to
  434 +specify which repos to show.
435 435
436 436 [gwd]: http://sitaramc.github.com/gitolite/doc/2-admin.html#gwd
437 437
38 doc/gitolite.conf-by-example.mkd
Source Rendered
@@ -63,12 +63,11 @@ end of the string respectively.
63 63 ^foo$ matches exact string 'foo'.
64 64
65 65 To be precise, the last one is "any string starting and ending with *the same*
66   -'foo'". (Without the italicised phrase, it could mean "foofoo" would also
67   -match, but it doesn't).
  66 +'foo'". "foofoo" does not match.
68 67
69   -`[0-9]` is an example of a character class; this one matches any single digit.
70   -`[a-z]` matches any lower case alpha. For example, `[0-9a-f]` is the range of
71   -hex characters. You can guess what `[a-zA-Z0-9_]` does, then.
  68 +`[0-9]` is an example of a character class; it matches any single digit.
  69 +`[a-z]` matches any lower case alpha, and `[0-9a-f]` is the range of hex
  70 +characters. You should now guess what `[a-zA-Z0-9_]` does.
72 71
73 72 `.` (the period) is special -- it matches any character. If you want to match
74 73 an actual period, you need to say `\.`.
@@ -107,11 +106,11 @@ branch or tag on it.
107 106 Wally can only read the repo. Alice and Ashok can push but not rewind; only
108 107 Sitaram and Dilbert can do that.
109 108
110   - R master = wally # MEANINGLESS! WONT DO WHAT YOU THINK IT DOES!!
  109 + R master = wally # MEANINGLESS! WILL NOT DO WHAT YOU THINK IT DOES!!
111 110
112   -This won't work. You can only restrict "read" access at the repo level not
113   -the branch level. This is a git issue, not a gitolite issue. Go bother them,
114   -or switch to gerrit.
  111 +This won't work. You can only restrict "read" access at the repo level, not
  112 +at the branch level. This is a git issue, not a gitolite issue. Go bother
  113 +them, or switch to gerrit.
115 114
116 115 repo foo
117 116 RW master$ = dilbert alice
@@ -119,9 +118,10 @@ or switch to gerrit.
119 118 RW refs/heads/master$ = dilbert alice
120 119
121 120 The reason for treating "master$" as "refs/heads/master$" is that matching
122   -branches is the most common use so we made it convenient to use. Anything
123   -*not* starting with `refs/` (or `NAME/`, but that is out of scope of this
124   -document), is implicitly prefixed with `refs/heads/`).
  121 +branches is the most common use so the syntax is optimised to make that
  122 +simpler to write and easier to read. Anything *not* starting with `refs/`
  123 +(<font color="gray">or `NAME/`, but that is out of scope for this
  124 +document</font>), is implicitly prefixed with `refs/heads/`.
125 125
126 126 The `master$` is called a "refex" (a regex that matches a ref).
127 127
@@ -129,9 +129,13 @@ Dilbert and Alice can push to the "master" branch. Unless some other rule
129 129 allows it, they cannot push to, say, "master1", "masterfull" etc., due to the
130 130 `$` at the end of the refex.
131 131
132   -This rule does not match "headmaster"; refexes are treated as if they have a
133   -`^` at the start. (This means `^refs/heads/master` in this case, not
134   -`^master`, in case you forgot!)
  132 +Refexes are *prefix matched*; i.e., treated as if they have a `^` at the
  133 +start. (This means `^refs/heads/master` in this case, not `^master`, in case
  134 +you forgot!)
  135 +
  136 +This rule therefore does not match "headmaster", or even
  137 +"refs/heads/refs/heads/master" (<font color="gray">yes, it is possible to
  138 +confuse yourself by pushing a branch like that in git</font>).
135 139
136 140 RW+ pu = dilbert
137 141 # again, remember this is equivalent to:
@@ -181,8 +185,8 @@ earlier.
181 185
182 186 * for non-version tags, only the 3rd rule matches, so anyone on staff can
183 187 push them
184   - * for version tags by bruce, the first rule matches so he can push them
185   - * for version tags by staffers *other than bruce*, the second rule matches
  188 + * for version tags by ashok, the first rule matches so he can push them
  189 + * for version tags by staffers *other than ashok*, the second rule matches
186 190 before the third one, and it has a `-` as the permission, so the push
187 191 fails
188 192
22 doc/gitolite.conf.mkd
Source Rendered
@@ -306,9 +306,9 @@ We'll look at the delete/rewind case in detail first:
306 306 * if, however, *any* of the rules for a repo contains a `D` (example: `RWD`,
307 307 `RW+D`, etc) then `RW+` by itself will permit only a rewind, not a delete
308 308
309   -The same thing applies to create/push, where if you have a permissions like
310   -`RWC` or `RW+C` anywhere, a simple `RW` or `RW+` can no longer *create* a new
311   -ref.
  309 +The same thing applies to create/push, where if you have permissions like
  310 +`RWC` or `RW+C` anywhere in that repo, a simple `RW` or `RW+` can no longer
  311 +*create* a new ref.
312 312
313 313 You can combine the `C` and `D` also. Thus, the set of permissions you now
314 314 know about are, in regex syntax: `R|RW+?C?D?`. See a later section for the
@@ -596,17 +596,5 @@ later to override the generic settings.
596 596 #### repo owner/description line for gitweb
597 597
598 598 You can include owner/description information in the conf file, and gitolite
599   -will put it in places where gitweb will pick it up. For example, suppose this
600   -software (gitolite) itself was being hosted on a gitolite server and intended
601   -to be shown on gitweb, I'd use a line like this:
602   -
603   - gitolite "Sitaram Chamarty" = "fast, secure, access control for git"
604   -
605   -The general syntax is very simple, just use one of:
606   -
607   - reponame = "some description string in double quotes"
608   - reponame "owner name" = "some description string in double quotes"
609   -
610   -Note: setting a description also gives gitweb access; you do not have to give
611   -gitweb access explicitly (as described or linked above) if you're specifying a
612   -description.
  599 +will put it in places where gitweb will pick it up. See [here][gwd] for more
  600 +on this.
12 doc/gitolite.rc.mkd
Source Rendered
@@ -294,18 +294,6 @@ on feedback from my users to find or fix issues.
294 294 does *not* include the special users "gitweb" and "daemon". If you want
295 295 @all to include these two users, set this variable.
296 296
297   - * mirroring setup
298   -
299   - These two variables enable mirroring support; see
300   - [doc/mirroring.mkd][mirr] for details. The two variables are
301   - `$GL_SLAVE_MODE`, (boolean, default undef), and `$ENV{GL_SLAVES}`,
302   - (environment variable, string, default undef)
303   -
304   - Note on the second variable above: you must use single quotes to give it
305   - its value, not double quotes, (like `$ENV{GL_SLAVES} = 'gitolite@server2
306   - gitolite@server3';`). Also note that this is an environment variable, not
307   - a regular perl variable, so mind the syntax if you're not a perl guy :-)
308   -
309 297 * `$GL_WILDREPOS_PERM_CATS`, string, default "READERS WRITERS"
310 298
311 299 Originally, we only allowed "R" and "RW" in the setperms command. Now we
52 doc/report-output.mkd
Source Rendered
@@ -33,21 +33,21 @@ Here is a sample output of the info command. There are 3 columns of
33 33 permissions (create, read, and write) in the output, although the first column
34 34 is often blank.
35 35
36   - $ ssh git@server info
37   - hello sitaram, the gitolite version here is v1.5.5-24-g2b066fc
38   - the gitolite config gives you the following access:
39   - R W SecureBrowse
40   - R W anu-wsd
41   - R W entrans
42   - @R W git-notes
43   - @R W gitolite
44   - R W gitolite-admin
45   - R W indic_web_input
46   - @C R W private/sitaram/[\w.-]+
47   - R W proxy
48   - @C @R W public/sitaram/[\w.-]+
49   - @R_ @W_ testing
50   - R W vkc
  36 + $ ssh git@server info
  37 + hello sitaram, this is gitolite v2.1-29-g5a125fa running on git 1.7.4.4
  38 + the gitolite config gives you the following access:
  39 + R SecureBrowse
  40 + R W anu-wsd
  41 + R W entrans
  42 + @R W git-notes
  43 + @R W gitolite
  44 + R W gitolite-admin
  45 + R W indic_web_input
  46 + @C R W private/sitaram/[\w.-]+
  47 + R W proxy
  48 + @C @R W public/sitaram/[\w.-]+
  49 + @R_ @W_ testing
  50 + R W vkc
51 51
52 52 <a name="_interpreting_the_output"></a>
53 53
@@ -80,17 +80,17 @@ to one of the `@all` uses), but no explicit access.
80 80
81 81 Here are a couple of samples with optional patterns:
82 82
83   - $ ssh git@server info git
84   - hello sitaram, the gitolite version here is v1.5.5-24-g2b066fc
85   - the gitolite config gives you the following access:
86   - @R W git-notes
87   - @R W gitolite
88   - R W gitolite-admin
89   -
90   - $ ssh git@server info admin
91   - hello sitaram, the gitolite version here is v1.5.5-24-g2b066fc
92   - the gitolite config gives you the following access:
93   - R W gitolite-admin
  83 + $ ssh git@server info git
  84 + hello sitaram, this is gitolite v2.1-29-g5a125fa running on git 1.7.4.4
  85 + the gitolite config gives you the following access:
  86 + @R W git-notes
  87 + @R W gitolite
  88 + R W gitolite-admin
  89 +
  90 + $ ssh git@server info admin
  91 + hello sitaram, this is gitolite v2.1-29-g5a125fa running on git 1.7.4.4
  92 + the gitolite config gives you the following access:
  93 + R W gitolite-admin
94 94
95 95 In "big-config" mode (i.e., when `GL_BIG_CONFIG` is set) the pattern is
96 96 **mandatory**. You can try and cheat the system by passing in a "." but
2  doc/ssh-troubleshooting.mkd
Source Rendered
@@ -207,7 +207,7 @@ single key to allow both gitolite access *and* shell access.
207 207 This is done by copying the pubkey (to which you want to give shell access) to
208 208 the server and running
209 209
210   - gl-tool shell-add ~/foo.pub
  210 + gl-tool add-shell-user ~/foo.pub
211 211
212 212 **IMPORTANT UPGRADE NOTE**: previous implementations of this feature were
213 213 crap. There was no easy/elegant way to ensure that someone who had repo admin
13 doc/wildcard-repositories.mkd
Source Rendered
@@ -87,6 +87,11 @@ Here's an example snippet:
87 87 RW = WRITERS @TAs
88 88 R = READERS @prof
89 89
  90 +Note the "C" permission. This is a standalone "C", which gives the named
  91 +users the right to *create a repo*. <font color="gray">This is not to be
  92 +confused with the "RWC" or its variants described elsewhere, which are about
  93 +*branches*, not *repos*.</font>
  94 +
90 95 For now, ignore the special usernames READERS and WRITERS, and just create a
91 96 new repo, as user "u4" (a student):
92 97
@@ -204,9 +209,11 @@ use 'getperms' to check:
204 209
205 210 The following points are important:
206 211
207   - * note the syntax of the commands; it's not a "git" command, and there's no
208   - `:` like in a repo URL. The first space-separated word is READERS or
209   - WRITERS, and the rest are simple usernames.
  212 + * note the syntax of the command; it's not a "git" command, and there's no
  213 + `:` like in a repo URL.
  214 + * for the actual text being sent in via STDIN, the first space-separated
  215 + word is the role (in this example, READERS or WRITERS), and the rest
  216 + are simple usernames.
210 217
211 218 <a name="_admin_adding_other_roles_than_READERS_and_WRITERS"></a>
212 219

0 comments on commit 877c662

Please sign in to comment.
Something went wrong with that request. Please try again.