undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

archive: improve documentation of --prefix

Browse Source 
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>
This commit is contained in:
René Scharfe 2022-05-28 08:57:46 +02:00 committed by Junio C Hamano
parent d516b2db0a
commit a75910602a
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/git-archive.txt
View File

@ -49,7 +49,9 @@ OPTIONS
Report progress to stderr. Report progress to stderr.
--prefix=<prefix>/:: --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>:: -o <file>::
--output=<file>:: --output=<file>::
@ -57,9 +59,9 @@ OPTIONS
--add-file=<file>:: --add-file=<file>::
Add a non-tracked file to the archive. Can be repeated to add 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 multiple files. The path of the file in the archive is built by
by concatenating the value for `--prefix` (if any) and the concatenating the value of the last `--prefix` option (if any)
basename of <file>. before this `--add-file` and the basename of <file>.
--worktree-attributes:: --worktree-attributes::
Look for attributes in .gitattributes files in the working tree 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 commit on the current branch. Note that the output format is
inferred by the extension of the output file. 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"`:: `git config tar.tar.xz.command "xz -c"`::
Configure a "tar.xz" format for making LZMA-compressed tarfiles. Configure a "tar.xz" format for making LZMA-compressed tarfiles.