path: root/archive.h
diff options
authorFranck Bui-Huu <>2006-09-07 13:12:02 (GMT)
committerJunio C Hamano <>2006-09-09 18:57:36 (GMT)
commit4df096a5ca24f2f39042c51cf51b8a2bec66a2b5 (patch)
treed630871109aef6af3dd12224e6729af9ed1ad81f /archive.h
parent2878836c5074be92b913c95446b94bbf1c9a9e1d (diff)
Add git-archive
git-archive is a command to make TAR and ZIP archives of a git tree. It helps prevent a proliferation of git-{format}-tree commands. Instead of directly calling git-{tar,zip}-tree command, it defines a very simple API, that archiver should implement and register in "git-archive.c". This API is made up by 2 functions whose prototype is defined in "archive.h" file. - The first one is used to parse 'extra' parameters which have signification only for the specific archiver. That would allow different archive backends to have different kind of options. - The second one is used to ask to an archive backend to build the archive given some already resolved parameters. The main reason for making this API is to avoid using git-{tar,zip}-tree commands, hence making them useless. Maybe it's time for them to die ? It also implements remote operations by defining a very simple protocol: it first sends the name of the specific uploader followed the repository name (git-upload-tar git:// Then it sends options. It's done by sending a sequence of one argument per packet, with prefix "argument ", followed by a flush. The remote protocol is implemented in "git-archive.c" for client side and is triggered by "--remote=<repo>" option. For example, to fetch a TAR archive in a remote repo, you can issue: $ git archive --format=tar --remote=git://xxx/yyy/zzz.git HEAD We choose to not make a new command "git-fetch-archive" for example, avoind one more GIT command which should be nice for users (less commands to remember, keeps existing --remote option). Signed-off-by: Franck Bui-Huu <> Acked-by: Rene Scharfe <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'archive.h')
1 files changed, 41 insertions, 0 deletions
diff --git a/archive.h b/archive.h
new file mode 100644
index 0000000..24b016f
--- /dev/null
+++ b/archive.h
@@ -0,0 +1,41 @@
+#ifndef ARCHIVE_H
+#define ARCHIVE_H
+#define MAX_EXTRA_ARGS 32
+#define MAX_ARGS (MAX_EXTRA_ARGS + 32)
+struct archiver_args {
+ const char *base;
+ struct tree *tree;
+ const unsigned char *commit_sha1;
+ time_t time;
+ const char **pathspec;
+ void *extra;
+typedef int (*write_archive_fn_t)(struct archiver_args *);
+typedef void *(*parse_extra_args_fn_t)(int argc, const char **argv);
+struct archiver {
+ const char *name;
+ const char *remote;
+ struct archiver_args args;
+ write_archive_fn_t write_archive;
+ parse_extra_args_fn_t parse_extra;
+extern struct archiver archivers[];
+extern int parse_archive_args(int argc,
+ const char **argv,
+ struct archiver *ar);
+extern void parse_treeish_arg(const char **treeish,
+ struct archiver_args *ar_args,
+ const char *prefix);
+extern void parse_pathspec_arg(const char **pathspec,
+ struct archiver_args *args);
+#endif /* ARCHIVE_H */