str: introduce `git_str` for internal, `git_buf` is externalethomson/gitstr

libgit2 has two distinct requirements that were previously solved by
`git_buf`.  We require:

1. A general purpose string class that provides a number of utility APIs
   for manipulating data (eg, concatenating, truncating, etc).
2. A structure that we can use to return strings to callers that they
   can take ownership of.

By using a single class (`git_buf`) for both of these purposes, we have
confused the API to the point that refactorings are difficult and
reasoning about correctness is also difficult.

Move the utility class `git_buf` to be called `git_str`: this represents
its general purpose, as an internal string buffer class.  The name also
is an homage to Junio Hamano ("gitstr").

The public API remains `git_buf`, and has a much smaller footprint.  It
is generally only used as an "out" param with strict requirements that
follow the documentation.  (Exceptions exist for some legacy APIs to
avoid breaking callers unnecessarily.)

Utility functions exist to convert a user-specified `git_buf` to a
`git_str` so that we can call internal functions, then converting it
back again.

1 files changed, 10 insertions, 10 deletions

diff --git a/tests/repo/env.c b/tests/repo/env.c
index 43defc168..4bd45d1a6 100644
--- a/tests/repo/env.c
+++ b/tests/repo/env.c
@@ -38,14 +38,14 @@ static int GIT_FORMAT_PRINTF(2, 3) cl_setenv_printf(const char *name, const char
 {
 	int ret;
 	va_list args;
-	git_buf buf = GIT_BUF_INIT;
+	git_str buf = GIT_STR_INIT;
 
 	va_start(args, fmt);
-	cl_git_pass(git_buf_vprintf(&buf, fmt, args));
+	cl_git_pass(git_str_vprintf(&buf, fmt, args));
 	va_end(args);
 
-	ret = cl_setenv(name, git_buf_cstr(&buf));
-	git_buf_dispose(&buf);
+	ret = cl_setenv(name, git_str_cstr(&buf));
+	git_str_dispose(&buf);
 	return ret;
 }
 
@@ -80,12 +80,12 @@ static void env_cd_(
 	void (*passfail_)(const char *, const char *, const char *, int),
 	const char *file, const char *func, int line)
 {
-	git_buf cwd_buf = GIT_BUF_INIT;
+	git_str cwd_buf = GIT_STR_INIT;
 	cl_git_pass(git_path_prettify_dir(&cwd_buf, ".", NULL));
 	cl_must_pass(p_chdir(path));
 	passfail_(NULL, file, func, line);
-	cl_must_pass(p_chdir(git_buf_cstr(&cwd_buf)));
-	git_buf_dispose(&cwd_buf);
+	cl_must_pass(p_chdir(git_str_cstr(&cwd_buf)));
+	git_str_dispose(&cwd_buf);
 }
 #define env_cd_pass(path) env_cd_((path), env_pass_, __FILE__, __func__, __LINE__)
 #define env_cd_fail(path) env_cd_((path), env_fail_, __FILE__, __func__, __LINE__)
@@ -128,7 +128,7 @@ static void env_check_objects_(bool a, bool t, bool p, const char *file, const c
 void test_repo_env__open(void)
 {
 	git_repository *repo = NULL;
-	git_buf repo_dir_buf = GIT_BUF_INIT;
+	git_str repo_dir_buf = GIT_STR_INIT;
 	const char *repo_dir = NULL;
 	git_index *index = NULL;
 	const char *t_obj = "testrepo.git/objects";
@@ -142,7 +142,7 @@ void test_repo_env__open(void)
 	cl_git_pass(p_rename("attr/.gitted", "attr/.git"));
 
 	cl_git_pass(git_path_prettify_dir(&repo_dir_buf, "attr", NULL));
-	repo_dir = git_buf_cstr(&repo_dir_buf);
+	repo_dir = git_str_cstr(&repo_dir_buf);
 
 	/* GIT_DIR that doesn't exist */
 	cl_setenv("GIT_DIR", "does-not-exist");
@@ -271,7 +271,7 @@ void test_repo_env__open(void)
 	cl_fixture_cleanup("testrepo.git");
 	cl_fixture_cleanup("attr");
 
-	git_buf_dispose(&repo_dir_buf);
+	git_str_dispose(&repo_dir_buf);
 
 	clear_git_env();
 }