docs/rev-list: add an examples section
[git.git] / archive.h
blob33551b7ee17be6adf9c16221ef1f605dbf8d477c
1 #ifndef ARCHIVE_H
2 #define ARCHIVE_H
4 #include "cache.h"
5 #include "pathspec.h"
7 struct repository;
9 struct archiver_args {
10 struct repository *repo;
11 char *refname;
12 const char *prefix;
13 const char *base;
14 size_t baselen;
15 struct tree *tree;
16 const struct object_id *commit_oid;
17 const struct commit *commit;
18 timestamp_t time;
19 struct pathspec pathspec;
20 unsigned int verbose : 1;
21 unsigned int worktree_attributes : 1;
22 unsigned int convert : 1;
23 int compression_level;
24 struct string_list extra_files;
27 /* main api */
29 int write_archive(int argc, const char **argv, const char *prefix,
30 struct repository *repo,
31 const char *name_hint, int remote);
33 const char *archive_format_from_filename(const char *filename);
35 /* archive backend stuff */
37 #define ARCHIVER_WANT_COMPRESSION_LEVELS 1
38 #define ARCHIVER_REMOTE 2
39 #define ARCHIVER_HIGH_COMPRESSION_LEVELS 4
40 struct archiver {
41 const char *name;
42 int (*write_archive)(const struct archiver *, struct archiver_args *);
43 unsigned flags;
44 void *data;
46 void register_archiver(struct archiver *);
48 void init_tar_archiver(void);
49 void init_zip_archiver(void);
50 void init_archivers(void);
52 typedef int (*write_archive_entry_fn_t)(struct archiver_args *args,
53 const struct object_id *oid,
54 const char *path, size_t pathlen,
55 unsigned int mode,
56 void *buffer, unsigned long size);
58 int write_archive_entries(struct archiver_args *args, write_archive_entry_fn_t write_entry);
60 #endif /* ARCHIVE_H */