mirror of
https://github.com/git/git.git
synced 2024-11-07 17:53:12 +01:00
48bb914ed6
The point of these sections is generally to:
1. Give credit where it is due.
2. Give the reader an idea of where to ask questions or
file bug reports.
But they don't do a good job of either case. For (1), they
are out of date and incomplete. A much more accurate answer
can be gotten through shortlog or blame. For (2), the
correct contact point is generally git@vger, and even if you
wanted to cc the contact point, the out-of-date and
incomplete fields mean you're likely sending to somebody
useless.
So let's drop the fields entirely from all manpages except
git(1) itself. We already point people to the mailing list
for bug reports there, and we can update the Authors section
to give credit to the major contributors and point to
shortlog and blame for more information.
Each page has a "This is part of git" footer, so people can
follow that to the main git manpage.
158 lines
4.7 KiB
Text
158 lines
4.7 KiB
Text
git-archive(1)
|
|
==============
|
|
|
|
NAME
|
|
----
|
|
git-archive - Create an archive of files from a named tree
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
|
|
[-o | --output=<file>] [--worktree-attributes]
|
|
[--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
|
|
[<path>...]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
Creates an archive of the specified format containing the tree
|
|
structure for the named tree, and writes it out to the standard
|
|
output. If <prefix> is specified it is
|
|
prepended to the filenames in the archive.
|
|
|
|
'git archive' behaves differently when given a tree ID versus when
|
|
given a commit ID or tag ID. In the first case the current time is
|
|
used as the modification time of each file in the archive. In the latter
|
|
case the commit time as recorded in the referenced commit object is
|
|
used instead. Additionally the commit ID is stored in a global
|
|
extended pax header if the tar format is used; it can be extracted
|
|
using 'git get-tar-commit-id'. In ZIP files it is stored as a file
|
|
comment.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
--format=<fmt>::
|
|
Format of the resulting archive: 'tar' or 'zip'. If this option
|
|
is not given, and the output file is specified, the format is
|
|
inferred from the filename if possible (e.g. writing to "foo.zip"
|
|
makes the output to be in the zip format). Otherwise the output
|
|
format is `tar`.
|
|
|
|
-l::
|
|
--list::
|
|
Show all available formats.
|
|
|
|
-v::
|
|
--verbose::
|
|
Report progress to stderr.
|
|
|
|
--prefix=<prefix>/::
|
|
Prepend <prefix>/ to each filename in the archive.
|
|
|
|
-o <file>::
|
|
--output=<file>::
|
|
Write the archive to <file> instead of stdout.
|
|
|
|
--worktree-attributes::
|
|
Look for attributes in .gitattributes in working directory too.
|
|
|
|
<extra>::
|
|
This can be any options that the archiver backend understands.
|
|
See next section.
|
|
|
|
--remote=<repo>::
|
|
Instead of making a tar archive from the local repository,
|
|
retrieve a tar archive from a remote repository.
|
|
|
|
--exec=<git-upload-archive>::
|
|
Used with --remote to specify the path to the
|
|
'git-upload-archive' on the remote side.
|
|
|
|
<tree-ish>::
|
|
The tree or commit to produce an archive for.
|
|
|
|
<path>::
|
|
Without an optional path parameter, all files and subdirectories
|
|
of the current working directory are included in the archive.
|
|
If one or more paths are specified, only these are included.
|
|
|
|
BACKEND EXTRA OPTIONS
|
|
---------------------
|
|
|
|
zip
|
|
~~~
|
|
-0::
|
|
Store the files instead of deflating them.
|
|
-9::
|
|
Highest and slowest compression level. You can specify any
|
|
number from 1 to 9 to adjust compression speed and ratio.
|
|
|
|
|
|
CONFIGURATION
|
|
-------------
|
|
|
|
tar.umask::
|
|
This variable can be used to restrict the permission bits of
|
|
tar archive entries. The default is 0002, which turns off the
|
|
world write bit. The special value "user" indicates that the
|
|
archiving user's umask will be used instead. See umask(2) for
|
|
details.
|
|
|
|
ATTRIBUTES
|
|
----------
|
|
|
|
export-ignore::
|
|
Files and directories with the attribute export-ignore won't be
|
|
added to archive files. See linkgit:gitattributes[5] for details.
|
|
|
|
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.
|
|
See linkgit:gitattributes[5] for details.
|
|
|
|
Note that attributes are by default taken from the `.gitattributes` files
|
|
in the tree that is being archived. If you want to tweak the way the
|
|
output is generated after the fact (e.g. you committed without adding an
|
|
appropriate export-ignore in its `.gitattributes`), adjust the checked out
|
|
`.gitattributes` file as necessary and use `--worktree-attributes`
|
|
option. Alternatively you can keep necessary attributes that should apply
|
|
while archiving any tree in your `$GIT_DIR/info/attributes` file.
|
|
|
|
EXAMPLES
|
|
--------
|
|
git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)::
|
|
|
|
Create a tar archive that contains the contents of the
|
|
latest commit on the current branch, and extract it in the
|
|
`/var/tmp/junk` directory.
|
|
|
|
git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz::
|
|
|
|
Create a compressed tarball for v1.4.0 release.
|
|
|
|
git archive --format=tar --prefix=git-1.4.0/ v1.4.0{caret}\{tree\} | gzip >git-1.4.0.tar.gz::
|
|
|
|
Create a compressed tarball for v1.4.0 release, but without a
|
|
global extended pax header.
|
|
|
|
git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip::
|
|
|
|
Put everything in the current head's Documentation/ directory
|
|
into 'git-1.4.0-docs.zip', with the prefix 'git-docs/'.
|
|
|
|
git archive -o latest.zip HEAD::
|
|
|
|
Create a Zip archive that contains the contents of the latest
|
|
commit on the current branch. Note that the output format is
|
|
inferred by the extension of the output file.
|
|
|
|
|
|
SEE ALSO
|
|
--------
|
|
linkgit:gitattributes[5]
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|