archive documentation: attributes are taken from the tree by default
By default, git-archive takes attributes from the tree being archived. People however often wonder why their attempts to affect the way how the command archives their tree by changing .gitattributes in their work tree fail. Add a bit of explanatory note to tell them how to achieve what they want to do. Noticed-by: Francois Marier Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Feb 10, 2010 at 12:33 UTC
9b4c8b0ae8a71535ff03a4ad88ac8ad67d58d845
1 file changed
+8
Documentation/git-archive.txt
+8
@@ -112,6 +112,14 @@ export-subst::
112
expand several placeholders when adding this file to an archive.
113
See linkgit:gitattributes[5] for details.
114
115
+Note that attributes are by default taken from the `.gitattributes` files
116
+in the tree that is being archived. If you want to tweak the way the
117
+output is generated after the fact (e.g. you committed without adding an
118
+appropriate export-ignore in its `.gitattributes`), adjust the checked out
119
+`.gitattributes` file as necessary and use `--work-tree-attributes`
120
+option. Alternatively you can keep necessary attributes that should apply
121
+while archiving any tree in your `$GIT_DIR/info/attributes` file.
122
+
123
EXAMPLES
124
--------
125
git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)::