diff options
author | Bruce Mitchener <bruce.mitchener@gmail.com> | 2012-05-19 20:24:55 +0700 |
---|---|---|
committer | Bruce Mitchener <bruce.mitchener@gmail.com> | 2012-05-19 20:26:52 +0700 |
commit | d73c94b21c58d78a7bf268bc9e3b0f4daa11e514 (patch) | |
tree | a97f69fd7bace881a10ca650e2461078e6391ccd | |
parent | ad5df35a47d56c3d716d7a56eac4aeb611987c11 (diff) | |
download | libgit2-d73c94b21c58d78a7bf268bc9e3b0f4daa11e514.tar.gz |
Fix spelling errors.
-rw-r--r-- | docs/error-handling.md | 4 | ||||
-rw-r--r-- | include/git2/attr.h | 2 | ||||
-rw-r--r-- | include/git2/diff.h | 2 | ||||
-rw-r--r-- | include/git2/index.h | 2 | ||||
-rw-r--r-- | include/git2/indexer.h | 2 | ||||
-rw-r--r-- | include/git2/object.h | 6 | ||||
-rw-r--r-- | include/git2/odb.h | 8 | ||||
-rw-r--r-- | include/git2/oid.h | 2 | ||||
-rw-r--r-- | include/git2/refs.h | 4 | ||||
-rw-r--r-- | include/git2/remote.h | 8 | ||||
-rw-r--r-- | include/git2/repository.h | 4 | ||||
-rw-r--r-- | include/git2/revwalk.h | 8 | ||||
-rw-r--r-- | include/git2/submodule.h | 2 | ||||
-rw-r--r-- | include/git2/tag.h | 2 | ||||
-rw-r--r-- | include/git2/tree.h | 4 |
15 files changed, 30 insertions, 30 deletions
diff --git a/docs/error-handling.md b/docs/error-handling.md index 04c855fbc..655afeba8 100644 --- a/docs/error-handling.md +++ b/docs/error-handling.md @@ -29,7 +29,7 @@ The simple error API - `void giterr_set(git_error **, int, const char *, ...)`: the main function used to set an error. It allocates a new error object and stores it in the passed error pointer. It has no return value. The arguments for `giterr_set` are as follows: - `git_error **error_ptr`: the pointer where the error will be created. - - `int error_class`: the class for the error. This is **not** an error code: this is an speficic enum that specifies the error family. The point is to map these families 1-1 with Exception types on higher level languages (e.g. GitRepositoryException) + - `int error_class`: the class for the error. This is **not** an error code: this is an specific enum that specifies the error family. The point is to map these families 1-1 with Exception types on higher level languages (e.g. GitRepositoryException) - `const char *error_str, ...`: the error string, with optional formatting arguments - `void giterr_free(git_error *)`: takes an error and frees it. This function is available in the external API. @@ -56,7 +56,7 @@ Here are some guidelines when writing error messages: - Use short, direct and objective messages. **One line, max**. libgit2 is a low level library: think that all the messages reported will be thrown as Ruby or Python exceptions. Think how long are common exception messages in those languages. -- **Do not add redundant information to the error message**, specially information that can be infered from the context. +- **Do not add redundant information to the error message**, specially information that can be inferred from the context. E.g. in `git_repository_open`, do not report a message like "Failed to open repository: path not found". Somebody is calling that function. If it fails, he already knows that the repository failed to open! diff --git a/include/git2/attr.h b/include/git2/attr.h index 28ca3bc1c..8f5a1268d 100644 --- a/include/git2/attr.h +++ b/include/git2/attr.h @@ -66,7 +66,7 @@ GIT_BEGIN_DECL /** * GIT_ATTR_HAS_VALUE checks if an attribute is set to a value (as - * opposied to TRUE, FALSE or UNSPECIFIED). This would be the case if + * opposed to TRUE, FALSE or UNSPECIFIED). This would be the case if * for a file with something like: * * *.txt eol=lf diff --git a/include/git2/diff.h b/include/git2/diff.h index bafe6268c..a0e8ad6d2 100644 --- a/include/git2/diff.h +++ b/include/git2/diff.h @@ -155,7 +155,7 @@ typedef int (*git_diff_hunk_fn)( * * These values describe where a line came from and will be passed to * the git_diff_data_fn when iterating over a diff. There are some - * special origin contants at the end that are used for the text + * special origin constants at the end that are used for the text * output callbacks to demarcate lines that are actually part of * the file or hunk headers. */ diff --git a/include/git2/index.h b/include/git2/index.h index 6a42c8515..0fb0f955a 100644 --- a/include/git2/index.h +++ b/include/git2/index.h @@ -295,7 +295,7 @@ GIT_EXTERN(const git_index_entry_unmerged *) git_index_get_unmerged_byindex(git_ /** * Return the stage number from a git index entry * - * This entry is calculated from the entrie's flag + * This entry is calculated from the entry's flag * attribute like this: * * (entry->flags & GIT_IDXENTRY_STAGEMASK) >> GIT_IDXENTRY_STAGESHIFT diff --git a/include/git2/indexer.h b/include/git2/indexer.h index 14bd0e402..626377701 100644 --- a/include/git2/indexer.h +++ b/include/git2/indexer.h @@ -28,7 +28,7 @@ typedef struct git_indexer_stream git_indexer_stream; /** * Create a new streaming indexer instance * - * @param out where to store the inexer instance + * @param out where to store the indexer instance * @param path to the gitdir (metadata directory) */ GIT_EXTERN(int) git_indexer_stream_new(git_indexer_stream **out, const char *gitdir); diff --git a/include/git2/object.h b/include/git2/object.h index 9e988b7b6..414325121 100644 --- a/include/git2/object.h +++ b/include/git2/object.h @@ -21,7 +21,7 @@ GIT_BEGIN_DECL /** - * Lookup a reference to one of the objects in a repostory. + * Lookup a reference to one of the objects in a repository. * * The generated reference is owned by the repository and * should be closed with the `git_object_free` method @@ -45,7 +45,7 @@ GIT_EXTERN(int) git_object_lookup( git_otype type); /** - * Lookup a reference to one of the objects in a repostory, + * Lookup a reference to one of the objects in a repository, * given a prefix of its identifier (short id). * * The object obtained will be so that its identifier @@ -114,7 +114,7 @@ GIT_EXTERN(git_repository *) git_object_owner(const git_object *obj); * This method instructs the library to close an existing * object; note that git_objects are owned and cached by the repository * so the object may or may not be freed after this library call, - * depending on how agressive is the caching mechanism used + * depending on how aggressive is the caching mechanism used * by the repository. * * IMPORTANT: diff --git a/include/git2/odb.h b/include/git2/odb.h index 1df193389..e2443178c 100644 --- a/include/git2/odb.h +++ b/include/git2/odb.h @@ -62,7 +62,7 @@ GIT_EXTERN(int) git_odb_open(git_odb **out, const char *objects_dir); * @param odb database to add the backend to * @param backend pointer to a git_odb_backend instance * @param priority Value for ordering the backends queue - * @return 0 on sucess; error code otherwise + * @return 0 on success; error code otherwise */ GIT_EXTERN(int) git_odb_add_backend(git_odb *odb, git_odb_backend *backend, int priority); @@ -83,7 +83,7 @@ GIT_EXTERN(int) git_odb_add_backend(git_odb *odb, git_odb_backend *backend, int * @param odb database to add the backend to * @param backend pointer to a git_odb_backend instance * @param priority Value for ordering the backends queue - * @return 0 on sucess; error code otherwise + * @return 0 on success; error code otherwise */ GIT_EXTERN(int) git_odb_add_alternate(git_odb *odb, git_odb_backend *backend, int priority); @@ -185,7 +185,7 @@ GIT_EXTERN(int) git_odb_exists(git_odb *db, const git_oid *id); * * @param oid pointer to store the OID result of the write * @param odb object database where to store the object - * @param data buffer with the data to storr + * @param data buffer with the data to store * @param len size of the buffer * @param type type of the data to store * @return 0 or an error code @@ -250,7 +250,7 @@ GIT_EXTERN(int) git_odb_open_rstream(git_odb_stream **stream, git_odb *db, const /** * Determine the object-ID (sha1 hash) of a data buffer * - * The resulting SHA-1 OID will the itentifier for the data + * The resulting SHA-1 OID will be the identifier for the data * buffer as if the data buffer it were to written to the ODB. * * @param id the resulting object-ID. diff --git a/include/git2/oid.h b/include/git2/oid.h index c06458d24..a05b40a37 100644 --- a/include/git2/oid.h +++ b/include/git2/oid.h @@ -84,7 +84,7 @@ GIT_EXTERN(void) git_oid_fmt(char *str, const git_oid *oid); * Format a git_oid into a loose-object path string. * * The resulting string is "aa/...", where "aa" is the first two - * hex digitis of the oid and "..." is the remaining 38 digits. + * hex digits of the oid and "..." is the remaining 38 digits. * * @param str output hex string; must be pointing at the start of * the hex sequence and have at least the number of bytes diff --git a/include/git2/refs.h b/include/git2/refs.h index 882e32769..2918215aa 100644 --- a/include/git2/refs.h +++ b/include/git2/refs.h @@ -124,7 +124,7 @@ GIT_EXTERN(const char *) git_reference_name(git_reference *ref); /** * Resolve a symbolic reference * - * Thie method iteratively peels a symbolic reference + * This method iteratively peels a symbolic reference * until it resolves to a direct reference to an OID. * * The peeled reference is returned in the `resolved_ref` @@ -293,7 +293,7 @@ GIT_EXTERN(int) git_reference_is_packed(git_reference *ref); * * Reference pointers may become outdated if the Git * repository is accessed simultaneously by other clients - * whilt the library is open. + * while the library is open. * * This method forces a reload of the reference from disk, * to ensure that the provided information is still diff --git a/include/git2/remote.h b/include/git2/remote.h index 865dfef04..7a032dbce 100644 --- a/include/git2/remote.h +++ b/include/git2/remote.h @@ -37,7 +37,7 @@ GIT_BEGIN_DECL * this when you have a URL instead of a remote's name. * * @param out pointer to the new remote object - * @param repo the associtated repository + * @param repo the associated repository * @param name the remote's name * @param url the remote repository's URL * @param fetch the fetch refspec to use for this remote @@ -100,7 +100,7 @@ GIT_EXTERN(const git_refspec *) git_remote_fetchspec(git_remote *remote); * Set the remote's push refspec * * @param remote the remote - * @apram spec the new push refspec + * @param spec the new push refspec * @return 0 or an error value */ GIT_EXTERN(int) git_remote_set_pushspec(git_remote *remote, const char *spec); @@ -149,7 +149,7 @@ GIT_EXTERN(int) git_remote_ls(git_remote *remote, git_headlist_cb list_cb, void * filename will be NULL and the function will return success. * * @param remote the remote to download from - * @param filename where to store the temproray filename + * @param filename where to store the temporary filename * @return 0 or an error code */ GIT_EXTERN(int) git_remote_download(git_remote *remote, git_off_t *bytes, git_indexer_stats *stats); @@ -195,7 +195,7 @@ GIT_EXTERN(int) git_remote_update_tips(git_remote *remote, int (*cb)(const char /** * Return whether a string is a valid remote URL * - * @param tranport the url to check + * @param url the url to check * @param 1 if the url is valid, 0 otherwise */ GIT_EXTERN(int) git_remote_valid_url(const char *url); diff --git a/include/git2/repository.h b/include/git2/repository.h index 3949438cf..0b56a0870 100644 --- a/include/git2/repository.h +++ b/include/git2/repository.h @@ -130,7 +130,7 @@ GIT_EXTERN(int) git_repository_head(git_reference **head_out, git_repository *re * instead of a branch. * * @param repo Repo to test - * @return 1 if HEAD is detached, 0 if i'ts not; error code if there + * @return 1 if HEAD is detached, 0 if it's not; error code if there * was an error. */ GIT_EXTERN(int) git_repository_head_detached(git_repository *repo); @@ -143,7 +143,7 @@ GIT_EXTERN(int) git_repository_head_detached(git_repository *repo); * * @param repo Repo to test * @return 1 if the current branch is an orphan, 0 if it's not; error - * code if therewas an error + * code if there was an error */ GIT_EXTERN(int) git_repository_head_orphan(git_repository *repo); diff --git a/include/git2/revwalk.h b/include/git2/revwalk.h index aac6fb7c2..2e9dc421a 100644 --- a/include/git2/revwalk.h +++ b/include/git2/revwalk.h @@ -104,7 +104,7 @@ GIT_EXTERN(int) git_revwalk_push(git_revwalk *walk, const git_oid *oid); /** * Push matching references * - * The OIDs pinted to by the references that match the given glob + * The OIDs pointed to by the references that match the given glob * pattern will be pushed to the revision walker. * * A leading 'refs/' is implied it not present as well as a trailing @@ -142,7 +142,7 @@ GIT_EXTERN(int) git_revwalk_hide(git_revwalk *walk, const git_oid *oid); /** * Hide matching references. * - * The OIDs pinted to by the references that match the given glob + * The OIDs pointed to by the references that match the given glob * pattern and their ancestors will be hidden from the output on the * revision walk. * @@ -169,7 +169,7 @@ GIT_EXTERN(int) git_revwalk_hide_head(git_revwalk *walk); * The reference must point to a commit. * * @param walk the walker being used for the traversal - * @param refname the referece to push + * @param refname the reference to push * @return 0 or an error code */ GIT_EXTERN(int) git_revwalk_push_ref(git_revwalk *walk, const char *refname); @@ -180,7 +180,7 @@ GIT_EXTERN(int) git_revwalk_push_ref(git_revwalk *walk, const char *refname); * The reference must point to a commit. * * @param walk the walker being used for the traversal - * @param refname the referece to hide + * @param refname the reference to hide * @return 0 or an error code */ GIT_EXTERN(int) git_revwalk_hide_ref(git_revwalk *walk, const char *refname); diff --git a/include/git2/submodule.h b/include/git2/submodule.h index 930168275..f65911a3b 100644 --- a/include/git2/submodule.h +++ b/include/git2/submodule.h @@ -83,7 +83,7 @@ GIT_EXTERN(int) git_submodule_foreach( /** * Lookup submodule information by name or path. * - * Given either the submodule name or path (they are ususally the same), + * Given either the submodule name or path (they are usually the same), * this returns a structure describing the submodule. If the submodule * does not exist, this will return GIT_ENOTFOUND and set the submodule * pointer to NULL. diff --git a/include/git2/tag.h b/include/git2/tag.h index 859c28995..13dc145b6 100644 --- a/include/git2/tag.h +++ b/include/git2/tag.h @@ -181,7 +181,7 @@ GIT_EXTERN(int) git_tag_create( * @param repo Repository where to store the tag * @param buffer Raw tag data * @param force Overwrite existing tags - * @return 0 on sucess; error code otherwise + * @return 0 on success; error code otherwise */ GIT_EXTERN(int) git_tag_create_frombuffer( git_oid *oid, diff --git a/include/git2/tree.h b/include/git2/tree.h index 777f8ff0d..8f62e752a 100644 --- a/include/git2/tree.h +++ b/include/git2/tree.h @@ -178,7 +178,7 @@ GIT_EXTERN(int) git_tree_create_fromindex(git_oid *oid, git_index *index); * * @param builder_p Pointer where to store the tree builder * @param source Source tree to initialize the builder (optional) - * @return 0 on sucess; error code otherwise + * @return 0 on success; error code otherwise */ GIT_EXTERN(int) git_treebuilder_create(git_treebuilder **builder_p, const git_tree *source); @@ -302,7 +302,7 @@ enum git_treewalk_mode { * data itself. * * If the callback returns a negative value, the passed entry - * will be skiped on the traversal. + * will be skipped on the traversal. * * @param tree The tree to walk * @param callback Function to call on each tree entry |