diff options
| author | René Scharfe <l.s.r@web.de> | 2022-05-28 08:57:46 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2022-05-28 10:29:40 -0700 |
| commit | a75910602a7367281409c4f13b5b87f350a0dc43 (patch) | |
| tree | c02ae809b8889e7c3999713a31df921ec4e77717 /Documentation/git-archive.txt | |
| parent | d516b2db0af2221bd6b13e7347abdcb5830b2829 (diff) | |
| download | git-a75910602a7367281409c4f13b5b87f350a0dc43.tar.gz | |
archive: improve documentation of --prefix
Document the interaction between --add-file and --prefix by giving an
example.
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: René Scharfe <l.s.r@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-archive.txt')
| -rw-r--r-- | Documentation/git-archive.txt | 16 |
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. |