Merge pull request libgit2#4436 from pks-t/pks/packfile-stream-free

pack: rename `git_packfile_stream_free`

Author: ethomson

examples/diff.c

@@ -332,6 +332,6 @@ static void diff_print_stats(git_diff *diff, struct opts *o)
 
 	fputs(b.ptr, stdout);
 
-	git_buf_free(&b);
+	git_buf_dispose(&b);
 	git_diff_stats_free(stats);
 }

examples/remote.c

@@ -64,7 +64,7 @@ int main(int argc, char *argv[])
 
 	check_lg2(git_repository_open(&repo, buf.ptr),
 		"Could not open repository", NULL);
-	git_buf_free(&buf);
+	git_buf_dispose(&buf);
 
 	switch (opt.cmd)
 	{

examples/tag.c

@@ -184,7 +184,7 @@ static void action_delete_tag(tag_state *state)
 
 	printf("Deleted tag '%s' (was %s)\n", opts->tag_name, abbrev_oid.ptr);
 
-	git_buf_free(&abbrev_oid);
+	git_buf_dispose(&abbrev_oid);
 	git_object_free(obj);
 }
 

include/git2/buffer.h

@@ -69,7 +69,19 @@ typedef struct {
  *
  * @param buffer The buffer to deallocate
  */
-GIT_EXTERN(void) git_buf_free(git_buf *buffer);
+GIT_EXTERN(void) git_buf_dispose(git_buf *buffer);
+
+/**
+ * Alias of `git_buf_dispose`.
+ *
+ * This function is directly calls `git_buf_dispose` now and is deprecated.
+ * Going forward, we refer to functions freeing the internal state of a
+ * structure a `dispose` function, while functions freeing the structure
+ * themselves will be called a `free` function.
+ *
+ * This function is going to be removed in v0.30.0.
+ */
+GIT_EXTERN(void) GIT_DEPRECATED(git_buf_free)(git_buf *buffer);
 
 /**
  * Resize the buffer allocation to make more space.

include/git2/common.h

@@ -48,6 +48,17 @@ typedef size_t size_t;
 # define GIT_EXTERN(type) extern type
 #endif
 
+/** Declare a function as deprecated. */
+#if defined(__GNUC__)
+# define GIT_DEPRECATED(func) \
+			 __attribute__((deprecated)) \
+			 func
+#elif defined(_MSC_VER)
+# define GIT_DEPRECATED(func) __declspec(deprecated) func
+#else
+# define GIT_DEPRECATED(func) func
+#endif
+
 /** Declare a function's takes printf style arguments. */
 #ifdef __GNUC__
 # define GIT_FORMAT_PRINTF(a,b) __attribute__((format (printf, a, b)))

src/apply.c

@@ -255,7 +255,7 @@ static int apply_binary_delta(
 
 	if (!error && inflated.size != binary_file->inflatedlen) {
 		error = apply_err("inflated delta does not match expected length");
-		git_buf_free(out);
+		git_buf_dispose(out);
 	}
 
 	if (error < 0)
@@ -281,7 +281,7 @@ static int apply_binary_delta(
 	}
 
 done:
-	git_buf_free(&inflated);
+	git_buf_dispose(&inflated);
 	return error;
 }
 
@@ -320,9 +320,9 @@ static int apply_binary(
 
 done:
 	if (error < 0)
-		git_buf_free(out);
+		git_buf_dispose(out);
 
-	git_buf_free(&reverse);
+	git_buf_dispose(&reverse);
 	return error;
 }
 

src/attr.c

@@ -298,7 +298,7 @@ static int system_attr_file(
 
 	/* We can safely provide a git_buf with no allocation (asize == 0) to
 	 * a consumer. This allows them to treat this as a regular `git_buf`,
-	 * but their call to `git_buf_free` will not attempt to free it.
+	 * but their call to `git_buf_dispose` will not attempt to free it.
 	 */
 	git_buf_attach_notowned(
 		out, attr_session->sysdir.ptr, attr_session->sysdir.size);
@@ -359,7 +359,7 @@ static int attr_setup(git_repository *repo, git_attr_session *attr_session)
 		attr_session->init_setup = 1;
 
 out:
-	git_buf_free(&path);
+	git_buf_dispose(&path);
 
 	return error;
 }
@@ -565,8 +565,8 @@ static int collect_attr_files(
  cleanup:
 	if (error < 0)
 		release_attr_files(files);
-	git_buf_free(&attrfile);
-	git_buf_free(&dir);
+	git_buf_dispose(&attrfile);
+	git_buf_dispose(&dir);
 
 	return error;
 }

src/attr_file.c

@@ -178,7 +178,7 @@ int git_attr_file__load(
 
 cleanup:
 	git_blob_free(blob);
-	git_buf_free(&content);
+	git_buf_dispose(&content);
 
 	return error;
 }
@@ -348,7 +348,7 @@ int git_attr_file__load_standalone(git_attr_file **out, const char *path)
 
 	if (!(error = git_futils_readbuffer(&content, path))) {
 		error = git_attr_file__parse_buffer(NULL, file, content.ptr);
-		git_buf_free(&content);
+		git_buf_dispose(&content);
 	}
 
 	if (error < 0)
@@ -518,7 +518,7 @@ int git_attr_path__init(
 
 void git_attr_path__free(git_attr_path *info)
 {
-	git_buf_free(&info->full);
+	git_buf_dispose(&info->full);
 	info->path = NULL;
 	info->basename = NULL;
 }
@@ -876,8 +876,8 @@ void git_attr_session__free(git_attr_session *session)
 	if (!session)
 		return;
 
-	git_buf_free(&session->sysdir);
-	git_buf_free(&session->tmp);
+	git_buf_dispose(&session->sysdir);
+	git_buf_dispose(&session->tmp);
 
 	memset(session, 0, sizeof(git_attr_session));
 }

src/attrcache.c

@@ -204,7 +204,7 @@ static int attr_cache_lookup(
 	*out_file  = file;
 	*out_entry = entry;
 
-	git_buf_free(&path);
+	git_buf_dispose(&path);
 	return error;
 }
 
@@ -310,7 +310,7 @@ static int attr_cache__lookup_path(
 	}
 
 	git_config_entry_free(entry);
-	git_buf_free(&buf);
+	git_buf_dispose(&buf);
 
 	return error;
 }

src/blob.c

@@ -126,7 +126,7 @@ static int write_file_filtered(
 		error = git_odb_write(id, odb, tgt.ptr, tgt.size, GIT_OBJ_BLOB);
 	}
 
-	git_buf_free(&tgt);
+	git_buf_dispose(&tgt);
 	return error;
 }
 
@@ -238,7 +238,7 @@ int git_blob__create_from_paths(
 
 done:
 	git_odb_free(odb);
-	git_buf_free(&path);
+	git_buf_dispose(&path);
 
 	return error;
 }
@@ -257,7 +257,7 @@ int git_blob_create_fromdisk(
 	const char *workdir, *hintpath;
 
 	if ((error = git_path_prettify(&full_path, path, NULL)) < 0) {
-		git_buf_free(&full_path);
+		git_buf_dispose(&full_path);
 		return error;
 	}
 
@@ -270,7 +270,7 @@ int git_blob_create_fromdisk(
 	error = git_blob__create_from_paths(
 		id, NULL, repo, git_buf_cstr(&full_path), hintpath, 0, true);
 
-	git_buf_free(&full_path);
+	git_buf_dispose(&full_path);
 	return error;
 }
 
@@ -340,7 +340,7 @@ int git_blob_create_fromstream(git_writestream **out, git_repository *repo, cons
 	if (error < 0)
 		blob_writestream_free((git_writestream *) stream);
 
-	git_buf_free(&path);
+	git_buf_dispose(&path);
 	return error;
 }