Update documentation for C-style quoting.

Signed-off-by: Junio C Hamano <junkio@cox.net>
git-mirror · Oct 18, 2005 · d88156e · d88156e
1 parent 71ac835
commit d88156e
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 2 deletions.
diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt
@@ -55,6 +55,11 @@ Example:
 :100644 100644 5be4a4...... 000000...... M file.c
 ------------------------------------------------
 
+When `-z` option is not used, TAB, LF, and backslash characters
+in pathnames are represented as `\t`, `\n`, and `\\`,
+respectively.
+
+
 Generating patches with -p
 --------------------------
 
@@ -137,3 +142,7 @@ the file that rename/copy produces, respectively.
        rename to <path>
        similarity index <number>
        dissimilarity index <number>
+       index <hash>..<hash> <mode>
+
+3.  TAB, LF, and backslash characters in pathnames are
+    represented as `\t`, `\n`, and `\\`, respectively.
diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
@@ -8,7 +8,7 @@ git-apply - Apply patch on a git index file and a work tree
 
 SYNOPSIS
 --------
-'git-apply' [--stat] [--summary] [--check] [--index] [--show-files] [--apply] [<patch>...]
+'git-apply' [--stat] [--summary] [--check] [--index] [--apply] [--show-files] [--index-info] [-z] [<patch>...]
 
 DESCRIPTION
 -----------
@@ -48,6 +48,20 @@ OPTIONS
 --show-files::
 	Show summary of files that are affected by the patch.
 
+--index-info::
+	Newer git-diff output has embedded 'index information'
+	for each blob to help identify the original version that
+	the patch applies to.  When this flag is given, and if
+	the original version of the blob is available locally,
+	outputs information about them to the standard output.
+
+-z::
+	When showing the index information, do not munge paths,
+	but use NUL terminated machine readable format.  Without
+	this flag, the pathnames output will have TAB, LF, and
+	backslash characters replaced with `\t`, `\n`, and `\\`,
+	respectively.
+
 --apply::
 	If you use any of the options marked ``Turns off
 	"apply"'' above, git-apply reads and outputs the

diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
@@ -54,7 +54,7 @@ OPTIONS
 	succeed.
 
 -z::
-	\0 line termination on output
+	\0 line termination on output.
 
 -x|--exclude=<pattern>::
 	Skips files matching pattern.
@@ -100,6 +100,10 @@ the dircache records up to three such pairs; one from tree O in stage
 the user (or the porcelain) to see what should eventually be recorded at the
 path. (see git-read-tree for more information on state)
 
+When `-z` option is not used, TAB, LF, and backslash characters
+in pathnames are represented as `\t`, `\n`, and `\\`,
+respectively.
+
 
 Exclude Patterns
 ----------------

diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt
@@ -38,6 +38,10 @@ Output Format
 -------------
         <mode> SP <type> SP <object> TAB <file>
 
+When `-z` option is not used, TAB, LF, and backslash characters
+in pathnames are represented as `\t`, `\n`, and `\\`,
+respectively.
+
 
 Author
 ------