Unverified Commit 3b8a06c0 by Edward Thomson Committed by GitHub

Merge pull request #6287 from SkinnyMind/docs-typos

docs: fix couple of typos
parents 565a3317 9af5db9a
...@@ -129,8 +129,8 @@ GIT_EXTERN(void) git_branch_iterator_free(git_branch_iterator *iter); ...@@ -129,8 +129,8 @@ GIT_EXTERN(void) git_branch_iterator_free(git_branch_iterator *iter);
* See `git_tag_create()` for rules about valid names. * See `git_tag_create()` for rules about valid names.
* *
* Note that if the move succeeds, the old reference object will not * Note that if the move succeeds, the old reference object will not
+ be valid anymore, and should be freed immediately by the user using * be valid anymore, and should be freed immediately by the user using
+ `git_reference_free()`. * `git_reference_free()`.
* *
* @param out New reference object for the updated name. * @param out New reference object for the updated name.
* *
......
...@@ -122,7 +122,7 @@ typedef struct { ...@@ -122,7 +122,7 @@ typedef struct {
* global configuration file. * global configuration file.
* *
* This method will not guess the path to the xdg compatible * 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 * @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`. * @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); ...@@ -149,8 +149,8 @@ GIT_EXTERN(int) git_config_find_xdg(git_buf *out);
/** /**
* Locate the path to the system configuration file * Locate the path to the system configuration file
* *
* If /etc/gitconfig doesn't exist, it will look for * If `/etc/gitconfig` doesn't exist, it will look for
* %PROGRAMFILES%\Git\etc\gitconfig. * `%PROGRAMFILES%\Git\etc\gitconfig`.
* *
* @param out Pointer to a user-allocated git_buf in which to store the path * @param out Pointer to a user-allocated git_buf in which to store the path
* @return 0 if a system configuration file has been * @return 0 if a system configuration file has been
...@@ -161,7 +161,7 @@ GIT_EXTERN(int) git_config_find_system(git_buf *out); ...@@ -161,7 +161,7 @@ GIT_EXTERN(int) git_config_find_system(git_buf *out);
/** /**
* Locate the path to the configuration file in ProgramData * 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 * @param out Pointer to a user-allocated git_buf in which to store the path
* @return 0 if a ProgramData configuration file has been * @return 0 if a ProgramData configuration file has been
......
...@@ -603,7 +603,7 @@ GIT_EXTERN(int) git_merge_commits( ...@@ -603,7 +603,7 @@ GIT_EXTERN(int) git_merge_commits(
* completes, resolve any conflicts and prepare a commit. * completes, resolve any conflicts and prepare a commit.
* *
* For compatibility with git, the repository is put into a merging * 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 * you should clear this state by calling
* `git_repository_state_cleanup()`. * `git_repository_state_cleanup()`.
* *
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment