diff options
| author | Junio C Hamano <gitster@pobox.com> | 2022-07-11 16:08:34 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2022-07-11 16:08:34 -0700 |
| commit | 7bc735932830b9840daeff68819d626c3b0cd07b (patch) | |
| tree | 6c36713b44abd490cd78976f7ad2839a9268abd3 /git-archive.txt | |
| parent | ebdf143ff06ab8a67139c290755d6c6ecfe3126b (diff) | |
| download | git-htmldocs-7bc735932830b9840daeff68819d626c3b0cd07b.tar.gz | |
Autogenerated HTML docs for v2.37.0-38-g55ece
Diffstat (limited to 'git-archive.txt')
| -rw-r--r-- | git-archive.txt | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/git-archive.txt b/git-archive.txt index 56989a2f3..60c040988 100644 --- a/git-archive.txt +++ b/git-archive.txt @@ -34,10 +34,12 @@ OPTIONS ------- --format=<fmt>:: - Format of the resulting archive: 'tar' or 'zip'. If this option + Format of the resulting archive. Possible values are `tar`, + `zip`, `tar.gz`, `tgz`, and any format defined using the + configuration option `tar.<format>.command`. If `--format` 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 + 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:: @@ -143,17 +145,16 @@ tar.<format>.command:: is executed using the shell with the generated tar file on its standard input, and should produce the final output on its standard output. Any compression-level options will be passed - to the command (e.g., "-9"). An output file with the same - extension as `<format>` will be use this format if no other - format is given. + to the command (e.g., `-9`). + -The "tar.gz" and "tgz" formats are defined automatically and default to -`gzip -cn`. You may override them with custom commands. +The `tar.gz` and `tgz` formats are defined automatically and use the +magic command `git archive gzip` by default, which invokes an internal +implementation of gzip. tar.<format>.remote:: - If true, enable `<format>` for use by remote clients via + If true, enable the format for use by remote clients via linkgit:git-upload-archive[1]. Defaults to false for - user-defined formats, but true for the "tar.gz" and "tgz" + user-defined formats, but true for the `tar.gz` and `tgz` formats. [[ATTRIBUTES]] |