Commit 7eb222fc by Kevin Sawicki

Correct typos in documentation

parent e5562e18
...@@ -83,7 +83,7 @@ GIT_BEGIN_DECL ...@@ -83,7 +83,7 @@ GIT_BEGIN_DECL
* in target, baseline, or index, and not ignored) from the working dir. * in target, baseline, or index, and not ignored) from the working dir.
* *
* - GIT_CHECKOUT_REMOVE_IGNORED means remove ignored files (that are also * - GIT_CHECKOUT_REMOVE_IGNORED means remove ignored files (that are also
* unrtacked) from the working directory as well. * untracked) from the working directory as well.
* *
* - GIT_CHECKOUT_UPDATE_ONLY means to only update the content of files that * - GIT_CHECKOUT_UPDATE_ONLY means to only update the content of files that
* already exist. Files will not be created nor deleted. This just skips * already exist. Files will not be created nor deleted. This just skips
...@@ -97,13 +97,13 @@ GIT_BEGIN_DECL ...@@ -97,13 +97,13 @@ GIT_BEGIN_DECL
* *
* - Unmerged index entries are conflicts. GIT_CHECKOUT_SKIP_UNMERGED skips * - Unmerged index entries are conflicts. GIT_CHECKOUT_SKIP_UNMERGED skips
* files with unmerged index entries instead. GIT_CHECKOUT_USE_OURS and * files with unmerged index entries instead. GIT_CHECKOUT_USE_OURS and
* GIT_CHECKOUT_USE_THEIRS to proceeed with the checkout using either the * GIT_CHECKOUT_USE_THEIRS to proceed with the checkout using either the
* stage 2 ("ours") or stage 3 ("theirs") version of files in the index. * stage 2 ("ours") or stage 3 ("theirs") version of files in the index.
*/ */
typedef enum { typedef enum {
GIT_CHECKOUT_NONE = 0, /** default is a dry run, no actual updates */ GIT_CHECKOUT_NONE = 0, /** default is a dry run, no actual updates */
/** Allow safe updates that cannot overwrite uncommited data */ /** Allow safe updates that cannot overwrite uncommitted data */
GIT_CHECKOUT_SAFE = (1u << 0), GIT_CHECKOUT_SAFE = (1u << 0),
/** Allow safe updates plus creation of missing files */ /** Allow safe updates plus creation of missing files */
......
...@@ -297,7 +297,7 @@ GIT_EXTERN(int) git_config_get_int32(int32_t *out, const git_config *cfg, const ...@@ -297,7 +297,7 @@ GIT_EXTERN(int) git_config_get_int32(int32_t *out, const git_config *cfg, const
* *
* All config files will be looked into, in the order of their * All config files will be looked into, in the order of their
* defined level. A higher level means a higher priority. The * defined level. A higher level means a higher priority. The
* first occurence of the variable will be returned here. * first occurrence of the variable will be returned here.
* *
* @param out pointer to the variable where the value should be stored * @param out pointer to the variable where the value should be stored
* @param cfg where to look for the variable * @param cfg where to look for the variable
...@@ -314,7 +314,7 @@ GIT_EXTERN(int) git_config_get_int64(int64_t *out, const git_config *cfg, const ...@@ -314,7 +314,7 @@ GIT_EXTERN(int) git_config_get_int64(int64_t *out, const git_config *cfg, const
* *
* All config files will be looked into, in the order of their * All config files will be looked into, in the order of their
* defined level. A higher level means a higher priority. The * defined level. A higher level means a higher priority. The
* first occurence of the variable will be returned here. * first occurrence of the variable will be returned here.
* *
* @param out pointer to the variable where the value should be stored * @param out pointer to the variable where the value should be stored
* @param cfg where to look for the variable * @param cfg where to look for the variable
...@@ -331,7 +331,7 @@ GIT_EXTERN(int) git_config_get_bool(int *out, const git_config *cfg, const char ...@@ -331,7 +331,7 @@ GIT_EXTERN(int) git_config_get_bool(int *out, const git_config *cfg, const char
* *
* All config files will be looked into, in the order of their * All config files will be looked into, in the order of their
* defined level. A higher level means a higher priority. The * defined level. A higher level means a higher priority. The
* first occurence of the variable will be returned here. * first occurrence of the variable will be returned here.
* *
* @param out pointer to the variable's value * @param out pointer to the variable's value
* @param cfg where to look for the variable * @param cfg where to look for the variable
......
...@@ -241,8 +241,8 @@ typedef struct { ...@@ -241,8 +241,8 @@ typedef struct {
* callback functions and you can use the contents to understand exactly * callback functions and you can use the contents to understand exactly
* what has changed. * what has changed.
* *
* The `old_file` repesents the "from" side of the diff and the `new_file` * The `old_file` represents the "from" side of the diff and the `new_file`
* repesents to "to" side of the diff. What those means depend on the * represents to "to" side of the diff. What those means depend on the
* function that was used to generate the diff and will be documented below. * function that was used to generate the diff and will be documented below.
* You can also use the `GIT_DIFF_REVERSE` flag to flip it around. * You can also use the `GIT_DIFF_REVERSE` flag to flip it around.
* *
......
...@@ -57,7 +57,7 @@ GIT_EXTERN(int) git_ignore_clear_internal_rules( ...@@ -57,7 +57,7 @@ GIT_EXTERN(int) git_ignore_clear_internal_rules(
* *
* This function checks the ignore rules to see if they would apply to the * This function checks the ignore rules to see if they would apply to the
* given file. This indicates if the file would be ignored regardless of * given file. This indicates if the file would be ignored regardless of
* whether the file is already in the index or commited to the repository. * whether the file is already in the index or committed to the repository.
* *
* One way to think of this is if you were to do "git add ." on the * One way to think of this is if you were to do "git add ." on the
* directory containing the file, would it be added or not? * directory containing the file, would it be added or not?
......
...@@ -56,7 +56,7 @@ GIT_EXTERN(int) git_refspec_src_matches(const git_refspec *refspec, const char * ...@@ -56,7 +56,7 @@ GIT_EXTERN(int) git_refspec_src_matches(const git_refspec *refspec, const char *
* Transform a reference to its target following the refspec's rules * Transform a reference to its target following the refspec's rules
* *
* @param out where to store the target name * @param out where to store the target name
* @param outlen the size ouf the `out` buffer * @param outlen the size of the `out` buffer
* @param spec the refspec * @param spec the refspec
* @param name the name of the reference to transform * @param name the name of the reference to transform
* @return 0, GIT_EBUFS or another error * @return 0, GIT_EBUFS or another error
......
...@@ -609,7 +609,7 @@ GIT_EXTERN(int) git_repository_set_head_detached( ...@@ -609,7 +609,7 @@ GIT_EXTERN(int) git_repository_set_head_detached(
* updated into making it point to the peeled Commit, and 0 is returned. * updated into making it point to the peeled Commit, and 0 is returned.
* *
* If the HEAD is already detached and points to a non commitish, the HEAD is * If the HEAD is already detached and points to a non commitish, the HEAD is
* unaletered, and -1 is returned. * unaltered, and -1 is returned.
* *
* Otherwise, the HEAD will be detached and point to the peeled Commit. * Otherwise, the HEAD will be detached and point to the peeled Commit.
* *
......
...@@ -210,7 +210,7 @@ GIT_EXTERN(int) git_status_file( ...@@ -210,7 +210,7 @@ GIT_EXTERN(int) git_status_file(
* *
* This function checks the ignore rules to see if they would apply to the * This function checks the ignore rules to see if they would apply to the
* given file. This indicates if the file would be ignored regardless of * given file. This indicates if the file would be ignored regardless of
* whether the file is already in the index or commited to the repository. * whether the file is already in the index or committed to the repository.
* *
* One way to think of this is if you were to do "git add ." on the * One way to think of this is if you were to do "git add ." on the
* directory containing the file, would it be added or not? * directory containing the file, would it be added or not?
......
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