doc: clarify ignore rules for git ls-files
[git] / fetch-pack.h
1 #ifndef FETCH_PACK_H
2 #define FETCH_PACK_H
3
4 #include "string-list.h"
5 #include "run-command.h"
6 #include "list-objects-filter-options.h"
7
8 struct oid_array;
9
10 struct fetch_pack_args {
11         const char *uploadpack;
12         int unpacklimit;
13         int depth;
14         const char *deepen_since;
15         const struct string_list *deepen_not;
16         struct list_objects_filter_options filter_options;
17         unsigned deepen_relative:1;
18         unsigned quiet:1;
19         unsigned keep_pack:1;
20         unsigned lock_pack:1;
21         unsigned use_thin_pack:1;
22         unsigned fetch_all:1;
23         unsigned stdin_refs:1;
24         unsigned diag_url:1;
25         unsigned verbose:1;
26         unsigned no_progress:1;
27         unsigned include_tag:1;
28         unsigned stateless_rpc:1;
29         unsigned check_self_contained_and_connected:1;
30         unsigned self_contained_and_connected:1;
31         unsigned cloning:1;
32         unsigned update_shallow:1;
33         unsigned deepen:1;
34         unsigned from_promisor:1;
35
36         /*
37          * If 1, fetch_pack() will also not modify any object flags.
38          * This allows fetch_pack() to safely be called by any function,
39          * regardless of which object flags it uses (if any).
40          */
41         unsigned no_dependents:1;
42 };
43
44 /*
45  * sought represents remote references that should be updated from.
46  * On return, the names that were found on the remote will have been
47  * marked as such.
48  */
49 struct ref *fetch_pack(struct fetch_pack_args *args,
50                        int fd[], struct child_process *conn,
51                        const struct ref *ref,
52                        const char *dest,
53                        struct ref **sought,
54                        int nr_sought,
55                        struct oid_array *shallow,
56                        char **pack_lockfile);
57
58 /*
59  * Print an appropriate error message for each sought ref that wasn't
60  * matched.  Return 0 if all sought refs were matched, otherwise 1.
61  */
62 int report_unmatched_refs(struct ref **sought, int nr_sought);
63
64 #endif