aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2022-05-28 10:38:06 -0700
committerJunio C Hamano <gitster@pobox.com>2022-05-28 10:38:06 -0700
commit23f2356fd902434a9b8e9e4cdae735f399c16ff0 (patch)
tree784776e2cfb963af14ac1b0bbe83a104e0abc008
parent8ddf593a250e07d388059f7e3f471078e1d2ed5c (diff)
parenta75910602a7367281409c4f13b5b87f350a0dc43 (diff)
downloadgit-23f2356fd902434a9b8e9e4cdae735f399c16ff0.tar.gz
Merge branch 'rs/document-archive-prefix' into js/scalar-diagnose
* rs/document-archive-prefix: archive: improve documentation of --prefix
-rw-r--r--Documentation/git-archive.txt16
1 files changed, 12 insertions, 4 deletions
diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt
index bc4e76a783..94519aae23 100644
--- a/Documentation/git-archive.txt
+++ b/Documentation/git-archive.txt
@@ -49,7 +49,9 @@ OPTIONS
Report progress to stderr.
--prefix=<prefix>/::
- Prepend <prefix>/ to each filename in the archive.
+ Prepend <prefix>/ to paths in the archive. Can be repeated; its
+ rightmost value is used for all tracked files. See below which
+ value gets used by `--add-file`.
-o <file>::
--output=<file>::
@@ -57,9 +59,9 @@ OPTIONS
--add-file=<file>::
Add a non-tracked file to the archive. Can be repeated to add
- multiple files. The path of the file in the archive is built
- by concatenating the value for `--prefix` (if any) and the
- basename of <file>.
+ multiple files. The path of the file in the archive is built by
+ concatenating the value of the last `--prefix` option (if any)
+ before this `--add-file` and the basename of <file>.
--worktree-attributes::
Look for attributes in .gitattributes files in the working tree
@@ -194,6 +196,12 @@ EXAMPLES
commit on the current branch. Note that the output format is
inferred by the extension of the output file.
+`git archive -o latest.tar --prefix=build/ --add-file=configure --prefix= HEAD`::
+
+ Creates a tar archive that contains the contents of the latest
+ commit on the current branch with no prefix and the untracked
+ file 'configure' with the prefix 'build/'.
+
`git config tar.tar.xz.command "xz -c"`::
Configure a "tar.xz" format for making LZMA-compressed tarfiles.