doc/source/en/TortoiseGit/git_doc/git-remote-helpers.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-remote-helpers(1)">\r
   5 <articleinfo>\r
   6     <title>git-remote-helpers(1)</title>\r
   7 <indexterm>\r
   8 <primary>git-remote-helpers(1)</primary>\r
   9 </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-remote-helpers - Helper programs to interact with remote repositories</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>git remote-&lt;transport&gt;</emphasis> &lt;repository&gt; [&lt;URL&gt;]</literallayout>\r
  19 </blockquote>\r
  20 </simplesect>\r
  21 <simplesect id="_description">\r
  22 <title>DESCRIPTION</title>\r
  23 <simpara>Remote helper programs are normally not used directly by end users,\r
  24 but they are invoked by git when it needs to interact with remote\r
  25 repositories git does not support natively.  A given helper will\r
  26 implement a subset of the capabilities documented here. When git\r
  27 needs to interact with a repository using a remote helper, it spawns\r
  28 the helper as an independent process, sends commands to the helper's\r
  29 standard input, and expects results from the helper's standard\r
  30 output. Because a remote helper runs as an independent process from\r
  31 git, there is no need to re-link git to add a new helper, nor any\r
  32 need to link the helper with the implementation of git.</simpara>\r
  33 <simpara>Every helper must support the "capabilities" command, which git\r
  34 uses to determine what other commands the helper will accept.  Those\r
  35 other commands can be used to discover and update remote refs,\r
  36 transport objects between the object database and the remote repository,\r
  37 and update the local object store.</simpara>\r
  38 <simpara>Git comes with a "curl" family of remote helpers, that handle various\r
  39 transport protocols, such as <emphasis>git-remote-http</emphasis>, <emphasis>git-remote-https</emphasis>,\r
  40 <emphasis>git-remote-ftp</emphasis> and <emphasis>git-remote-ftps</emphasis>. They implement the capabilities\r
  41 <emphasis>fetch</emphasis>, <emphasis>option</emphasis>, and <emphasis>push</emphasis>.</simpara>\r
  42 </simplesect>\r
  43 <simplesect id="_input_format">\r
  44 <title>INPUT FORMAT</title>\r
  45 <simpara>Git sends the remote helper a list of commands on standard input, one\r
  46 per line.  The first command is always the <emphasis>capabilities</emphasis> command, in\r
  47 response to which the remote helper must print a list of the\r
  48 capabilities it supports (see below) followed by a blank line.  The\r
  49 response to the capabilities command determines what commands Git uses\r
  50 in the remainder of the command stream.</simpara>\r
  51 <simpara>The command stream is terminated by a blank line.  In some cases\r
  52 (indicated in the documentation of the relevant commands), this blank\r
  53 line is followed by a payload in some other protocol (e.g., the pack\r
  54 protocol), while in others it indicates the end of input.</simpara>\r
  55 <section id="_capabilities">\r
  56 <title>Capabilities</title>\r
  57 <simpara>Each remote helper is expected to support only a subset of commands.\r
  58 The operations a helper supports are declared to git in the response\r
  59 to the <emphasis>capabilities</emphasis> command (see COMMANDS, below).</simpara>\r
  60 <variablelist>\r
  61 <varlistentry>\r
  62 <term>\r
  63 <emphasis>option</emphasis>\r
  64 </term>\r
  65 <listitem>\r
  66 <simpara>\r
  67         For specifying settings like <emphasis>verbosity</emphasis> (how much output to\r
  68         write to stderr) and <emphasis>depth</emphasis> (how much history is wanted in the\r
  69         case of a shallow clone) that affect how other commands are\r
  70         carried out.\r
  71 </simpara>\r
  72 </listitem>\r
  73 </varlistentry>\r
  74 <varlistentry>\r
  75 <term>\r
  76 <emphasis>connect</emphasis>\r
  77 </term>\r
  78 <listitem>\r
  79 <simpara>\r
  80         For fetching and pushing using git's native packfile protocol\r
  81         that requires a bidirectional, full-duplex connection.\r
  82 </simpara>\r
  83 </listitem>\r
  84 </varlistentry>\r
  85 <varlistentry>\r
  86 <term>\r
  87 <emphasis>push</emphasis>\r
  88 </term>\r
  89 <listitem>\r
  90 <simpara>\r
  91         For listing remote refs and pushing specified objects from the\r
  92         local object store to remote refs.\r
  93 </simpara>\r
  94 </listitem>\r
  95 </varlistentry>\r
  96 <varlistentry>\r
  97 <term>\r
  98 <emphasis>fetch</emphasis>\r
  99 </term>\r
 100 <listitem>\r
 101 <simpara>\r
 102         For listing remote refs and fetching the associated history to\r
 103         the local object store.\r
 104 </simpara>\r
 105 </listitem>\r
 106 </varlistentry>\r
 107 <varlistentry>\r
 108 <term>\r
 109 <emphasis>import</emphasis>\r
 110 </term>\r
 111 <listitem>\r
 112 <simpara>\r
 113         For listing remote refs and fetching the associated history as\r
 114         a fast-import stream.\r
 115 </simpara>\r
 116 </listitem>\r
 117 </varlistentry>\r
 118 <varlistentry>\r
 119 <term>\r
 120 <emphasis>refspec</emphasis> &lt;refspec&gt;\r
 121 </term>\r
 122 <listitem>\r
 123 <simpara>\r
 124         This modifies the <emphasis>import</emphasis> capability, allowing the produced\r
 125         fast-import stream to modify refs in a private namespace\r
 126         instead of writing to refs/heads or refs/remotes directly.\r
 127         It is recommended that all importers providing the <emphasis>import</emphasis>\r
 128         capability use this.\r
 129 </simpara>\r
 130 <simpara>A helper advertising the capability\r
 131 <emphasis>refspec refs/heads/*:refs/svn/origin/branches/*</emphasis>\r
 132 is saying that, when it is asked to <emphasis>import refs/heads/topic</emphasis>, the\r
 133 stream it outputs will update the <emphasis>refs/svn/origin/branches/topic</emphasis>\r
 134 ref.</simpara>\r
 135 <simpara>This capability can be advertised multiple times.  The first\r
 136 applicable refspec takes precedence.  The left-hand of refspecs\r
 137 advertised with this capability must cover all refs reported by\r
 138 the list command.  If no <emphasis>refspec</emphasis> capability is advertised,\r
 139 there is an implied <emphasis>refspec *:*</emphasis>.</simpara>\r
 140 </listitem>\r
 141 </varlistentry>\r
 142 </variablelist>\r
 143 </section>\r
 144 <section id="_capabilities_for_pushing">\r
 145 <title>Capabilities for Pushing</title>\r
 146 <variablelist>\r
 147 <varlistentry>\r
 148 <term>\r
 149 <emphasis>connect</emphasis>\r
 150 </term>\r
 151 <listitem>\r
 152 <simpara>\r
 153         Can attempt to connect to <emphasis>git receive-pack</emphasis> (for pushing),\r
 154         <emphasis>git upload-pack</emphasis>, etc for communication using the\r
 155         packfile protocol.\r
 156 </simpara>\r
 157 <simpara>Supported commands: <emphasis>connect</emphasis>.</simpara>\r
 158 </listitem>\r
 159 </varlistentry>\r
 160 <varlistentry>\r
 161 <term>\r
 162 <emphasis>push</emphasis>\r
 163 </term>\r
 164 <listitem>\r
 165 <simpara>\r
 166         Can discover remote refs and push local commits and the\r
 167         history leading up to them to new or existing remote refs.\r
 168 </simpara>\r
 169 <simpara>Supported commands: <emphasis>list for-push</emphasis>, <emphasis>push</emphasis>.</simpara>\r
 170 </listitem>\r
 171 </varlistentry>\r
 172 </variablelist>\r
 173 <simpara>If a helper advertises both <emphasis>connect</emphasis> and <emphasis>push</emphasis>, git will use\r
 174 <emphasis>connect</emphasis> if possible and fall back to <emphasis>push</emphasis> if the helper requests\r
 175 so when connecting (see the <emphasis>connect</emphasis> command under COMMANDS).</simpara>\r
 176 </section>\r
 177 <section id="_capabilities_for_fetching">\r
 178 <title>Capabilities for Fetching</title>\r
 179 <variablelist>\r
 180 <varlistentry>\r
 181 <term>\r
 182 <emphasis>connect</emphasis>\r
 183 </term>\r
 184 <listitem>\r
 185 <simpara>\r
 186         Can try to connect to <emphasis>git upload-pack</emphasis> (for fetching),\r
 187         <emphasis>git receive-pack</emphasis>, etc for communication using the\r
 188         packfile protocol.\r
 189 </simpara>\r
 190 <simpara>Supported commands: <emphasis>connect</emphasis>.</simpara>\r
 191 </listitem>\r
 192 </varlistentry>\r
 193 <varlistentry>\r
 194 <term>\r
 195 <emphasis>fetch</emphasis>\r
 196 </term>\r
 197 <listitem>\r
 198 <simpara>\r
 199         Can discover remote refs and transfer objects reachable from\r
 200         them to the local object store.\r
 201 </simpara>\r
 202 <simpara>Supported commands: <emphasis>list</emphasis>, <emphasis>fetch</emphasis>.</simpara>\r
 203 </listitem>\r
 204 </varlistentry>\r
 205 <varlistentry>\r
 206 <term>\r
 207 <emphasis>import</emphasis>\r
 208 </term>\r
 209 <listitem>\r
 210 <simpara>\r
 211         Can discover remote refs and output objects reachable from\r
 212         them as a stream in fast-import format.\r
 213 </simpara>\r
 214 <simpara>Supported commands: <emphasis>list</emphasis>, <emphasis>import</emphasis>.</simpara>\r
 215 </listitem>\r
 216 </varlistentry>\r
 217 </variablelist>\r
 218 <simpara>If a helper advertises <emphasis>connect</emphasis>, git will use it if possible and\r
 219 fall back to another capability if the helper requests so when\r
 220 connecting (see the <emphasis>connect</emphasis> command under COMMANDS).\r
 221 When choosing between <emphasis>fetch</emphasis> and <emphasis>import</emphasis>, git prefers <emphasis>fetch</emphasis>.\r
 222 Other frontends may have some other order of preference.</simpara>\r
 223 <variablelist>\r
 224 <varlistentry>\r
 225 <term>\r
 226 <emphasis>refspec</emphasis> &lt;refspec&gt;\r
 227 </term>\r
 228 <listitem>\r
 229 <simpara>\r
 230         This modifies the <emphasis>import</emphasis> capability.\r
 231 </simpara>\r
 232 <simpara>A helper advertising\r
 233 <emphasis>refspec refs/heads/*:refs/svn/origin/branches/*</emphasis>\r
 234 in its capabilities is saying that, when it handles\r
 235 <emphasis>import refs/heads/topic</emphasis>, the stream it outputs will update the\r
 236 <emphasis>refs/svn/origin/branches/topic</emphasis> ref.</simpara>\r
 237 <simpara>This capability can be advertised multiple times.  The first\r
 238 applicable refspec takes precedence.  The left-hand of refspecs\r
 239 advertised with this capability must cover all refs reported by\r
 240 the list command.  If no <emphasis>refspec</emphasis> capability is advertised,\r
 241 there is an implied <emphasis>refspec *:*</emphasis>.</simpara>\r
 242 </listitem>\r
 243 </varlistentry>\r
 244 </variablelist>\r
 245 </section>\r
 246 </simplesect>\r
 247 <simplesect id="_invocation">\r
 248 <title>INVOCATION</title>\r
 249 <simpara>Remote helper programs are invoked with one or (optionally) two\r
 250 arguments. The first argument specifies a remote repository as in git;\r
 251 it is either the name of a configured remote or a URL. The second\r
 252 argument specifies a URL; it is usually of the form\r
 253 <emphasis>&lt;transport&gt;://&lt;address&gt;</emphasis>, but any arbitrary string is possible.\r
 254 The <emphasis>GIT_DIR</emphasis> environment variable is set up for the remote helper\r
 255 and can be used to determine where to store additional data or from\r
 256 which directory to invoke auxiliary git commands.</simpara>\r
 257 <simpara>When git encounters a URL of the form <emphasis>&lt;transport&gt;://&lt;address&gt;</emphasis>, where\r
 258 <emphasis>&lt;transport&gt;</emphasis> is a protocol that it cannot handle natively, it\r
 259 automatically invokes <emphasis>git remote-&lt;transport&gt;</emphasis> with the full URL as\r
 260 the second argument. If such a URL is encountered directly on the\r
 261 command line, the first argument is the same as the second, and if it\r
 262 is encountered in a configured remote, the first argument is the name\r
 263 of that remote.</simpara>\r
 264 <simpara>A URL of the form <emphasis>&lt;transport&gt;::&lt;address&gt;</emphasis> explicitly instructs git to\r
 265 invoke <emphasis>git remote-&lt;transport&gt;</emphasis> with <emphasis>&lt;address&gt;</emphasis> as the second\r
 266 argument. If such a URL is encountered directly on the command line,\r
 267 the first argument is <emphasis>&lt;address&gt;</emphasis>, and if it is encountered in a\r
 268 configured remote, the first argument is the name of that remote.</simpara>\r
 269 <simpara>Additionally, when a configured remote has <emphasis>remote.&lt;name&gt;.vcs</emphasis> set to\r
 270 <emphasis>&lt;transport&gt;</emphasis>, git explicitly invokes <emphasis>git remote-&lt;transport&gt;</emphasis> with\r
 271 <emphasis>&lt;name&gt;</emphasis> as the first argument. If set, the second argument is\r
 272 <emphasis>remote.&lt;name&gt;.url</emphasis>; otherwise, the second argument is omitted.</simpara>\r
 273 </simplesect>\r
 274 <simplesect id="_commands">\r
 275 <title>COMMANDS</title>\r
 276 <simpara>Commands are given by the caller on the helper's standard input, one per line.</simpara>\r
 277 <variablelist>\r
 278 <varlistentry>\r
 279 <term>\r
 280 <emphasis>capabilities</emphasis>\r
 281 </term>\r
 282 <listitem>\r
 283 <simpara>\r
 284         Lists the capabilities of the helper, one per line, ending\r
 285         with a blank line. Each capability may be preceded with <emphasis>*</emphasis>,\r
 286         which marks them mandatory for git version using the remote\r
 287         helper to understand (unknown mandatory capability is fatal\r
 288         error).\r
 289 </simpara>\r
 290 </listitem>\r
 291 </varlistentry>\r
 292 <varlistentry>\r
 293 <term>\r
 294 <emphasis>list</emphasis>\r
 295 </term>\r
 296 <listitem>\r
 297 <simpara>\r
 298         Lists the refs, one per line, in the format "&lt;value&gt; &lt;name&gt;\r
 299         [&lt;attr&gt; &#8230;]". The value may be a hex sha1 hash, "@&lt;dest&gt;" for\r
 300         a symref, or "?" to indicate that the helper could not get the\r
 301         value of the ref. A space-separated list of attributes follows\r
 302         the name; unrecognized attributes are ignored. The list ends\r
 303         with a blank line.\r
 304 </simpara>\r
 305 <simpara>If <emphasis>push</emphasis> is supported this may be called as <emphasis>list for-push</emphasis>\r
 306 to obtain the current refs prior to sending one or more <emphasis>push</emphasis>\r
 307 commands to the helper.</simpara>\r
 308 </listitem>\r
 309 </varlistentry>\r
 310 <varlistentry>\r
 311 <term>\r
 312 <emphasis>option</emphasis> &lt;name&gt; &lt;value&gt;\r
 313 </term>\r
 314 <listitem>\r
 315 <simpara>\r
 316         Sets the transport helper option &lt;name&gt; to &lt;value&gt;.  Outputs a\r
 317         single line containing one of <emphasis>ok</emphasis> (option successfully set),\r
 318         <emphasis>unsupported</emphasis> (option not recognized) or <emphasis>error &lt;msg&gt;</emphasis>\r
 319         (option &lt;name&gt; is supported but &lt;value&gt; is not valid\r
 320         for it).  Options should be set before other commands,\r
 321         and may influence the behavior of those commands.\r
 322 </simpara>\r
 323 <simpara>Supported if the helper has the "option" capability.</simpara>\r
 324 </listitem>\r
 325 </varlistentry>\r
 326 <varlistentry>\r
 327 <term>\r
 328 <emphasis>fetch</emphasis> &lt;sha1&gt; &lt;name&gt;\r
 329 </term>\r
 330 <listitem>\r
 331 <simpara>\r
 332         Fetches the given object, writing the necessary objects\r
 333         to the database.  Fetch commands are sent in a batch, one\r
 334         per line, terminated with a blank line.\r
 335         Outputs a single blank line when all fetch commands in the\r
 336         same batch are complete. Only objects which were reported\r
 337         in the ref list with a sha1 may be fetched this way.\r
 338 </simpara>\r
 339 <simpara>Optionally may output a <emphasis>lock &lt;file&gt;</emphasis> line indicating a file under\r
 340 GIT_DIR/objects/pack which is keeping a pack until refs can be\r
 341 suitably updated.</simpara>\r
 342 <simpara>Supported if the helper has the "fetch" capability.</simpara>\r
 343 </listitem>\r
 344 </varlistentry>\r
 345 <varlistentry>\r
 346 <term>\r
 347 <emphasis>push</emphasis> +&lt;src&gt;:&lt;dst&gt;\r
 348 </term>\r
 349 <listitem>\r
 350 <simpara>\r
 351         Pushes the given local &lt;src&gt; commit or branch to the\r
 352         remote branch described by &lt;dst&gt;.  A batch sequence of\r
 353         one or more <emphasis>push</emphasis> commands is terminated with a blank line\r
 354         (if there is only one reference to push, a single <emphasis>push</emphasis> command\r
 355         is followed by a blank line). For example, the following would\r
 356         be two batches of <emphasis>push</emphasis>, the first asking the remote-helper\r
 357         to push the local ref <emphasis>master</emphasis> to the remote ref <emphasis>master</emphasis> and\r
 358         the local <emphasis>HEAD</emphasis> to the remote <emphasis>branch</emphasis>, and the second\r
 359         asking to push ref <emphasis>foo</emphasis> to ref <emphasis>bar</emphasis> (forced update requested\r
 360         by the <emphasis>+</emphasis>).\r
 361 </simpara>\r
 362 <screen>push refs/heads/master:refs/heads/master\r
 363 push HEAD:refs/heads/branch\r
 364 \n\r
 365 push +refs/heads/foo:refs/heads/bar\r
 366 \n</screen>\r
 367 <simpara>Zero or more protocol options may be entered after the last <emphasis>push</emphasis>\r
 368 command, before the batch's terminating blank line.</simpara>\r
 369 <simpara>When the push is complete, outputs one or more <emphasis>ok &lt;dst&gt;</emphasis> or\r
 370 <emphasis>error &lt;dst&gt; &lt;why&gt;?</emphasis> lines to indicate success or failure of\r
 371 each pushed ref.  The status report output is terminated by\r
 372 a blank line.  The option field &lt;why&gt; may be quoted in a C\r
 373 style string if it contains an LF.</simpara>\r
 374 <simpara>Supported if the helper has the "push" capability.</simpara>\r
 375 </listitem>\r
 376 </varlistentry>\r
 377 <varlistentry>\r
 378 <term>\r
 379 <emphasis>import</emphasis> &lt;name&gt;\r
 380 </term>\r
 381 <listitem>\r
 382 <simpara>\r
 383         Produces a fast-import stream which imports the current value\r
 384         of the named ref. It may additionally import other refs as\r
 385         needed to construct the history efficiently. The script writes\r
 386         to a helper-specific private namespace. The value of the named\r
 387         ref should be written to a location in this namespace derived\r
 388         by applying the refspecs from the "refspec" capability to the\r
 389         name of the ref.\r
 390 </simpara>\r
 391 <simpara>Especially useful for interoperability with a foreign versioning\r
 392 system.</simpara>\r
 393 <simpara>Just like <emphasis>push</emphasis>, a batch sequence of one or more <emphasis>import</emphasis> is\r
 394 terminated with a blank line. For each batch of <emphasis>import</emphasis>, the remote\r
 395 helper should produce a fast-import stream terminated by a <emphasis>done</emphasis>\r
 396 command.</simpara>\r
 397 <simpara>Supported if the helper has the "import" capability.</simpara>\r
 398 </listitem>\r
 399 </varlistentry>\r
 400 <varlistentry>\r
 401 <term>\r
 402 <emphasis>connect</emphasis> &lt;service&gt;\r
 403 </term>\r
 404 <listitem>\r
 405 <simpara>\r
 406         Connects to given service. Standard input and standard output\r
 407         of helper are connected to specified service (git prefix is\r
 408         included in service name so e.g. fetching uses <emphasis>git-upload-pack</emphasis>\r
 409         as service) on remote side. Valid replies to this command are\r
 410         empty line (connection established), <emphasis>fallback</emphasis> (no smart\r
 411         transport support, fall back to dumb transports) and just\r
 412         exiting with error message printed (can't connect, don't\r
 413         bother trying to fall back). After line feed terminating the\r
 414         positive (empty) response, the output of service starts. After\r
 415         the connection ends, the remote helper exits.\r
 416 </simpara>\r
 417 <simpara>Supported if the helper has the "connect" capability.</simpara>\r
 418 </listitem>\r
 419 </varlistentry>\r
 420 </variablelist>\r
 421 <simpara>If a fatal error occurs, the program writes the error message to\r
 422 stderr and exits. The caller should expect that a suitable error\r
 423 message has been printed if the child closes the connection without\r
 424 completing a valid response for the current command.</simpara>\r
 425 <simpara>Additional commands may be supported, as may be determined from\r
 426 capabilities reported by the helper.</simpara>\r
 427 </simplesect>\r
 428 <simplesect id="_ref_list_attributes">\r
 429 <title>REF LIST ATTRIBUTES</title>\r
 430 <variablelist>\r
 431 <varlistentry>\r
 432 <term>\r
 433 <emphasis>for-push</emphasis>\r
 434 </term>\r
 435 <listitem>\r
 436 <simpara>\r
 437         The caller wants to use the ref list to prepare push\r
 438         commands.  A helper might chose to acquire the ref list by\r
 439         opening a different type of connection to the destination.\r
 440 </simpara>\r
 441 </listitem>\r
 442 </varlistentry>\r
 443 <varlistentry>\r
 444 <term>\r
 445 <emphasis>unchanged</emphasis>\r
 446 </term>\r
 447 <listitem>\r
 448 <simpara>\r
 449         This ref is unchanged since the last import or fetch, although\r
 450         the helper cannot necessarily determine what value that produced.\r
 451 </simpara>\r
 452 </listitem>\r
 453 </varlistentry>\r
 454 </variablelist>\r
 455 </simplesect>\r
 456 <simplesect id="_options">\r
 457 <title>OPTIONS</title>\r
 458 <variablelist>\r
 459 <varlistentry>\r
 460 <term>\r
 461 <emphasis>option verbosity</emphasis> &lt;n&gt;\r
 462 </term>\r
 463 <listitem>\r
 464 <simpara>\r
 465         Changes the verbosity of messages displayed by the helper.\r
 466         A value of 0 for &lt;n&gt; means that processes operate\r
 467         quietly, and the helper produces only error output.\r
 468         1 is the default level of verbosity, and higher values\r
 469         of &lt;n&gt; correspond to the number of -v flags passed on the\r
 470         command line.\r
 471 </simpara>\r
 472 </listitem>\r
 473 </varlistentry>\r
 474 <varlistentry>\r
 475 <term>\r
 476 <emphasis>option progress</emphasis> {<emphasis>true</emphasis>|<emphasis>false</emphasis>}\r
 477 </term>\r
 478 <listitem>\r
 479 <simpara>\r
 480         Enables (or disables) progress messages displayed by the\r
 481         transport helper during a command.\r
 482 </simpara>\r
 483 </listitem>\r
 484 </varlistentry>\r
 485 <varlistentry>\r
 486 <term>\r
 487 <emphasis>option depth</emphasis> &lt;depth&gt;\r
 488 </term>\r
 489 <listitem>\r
 490 <simpara>\r
 491         Deepens the history of a shallow repository.\r
 492 </simpara>\r
 493 </listitem>\r
 494 </varlistentry>\r
 495 <varlistentry>\r
 496 <term>\r
 497 <emphasis>option followtags</emphasis> {<emphasis>true</emphasis>|<emphasis>false</emphasis>}\r
 498 </term>\r
 499 <listitem>\r
 500 <simpara>\r
 501         If enabled the helper should automatically fetch annotated\r
 502         tag objects if the object the tag points at was transferred\r
 503         during the fetch command.  If the tag is not fetched by\r
 504         the helper a second fetch command will usually be sent to\r
 505         ask for the tag specifically.  Some helpers may be able to\r
 506         use this option to avoid a second network connection.\r
 507 </simpara>\r
 508 </listitem>\r
 509 </varlistentry>\r
 510 </variablelist>\r
 511 <simpara><emphasis>option dry-run</emphasis> {<emphasis>true</emphasis>|<emphasis>false</emphasis>}:\r
 512         If true, pretend the operation completed successfully,\r
 513         but don't actually change any repository data.  For most\r
 514         helpers this only applies to the <emphasis>push</emphasis>, if supported.</simpara>\r
 515 <variablelist>\r
 516 <varlistentry>\r
 517 <term>\r
 518 <emphasis>option servpath &lt;c-style-quoted-path&gt;</emphasis>\r
 519 </term>\r
 520 <listitem>\r
 521 <simpara>\r
 522         Sets service path (--upload-pack, --receive-pack etc.) for\r
 523         next connect. Remote helper may support this option, but\r
 524         must not rely on this option being set before\r
 525         connect request occurs.\r
 526 </simpara>\r
 527 </listitem>\r
 528 </varlistentry>\r
 529 </variablelist>\r
 530 </simplesect>\r
 531 <simplesect id="_see_also">\r
 532 <title>SEE ALSO</title>\r
 533 <simpara><xref linkend="git-remote(1)" /></simpara>\r
 534 <simpara><xref linkend="git-remote-testgit(1)" /></simpara>\r
 535 </simplesect>\r
 536 <simplesect id="_git">\r
 537 <title>GIT</title>\r
 538 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 539 </simplesect>\r
 540 </article>\r