Permalink
Browse files

63888b7 vref: more clarifications

  • Loading branch information...
1 parent c0f4656 commit 30da9e42ef89d65aaa03600c258dcd890d2f30ca @sitaramc committed Mar 15, 2013
Showing with 509 additions and 16 deletions.
  1. +1 −1 deleg.html
  2. +8 −3 gitolite.html
  3. +1 −1 master-toc.html
  4. +3 −3 non-core.html
  5. +13 −8 vref.html
  6. +483 −0 vref2.html
View
@@ -56,7 +56,7 @@
access rules for any other sub-admin's repos.</p>
<p>Delegation is achieved by combining two gitolite features: <a href="deleg.html#subconf">subconf</a> and the
-<a href="vref.html#NAME">NAME VREF</a>.</p>
+<a href="vref2.html#NAME">NAME VREF</a>.</p>
<p>To understand delegation, read both those links then come back to this
example.</p>
View
@@ -3657,6 +3657,9 @@
won't make sense until you read further, but I had to put it up here for folks
who stop reading halfway!</p>
+<p><strong>IMPORTANT</strong>: VREFs is an advanced topic. Be prepared to spend some time
+experimenting to understand things.</p>
+
<p>Here's an example to start you off.</p>
<pre><code>repo r1
@@ -3682,9 +3685,11 @@
<p>We know that "refs/heads/master" and such are normal git refs that are matched
against the <a href="gitolite.html#rules-rules">rules</a> to decide if the push is to be allowed or denied.</p>
-<p>A VREF is just another ref that is checked against the rules. For example,
-VREF/COUNT/5 means "this push has more than 5 changed files". Or
-VREF/NAME/Makefile means "the file called Makefile was changed in this push".</p>
+<p>This ref is a "property" of the push.</p>
+
+<p>Similarly, there could be several other "properties" that you may want to test
+-- we call them "virtual" refs, or VREFs. For example, "this push has more
+than 5 changed files". Or "this push changed the file called Makefile".</p>
<h3>how do I use a VREF?</h3>
View
@@ -260,7 +260,7 @@
</li>
<li><a href="deleg.html">delegating</a> access control responsibilities
<ul>
-<li>(<a href="vref.html#NAME">link</a>: the NAME VREF)
+<li>(<a href="vref2.html#NAME">link</a>: the NAME VREF)
</li>
<li>the <a href="deleg.html#subconf">subconf</a> command
</li>
View
@@ -250,7 +250,7 @@
details. However, here's a list of VREFs shipped with gitolite:</p>
<ul>
-<li><em><a href="vref.html#COUNT">COUNT</a></em> -- restrict pushes by number of changed or new files pushed
+<li><em><a href="vref2.html#COUNT">COUNT</a></em> -- restrict pushes by number of changed or new files pushed
</li>
<li><em>EMAIL-CHECK</em> -- check if all new commits are authored by the person pushing
</li>
@@ -260,7 +260,7 @@
<li><em>MAX_NEWBIN_SIZE</em> -- restrict by size of new binary files (helps catch
people checking in random PDFs, JARs, WARs, etc.)
</li>
-<li><strong><a href="vref.html#NAME">NAME</a></strong> -- restrict pushes by dir/file name
+<li><strong><a href="vref2.html#NAME">NAME</a></strong> -- restrict pushes by dir/file name
</li>
<li><a href="non-core.html#partial-copy">partial-copy</a> -- simulated read control for branches (in combination
with the partial-copy trigger)
@@ -269,7 +269,7 @@
expressions over refexes, like "refex-1 and not refex-2". (Example:
changing file 'foo' but not on 'master' branch)
</li>
-<li><em><a href="vref.html#votes">VOTES</a></em> -- voting on commits a la gerrit
+<li><em><a href="vref2.html#votes">VOTES</a></em> -- voting on commits a la gerrit
</li>
</ul>
View
@@ -54,6 +54,9 @@
won't make sense until you read further, but I had to put it up here for folks
who stop reading halfway!</p>
+<p><strong>IMPORTANT</strong>: VREFs is an advanced topic. Be prepared to spend some time
+experimenting to understand things.</p>
+
<hr />
<ul>
@@ -77,27 +80,27 @@
<ul>
<li>what if the VREF-maker prints a different VREF?
</li>
-<li><a href="vref.html#vref-fallthru">why is fallthru considered success with VREFs</a>
+<li><a href="vref2.html#vref-fallthru">why is fallthru considered success with VREFs</a>
</li>
<li>what if the VREF-maker prints something that's not even a VREF?
</li>
<li>in what order are VREF-makers called?
</li>
-<li><a href="vref.html#vref-args">what arguments are passed to the vref-maker?</a>
+<li><a href="vref2.html#vref-args">what arguments are passed to the vref-maker?</a>
</li>
</ul>
</li>
<li>VREF-makers shipped with gitolite
<ul>
-<li><a href="vref.html#NAME">restricting pushes by dir/file name</a>
+<li><a href="vref2.html#NAME">restricting pushes by dir/file name</a>
</li>
-<li><a href="vref.html#COUNT">number of changed or new files</a>
+<li><a href="vref2.html#COUNT">number of changed or new files</a>
</li>
<li>advanced filetype detection
</li>
<li>checking author email
</li>
-<li><a href="vref.html#votes">voting on commits</a>
+<li><a href="vref2.html#votes">voting on commits</a>
</li>
</ul>
</li>
@@ -142,9 +145,11 @@
<p>We know that "refs/heads/master" and such are normal git refs that are matched
against the <a href="rules.html">rules</a> to decide if the push is to be allowed or denied.</p>
-<p>A VREF is just another ref that is checked against the rules. For example,
-VREF/COUNT/5 means "this push has more than 5 changed files". Or
-VREF/NAME/Makefile means "the file called Makefile was changed in this push".</p>
+<p>This ref is a "property" of the push.</p>
+
+<p>Similarly, there could be several other "properties" that you may want to test
+-- we call them "virtual" refs, or VREFs. For example, "this push has more
+than 5 changed files". Or "this push changed the file called Makefile".</p>
<h2>how do I use a VREF?</h2>
Oops, something went wrong.

0 comments on commit 30da9e4

Please sign in to comment.