Autogenerated HTML docs for v1.6.5.3-298-g39add

1 files changed, 125 insertions, 6 deletions

diff --git a/git-remote-helpers.html b/git-remote-helpers.html
index 31c4f1734..474772d7c 100644
--- a/git-remote-helpers.html
+++ b/git-remote-helpers.html
@@ -355,19 +355,59 @@ helper programs will behave as documented here.</p></div>
         the name; unrecognized attributes are ignored. After the

         complete list, outputs a blank line.

 </p>

+<div class="para"><p>If <em>push</em> is supported this may be called as <em>list for-push</em>

+to obtain the current refs prior to sending one or more <em>push</em>

+commands to the helper.</p></div>

+</dd>

+<dt>

+<em>option</em> &lt;name&gt; &lt;value&gt;

+</dt>

+<dd>

+<p>

+        Set the transport helper option &lt;name&gt; to &lt;value&gt;.  Outputs a

+        single line containing one of <em>ok</em> (option successfully set),

+        <em>unsupported</em> (option not recognized) or <em>error &lt;msg&gt;</em>

+        (option &lt;name&gt; is supported but &lt;value&gt; is not correct

+        for it).  Options should be set before other commands,

+        and may how those commands behave.

+</p>

+<div class="para"><p>Supported if the helper has the "option" capability.</p></div>

 </dd>

 <dt>

 <em>fetch</em> &lt;sha1&gt; &lt;name&gt;

 </dt>

 <dd>

 <p>

-        Fetches the given object, writing the necessary objects to the

-        database. Outputs a blank line when the fetch is

-        complete. Only objects which were reported in the ref list

-        with a sha1 may be fetched this way.

+        Fetches the given object, writing the necessary objects

+        to the database.  Fetch commands are sent in a batch, one

+        per line, and the batch is terminated with a blank line.

+        Outputs a single blank line when all fetch commands in the

+        same batch are complete. Only objects which were reported

+        in the ref list with a sha1 may be fetched this way.

 </p>

+<div class="para"><p>Optionally may output a <em>lock &lt;file&gt;</em> line indicating a file under

+GIT_DIR/objects/pack which is keeping a pack until refs can be

+suitably updated.</p></div>

 <div class="para"><p>Supported if the helper has the "fetch" capability.</p></div>

 </dd>

+<dt>

+<em>push</em> +&lt;src&gt;:&lt;dst&gt;

+</dt>

+<dd>

+<p>

+        Pushes the given &lt;src&gt; commit or branch locally to the

+        remote branch described by &lt;dst&gt;.  A batch sequence of

+        one or more push commands is terminated with a blank line.

+</p>

+<div class="para"><p>Zero or more protocol options may be entered after the last <em>push</em>

+command, before the batch's terminating blank line.</p></div>

+<div class="para"><p>When the push is complete, outputs one or more <em>ok &lt;dst&gt;</em> or

+<em>error &lt;dst&gt; &lt;why&gt;?</em> lines to indicate success or failure of

+each pushed ref.  The status report output is terminated by

+a blank line.  The option field &lt;why&gt; may be quoted in a C

+style string if it contains an LF.</p></div>

+<div class="para"><p>Supported if the helper has the "push" capability.</p></div>

+</dd>

 </dl></div>

 <div class="para"><p>If a fatal error occurs, the program writes the error message to

 stderr and exits. The caller should expect that a suitable error

@@ -387,11 +427,90 @@ capabilities reported by the helper.</p></div>
         This helper supports the <em>fetch</em> command.

 </p>

 </dd>

+<dt>

+<em>option</em>

+</dt>

+<dd>

+<p>

+        This helper supports the option command.

+</p>

+</dd>

+<dt>

+<em>push</em>

+</dt>

+<dd>

+<p>

+        This helper supports the <em>push</em> command.

+</p>

+</dd>

 </dl></div>

 </div>

 <h2 id="_ref_list_attributes">REF LIST ATTRIBUTES</h2>

 <div class="sectionbody">

-<div class="para"><p>None are defined yet, but the caller must accept any which are supplied.</p></div>

+<div class="vlist"><dl>

+<dt>

+<em>for-push</em>

+</dt>

+<dd>

+<p>

+        The caller wants to use the ref list to prepare push

+        commands.  A helper might chose to acquire the ref list by

+        opening a different type of connection to the destination.

+</p>

+</dd>

+</dl></div>

+</div>

+<h2 id="_options">OPTIONS</h2>

+<div class="sectionbody">

+<div class="vlist"><dl>

+<dt>

+<em>option verbosity</em> &lt;N&gt;

+</dt>

+<dd>

+<p>

+        Change the level of messages displayed by the helper.

+        When N is 0 the end-user has asked the process to be

+        quiet, and the helper should produce only error output.

+        N of 1 is the default level of verbosity, higher values

+        of N correspond to the number of -v flags passed on the

+        command line.

+</p>

+</dd>

+<dt>

+<em>option progress</em> {<em>true</em>|<em>false</em>}

+</dt>

+<dd>

+<p>

+        Enable (or disable) progress messages displayed by the

+        transport helper during a command.

+</p>

+</dd>

+<dt>

+<em>option depth</em> &lt;depth&gt;

+</dt>

+<dd>

+<p>

+        Deepen the history of a shallow repository.

+</p>

+</dd>

+<dt>

+<em>option followtags</em> {<em>true</em>|<em>false</em>}

+</dt>

+<dd>

+<p>

+        If enabled the helper should automatically fetch annotated

+        tag objects if the object the tag points at was transferred

+        during the fetch command.  If the tag is not fetched by

+        the helper a second fetch command will usually be sent to

+        ask for the tag specifically.  Some helpers may be able to

+        use this option to avoid a second network connection.

+</p>

+</dd>

+</dl></div>

+<div class="para"><p><em>option dry-run</em> {<em>true</em>|<em>false</em>}:

+        If true, pretend the operation completed successfully,

+        but don't actually change any repository data.  For most

+        helpers this only applies to the <em>push</em>, if supported.</p></div>

 </div>

 <h2 id="_documentation">Documentation</h2>

 <div class="sectionbody">

@@ -403,7 +522,7 @@ capabilities reported by the helper.</p></div>
 </div>

 <div id="footer">

 <div id="footer-text">

-Last updated 2009-11-15 09:57:16 UTC

+Last updated 2009-11-21 17:36:57 UTC

 </div>

 </div>

 </body>