Autogenerated HTML docs for v1.2.4-g2dcd
authorJunio C Hamano <junio@hera.kernel.org>
Tue, 7 Mar 2006 05:16:28 +0000 (05:16 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Tue, 7 Mar 2006 05:16:28 +0000 (05:16 +0000)
git-checkout-index.html
git-checkout-index.txt

index 5b2d6d4..b2e1a2a 100644 (file)
@@ -274,7 +274,8 @@ git-checkout-index(1) Manual Page
 <div class="sectionbody">\r
 <div class="verseblock">\r
 <div class="content"><em>git-checkout-index</em> [-u] [-q] [-a] [-f] [-n] [--prefix=&lt;string&gt;]\r
-                   [--stage=&lt;number&gt;]\r
+                   [--stage=&lt;number&gt;|all]\r
+                   [--temp]\r
                    [-z] [--stdin]\r
                    [--] [&lt;file&gt;]*</div></div>\r
 </div>\r
@@ -339,12 +340,23 @@ git-checkout-index(1) Manual Page
 </p>\r
 </dd>\r
 <dt>\r
---stage=&lt;number&gt;\r
+--stage=&lt;number&gt;|all\r
 </dt>\r
 <dd>\r
 <p>\r
         Instead of checking out unmerged entries, copy out the\r
         files from named stage.  &lt;number&gt; must be between 1 and 3.\r
+        Note: --stage=all automatically implies --temp.\r
+</p>\r
+</dd>\r
+<dt>\r
+--temp\r
+</dt>\r
+<dd>\r
+<p>\r
+        Instead of copying the files to the working directory\r
+        write the content to temporary files.  The temporary name\r
+        associations will be written to stdout.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -398,6 +410,48 @@ since git-checkout-index accepts --stdin it would be faster to use:</p>
 it will prevent problems with a filename of, for example,  <tt>-a</tt>.\r
 Using <tt>--</tt> is probably a good policy in scripts.</p>\r
 </div>\r
+<h2>Using --temp or --stage=all</h2>\r
+<div class="sectionbody">\r
+<p>When <tt>--temp</tt> is used (or implied by <tt>--stage=all</tt>)\r
+<tt>git-checkout-index</tt> will create a temporary file for each index\r
+entry being checked out.  The index will not be updated with stat\r
+information.  These options can be useful if the caller needs all\r
+stages of all unmerged entries so that the unmerged files can be\r
+processed by an external merge tool.</p>\r
+<p>A listing will be written to stdout providing the association of\r
+temporary file names to tracked path names.  The listing format\r
+has two variations:</p>\r
+<ol>\r
+<li>\r
+<p>\r
+tempname TAB path RS\r
+</p>\r
+<p>The first format is what gets used when <tt>--stage</tt> is omitted or\r
+is not <tt>--stage=all</tt>. The field tempname is the temporary file\r
+name holding the file content and path is the tracked path name in\r
+the index.  Only the requested entries are output.</p>\r
+</li>\r
+<li>\r
+<p>\r
+stage1temp SP stage2temp SP stage3tmp TAB path RS\r
+</p>\r
+<p>The second format is what gets used when <tt>--stage=all</tt>.  The three\r
+stage temporary fields (stage1temp, stage2temp, stage3temp) list the\r
+name of the temporary file if there is a stage entry in the index\r
+or <tt>.</tt> if there is no stage entry.  Paths which only have a stage 0\r
+entry will always be omitted from the output.</p>\r
+</li>\r
+</ol>\r
+<p>In both formats RS (the record separator) is newline by default\r
+but will be the null byte if -z was passed on the command line.\r
+The temporary file names are always safe strings; they will never\r
+contain directory separators or whitespace characters.  The path\r
+field is always relative to the current directory and the temporary\r
+file names are always relative to the top level directory.</p>\r
+<p>If the object being copied out to a temporary file is a symbolic\r
+link the content of the link will be written to a normal file.  It is\r
+up to the end-user or the Porcelain to make use of this information.</p>\r
+</div>\r
 <h2>EXAMPLES</h2>\r
 <div class="sectionbody">\r
 <dl>\r
@@ -457,7 +511,7 @@ Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 05-Mar-2006 01:54:46 UTC\r
+Last updated 07-Mar-2006 05:16:20 UTC\r
 </div>\r
 </div>\r
 </body>\r
index b0b6588..09bd6a5 100644 (file)
@@ -10,7 +10,8 @@ SYNOPSIS
 --------
 [verse]
 'git-checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>]
-                  [--stage=<number>]
+                  [--stage=<number>|all]
+                  [--temp]
                   [-z] [--stdin]
                   [--] [<file>]\*
 
@@ -43,9 +44,15 @@ OPTIONS
        When creating files, prepend <string> (usually a directory
        including a trailing /)
 
---stage=<number>::
+--stage=<number>|all::
        Instead of checking out unmerged entries, copy out the
        files from named stage.  <number> must be between 1 and 3.
+       Note: --stage=all automatically implies --temp.
+
+--temp::
+       Instead of copying the files to the working directory
+       write the content to temporary files.  The temporary name
+       associations will be written to stdout.
 
 --stdin::
        Instead of taking list of paths from the command line,
@@ -87,6 +94,46 @@ it will prevent problems with a filename of, for example,  `-a`.
 Using `--` is probably a good policy in scripts.
 
 
+Using --temp or --stage=all
+---------------------------
+When `--temp` is used (or implied by `--stage=all`)
+`git-checkout-index` will create a temporary file for each index
+entry being checked out.  The index will not be updated with stat
+information.  These options can be useful if the caller needs all
+stages of all unmerged entries so that the unmerged files can be
+processed by an external merge tool.
+
+A listing will be written to stdout providing the association of
+temporary file names to tracked path names.  The listing format
+has two variations:
+
+    . tempname TAB path RS
++
+The first format is what gets used when `--stage` is omitted or
+is not `--stage=all`. The field tempname is the temporary file
+name holding the file content and path is the tracked path name in
+the index.  Only the requested entries are output.
+
+    . stage1temp SP stage2temp SP stage3tmp TAB path RS
++
+The second format is what gets used when `--stage=all`.  The three
+stage temporary fields (stage1temp, stage2temp, stage3temp) list the
+name of the temporary file if there is a stage entry in the index
+or `.` if there is no stage entry.  Paths which only have a stage 0
+entry will always be omitted from the output.
+
+In both formats RS (the record separator) is newline by default
+but will be the null byte if -z was passed on the command line.
+The temporary file names are always safe strings; they will never
+contain directory separators or whitespace characters.  The path
+field is always relative to the current directory and the temporary
+file names are always relative to the top level directory.
+
+If the object being copied out to a temporary file is a symbolic
+link the content of the link will be written to a normal file.  It is
+up to the end-user or the Porcelain to make use of this information.
+
+
 EXAMPLES
 --------
 To update and refresh only the files already checked out::