diff options
author | Edward Thomson <ethomson@edwardthomson.com> | 2022-06-11 16:50:35 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-06-11 16:50:35 -0400 |
commit | 3b8a06c01ced3e39df9ea2739b8f8beacbba2702 (patch) | |
tree | 660e505bc6b95a0de81ee1c2035778ef329fd3f6 | |
parent | 565a33173786a0c283a013f43f6355bd24fd579f (diff) | |
parent | 9af5db9a5f835e4e8d8112acebe740a8bb95f2eb (diff) | |
download | libgit2-3b8a06c01ced3e39df9ea2739b8f8beacbba2702.tar.gz |
Merge pull request #6287 from SkinnyMind/docs-typos
docs: fix couple of typos
-rw-r--r-- | include/git2/branch.h | 4 | ||||
-rw-r--r-- | include/git2/config.h | 8 | ||||
-rw-r--r-- | include/git2/merge.h | 2 |
3 files changed, 7 insertions, 7 deletions
diff --git a/include/git2/branch.h b/include/git2/branch.h index 36a393d10..27c6fa157 100644 --- a/include/git2/branch.h +++ b/include/git2/branch.h @@ -129,8 +129,8 @@ GIT_EXTERN(void) git_branch_iterator_free(git_branch_iterator *iter); * See `git_tag_create()` for rules about valid names. * * Note that if the move succeeds, the old reference object will not - + be valid anymore, and should be freed immediately by the user using - + `git_reference_free()`. + * be valid anymore, and should be freed immediately by the user using + * `git_reference_free()`. * * @param out New reference object for the updated name. * diff --git a/include/git2/config.h b/include/git2/config.h index a5486a4c9..99194476f 100644 --- a/include/git2/config.h +++ b/include/git2/config.h @@ -122,7 +122,7 @@ typedef struct { * global configuration file. * * This method will not guess the path to the xdg compatible - * config file (.config/git/config). + * config file (`.config/git/config`). * * @param out Pointer to a user-allocated git_buf in which to store the path * @return 0 if a global configuration file has been found. Its path will be stored in `out`. @@ -149,8 +149,8 @@ GIT_EXTERN(int) git_config_find_xdg(git_buf *out); /** * Locate the path to the system configuration file * - * If /etc/gitconfig doesn't exist, it will look for - * %PROGRAMFILES%\Git\etc\gitconfig. + * If `/etc/gitconfig` doesn't exist, it will look for + * `%PROGRAMFILES%\Git\etc\gitconfig`. * * @param out Pointer to a user-allocated git_buf in which to store the path * @return 0 if a system configuration file has been @@ -161,7 +161,7 @@ GIT_EXTERN(int) git_config_find_system(git_buf *out); /** * Locate the path to the configuration file in ProgramData * - * Look for the file in %PROGRAMDATA%\Git\config used by portable git. + * Look for the file in `%PROGRAMDATA%\Git\config` used by portable git. * * @param out Pointer to a user-allocated git_buf in which to store the path * @return 0 if a ProgramData configuration file has been diff --git a/include/git2/merge.h b/include/git2/merge.h index e90941a49..fcce5594d 100644 --- a/include/git2/merge.h +++ b/include/git2/merge.h @@ -603,7 +603,7 @@ GIT_EXTERN(int) git_merge_commits( * completes, resolve any conflicts and prepare a commit. * * For compatibility with git, the repository is put into a merging - * state. Once the commit is done (or if the uses wishes to abort), + * state. Once the commit is done (or if the user wishes to abort), * you should clear this state by calling * `git_repository_state_cleanup()`. * |