Commit a258d8e3574c4e993bf16e0c136d1a5fbc356728

Carlos Martín Nieto 2013-03-30T03:39:19

branch: rename 'tracking' to 'upstream' The term 'tracking' is overloaded. Help distinguish what we mean by using 'upstream' for this part of the library.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
diff --git a/include/git2/branch.h b/include/git2/branch.h
index 4d24e2d..28bb1f5 100644
--- a/include/git2/branch.h
+++ b/include/git2/branch.h
@@ -173,7 +173,7 @@ GIT_EXTERN(int) git_branch_name(const char **out,
  * @return 0 on success; GIT_ENOTFOUND when no remote tracking
  * reference exists, otherwise an error code.
  */
-GIT_EXTERN(int) git_branch_tracking(
+GIT_EXTERN(int) git_branch_upstream(
 	git_reference **out,
 	git_reference *branch);
 
@@ -195,7 +195,7 @@ GIT_EXTERN(int) git_branch_tracking(
  *     including the trailing NUL byte; GIT_ENOTFOUND when no remote tracking
  *     reference exists, otherwise an error code.
  */
-GIT_EXTERN(int) git_branch_tracking_name(
+GIT_EXTERN(int) git_branch_upstream_name(
 	char *tracking_branch_name_out,
 	size_t buffer_size,
 	git_repository *repo,
diff --git a/src/branch.c b/src/branch.c
index 45ecca7..56c63a8 100644
--- a/src/branch.c
+++ b/src/branch.c
@@ -228,7 +228,7 @@ int git_branch_name(const char **out, git_reference *ref)
 	return 0;
 }
 
-static int retrieve_tracking_configuration(
+static int retrieve_upstream_configuration(
 	const char **out,
 	git_repository *repo,
 	const char *canonical_branch_name,
@@ -250,7 +250,7 @@ static int retrieve_tracking_configuration(
 	return error;
 }
 
-int git_branch_tracking__name(
+int git_branch_upstream__name(
 	git_buf *tracking_name,
 	git_repository *repo,
 	const char *canonical_branch_name)
@@ -266,11 +266,11 @@ int git_branch_tracking__name(
 	if (!git_reference__is_branch(canonical_branch_name))
 		return not_a_local_branch(canonical_branch_name);
 
-	if ((error = retrieve_tracking_configuration(
+	if ((error = retrieve_upstream_configuration(
 		&remote_name, repo, canonical_branch_name, "branch.%s.remote")) < 0)
 			goto cleanup;
 
-	if ((error = retrieve_tracking_configuration(
+	if ((error = retrieve_upstream_configuration(
 		&merge_name, repo, canonical_branch_name, "branch.%s.merge")) < 0)
 			goto cleanup;
 
@@ -386,7 +386,7 @@ cleanup:
 	return error;
 }
 
-int git_branch_tracking_name(
+int git_branch_upstream_name(
 	char *tracking_branch_name_out,
 	size_t buffer_size,
 	git_repository *repo,
@@ -400,7 +400,7 @@ int git_branch_tracking_name(
 	if (tracking_branch_name_out && buffer_size)
 		*tracking_branch_name_out = '\0';
 
-	if ((error = git_branch_tracking__name(
+	if ((error = git_branch_upstream__name(
 		&buf, repo, canonical_branch_name)) < 0)
 			goto cleanup;
 
@@ -422,14 +422,14 @@ cleanup:
 	return (int)error;
 }
 
-int git_branch_tracking(
+int git_branch_upstream(
 		git_reference **tracking_out,
 		git_reference *branch)
 {
 	int error;
 	git_buf tracking_name = GIT_BUF_INIT;
 
-	if ((error = git_branch_tracking__name(&tracking_name,
+	if ((error = git_branch_upstream__name(&tracking_name,
 		git_reference_owner(branch), git_reference_name(branch))) < 0)
 			return error;
 
diff --git a/src/branch.h b/src/branch.h
index 8a26c4f..d02f2af 100644
--- a/src/branch.h
+++ b/src/branch.h
@@ -9,7 +9,7 @@
 
 #include "buffer.h"
 
-int git_branch_tracking__name(
+int git_branch_upstream__name(
 	git_buf *tracking_name,
 	git_repository *repo,
 	const char *canonical_branch_name);
diff --git a/src/remote.c b/src/remote.c
index a6f62d6..896361e 100644
--- a/src/remote.c
+++ b/src/remote.c
@@ -705,7 +705,7 @@ static int remote_head_for_ref(git_remote_head **out, git_remote *remote, git_ve
 
 	if ((error = git_reference_resolve(&resolved_ref, ref)) < 0 ||
 		(!git_reference_is_branch(resolved_ref)) ||
-		(error = git_branch_tracking(&tracking_ref, resolved_ref)) < 0 ||
+		(error = git_branch_upstream(&tracking_ref, resolved_ref)) < 0 ||
 		(error = git_refspec_transform_l(&remote_name, &remote->fetch, git_reference_name(tracking_ref))) < 0) {
 		/* Not an error if HEAD is orphaned or no tracking branch */
 		if (error == GIT_ENOTFOUND)
diff --git a/src/revparse.c b/src/revparse.c
index 1518a7c..2fd6361 100644
--- a/src/revparse.c
+++ b/src/revparse.c
@@ -356,7 +356,7 @@ static int retrieve_remote_tracking_reference(git_reference **base_ref, const ch
 		goto cleanup;
 	}
 
-	if ((error = git_branch_tracking(&tracking, ref)) < 0)
+	if ((error = git_branch_upstream(&tracking, ref)) < 0)
 		goto cleanup;
 	
 	*base_ref = tracking;
diff --git a/src/submodule.c b/src/submodule.c
index 066a881..2fdaf2f 100644
--- a/src/submodule.c
+++ b/src/submodule.c
@@ -1327,7 +1327,7 @@ static int lookup_head_remote(git_buf *url, git_repository *repo)
 		goto cleanup;
 	}
 
-	if ((error = git_branch_tracking(&remote, head)) < 0)
+	if ((error = git_branch_upstream(&remote, head)) < 0)
 		goto cleanup;
 
 	/* remote should refer to something like refs/remotes/ORIGIN/BRANCH */
diff --git a/tests-clar/clone/empty.c b/tests-clar/clone/empty.c
index 0f86725..f190523 100644
--- a/tests-clar/clone/empty.c
+++ b/tests-clar/clone/empty.c
@@ -49,7 +49,7 @@ void test_clone_empty__can_clone_an_empty_local_repo_barely(void)
 
 	/* ...one can still retrieve the name of the remote tracking reference */
 	cl_assert_equal_i((int)strlen(expected_tracked_branch_name) + 1, 
-		git_branch_tracking_name(buffer, 1024, g_repo_cloned, local_name));
+		git_branch_upstream_name(buffer, 1024, g_repo_cloned, local_name));
 
 	cl_assert_equal_s(expected_tracked_branch_name, buffer);
 
diff --git a/tests-clar/refs/branches/tracking.c b/tests-clar/refs/branches/tracking.c
deleted file mode 100644
index 30599d9..0000000
--- a/tests-clar/refs/branches/tracking.c
+++ /dev/null
@@ -1,95 +0,0 @@
-#include "clar_libgit2.h"
-#include "refs.h"
-
-static git_repository *repo;
-static git_reference *branch, *tracking;
-
-void test_refs_branches_tracking__initialize(void)
-{
-	cl_git_pass(git_repository_open(&repo, cl_fixture("testrepo.git")));
-
-	branch = NULL;
-	tracking = NULL;
-}
-
-void test_refs_branches_tracking__cleanup(void)
-{
-	git_reference_free(tracking);
-	git_reference_free(branch);
-	branch = NULL;
-
-	git_repository_free(repo);
-	repo = NULL;
-}
-
-void test_refs_branches_tracking__can_retrieve_the_remote_tracking_reference_of_a_local_branch(void)
-{
-	cl_git_pass(git_reference_lookup(&branch, repo, "refs/heads/master"));
-
-	cl_git_pass(git_branch_tracking(&tracking, branch));
-
-	cl_assert_equal_s("refs/remotes/test/master", git_reference_name(tracking));
-}
-
-void test_refs_branches_tracking__can_retrieve_the_local_tracking_reference_of_a_local_branch(void)
-{
-	cl_git_pass(git_reference_lookup(&branch, repo, "refs/heads/track-local"));
-
-	cl_git_pass(git_branch_tracking(&tracking, branch));
-
-	cl_assert_equal_s("refs/heads/master", git_reference_name(tracking));
-}
-
-void test_refs_branches_tracking__cannot_retrieve_a_remote_tracking_reference_from_a_non_branch(void)
-{
-	cl_git_pass(git_reference_lookup(&branch, repo, "refs/tags/e90810b"));
-
-	cl_git_fail(git_branch_tracking(&tracking, branch));
-}
-
-void test_refs_branches_tracking__trying_to_retrieve_a_remote_tracking_reference_from_a_plain_local_branch_returns_GIT_ENOTFOUND(void)
-{
-	cl_git_pass(git_reference_lookup(&branch, repo, "refs/heads/subtrees"));
-
-	cl_assert_equal_i(GIT_ENOTFOUND, git_branch_tracking(&tracking, branch));
-}
-
-void test_refs_branches_tracking__trying_to_retrieve_a_remote_tracking_reference_from_a_branch_with_no_fetchspec_returns_GIT_ENOTFOUND(void)
-{
-	cl_git_pass(git_reference_lookup(&branch, repo, "refs/heads/cannot-fetch"));
-
-	cl_assert_equal_i(GIT_ENOTFOUND, git_branch_tracking(&tracking, branch));
-}
-
-static void assert_merge_and_or_remote_key_missing(git_repository *repository, const git_commit *target, const char *entry_name)
-{
-	git_reference *branch;
-
-	cl_assert_equal_i(GIT_OBJ_COMMIT, git_object_type((git_object*)target));
-	cl_git_pass(git_branch_create(&branch, repository, entry_name, (git_commit*)target, 0));
-
-	cl_assert_equal_i(GIT_ENOTFOUND, git_branch_tracking(&tracking, branch));
-
-	git_reference_free(branch);
-}
-
-void test_refs_branches_tracking__retrieve_a_remote_tracking_reference_from_a_branch_with_no_remote_returns_GIT_ENOTFOUND(void)
-{
-	git_reference *head;
-	git_repository *repository;
-	git_commit *target;
-
-	repository = cl_git_sandbox_init("testrepo.git");
-
-	cl_git_pass(git_repository_head(&head, repository));
-	cl_git_pass(git_reference_peel(((git_object **)&target), head, GIT_OBJ_COMMIT));
-	git_reference_free(head);
-
-	assert_merge_and_or_remote_key_missing(repository, target, "remoteless");
-	assert_merge_and_or_remote_key_missing(repository, target, "mergeless");
-	assert_merge_and_or_remote_key_missing(repository, target, "mergeandremoteless");
-
-	git_commit_free(target);
-
-	cl_git_sandbox_cleanup();
-}
diff --git a/tests-clar/refs/branches/trackingname.c b/tests-clar/refs/branches/trackingname.c
deleted file mode 100644
index 5aee333..0000000
--- a/tests-clar/refs/branches/trackingname.c
+++ /dev/null
@@ -1,42 +0,0 @@
-#include "clar_libgit2.h"
-#include "branch.h"
-
-static git_repository *repo;
-static git_buf tracking_name;
-
-void test_refs_branches_trackingname__initialize(void)
-{
-	cl_git_pass(git_repository_open(&repo, cl_fixture("testrepo.git")));
-
-	git_buf_init(&tracking_name, 0);
-}
-
-void test_refs_branches_trackingname__cleanup(void)
-{
-	git_buf_free(&tracking_name);
-
-	git_repository_free(repo);
-	repo = NULL;
-}
-
-void test_refs_branches_trackingname__can_retrieve_the_remote_tracking_reference_name_of_a_local_branch(void)
-{
-	cl_git_pass(git_branch_tracking__name(
-		&tracking_name, repo, "refs/heads/master"));
-
-	cl_assert_equal_s("refs/remotes/test/master", git_buf_cstr(&tracking_name));
-}
-
-void test_refs_branches_trackingname__can_retrieve_the_local_tracking_reference_name_of_a_local_branch(void)
-{
-	cl_git_pass(git_branch_tracking__name(
-		&tracking_name, repo, "refs/heads/track-local"));
-
-	cl_assert_equal_s("refs/heads/master", git_buf_cstr(&tracking_name));
-}
-
-void test_refs_branches_trackingname__can_return_the_size_of_thelocal_tracking_reference_name_of_a_local_branch(void)
-{
-	cl_assert_equal_i((int)strlen("refs/heads/master") + 1,
-		git_branch_tracking_name(NULL, 0, repo, "refs/heads/track-local"));
-}
diff --git a/tests-clar/refs/branches/upstream.c b/tests-clar/refs/branches/upstream.c
new file mode 100644
index 0000000..fca2541
--- /dev/null
+++ b/tests-clar/refs/branches/upstream.c
@@ -0,0 +1,95 @@
+#include "clar_libgit2.h"
+#include "refs.h"
+
+static git_repository *repo;
+static git_reference *branch, *upstream;
+
+void test_refs_branches_upstream__initialize(void)
+{
+	cl_git_pass(git_repository_open(&repo, cl_fixture("testrepo.git")));
+
+	branch = NULL;
+	upstream = NULL;
+}
+
+void test_refs_branches_upstream__cleanup(void)
+{
+	git_reference_free(upstream);
+	git_reference_free(branch);
+	branch = NULL;
+
+	git_repository_free(repo);
+	repo = NULL;
+}
+
+void test_refs_branches_upstream__can_retrieve_the_remote_tracking_reference_of_a_local_branch(void)
+{
+	cl_git_pass(git_reference_lookup(&branch, repo, "refs/heads/master"));
+
+	cl_git_pass(git_branch_upstream(&upstream, branch));
+
+	cl_assert_equal_s("refs/remotes/test/master", git_reference_name(upstream));
+}
+
+void test_refs_branches_upstream__can_retrieve_the_local_upstream_reference_of_a_local_branch(void)
+{
+	cl_git_pass(git_reference_lookup(&branch, repo, "refs/heads/track-local"));
+
+	cl_git_pass(git_branch_upstream(&upstream, branch));
+
+	cl_assert_equal_s("refs/heads/master", git_reference_name(upstream));
+}
+
+void test_refs_branches_upstream__cannot_retrieve_a_remote_upstream_reference_from_a_non_branch(void)
+{
+	cl_git_pass(git_reference_lookup(&branch, repo, "refs/tags/e90810b"));
+
+	cl_git_fail(git_branch_upstream(&upstream, branch));
+}
+
+void test_refs_branches_upstream__trying_to_retrieve_a_remote_tracking_reference_from_a_plain_local_branch_returns_GIT_ENOTFOUND(void)
+{
+	cl_git_pass(git_reference_lookup(&branch, repo, "refs/heads/subtrees"));
+
+	cl_assert_equal_i(GIT_ENOTFOUND, git_branch_upstream(&upstream, branch));
+}
+
+void test_refs_branches_upstream__trying_to_retrieve_a_remote_tracking_reference_from_a_branch_with_no_fetchspec_returns_GIT_ENOTFOUND(void)
+{
+	cl_git_pass(git_reference_lookup(&branch, repo, "refs/heads/cannot-fetch"));
+
+	cl_assert_equal_i(GIT_ENOTFOUND, git_branch_upstream(&upstream, branch));
+}
+
+static void assert_merge_and_or_remote_key_missing(git_repository *repository, const git_commit *target, const char *entry_name)
+{
+	git_reference *branch;
+
+	cl_assert_equal_i(GIT_OBJ_COMMIT, git_object_type((git_object*)target));
+	cl_git_pass(git_branch_create(&branch, repository, entry_name, (git_commit*)target, 0));
+
+	cl_assert_equal_i(GIT_ENOTFOUND, git_branch_upstream(&upstream, branch));
+
+	git_reference_free(branch);
+}
+
+void test_refs_branches_upstream__retrieve_a_remote_tracking_reference_from_a_branch_with_no_remote_returns_GIT_ENOTFOUND(void)
+{
+	git_reference *head;
+	git_repository *repository;
+	git_commit *target;
+
+	repository = cl_git_sandbox_init("testrepo.git");
+
+	cl_git_pass(git_repository_head(&head, repository));
+	cl_git_pass(git_reference_peel(((git_object **)&target), head, GIT_OBJ_COMMIT));
+	git_reference_free(head);
+
+	assert_merge_and_or_remote_key_missing(repository, target, "remoteless");
+	assert_merge_and_or_remote_key_missing(repository, target, "mergeless");
+	assert_merge_and_or_remote_key_missing(repository, target, "mergeandremoteless");
+
+	git_commit_free(target);
+
+	cl_git_sandbox_cleanup();
+}
diff --git a/tests-clar/refs/branches/upstreamname.c b/tests-clar/refs/branches/upstreamname.c
new file mode 100644
index 0000000..f05607d
--- /dev/null
+++ b/tests-clar/refs/branches/upstreamname.c
@@ -0,0 +1,42 @@
+#include "clar_libgit2.h"
+#include "branch.h"
+
+static git_repository *repo;
+static git_buf upstream_name;
+
+void test_refs_branches_upstreamname__initialize(void)
+{
+	cl_git_pass(git_repository_open(&repo, cl_fixture("testrepo.git")));
+
+	git_buf_init(&upstream_name, 0);
+}
+
+void test_refs_branches_upstreamname__cleanup(void)
+{
+	git_buf_free(&upstream_name);
+
+	git_repository_free(repo);
+	repo = NULL;
+}
+
+void test_refs_branches_upstreamname__can_retrieve_the_remote_tracking_reference_name_of_a_local_branch(void)
+{
+	cl_git_pass(git_branch_upstream__name(
+		&upstream_name, repo, "refs/heads/master"));
+
+	cl_assert_equal_s("refs/remotes/test/master", git_buf_cstr(&upstream_name));
+}
+
+void test_refs_branches_upstreamname__can_retrieve_the_local_upstream_reference_name_of_a_local_branch(void)
+{
+	cl_git_pass(git_branch_upstream__name(
+		&upstream_name, repo, "refs/heads/track-local"));
+
+	cl_assert_equal_s("refs/heads/master", git_buf_cstr(&upstream_name));
+}
+
+void test_refs_branches_upstreamname__can_return_the_size_of_thelocal_upstream_reference_name_of_a_local_branch(void)
+{
+	cl_assert_equal_i((int)strlen("refs/heads/master") + 1,
+		git_branch_upstream_name(NULL, 0, repo, "refs/heads/track-local"));
+}