diff options
| author | René Scharfe <l.s.r@web.de> | 2022-06-15 16:58:38 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2022-06-15 20:19:46 (GMT) |
| commit | 650134a47894244b3804b5d175439b362453fa4a (patch) | |
| tree | bd4a8787a9fb71ec725a0e17d3bbe1baea5c6e8b /Documentation/git-archive.txt | |
| parent | 5699ec1b0aec51b9e9ba5a2785f65970c5a95d84 (diff) | |
| download | git-650134a47894244b3804b5d175439b362453fa4a.zip git-650134a47894244b3804b5d175439b362453fa4a.tar.gz git-650134a47894244b3804b5d175439b362453fa4a.tar.bz2 | |
archive: update format documentation
Mention all formats in the --format section, use backtick quoting for
literal values throughout, clarify the description of the configuration
option.
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 | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt index 56989a2..ff3f7b0 100644 --- a/Documentation/git-archive.txt +++ b/Documentation/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,15 @@ 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 +command `gzip -cn` by default. 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]] |