user-manual: clean up fast-forward and dangling-objects sections
[git] / builtin-pack-refs.c
1 #include "cache.h"
2 #include "refs.h"
3 #include "object.h"
4 #include "tag.h"
5
6 static const char builtin_pack_refs_usage[] =
7 "git-pack-refs [--all] [--prune | --no-prune]";
8
9 struct ref_to_prune {
10         struct ref_to_prune *next;
11         unsigned char sha1[20];
12         char name[FLEX_ARRAY];
13 };
14
15 struct pack_refs_cb_data {
16         int prune;
17         int all;
18         struct ref_to_prune *ref_to_prune;
19         FILE *refs_file;
20 };
21
22 static int do_not_prune(int flags)
23 {
24         /* If it is already packed or if it is a symref,
25          * do not prune it.
26          */
27         return (flags & (REF_ISSYMREF|REF_ISPACKED));
28 }
29
30 static int handle_one_ref(const char *path, const unsigned char *sha1,
31                           int flags, void *cb_data)
32 {
33         struct pack_refs_cb_data *cb = cb_data;
34         int is_tag_ref;
35
36         /* Do not pack the symbolic refs */
37         if ((flags & REF_ISSYMREF))
38                 return 0;
39         is_tag_ref = !prefixcmp(path, "refs/tags/");
40
41         /* ALWAYS pack refs that were already packed or are tags */
42         if (!cb->all && !is_tag_ref && !(flags & REF_ISPACKED))
43                 return 0;
44
45         fprintf(cb->refs_file, "%s %s\n", sha1_to_hex(sha1), path);
46         if (is_tag_ref) {
47                 struct object *o = parse_object(sha1);
48                 if (o->type == OBJ_TAG) {
49                         o = deref_tag(o, path, 0);
50                         if (o)
51                                 fprintf(cb->refs_file, "^%s\n",
52                                         sha1_to_hex(o->sha1));
53                 }
54         }
55
56         if (cb->prune && !do_not_prune(flags)) {
57                 int namelen = strlen(path) + 1;
58                 struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);
59                 hashcpy(n->sha1, sha1);
60                 strcpy(n->name, path);
61                 n->next = cb->ref_to_prune;
62                 cb->ref_to_prune = n;
63         }
64         return 0;
65 }
66
67 /* make sure nobody touched the ref, and unlink */
68 static void prune_ref(struct ref_to_prune *r)
69 {
70         struct ref_lock *lock = lock_ref_sha1(r->name + 5, r->sha1);
71
72         if (lock) {
73                 unlink(git_path("%s", r->name));
74                 unlock_ref(lock);
75         }
76 }
77
78 static void prune_refs(struct ref_to_prune *r)
79 {
80         while (r) {
81                 prune_ref(r);
82                 r = r->next;
83         }
84 }
85
86 static struct lock_file packed;
87
88 int cmd_pack_refs(int argc, const char **argv, const char *prefix)
89 {
90         int fd, i;
91         struct pack_refs_cb_data cbdata;
92
93         memset(&cbdata, 0, sizeof(cbdata));
94
95         cbdata.prune = 1;
96         for (i = 1; i < argc; i++) {
97                 const char *arg = argv[i];
98                 if (!strcmp(arg, "--prune")) {
99                         cbdata.prune = 1; /* now the default */
100                         continue;
101                 }
102                 if (!strcmp(arg, "--no-prune")) {
103                         cbdata.prune = 0;
104                         continue;
105                 }
106                 if (!strcmp(arg, "--all")) {
107                         cbdata.all = 1;
108                         continue;
109                 }
110                 /* perhaps other parameters later... */
111                 break;
112         }
113         if (i != argc)
114                 usage(builtin_pack_refs_usage);
115
116         fd = hold_lock_file_for_update(&packed, git_path("packed-refs"), 1);
117         cbdata.refs_file = fdopen(fd, "w");
118         if (!cbdata.refs_file)
119                 die("unable to create ref-pack file structure (%s)",
120                     strerror(errno));
121
122         /* perhaps other traits later as well */
123         fprintf(cbdata.refs_file, "# pack-refs with: peeled \n");
124
125         for_each_ref(handle_one_ref, &cbdata);
126         fflush(cbdata.refs_file);
127         fsync(fd);
128         fclose(cbdata.refs_file);
129         if (commit_lock_file(&packed) < 0)
130                 die("unable to overwrite old ref-pack file (%s)", strerror(errno));
131         if (cbdata.prune)
132                 prune_refs(cbdata.ref_to_prune);
133         return 0;
134 }