diff options
author | Edward Thomson <ethomson@edwardthomson.com> | 2019-06-06 16:36:23 -0400 |
---|---|---|
committer | Edward Thomson <ethomson@edwardthomson.com> | 2019-06-14 09:57:00 +0100 |
commit | 0b5ba0d744e69da5dc8c08d167c83dd87ed83af2 (patch) | |
tree | 0dcca647cc9d9fe8080c2b0ea483dff5d74ee566 /include/git2/worktree.h | |
parent | a5ddae68f86b459ce53319c8af1e7b1ea7d21dd6 (diff) | |
download | libgit2-0b5ba0d744e69da5dc8c08d167c83dd87ed83af2.tar.gz |
Rename opt init functions to `options_init`
In libgit2 nomenclature, when we need to verb a direct object, we name
a function `git_directobject_verb`. Thus, if we need to init an options
structure named `git_foo_options`, then the name of the function that
does that should be `git_foo_options_init`.
The previous names of `git_foo_init_options` is close - it _sounds_ as
if it's initializing the options of a `foo`, but in fact
`git_foo_options` is its own noun that should be respected.
Deprecate the old names; they'll now call directly to the new ones.
Diffstat (limited to 'include/git2/worktree.h')
-rw-r--r-- | include/git2/worktree.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/include/git2/worktree.h b/include/git2/worktree.h index 925d85a69..049511da1 100644 --- a/include/git2/worktree.h +++ b/include/git2/worktree.h @@ -78,7 +78,7 @@ GIT_EXTERN(int) git_worktree_validate(const git_worktree *wt); * Worktree add options structure * * Initialize with `GIT_WORKTREE_ADD_OPTIONS_INIT`. Alternatively, you can - * use `git_worktree_add_init_options`. + * use `git_worktree_add_options_init`. * */ typedef struct git_worktree_add_options { @@ -101,7 +101,7 @@ typedef struct git_worktree_add_options { * @param version The struct version; pass `GIT_WORKTREE_ADD_OPTIONS_VERSION`. * @return Zero on success; -1 on failure. */ -GIT_EXTERN(int) git_worktree_add_init_options(git_worktree_add_options *opts, +GIT_EXTERN(int) git_worktree_add_options_init(git_worktree_add_options *opts, unsigned int version); /** @@ -174,7 +174,7 @@ GIT_EXTERN(const char *) git_worktree_name(const git_worktree *wt); * is valid for the lifetime of the git_worktree. */ GIT_EXTERN(const char *) git_worktree_path(const git_worktree *wt); - + /** * Flags which can be passed to git_worktree_prune to alter its * behavior. @@ -192,7 +192,7 @@ typedef enum { * Worktree prune options structure * * Initialize with `GIT_WORKTREE_PRUNE_OPTIONS_INIT`. Alternatively, you can - * use `git_worktree_prune_init_options`. + * use `git_worktree_prune_options_init`. * */ typedef struct git_worktree_prune_options { @@ -214,7 +214,7 @@ typedef struct git_worktree_prune_options { * @param version The struct version; pass `GIT_WORKTREE_PRUNE_OPTIONS_VERSION`. * @return Zero on success; -1 on failure. */ -GIT_EXTERN(int) git_worktree_prune_init_options( +GIT_EXTERN(int) git_worktree_prune_options_init( git_worktree_prune_options *opts, unsigned int version); |