diff options
| author | Edward Thomson <ethomson@edwardthomson.com> | 2021-09-07 17:53:49 -0400 |
|---|---|---|
| committer | Edward Thomson <ethomson@edwardthomson.com> | 2021-10-17 09:49:01 -0400 |
| commit | f0e693b18afbe1de37d7da5b5a8967b6c87d8e53 (patch) | |
| tree | be5e1cdbfa218ba81ec06bf45e45cfeb7f79a2a5 /tests/revert | |
| parent | 5346be3ddd3bcf19779c5d62e71f8442a0171133 (diff) | |
| download | libgit2-ethomson/gitstr.tar.gz | |
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.
Diffstat (limited to 'tests/revert')
| -rw-r--r-- | tests/revert/bare.c | 1 | ||||
| -rw-r--r-- | tests/revert/workdir.c | 11 |
2 files changed, 5 insertions, 7 deletions
diff --git a/tests/revert/bare.c b/tests/revert/bare.c index 03cffbf3e..9261cfe86 100644 --- a/tests/revert/bare.c +++ b/tests/revert/bare.c @@ -1,7 +1,6 @@ #include "clar.h" #include "clar_libgit2.h" -#include "buffer.h" #include "futils.h" #include "git2/revert.h" diff --git a/tests/revert/workdir.c b/tests/revert/workdir.c index 2ad059d99..36824044b 100644 --- a/tests/revert/workdir.c +++ b/tests/revert/workdir.c @@ -1,7 +1,6 @@ #include "clar.h" #include "clar_libgit2.h" -#include "buffer.h" #include "futils.h" #include "git2/revert.h" @@ -66,7 +65,7 @@ void test_revert_workdir__conflicts(void) git_reference *head_ref; git_commit *head, *commit; git_oid revert_oid; - git_buf conflicting_buf = GIT_BUF_INIT, mergemsg_buf = GIT_BUF_INIT; + git_str conflicting_buf = GIT_STR_INIT, mergemsg_buf = GIT_STR_INIT; struct merge_index_entry merge_index_entries[] = { { 0100644, "7731926a337c4eaba1e2187d90ebfa0a93659382", 1, "file1.txt" }, @@ -126,8 +125,8 @@ void test_revert_workdir__conflicts(void) git_commit_free(commit); git_commit_free(head); git_reference_free(head_ref); - git_buf_dispose(&mergemsg_buf); - git_buf_dispose(&conflicting_buf); + git_str_dispose(&mergemsg_buf); + git_str_dispose(&conflicting_buf); } /* git reset --hard 39467716290f6df775a91cdb9a4eb39295018145 @@ -308,7 +307,7 @@ void test_revert_workdir__again_after_edit(void) */ void test_revert_workdir__again_after_edit_two(void) { - git_buf diff_buf = GIT_BUF_INIT; + git_str diff_buf = GIT_STR_INIT; git_config *config; git_oid head_commit_oid, revert_commit_oid; git_commit *head_commit, *revert_commit; @@ -350,7 +349,7 @@ void test_revert_workdir__again_after_edit_two(void) git_commit_free(revert_commit); git_commit_free(head_commit); git_config_free(config); - git_buf_dispose(&diff_buf); + git_str_dispose(&diff_buf); } /* git reset --hard 72333f47d4e83616630ff3b0ffe4c0faebcc3c45 |