Merge branch 'jh/clone-packed-refs'

[git.git] / Documentation / gitattributes.txt

diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt
index cc9c7c52c006cb81987a996d65595d99653dfefe..6e67990f64372855dd665da4747a7f7c235ac856 100644 (file)
--- a/Documentation/gitattributes.txt
+++ b/Documentation/gitattributes.txt
@@ -63,6 +63,13 @@ path in question, and its parent directories (the further the
 directory that contains `.gitattributes` is from the path in
 question, the lower its precedence).
 
 directory that contains `.gitattributes` is from the path in
 question, the lower its precedence).
 

+If you wish to affect only a single repository (i.e., to assign
+attributes to files that are particular to one user's workflow), then
+attributes should be placed in the `$GIT_DIR/info/attributes` file.
+Attributes which should be version-controlled and distributed to other
+repositories (i.e., attributes of interest to all users) should go into
+`.gitattributes` files.
+

 Sometimes you would need to override an setting of an attribute
 for a path to `unspecified` state.  This can be done by listing
 the name of the attribute prefixed with an exclamation point `!`.
 Sometimes you would need to override an setting of an attribute
 for a path to `unspecified` state.  This can be done by listing
 the name of the attribute prefixed with an exclamation point `!`.


@@ -133,6 +140,26 @@ When `core.autocrlf` is set to "input", line endings are
 converted to LF upon checkin, but there is no conversion done
 upon checkout.
 
 converted to LF upon checkin, but there is no conversion done
 upon checkout.
 

+If `core.safecrlf` is set to "true" or "warn", git verifies if
+the conversion is reversible for the current setting of
+`core.autocrlf`.  For "true", git rejects irreversible
+conversions; for "warn", git only prints a warning but accepts
+an irreversible conversion.  The safety triggers to prevent such
+a conversion done to the files in the work tree, but there are a
+few exceptions.  Even though...
+
+- "git add" itself does not touch the files in the work tree, the
+  next checkout would, so the safety triggers;
+
+- "git apply" to update a text file with a patch does touch the files
+  in the work tree, but the operation is about text files and CRLF
+  conversion is about fixing the line ending inconsistencies, so the
+  safety does not trigger;
+
+- "git diff" itself does not touch the files in the work tree, it is
+  often run to inspect the changes you intend to next "git add".  To
+  catch potential problems early, safety triggers.
+

 
 `ident`
 ^^^^^^^
 
 `ident`
 ^^^^^^^


@@ -238,7 +265,7 @@ When git needs to show you a diff for the path with `diff`
 attribute set to `jcdiff`, it calls the command you specified
 with the above configuration, i.e. `j-c-diff`, with 7
 parameters, just like `GIT_EXTERNAL_DIFF` program is called.
 attribute set to `jcdiff`, it calls the command you specified
 with the above configuration, i.e. `j-c-diff`, with 7
 parameters, just like `GIT_EXTERNAL_DIFF` program is called.

-See gitlink:git[7] for details.
+See linkgit:git[1] for details.

 
 
 Defining a custom hunk-header
 
 
 Defining a custom hunk-header


@@ -400,7 +427,7 @@ Checking whitespace errors
 
 The `core.whitespace` configuration variable allows you to define what
 `diff` and `apply` should consider whitespace errors for all paths in
 
 The `core.whitespace` configuration variable allows you to define what
 `diff` and `apply` should consider whitespace errors for all paths in

-the project (See gitlink:git-config[1]).  This attribute gives you finer
+the project (See linkgit:git-config[1]).  This attribute gives you finer

 control per path.
 
 Set::
 control per path.
 
 Set::


@@ -475,15 +502,21 @@ frotz     unspecified
 Creating an archive
 ~~~~~~~~~~~~~~~~~~~
 
 Creating an archive
 ~~~~~~~~~~~~~~~~~~~
 

+`export-ignore`
+^^^^^^^^^^^^^^^
+
+Files and directories with the attribute `export-ignore` won't be added to
+archive files.
+

 `export-subst`
 ^^^^^^^^^^^^^^
 
 If the attribute `export-subst` is set for a file then git will expand
 several placeholders when adding this file to an archive.  The
 expansion depends on the availability of a commit ID, i.e. if
 `export-subst`
 ^^^^^^^^^^^^^^
 
 If the attribute `export-subst` is set for a file then git will expand
 several placeholders when adding this file to an archive.  The
 expansion depends on the availability of a commit ID, i.e. if

-gitlink:git-archive[1] has been given a tree instead of a commit or a
+linkgit:git-archive[1] has been given a tree instead of a commit or a

 tag then no replacement will be done.  The placeholders are the same
 tag then no replacement will be done.  The placeholders are the same

-as those for the option `--pretty=format:` of gitlink:git-log[1],
+as those for the option `--pretty=format:` of linkgit:git-log[1],

 except that they need to be wrapped like this: `$Format:PLACEHOLDERS$`
 in the file.  E.g. the string `$Format:%H$` will be replaced by the
 commit hash.
 except that they need to be wrapped like this: `$Format:PLACEHOLDERS$`
 in the file.  E.g. the string `$Format:%H$` will be replaced by the
 commit hash.


@@ -491,4 +524,4 @@ commit hash.
 
 GIT
 ---
 
 GIT
 ---

-Part of the gitlink:git[7] suite
+Part of the linkgit:git[1] suite