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, 11 insertions, 11 deletions

diff --git a/tests/submodule/add.c b/tests/submodule/add.c
index fc458f826..b564123dd 100644
--- a/tests/submodule/add.c
+++ b/tests/submodule/add.c
@@ -17,20 +17,20 @@ void test_submodule_add__cleanup(void)
 
 static void assert_submodule_url(const char* name, const char *url)
 {
-	git_buf key = GIT_BUF_INIT;
+	git_str key = GIT_STR_INIT;
 
 
-	cl_git_pass(git_buf_printf(&key, "submodule.%s.url", name));
-	assert_config_entry_value(g_repo, git_buf_cstr(&key), url);
+	cl_git_pass(git_str_printf(&key, "submodule.%s.url", name));
+	assert_config_entry_value(g_repo, git_str_cstr(&key), url);
 
-	git_buf_dispose(&key);
+	git_str_dispose(&key);
 }
 
 void test_submodule_add__url_absolute(void)
 {
 	git_submodule *sm;
 	git_repository *repo;
-	git_buf dot_git_content = GIT_BUF_INIT;
+	git_str dot_git_content = GIT_STR_INIT;
 
 	g_repo = setup_fixture_submod2();
 
@@ -63,7 +63,7 @@ void test_submodule_add__url_absolute(void)
 	cl_assert_equal_s("gitdir: ../.git/modules/sm_libgit2/", dot_git_content.ptr);
 
 	git_repository_free(repo);
-	git_buf_dispose(&dot_git_content);
+	git_str_dispose(&dot_git_content);
 
 	/* add a submodule not using a gitlink */
 
@@ -151,11 +151,11 @@ void test_submodule_add__path_exists_in_index(void)
 {
 	git_index *index;
 	git_submodule *sm;
-	git_buf filename = GIT_BUF_INIT;
+	git_str filename = GIT_STR_INIT;
 
 	g_repo = cl_git_sandbox_init("testrepo");
 
-	cl_git_pass(git_buf_joinpath(&filename, "subdirectory", "test.txt"));
+	cl_git_pass(git_str_joinpath(&filename, "subdirectory", "test.txt"));
 
 	cl_git_pass(git_repository_index__weakptr(&index, g_repo));
 
@@ -164,14 +164,14 @@ void test_submodule_add__path_exists_in_index(void)
 	cl_git_fail_with(git_submodule_add_setup(&sm, g_repo, "./", "subdirectory", 1), GIT_EEXISTS);
 
 	git_submodule_free(sm);
-	git_buf_dispose(&filename);
+	git_str_dispose(&filename);
 }
 
 void test_submodule_add__file_exists_in_index(void)
 {
 	git_index *index;
 	git_submodule *sm;
-	git_buf name = GIT_BUF_INIT;
+	git_str name = GIT_STR_INIT;
 
 	g_repo = cl_git_sandbox_init("testrepo");
 
@@ -182,7 +182,7 @@ void test_submodule_add__file_exists_in_index(void)
 	cl_git_fail_with(git_submodule_add_setup(&sm, g_repo, "./", "subdirectory", 1), GIT_EEXISTS);
 
 	git_submodule_free(sm);
-	git_buf_dispose(&name);
+	git_str_dispose(&name);
 }
 
 void test_submodule_add__submodule_clone(void)