Skip to content

Commit 9af5db9

Browse files
committed
docs: fix couple of typos
1 parent 13502d9 commit 9af5db9

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

include/git2/branch.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@ GIT_EXTERN(void) git_branch_iterator_free(git_branch_iterator *iter);
129129
* See `git_tag_create()` for rules about valid names.
130130
*
131131
* Note that if the move succeeds, the old reference object will not
132-
+ be valid anymore, and should be freed immediately by the user using
133-
+ `git_reference_free()`.
132+
* be valid anymore, and should be freed immediately by the user using
133+
* `git_reference_free()`.
134134
*
135135
* @param out New reference object for the updated name.
136136
*

include/git2/config.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ typedef struct {
122122
* global configuration file.
123123
*
124124
* This method will not guess the path to the xdg compatible
125-
* config file (.config/git/config).
125+
* config file (`.config/git/config`).
126126
*
127127
* @param out Pointer to a user-allocated git_buf in which to store the path
128128
* @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);
149149
/**
150150
* Locate the path to the system configuration file
151151
*
152-
* If /etc/gitconfig doesn't exist, it will look for
153-
* %PROGRAMFILES%\Git\etc\gitconfig.
152+
* If `/etc/gitconfig` doesn't exist, it will look for
153+
* `%PROGRAMFILES%\Git\etc\gitconfig`.
154154
*
155155
* @param out Pointer to a user-allocated git_buf in which to store the path
156156
* @return 0 if a system configuration file has been
@@ -161,7 +161,7 @@ GIT_EXTERN(int) git_config_find_system(git_buf *out);
161161
/**
162162
* Locate the path to the configuration file in ProgramData
163163
*
164-
* Look for the file in %PROGRAMDATA%\Git\config used by portable git.
164+
* Look for the file in `%PROGRAMDATA%\Git\config` used by portable git.
165165
*
166166
* @param out Pointer to a user-allocated git_buf in which to store the path
167167
* @return 0 if a ProgramData configuration file has been

include/git2/merge.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -603,7 +603,7 @@ GIT_EXTERN(int) git_merge_commits(
603603
* completes, resolve any conflicts and prepare a commit.
604604
*
605605
* For compatibility with git, the repository is put into a merging
606-
* state. Once the commit is done (or if the uses wishes to abort),
606+
* state. Once the commit is done (or if the user wishes to abort),
607607
* you should clear this state by calling
608608
* `git_repository_state_cleanup()`.
609609
*

0 commit comments

Comments
 (0)