generated docs

1 files changed, 1 insertions, 0 deletions

diff --git a/v0.3.0.json b/v0.3.0.json
new file mode 100644
index 000000000..ea67e6c24
--- /dev/null
+++ b/v0.3.0.json
@@ -0,0 +1 @@
+{"functions":{"git_tag_set_target":{"comments":"","file":"tag.h","argline":"git_tag *tag, git_object *target","group":"tag","lineto":120,"description":"Set the target of a tag (i.e. the object that the tag points to)","rawComments":"\n Set the target of a tag (i.e. the object that the tag points to)\n @param tag The tag to modify\n @param target the new tagged target\n\n","args":[{"type":"git_tag *","comment":"The tag to modify","name":"tag"},{"type":"git_object *","comment":"the new tagged target","name":"target"}],"sig":"git_tag *::git_object *","line":115,"return":{"type":"void","comment":""}},"git_tree_remove_entry_byname":{"comments":"This will mark the tree as modified; the modified entry will\n be written back to disk on the next git_object_write()","file":"tree.h","argline":"git_tree *tree, const char *filename","group":"tree","lineto":205,"description":"Remove an entry by its filename.","rawComments":"\n Remove an entry by its filename.\n\n This will mark the tree as modified; the modified entry will\n be written back to disk on the next git_object_write()\n\n @param tree Tree where to remove the entry\n @param filename File name of the entry\n @return 0 on successful removal; GIT_ENOTFOUND if the entry wasn't found\n\n","args":[{"type":"git_tree *","comment":"Tree where to remove the entry","name":"tree"},{"type":"const char *","comment":"File name of the entry","name":"filename"}],"sig":"git_tree *::const char *","line":195,"return":{"type":"int","comment":"0 on successful removal; GIT_ENOTFOUND if the entry wasn't found"}},"git_tree_entry_attributes":{"comments":"","file":"tree.h","argline":"git_tree_entry *entry","group":"tree","lineto":109,"description":"Get the UNIX file attributes of a tree entry","rawComments":"\n Get the UNIX file attributes of a tree entry\n @param entry a tree entry\n @return attributes as an integer\n\n","args":[{"type":"git_tree_entry *","comment":"a tree entry","name":"entry"}],"sig":"git_tree_entry *","line":104,"return":{"type":"unsigned int","comment":"attributes as an integer"}},"git_tree_new":{"comments":"The tree object must be manually filled using\n setter methods before it can be written to its\n repository.","file":"tree.h","argline":"git_tree **tree, git_repository *repo","group":"tree","lineto":71,"description":"Create a new in-memory git_tree.","rawComments":"\n Create a new in-memory git_tree.\n\n The tree object must be manually filled using\n setter methods before it can be written to its\n repository.\n\n @param tree pointer to the new tree\n @param repo The repository where the object will reside\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_tree **","comment":"pointer to the new tree","name":"tree"},{"type":"git_repository *","comment":"The repository where the object will reside","name":"repo"}],"sig":"git_tree **::git_repository *","line":57,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_commit_parentcount":{"comments":"","file":"commit.h","argline":"git_commit *commit","group":"commit","lineto":136,"description":"Get the number of parents of this commit","rawComments":"\n Get the number of parents of this commit\n\n @param commit a previously loaded commit.\n @return integer of count of parents\n\n","args":[{"type":"git_commit *","comment":"a previously loaded commit.","name":"commit"}],"sig":"git_commit *","line":130,"return":{"type":"unsigned int","comment":"integer of count of parents"}},"git_oid_mkstr":{"comments":"","file":"oid.h","argline":"git_oid *out, const char *str","group":"oid","lineto":60,"description":"Parse a hex formatted object id into a git_oid.","rawComments":"\n Parse a hex formatted object id into a git_oid.\n @param out oid structure the result is written into.\n @param str input hex string; must be pointing at the start of\n        the hex sequence and have at least the number of bytes\n        needed for an oid encoded in hex (40 bytes).\n @return GIT_SUCCESS if valid; GIT_ENOTOID on failure.\n\n","args":[{"type":"git_oid *","comment":"oid structure the result is written into.","name":"out"},{"type":"const char *","comment":"input hex string; must be pointing at the start of         the hex sequence and have at least the number of bytes         needed for an oid encoded in hex (40 bytes).","name":"str"}],"sig":"git_oid *::const char *","line":52,"return":{"type":"int","comment":"GIT_SUCCESS if valid; GIT_ENOTOID on failure."}},"git_tree_lookup":{"comments":"","file":"tree.h","argline":"git_tree **tree, git_repository *repo, const git_oid *id","group":"tree","lineto":55,"description":"Lookup a tree object from the repository. The generated tree object is owned by the revision repo and shall not be freed by the user.","rawComments":"\n Lookup a tree object from the repository.\n The generated tree object is owned by the revision\n repo and shall not be freed by the user.\n\n @param tree pointer to the looked up tree\n @param repo the repo to use when locating the tree.\n @param id identity of the tree to locate.\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_tree **","comment":"pointer to the looked up tree","name":"tree"},{"type":"git_repository *","comment":"the repo to use when locating the tree.","name":"repo"},{"type":"const git_oid *","comment":"identity of the tree to locate.","name":"id"}],"sig":"git_tree **::git_repository *::const git_oid *","line":42,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_tag_set_message":{"comments":"","file":"tag.h","argline":"git_tag *tag, const char *message","group":"tag","lineto":141,"description":"Set the message of a tag","rawComments":"\n Set the message of a tag\n @param tag The tag to modify\n @param message the new tagger for the tag\n\n","args":[{"type":"git_tag *","comment":"The tag to modify","name":"tag"},{"type":"const char *","comment":"the new tagger for the tag","name":"message"}],"sig":"git_tag *::const char *","line":136,"return":{"type":"void","comment":""}},"git_tag_set_tagger":{"comments":"","file":"tag.h","argline":"git_tag *tag, const git_signature *tagger_sig","group":"tag","lineto":134,"description":"Set the tagger of a tag","rawComments":"\n Set the tagger of a tag\n @param tag The tag to modify\n @param tagger_sig signature of the tagging action\n\n","args":[{"type":"git_tag *","comment":"The tag to modify","name":"tag"},{"type":"const git_signature *","comment":"signature of the tagging action","name":"tagger_sig"}],"sig":"git_tag *::const git_signature *","line":129,"return":{"type":"void","comment":""}},"git_odb_open":{"comments":"- git_odb_backend_loose: read and write loose object files\n\t\tfrom disk, assuming `objects_dir` as the Objects folder\n\n\t- git_odb_backend_pack: read objects from packfiles,\n\t\tassuming `objects_dir` as the Objects folder which\n\t\tcontains a 'pack/' folder with the corresponding data","file":"odb.h","argline":"git_odb **out, const char *objects_dir","group":"odb","lineto":71,"description":"Create a new object database and automatically add the two default backends:","rawComments":"\n Create a new object database and automatically add\n the two default backends:\n\n\t- git_odb_backend_loose: read and write loose object files\n\t\tfrom disk, assuming `objects_dir` as the Objects folder\n\n\t- git_odb_backend_pack: read objects from packfiles,\n\t\tassuming `objects_dir` as the Objects folder which\n\t\tcontains a 'pack/' folder with the corresponding data\n\n @param out location to store the database pointer, if opened.\n            Set to NULL if the open failed.\n @param objects_dir path of the backends' \"objects\" directory.\n @return GIT_SUCCESS if the database opened; otherwise an error\n         code describing why the open was not possible.\n\n","args":[{"type":"git_odb **","comment":"location to store the database pointer, if opened.             Set to NULL if the open failed.","name":"out"},{"type":"const char *","comment":"path of the backends' \"objects\" directory.","name":"objects_dir"}],"sig":"git_odb **::const char *","line":54,"return":{"type":"int","comment":"GIT_SUCCESS if the database opened; otherwise an error          code describing why the open was not possible."}},"git_reference_set_target":{"comments":"This converts the reference into a symbolic\n reference.\n\n This marks the reference as modified; changes\n won't take effect until it is manually written back\n to disk.","file":"refs.h","argline":"git_reference *ref, const char *target","group":"reference","lineto":156,"description":"Set the target reference of a reference.","rawComments":"\n Set the target reference of a reference.\n\n This converts the reference into a symbolic\n reference.\n\n This marks the reference as modified; changes\n won't take effect until it is manually written back\n to disk.\n\n @param ref The reference\n @param target The new target for the reference\n\n","args":[{"type":"git_reference *","comment":"The reference","name":"ref"},{"type":"const char *","comment":"The new target for the reference","name":"target"}],"sig":"git_reference *::const char *","line":143,"return":{"type":"void","comment":""}},"git_commit_message":{"comments":"","file":"commit.h","argline":"git_commit *commit","group":"commit","lineto":93,"description":"Get the full message of a commit.","rawComments":"\n Get the full message of a commit.\n @param commit a previously loaded commit.\n @return the message of a commit\n\n","args":[{"type":"git_commit *","comment":"a previously loaded commit.","name":"commit"}],"sig":"git_commit *","line":88,"return":{"type":"const char *","comment":"the message of a commit"}},"git_tree_entry_set_attributes":{"comments":"This will mark the tree that contains the entry as modified;\n the modified entry will be written back to disk on the next git_object_write()\n\n @param oid new attributes for the entry","file":"tree.h","argline":"git_tree_entry *entry, int attr","group":"tree","lineto":248,"description":"Change the attributes of a tree entry.","rawComments":"\n Change the attributes of a tree entry.\n\n This will mark the tree that contains the entry as modified;\n the modified entry will be written back to disk on the next git_object_write()\n\n @param entry Entry object which will be modified\n @param oid new attributes for the entry\n\n","args":[{"type":"git_tree_entry *","comment":"Entry object which will be modified","name":"entry"},{"type":"int","comment":"","name":"attr"}],"sig":"git_tree_entry *::int","line":239,"return":{"type":"void","comment":""}},"git_tree_add_entry_unsorted":{"comments":"This will mark the tree as modified; the new entry will\n be written back to disk on the next git_object_write()\n\n @iparam id OID for the tree entry","file":"tree.h","argline":"git_tree_entry **entry, git_tree *tree, const git_oid *id, const char *filename, int attributes","group":"tree","lineto":166,"description":"Add a new entry to a tree, returning that new entry. The only difference with this call is that it does not sort tree afterwards, this requirement is left to the caller.","rawComments":"\n Add a new entry to a tree, returning that new entry.\n The only difference with this call is that it does not sort\n tree afterwards, this requirement is left to the caller.\n\n This will mark the tree as modified; the new entry will\n be written back to disk on the next git_object_write()\n\n @param entry Entry object which will be created\n @param tree Tree object to store the entry\n @iparam id OID for the tree entry\n @param filename Filename for the tree entry\n @param attributes UNIX file attributes for the entry\n @return 0 on success; otherwise error code\n\n","args":[{"type":"git_tree_entry **","comment":"Entry object which will be created","name":"entry"},{"type":"git_tree *","comment":"Tree object to store the entry","name":"tree"},{"type":"const git_oid *","comment":"","name":"id"},{"type":"const char *","comment":"Filename for the tree entry","name":"filename"},{"type":"int","comment":"UNIX file attributes for the entry","name":"attributes"}],"sig":"git_tree_entry **::git_tree *::const git_oid *::const char *::int","line":151,"return":{"type":"int","comment":"0 on success; otherwise error code"}},"git_rawobj_hash":{"comments":"The input obj must be a valid loose object type and the data\n pointer must not be NULL, unless the len field is also zero.\n\n @return\n - GIT_SUCCESS if the object-ID was correctly determined.\n - GIT_ERROR if the given object is malformed.","file":"odb.h","argline":"git_oid *id, git_rawobj *obj","group":"rawobj","lineto":169,"description":"Determine the object-ID (sha1 hash) of the given git_rawobj.","rawComments":"\n Determine the object-ID (sha1 hash) of the given git_rawobj.\n\n The input obj must be a valid loose object type and the data\n pointer must not be NULL, unless the len field is also zero.\n\n @param id the resulting object-ID.\n @param obj the object whose hash is to be determined.\n @return\n - GIT_SUCCESS if the object-ID was correctly determined.\n - GIT_ERROR if the given object is malformed.\n\n","args":[{"type":"git_oid *","comment":"the resulting object-ID.","name":"id"},{"type":"git_rawobj *","comment":"the object whose hash is to be determined.","name":"obj"}],"sig":"git_oid *::git_rawobj *","line":157,"return":{"type":"int","comment":""}},"git_commit_time_offset":{"comments":"","file":"commit.h","argline":"git_commit *commit","group":"commit","lineto":107,"description":"Get the commit timezone offset (i.e. committer's preferred timezone) of a commit.","rawComments":"\n Get the commit timezone offset (i.e. committer's preferred timezone) of a commit.\n @param commit a previously loaded commit.\n @return positive or negative timezone offset, in minutes from UTC\n\n","args":[{"type":"git_commit *","comment":"a previously loaded commit.","name":"commit"}],"sig":"git_commit *","line":102,"return":{"type":"int","comment":"positive or negative timezone offset, in minutes from UTC"}},"git_revwalk_free":{"comments":"","file":"revwalk.h","argline":"git_revwalk *walk","group":"revwalk","lineto":123,"description":"Free a revwalk previously allocated.","rawComments":"\n Free a revwalk previously allocated.\n @param walk traversal handle to close.  If NULL nothing occurs.\n\n","args":[{"type":"git_revwalk *","comment":"traversal handle to close.  If NULL nothing occurs.","name":"walk"}],"sig":"git_revwalk *","line":119,"return":{"type":"void","comment":""}},"git_commit_set_tree":{"comments":"","file":"commit.h","argline":"git_commit *commit, git_tree *tree","group":"commit","lineto":180,"description":"Set the tree which is pointed to by a commit","rawComments":"\n Set the tree which is pointed to by a commit\n @param commit the commit object\n @param tree the new tree\n\n","args":[{"type":"git_commit *","comment":"the commit object","name":"commit"},{"type":"git_tree *","comment":"the new tree","name":"tree"}],"sig":"git_commit *::git_tree *","line":175,"return":{"type":"void","comment":""}},"git_revwalk_new":{"comments":"","file":"revwalk.h","argline":"git_revwalk **walker, git_repository *repo","group":"revwalk","lineto":76,"description":"Allocate a new revision walker to iterate through a repo.","rawComments":"\n Allocate a new revision walker to iterate through a repo.\n\n @param walker pointer to the new revision walker\n @param repo the repo to walk through\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_revwalk **","comment":"pointer to the new revision walker","name":"walker"},{"type":"git_repository *","comment":"the repo to walk through","name":"repo"}],"sig":"git_revwalk **::git_repository *","line":69,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_signature_new":{"comments":"@name name of the person\n @email email of the person\n @time time when the action happened\n @offset timezone offset in minutes for the time","file":"signature.h","argline":"const char *name, const char *email, time_t time, int offset","group":"signature","lineto":50,"description":"Create a new action signature. The signature must be freed manually or using git_signature_free","rawComments":"\n Create a new action signature. The signature must be freed\n manually or using git_signature_free\n\n @name name of the person\n @email email of the person\n @time time when the action happened\n @offset timezone offset in minutes for the time\n @return the new sig, NULl on out of memory\n\n","args":[{"type":"const char *","comment":"","name":"name"},{"type":"const char *","comment":"","name":"email"},{"type":"time_t","comment":"","name":"time"},{"type":"int","comment":"","name":"offset"}],"sig":"const char *::const char *::time_t::int","line":40,"return":{"type":"git_signature *","comment":"the new sig, NULl on out of memory"}},"git_oid_cmp":{"comments":"","file":"oid.h","argline":"const git_oid *a, const git_oid *b","group":"oid","lineto":133,"description":"Compare two oid structures.","rawComments":"\n Compare two oid structures.\n @param a first oid structure.\n @param b second oid structure.\n @return <0, 0, >0 if a < b, a == b, a > b.\n\n","args":[{"type":"const git_oid *","comment":"first oid structure.","name":"a"},{"type":"const git_oid *","comment":"second oid structure.","name":"b"}],"sig":"const git_oid *::const git_oid *","line":127,"return":{"type":"int","comment":"<0, 0, >0 if a < b, a == b, a > b."}},"git_signature_dup":{"comments":"All internal strings are also duplicated.\n @sig signature to duplicated","file":"signature.h","argline":"const git_signature *sig","group":"signature","lineto":59,"description":"Create a copy of an existing signature.","rawComments":"\n Create a copy of an existing signature.\n\n All internal strings are also duplicated.\n @sig signature to duplicated\n @return a copy of sig, NULL on out of memory\n\n","args":[{"type":"const git_signature *","comment":"","name":"sig"}],"sig":"const git_signature *","line":52,"return":{"type":"git_signature *","comment":"a copy of sig, NULL on out of memory"}},"git_repository_index":{"comments":"This is a cheap operation; the index is only opened on the first call,\n and subsequent calls only retrieve the previous pointer.","file":"repository.h","argline":"git_index **index, git_repository *repo","group":"repository","lineto":173,"description":"Get the Index file of a Git repository","rawComments":"\n Get the Index file of a Git repository\n\n This is a cheap operation; the index is only opened on the first call,\n and subsequent calls only retrieve the previous pointer.\n\n @param index Pointer where to store the index\n @param repo a repository object\n @return 0 on success; error code if the index could not be opened\n\n","args":[{"type":"git_index **","comment":"Pointer where to store the index","name":"index"},{"type":"git_repository *","comment":"a repository object","name":"repo"}],"sig":"git_index **::git_repository *","line":163,"return":{"type":"int","comment":"0 on success; error code if the index could not be opened"}},"git_tag_name":{"comments":"","file":"tag.h","argline":"git_tag *t","group":"tag","lineto":99,"description":"Get the name of a tag @param tag a previously loaded tag.","rawComments":"\n Get the name of a tag\n @param tag a previously loaded tag.\n @return name of the tag\n\n","args":[{"type":"git_tag *","comment":"","name":"t"}],"sig":"git_tag *","line":94,"return":{"type":"const char *","comment":"name of the tag"}},"git_blob_rawcontent":{"comments":"A pointer to the raw content of a blob is returned;\n this pointer is owned internally by the object and shall\n not be free'd. The pointer may be invalidated at a later\n time (e.g. when changing the contents of the blob).","file":"blob.h","argline":"git_blob *blob","group":"blob","lineto":105,"description":"Get a read-only buffer with the raw content of a blob.","rawComments":"\n Get a read-only buffer with the raw content of a blob.\n\n A pointer to the raw content of a blob is returned;\n this pointer is owned internally by the object and shall\n not be free'd. The pointer may be invalidated at a later\n time (e.g. when changing the contents of the blob).\n\n @param blob pointer to the blob\n @return the pointer; NULL if the blob has no contents\n\n","args":[{"type":"git_blob *","comment":"pointer to the blob","name":"blob"}],"sig":"git_blob *","line":94,"return":{"type":"const char *","comment":"the pointer; NULL if the blob has no contents"}},"git_tree_add_entry":{"comments":"This will mark the tree as modified; the new entry will\n be written back to disk on the next git_object_write()\n\n @iparam id OID for the tree entry","file":"tree.h","argline":"git_tree_entry **entry_out, git_tree *tree, const git_oid *id, const char *filename, int attributes","group":"tree","lineto":149,"description":"Add a new entry to a tree and return the new entry.","rawComments":"\n Add a new entry to a tree and return the new entry.\n\n This will mark the tree as modified; the new entry will\n be written back to disk on the next git_object_write()\n\n @param entry_out Pointer to the entry that just got\n\tcreated. May be NULL if you are not interested on\n\tgetting the new entry\n @param tree Tree object to store the entry\n @iparam id OID for the tree entry\n @param filename Filename for the tree entry\n @param attributes UNIX file attributes for the entry\n @return 0 on success; otherwise error code\n\n","args":[{"type":"git_tree_entry **","comment":"Pointer to the entry that just got  created. May be NULL if you are not interested on  getting the new entry","name":"entry_out"},{"type":"git_tree *","comment":"Tree object to store the entry","name":"tree"},{"type":"const git_oid *","comment":"","name":"id"},{"type":"const char *","comment":"Filename for the tree entry","name":"filename"},{"type":"int","comment":"UNIX file attributes for the entry","name":"attributes"}],"sig":"git_tree_entry **::git_tree *::const git_oid *::const char *::int","line":134,"return":{"type":"int","comment":"0 on success; otherwise error code"}},"git_object_typeisloose":{"comments":"","file":"object.h","argline":"git_otype type","group":"object","lineto":127,"description":"Determine if the given git_otype is a valid loose object type.","rawComments":"\n Determine if the given git_otype is a valid loose object type.\n\n @param type object type to test.\n @return true if the type represents a valid loose object type,\n false otherwise.\n\n","args":[{"type":"git_otype","comment":"object type to test.","name":"type"}],"sig":"git_otype","line":120,"return":{"type":"int","comment":"true if the type represents a valid loose object type,  false otherwise."}},"git_revwalk_repository":{"comments":"","file":"revwalk.h","argline":"git_revwalk *walk","group":"revwalk","lineto":132,"description":"Return the repository on which this walker is operating.","rawComments":"\n Return the repository on which this walker\n is operating.\n\n @param walk the revision walker\n @return the repository being walked\n\n","args":[{"type":"git_revwalk *","comment":"the revision walker","name":"walk"}],"sig":"git_revwalk *","line":125,"return":{"type":"git_repository *","comment":"the repository being walked"}},"git_tree_clear_entries":{"comments":"This will mark the tree as modified; the modified entry will\n be written back to disk on the next git_object_write().","file":"tree.h","argline":"git_tree *tree","group":"tree","lineto":215,"description":"Clear all the entries in a tree.","rawComments":"\n Clear all the entries in a tree.\n\n This will mark the tree as modified; the modified entry will\n be written back to disk on the next git_object_write().\n\n @param tree Tree object whose entries are to be sorted\n\n","args":[{"type":"git_tree *","comment":"Tree object whose entries are to be sorted","name":"tree"}],"sig":"git_tree *","line":207,"return":{"type":"void","comment":""}},"git_reference_type":{"comments":"Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC)","file":"refs.h","argline":"git_reference *ref","group":"reference","lineto":82,"description":"Get the type of a reference","rawComments":"\n Get the type of a reference\n\n Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC)\n\n @param ref The reference\n @return the type\n\n","args":[{"type":"git_reference *","comment":"The reference","name":"ref"}],"sig":"git_reference *","line":74,"return":{"type":"git_rtype","comment":"the type"}},"git_revwalk_hide":{"comments":"","file":"revwalk.h","argline":"git_revwalk *walk, git_commit *commit","group":"revwalk","lineto":98,"description":"Mark a commit (and its ancestors) uninteresting for the output. @param walker the walker being used for the traversal.","rawComments":"\n Mark a commit (and its ancestors) uninteresting for the output.\n @param walker the walker being used for the traversal.\n @param commit the commit that will be ignored during the traversal\n\n","args":[{"type":"git_revwalk *","comment":"","name":"walk"},{"type":"git_commit *","comment":"the commit that will be ignored during the traversal","name":"commit"}],"sig":"git_revwalk *::git_commit *","line":93,"return":{"type":"int","comment":""}},"git_object_id":{"comments":"In-memory objects created by git_object_new() do not\n have a SHA1 ID until they are written on a repository.","file":"object.h","argline":"git_object *obj","group":"object","lineto":69,"description":"Get the id (SHA1) of a repository object","rawComments":"\n Get the id (SHA1) of a repository object\n\n In-memory objects created by git_object_new() do not\n have a SHA1 ID until they are written on a repository.\n\n @param obj the repository object\n @return the SHA1 id\n\n","args":[{"type":"git_object *","comment":"the repository object","name":"obj"}],"sig":"git_object *","line":60,"return":{"type":"const git_oid *","comment":"the SHA1 id"}},"git_reference_oid":{"comments":"Only available if the reference is direct (i.e. not symbolic)","file":"refs.h","argline":"git_reference *ref","group":"reference","lineto":62,"description":"Get the OID pointed to by a reference.","rawComments":"\n Get the OID pointed to by a reference.\n\n Only available if the reference is direct (i.e. not symbolic)\n\n @param ref The reference\n @return a pointer to the oid if available, NULL otherwise\n\n","args":[{"type":"git_reference *","comment":"The reference","name":"ref"}],"sig":"git_reference *","line":54,"return":{"type":"const git_oid *","comment":"a pointer to the oid if available, NULL otherwise"}},"git_commit_set_committer":{"comments":"","file":"commit.h","argline":"git_commit *commit, const git_signature *committer_sig","group":"commit","lineto":166,"description":"Set the committer of a commit @param author_sig signature of the committer","rawComments":"\n Set the committer of a commit\n @param commit the commit object\n @param author_sig signature of the committer\n\n","args":[{"type":"git_commit *","comment":"the commit object","name":"commit"},{"type":"const git_signature *","comment":"","name":"committer_sig"}],"sig":"git_commit *::const git_signature *","line":161,"return":{"type":"void","comment":""}},"git_reference_write":{"comments":"The reference must have a valid name and a valid target\n (either direct or symbolic).\n\n If the reference has been loaded from disk and no changes\n have been made, no action will take place.\n\n The writing to disk is atomic.","file":"refs.h","argline":"git_reference *ref","group":"reference","lineto":121,"description":"Write a reference back to disk.","rawComments":"\n Write a reference back to disk.\n\n The reference must have a valid name and a valid target\n (either direct or symbolic).\n\n If the reference has been loaded from disk and no changes\n have been made, no action will take place.\n\n The writing to disk is atomic.\n\n @param ref The reference\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_reference *","comment":"The reference","name":"ref"}],"sig":"git_reference *","line":107,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_reference_set_name":{"comments":"This marks the reference as modified; changes\n won't take effect until it is manually written back\n to disk.","file":"refs.h","argline":"git_reference *ref, const char *name","group":"reference","lineto":141,"description":"Set the name of a reference.","rawComments":"\n Set the name of a reference.\n\n This marks the reference as modified; changes\n won't take effect until it is manually written back\n to disk.\n\n @param ref The reference\n @param name The new name for the reference\n\n","args":[{"type":"git_reference *","comment":"The reference","name":"ref"},{"type":"const char *","comment":"The new name for the reference","name":"name"}],"sig":"git_reference *::const char *","line":131,"return":{"type":"void","comment":""}},"__attribute__":{"comments":"","file":"common.h","argline":"(visibility(\"default\"))","lineto":57,"description":"Declare a public TLS symbol exported for application use.","rawComments":" Declare a public TLS symbol exported for application use. ","args":[{"type":"","comment":"","name":"(visibility(\"default\"))"}],"sig":"","line":52,"return":{"type":"","comment":""}},"git_repository_newobject":{"comments":"The object's attributes can be filled in using the\n corresponding setter methods.\n\n The object will be written back to given git_repository\n when the git_object_write() function is called; objects\n cannot be written to disk until all their main\n attributes have been properly filled.\n\n Objects are instantiated with no SHA1 id; their id\n will be automatically generated when writing to the\n repository.\n\n @parem repo Repository where the object belongs","file":"repository.h","argline":"git_object **object, git_repository *repo, git_otype type","group":"repository","lineto":196,"description":"Create a new in-memory repository object with the given type.","rawComments":"\n Create a new in-memory repository object with\n the given type.\n\n The object's attributes can be filled in using the\n corresponding setter methods.\n\n The object will be written back to given git_repository\n when the git_object_write() function is called; objects\n cannot be written to disk until all their main\n attributes have been properly filled.\n\n Objects are instantiated with no SHA1 id; their id\n will be automatically generated when writing to the\n repository.\n\n @param object pointer to the new object\n @parem repo Repository where the object belongs\n @param type Type of the object to be created\n @return the new object\n\n","args":[{"type":"git_object **","comment":"pointer to the new object","name":"object"},{"type":"git_repository *","comment":"","name":"repo"},{"type":"git_otype","comment":"Type of the object to be created","name":"type"}],"sig":"git_object **::git_repository *::git_otype","line":175,"return":{"type":"int","comment":"the new object"}},"git_commit_add_parent":{"comments":"","file":"commit.h","argline":"git_commit *commit, git_commit *new_parent","group":"commit","lineto":152,"description":"Add a new parent commit to an existing commit","rawComments":"\n Add a new parent commit to an existing commit\n @param commit the commit object\n @param new_parent the new commit which will be a parent\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_commit *","comment":"the commit object","name":"commit"},{"type":"git_commit *","comment":"the new commit which will be a parent","name":"new_parent"}],"sig":"git_commit *::git_commit *","line":146,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_repository_database":{"comments":"","file":"repository.h","argline":"git_repository *repo","group":"repository","lineto":161,"description":"Get the object database behind a Git repository","rawComments":"\n Get the object database behind a Git repository\n\n @param repo a repository object\n @return a pointer to the object db\n\n","args":[{"type":"git_repository *","comment":"a repository object","name":"repo"}],"sig":"git_repository *","line":155,"return":{"type":"git_odb *","comment":"a pointer to the object db"}},"git_tree_entry_id":{"comments":"","file":"tree.h","argline":"git_tree_entry *entry","group":"tree","lineto":123,"description":"Get the id of the object pointed by the entry","rawComments":"\n Get the id of the object pointed by the entry\n @param entry a tree entry\n @return the oid of the object\n\n","args":[{"type":"git_tree_entry *","comment":"a tree entry","name":"entry"}],"sig":"git_tree_entry *","line":118,"return":{"type":"const git_oid *","comment":"the oid of the object"}},"git_odb_close":{"comments":"","file":"odb.h","argline":"git_odb *db","group":"odb","lineto":88,"description":"Close an open object database.","rawComments":"\n Close an open object database.\n @param db database pointer to close.  If NULL no action is taken.\n\n","args":[{"type":"git_odb *","comment":"database pointer to close.  If NULL no action is taken.","name":"db"}],"sig":"git_odb *","line":84,"return":{"type":"void","comment":""}},"git_tree_entry_byname":{"comments":"","file":"tree.h","argline":"git_tree *tree, const char *filename","group":"tree","lineto":94,"description":"Lookup a tree entry by its filename","rawComments":"\n Lookup a tree entry by its filename\n @param tree a previously loaded tree.\n @param filename the filename of the desired entry\n @return the tree entry; NULL if not found\n\n","args":[{"type":"git_tree *","comment":"a previously loaded tree.","name":"tree"},{"type":"const char *","comment":"the filename of the desired entry","name":"filename"}],"sig":"git_tree *::const char *","line":88,"return":{"type":"git_tree_entry *","comment":"the tree entry; NULL if not found"}},"git_repository_lookup":{"comments":"The generated reference is owned by the repository and\n should not be freed by the user.\n\n The 'type' parameter must match the type of the object\n in the odb; the method will fail otherwise.\n The special value 'GIT_OBJ_ANY' may be passed to let\n the method guess the object's type.","file":"repository.h","argline":"git_object **object, git_repository *repo, const git_oid *id, git_otype type","group":"repository","lineto":153,"description":"Lookup a reference to one of the objects in the repostory.","rawComments":"\n Lookup a reference to one of the objects in the repostory.\n\n The generated reference is owned by the repository and\n should not be freed by the user.\n\n The 'type' parameter must match the type of the object\n in the odb; the method will fail otherwise.\n The special value 'GIT_OBJ_ANY' may be passed to let\n the method guess the object's type.\n\n @param object pointer to the looked-up object\n @param repo the repository to look up the object\n @param id the unique identifier for the object\n @param type the type of the object\n @return a reference to the object\n\n","args":[{"type":"git_object **","comment":"pointer to the looked-up object","name":"object"},{"type":"git_repository *","comment":"the repository to look up the object","name":"repo"},{"type":"const git_oid *","comment":"the unique identifier for the object","name":"id"},{"type":"git_otype","comment":"the type of the object","name":"type"}],"sig":"git_object **::git_repository *::const git_oid *::git_otype","line":136,"return":{"type":"int","comment":"a reference to the object"}},"git_tag_id":{"comments":"","file":"tag.h","argline":"git_tag *tag","group":"tag","lineto":78,"description":"Get the id of a tag.","rawComments":"\n Get the id of a tag.\n @param tag a previously loaded tag.\n @return object identity for the tag.\n\n","args":[{"type":"git_tag *","comment":"a previously loaded tag.","name":"tag"}],"sig":"git_tag *","line":73,"return":{"type":"const git_oid *","comment":"object identity for the tag."}},"git_reference_target":{"comments":"Only available if the reference is symbolic","file":"refs.h","argline":"git_reference *ref","group":"reference","lineto":72,"description":"Get full name to the reference pointed by this reference","rawComments":"\n Get full name to the reference pointed by this reference\n\n Only available if the reference is symbolic\n\n @param ref The reference\n @return a pointer to the name if available, NULL otherwise\n\n","args":[{"type":"git_reference *","comment":"The reference","name":"ref"}],"sig":"git_reference *","line":64,"return":{"type":"const char *","comment":"a pointer to the name if available, NULL otherwise"}},"git_odb_add_backend":{"comments":"Read <odb_backends.h> for more information.\n\n @paramm backend pointer to a git_odb_backend instance","file":"odb.h","argline":"git_odb *odb, git_odb_backend *backend","group":"odb","lineto":82,"description":"Add a custom backend to an existing Object DB","rawComments":"\n Add a custom backend to an existing Object DB\n\n Read <odb_backends.h> for more information.\n\n @param odb database to add the backend to\n @paramm backend pointer to a git_odb_backend instance\n @return 0 on sucess; error code otherwise\n\n","args":[{"type":"git_odb *","comment":"database to add the backend to","name":"odb"},{"type":"git_odb_backend *","comment":"","name":"backend"}],"sig":"git_odb *::git_odb_backend *","line":73,"return":{"type":"int","comment":"0 on sucess; error code otherwise"}},"git_tree_sort_entries":{"comments":"This does not mark the tree as modified.  It is intended to be used\n after several invocations of git_tree_add_entry2.\n git_tree_add_entry, on the other hand, sorts after each entry is\n added.","file":"tree.h","argline":"git_tree *tree","group":"tree","lineto":179,"description":"Sort the entries in a tree created using git_tree_add_entry2.","rawComments":"\n Sort the entries in a tree created using git_tree_add_entry2.\n\n This does not mark the tree as modified.  It is intended to be used\n after several invocations of git_tree_add_entry2.\n git_tree_add_entry, on the other hand, sorts after each entry is\n added.\n\n @param tree Tree object whose entries are to be sorted\n @return 0 on success; otherwise error code\n\n","args":[{"type":"git_tree *","comment":"Tree object whose entries are to be sorted","name":"tree"}],"sig":"git_tree *","line":168,"return":{"type":"int","comment":"0 on success; otherwise error code"}},"git_repository_lookup_ref":{"comments":"The generated reference is owned by the repository and\n should not be freed by the user.\n\n TODO:\n\t- Ensure the reference name is valid","file":"repository.h","argline":"git_reference **reference_out, git_repository *repo, const char *name","group":"repository","lineto":235,"description":"Lookup a reference by its name in the repository.","rawComments":"\n Lookup a reference by its name in the repository.\n\n The generated reference is owned by the repository and\n should not be freed by the user.\n\n TODO:\n\t- Ensure the reference name is valid\n\n @param reference_out pointer to the looked-up reference\n @param repo the repository to look up the reference\n @param name the long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...)\n @return a reference to the reference\n\n","args":[{"type":"git_reference **","comment":"pointer to the looked-up reference","name":"reference_out"},{"type":"git_repository *","comment":"the repository to look up the reference","name":"repo"},{"type":"const char *","comment":"the long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...)","name":"name"}],"sig":"git_reference **::git_repository *::const char *","line":221,"return":{"type":"int","comment":"a reference to the reference"}},"git_index_insert":{"comments":"","file":"index.h","argline":"git_index *index, const git_index_entry *source_entry","group":"index","lineto":173,"description":"Insert an entry into the index. A full copy (including the 'path' string) of the given 'source_entry' will be inserted on the index; if the index already contains an entry for the same path, the entry will be updated.","rawComments":"\n Insert an entry into the index.\n A full copy (including the 'path' string) of the given\n 'source_entry' will be inserted on the index; if the index\n already contains an entry for the same path, the entry\n will be updated.\n\n @param index an existing index object\n @param source_entry new entry object\n @return 0 on success, otherwise an error code\n\n","args":[{"type":"git_index *","comment":"an existing index object","name":"index"},{"type":"const git_index_entry *","comment":"new entry object","name":"source_entry"}],"sig":"git_index *::const git_index_entry *","line":162,"return":{"type":"int","comment":"0 on success, otherwise an error code"}},"git_blob_new":{"comments":"The blob object must be manually filled using\n the 'set_rawcontent' methods before it can\n be written back to disk.","file":"blob.h","argline":"git_blob **blob, git_repository *repo","group":"blob","lineto":71,"description":"Create a new in-memory git_blob.","rawComments":"\n Create a new in-memory git_blob.\n\n The blob object must be manually filled using\n the 'set_rawcontent' methods before it can\n be written back to disk.\n\n @param blob pointer to the new blob\n @param repo The repository where the object will reside\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_blob **","comment":"pointer to the new blob","name":"blob"},{"type":"git_repository *","comment":"The repository where the object will reside","name":"repo"}],"sig":"git_blob **::git_repository *","line":57,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_object_type":{"comments":"","file":"object.h","argline":"git_object *obj","group":"object","lineto":77,"description":"Get the object type of an object","rawComments":"\n Get the object type of an object\n\n @param obj the repository object\n @return the object's type\n\n","args":[{"type":"git_object *","comment":"the repository object","name":"obj"}],"sig":"git_object *","line":71,"return":{"type":"git_otype","comment":"the object's type"}},"git_rawobj_close":{"comments":"As a result of this call, obj->data will be set to NULL.\n\n If obj->data is already NULL, nothing happens.","file":"odb.h","argline":"git_rawobj *obj","group":"rawobj","lineto":180,"description":"Release all memory used by the obj structure.","rawComments":"\n Release all memory used by the obj structure.\n\n As a result of this call, obj->data will be set to NULL.\n\n If obj->data is already NULL, nothing happens.\n\n @param obj object descriptor to free.\n\n","args":[{"type":"git_rawobj *","comment":"object descriptor to free.","name":"obj"}],"sig":"git_rawobj *","line":171,"return":{"type":"void","comment":""}},"git_blob_set_rawcontent_fromfile":{"comments":"","file":"blob.h","argline":"git_blob *blob, const char *filename","group":"blob","lineto":81,"description":"Fill a blob with the contents inside the pointed file.","rawComments":"\n Fill a blob with the contents inside\n the pointed file.\n\n @param blob pointer to the new blob\n @param filename name of the file to read\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_blob *","comment":"pointer to the new blob","name":"blob"},{"type":"const char *","comment":"name of the file to read","name":"filename"}],"sig":"git_blob *::const char *","line":73,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_index_add":{"comments":"","file":"index.h","argline":"git_index *index, const char *path, int stage","group":"index","lineto":151,"description":"Add or update an index entry from a file in disk.","rawComments":"\n Add or update an index entry from a file in disk.\n\n @param index an existing index object\n @param path filename to add\n @param stage stage for the entry\n @return 0 on success, otherwise an error code\n\n","args":[{"type":"git_index *","comment":"an existing index object","name":"index"},{"type":"const char *","comment":"filename to add","name":"path"},{"type":"int","comment":"stage for the entry","name":"stage"}],"sig":"git_index *::const char *::int","line":143,"return":{"type":"int","comment":"0 on success, otherwise an error code"}},"git_odb_backend_sqlite":{"comments":"","file":"odb_backend.h","argline":"git_odb_backend **backend_out, const char *sqlite_db","group":"odb","lineto":73,"description":"","rawComments":"","args":[{"type":"git_odb_backend **","comment":"","name":"backend_out"},{"type":"const char *","comment":"","name":"sqlite_db"}],"sig":"git_odb_backend **::const char *","line":73,"return":{"type":"int","comment":""}},"git_tag_new":{"comments":"The tag object must be manually filled using\n setter methods before it can be written to its\n repository.","file":"tag.h","argline":"git_tag **tag, git_repository *repo","group":"tag","lineto":71,"description":"Create a new in-memory git_tag.","rawComments":"\n Create a new in-memory git_tag.\n\n The tag object must be manually filled using\n setter methods before it can be written to its\n repository.\n\n @param tag pointer to the new tag\n @param repo The repository where the object will reside\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_tag **","comment":"pointer to the new tag","name":"tag"},{"type":"git_repository *","comment":"The repository where the object will reside","name":"repo"}],"sig":"git_tag **::git_repository *","line":57,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_repository_free":{"comments":"","file":"repository.h","argline":"git_repository *repo","group":"repository","lineto":202,"description":"Free a previously allocated repository","rawComments":"\n Free a previously allocated repository\n @param repo repository handle to close. If NULL nothing occurs.\n\n","args":[{"type":"git_repository *","comment":"repository handle to close. If NULL nothing occurs.","name":"repo"}],"sig":"git_repository *","line":198,"return":{"type":"void","comment":""}},"git_index_get":{"comments":"This entry can be modified, and the changes will be written\n back to disk on the next write() call.","file":"index.h","argline":"git_index *index, int n","group":"index","lineto":185,"description":"Get a pointer to one of the entries in the index","rawComments":"\n Get a pointer to one of the entries in the index\n\n This entry can be modified, and the changes will be written\n back to disk on the next write() call.\n\n @param index an existing index object\n @param n the position of the entry\n @return a pointer to the entry; NULL if out of bounds\n\n","args":[{"type":"git_index *","comment":"an existing index object","name":"index"},{"type":"int","comment":"the position of the entry","name":"n"}],"sig":"git_index *::int","line":175,"return":{"type":"git_index_entry *","comment":"a pointer to the entry; NULL if out of bounds"}},"git_oid_cpy":{"comments":"","file":"oid.h","argline":"git_oid *out, const git_oid *src","group":"oid","lineto":125,"description":"Copy an oid from one structure to another.","rawComments":"\n Copy an oid from one structure to another.\n @param out oid structure the result is written into.\n @param src oid structure to copy from.\n\n","args":[{"type":"git_oid *","comment":"oid structure the result is written into.","name":"out"},{"type":"const git_oid *","comment":"oid structure to copy from.","name":"src"}],"sig":"git_oid *::const git_oid *","line":120,"return":{"type":"void","comment":""}},"git_object_write":{"comments":"The object will be written to its corresponding\n repository.\n\n If the object has no changes since it was first\n read from the repository, no actions will take place.\n\n If the object has been modified since it was read from\n the repository, or it has been created from scratch\n in memory, it will be written to the repository and\n its SHA1 ID will be updated accordingly.","file":"object.h","argline":"git_object *object","group":"object","lineto":58,"description":"Write back an object to disk.","rawComments":"\n Write back an object to disk.\n\n The object will be written to its corresponding\n repository.\n\n If the object has no changes since it was first\n read from the repository, no actions will take place.\n\n If the object has been modified since it was read from\n the repository, or it has been created from scratch\n in memory, it will be written to the repository and\n its SHA1 ID will be updated accordingly.\n\n @param object Git object to write back\n @return 0 on success; otherwise an error code\n\n","args":[{"type":"git_object *","comment":"Git object to write back","name":"object"}],"sig":"git_object *","line":41,"return":{"type":"int","comment":"0 on success; otherwise an error code"}},"git_index_open_inrepo":{"comments":"@param index_path the path to the index file in disk","file":"index.h","argline":"git_index **index, git_repository *repo","group":"index","lineto":97,"description":"Open the Index inside the git repository pointed by 'repo'.","rawComments":"\n Open the Index inside the git repository pointed\n by 'repo'.\n\n @param repo the git repo which owns the index\n @param index_path the path to the index file in disk\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_index **","comment":"","name":"index"},{"type":"git_repository *","comment":"the git repo which owns the index","name":"repo"}],"sig":"git_index **::git_repository *","line":89,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_revwalk_next":{"comments":"","file":"revwalk.h","argline":"git_commit **commit, git_revwalk *walk","group":"revwalk","lineto":108,"description":"Get the next commit from the revision traversal.","rawComments":"\n Get the next commit from the revision traversal.\n\n @param commit Pointer where to store the next commit\n @param walk the walker to pop the commit from.\n @return GIT_SUCCESS if the next commit was found;\n\tGIT_EREVWALKOVER if there are no commits left to iterate\n\n","args":[{"type":"git_commit **","comment":"Pointer where to store the next commit","name":"commit"},{"type":"git_revwalk *","comment":"the walker to pop the commit from.","name":"walk"}],"sig":"git_commit **::git_revwalk *","line":100,"return":{"type":"int","comment":"GIT_SUCCESS if the next commit was found;  GIT_EREVWALKOVER if there are no commits left to iterate"}},"git_repository_init":{"comments":"TODO:\n\t- Reinit the repository\n\t- Create config files","file":"repository.h","argline":"git_repository **repo_out, const char *path, unsigned is_bare","group":"repository","lineto":219,"description":"Creates a new Git repository in the given folder.","rawComments":"\n Creates a new Git repository in the given folder.\n\n TODO:\n\t- Reinit the repository\n\t- Create config files\n\n @param repo_out pointer to the repo which will be created or reinitialized\n @param path the path to the repository\n @param is_bare if true, a Git repository without a working directory is created\n\t\tat the pointed path. If false, provided path will be considered as the working\n\t\tdirectory into which the .git directory will be created.\n\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_repository **","comment":"pointer to the repo which will be created or reinitialized","name":"repo_out"},{"type":"const char *","comment":"the path to the repository","name":"path"},{"type":"unsigned","comment":"if true, a Git repository without a working directory is created   at the pointed path. If false, provided path will be considered as the working   directory into which the .git directory will be created.","name":"is_bare"}],"sig":"git_repository **::const char *::unsigned","line":204,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_index_clear":{"comments":"","file":"index.h","argline":"git_index *index","group":"index","lineto":106,"description":"Clear the contents (all the entries) of an index object. This clears the index object in memory; changes must be manually written to disk for them to take effect.","rawComments":"\n Clear the contents (all the entries) of an index object.\n This clears the index object in memory; changes must be manually\n written to disk for them to take effect.\n\n @param index an existing index object\n\n","args":[{"type":"git_index *","comment":"an existing index object","name":"index"}],"sig":"git_index *","line":99,"return":{"type":"void","comment":""}},"git_tree_entrycount":{"comments":"","file":"tree.h","argline":"git_tree *tree","group":"tree","lineto":86,"description":"Get the number of entries listed in a tree","rawComments":"\n Get the number of entries listed in a tree\n @param tree a previously loaded tree.\n @return the number of entries in the tree\n\n","args":[{"type":"git_tree *","comment":"a previously loaded tree.","name":"tree"}],"sig":"git_tree *","line":81,"return":{"type":"size_t","comment":"the number of entries in the tree"}},"git_commit_time":{"comments":"","file":"commit.h","argline":"git_commit *commit","group":"commit","lineto":100,"description":"Get the commit time (i.e. committer time) of a commit.","rawComments":"\n Get the commit time (i.e. committer time) of a commit.\n @param commit a previously loaded commit.\n @return the time of a commit\n\n","args":[{"type":"git_commit *","comment":"a previously loaded commit.","name":"commit"}],"sig":"git_commit *","line":95,"return":{"type":"time_t","comment":"the time of a commit"}},"git_index_free":{"comments":"","file":"index.h","argline":"git_index *index","group":"index","lineto":113,"description":"Free an existing index object.","rawComments":"\n Free an existing index object.\n\n @param index an existing index object\n\n","args":[{"type":"git_index *","comment":"an existing index object","name":"index"}],"sig":"git_index *","line":108,"return":{"type":"void","comment":""}},"git_tag_target":{"comments":"","file":"tag.h","argline":"git_tag *t","group":"tag","lineto":85,"description":"Get the tagged object of a tag @param tag a previously loaded tag.","rawComments":"\n Get the tagged object of a tag\n @param tag a previously loaded tag.\n @return reference to a repository object\n\n","args":[{"type":"git_tag *","comment":"","name":"t"}],"sig":"git_tag *","line":80,"return":{"type":"const git_object *","comment":"reference to a repository object"}},"git_index_write":{"comments":"","file":"index.h","argline":"git_index *index","group":"index","lineto":131,"description":"Write an existing index object from memory back to disk using an atomic file lock.","rawComments":"\n Write an existing index object from memory back to disk\n using an atomic file lock.\n\n @param index an existing index object\n @return 0 on success, otherwise an error code\n\n","args":[{"type":"git_index *","comment":"an existing index object","name":"index"}],"sig":"git_index *","line":124,"return":{"type":"int","comment":"0 on success, otherwise an error code"}},"git_revwalk_push":{"comments":"@param walker the walker being used for the traversal.","file":"revwalk.h","argline":"git_revwalk *walk, git_commit *commit","group":"revwalk","lineto":91,"description":"Mark a commit to start traversal from. The commit object must belong to the repo which is being walked through.","rawComments":"\n Mark a commit to start traversal from.\n The commit object must belong to the repo which is being walked through.\n\n @param walker the walker being used for the traversal.\n @param commit the commit to start from.\n\n","args":[{"type":"git_revwalk *","comment":"","name":"walk"},{"type":"git_commit *","comment":"the commit to start from.","name":"commit"}],"sig":"git_revwalk *::git_commit *","line":84,"return":{"type":"int","comment":""}},"git_blob_lookup":{"comments":"","file":"blob.h","argline":"git_blob **blob, git_repository *repo, const git_oid *id","group":"blob","lineto":55,"description":"Lookup a blob object from a repository. The generated blob object is owned by the revision repo and shall not be freed by the user.","rawComments":"\n Lookup a blob object from a repository.\n The generated blob object is owned by the revision\n repo and shall not be freed by the user.\n\n @param blob pointer to the looked up blob\n @param repo the repo to use when locating the blob.\n @param id identity of the blob to locate.\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_blob **","comment":"pointer to the looked up blob","name":"blob"},{"type":"git_repository *","comment":"the repo to use when locating the blob.","name":"repo"},{"type":"const git_oid *","comment":"identity of the blob to locate.","name":"id"}],"sig":"git_blob **::git_repository *::const git_oid *","line":42,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_tree_entry_set_id":{"comments":"This will mark the tree that contains the entry as modified;\n the modified entry will be written back to disk on the next git_object_write()","file":"tree.h","argline":"git_tree_entry *entry, const git_oid *oid","group":"tree","lineto":226,"description":"Change the SHA1 id of a tree entry.","rawComments":"\n Change the SHA1 id of a tree entry.\n\n This will mark the tree that contains the entry as modified;\n the modified entry will be written back to disk on the next git_object_write()\n\n @param entry Entry object which will be modified\n @param oid new SHA1 oid for the entry\n\n","args":[{"type":"git_tree_entry *","comment":"Entry object which will be modified","name":"entry"},{"type":"const git_oid *","comment":"new SHA1 oid for the entry","name":"oid"}],"sig":"git_tree_entry *::const git_oid *","line":217,"return":{"type":"void","comment":""}},"git_odb_new":{"comments":"Before the ODB can be used for read/writing, a custom database\n backend must be manually added using `git_odb_add_backend()`","file":"odb.h","argline":"git_odb **out","group":"odb","lineto":52,"description":"Create a new object database with no backends.","rawComments":"\n Create a new object database with no backends.\n\n Before the ODB can be used for read/writing, a custom database\n backend must be manually added using `git_odb_add_backend()`\n\n @param out location to store the database pointer, if opened.\n            Set to NULL if the open failed.\n @return GIT_SUCCESS if the database was created; otherwise an error\n         code describing why the open was not possible.\n\n","args":[{"type":"git_odb **","comment":"location to store the database pointer, if opened.             Set to NULL if the open failed.","name":"out"}],"sig":"git_odb **","line":41,"return":{"type":"int","comment":"GIT_SUCCESS if the database was created; otherwise an error          code describing why the open was not possible."}},"git_commit_tree":{"comments":"","file":"commit.h","argline":"git_commit *commit","group":"commit","lineto":128,"description":"Get the tree pointed to by a commit.","rawComments":"\n Get the tree pointed to by a commit.\n @param commit a previously loaded commit.\n @return the tree of a commit\n\n","args":[{"type":"git_commit *","comment":"a previously loaded commit.","name":"commit"}],"sig":"git_commit *","line":123,"return":{"type":"const git_tree *","comment":"the tree of a commit"}},"git_oid_allocfmt":{"comments":"","file":"oid.h","argline":"const git_oid *oid","group":"oid","lineto":101,"description":"Format a gid_oid into a newly allocated c-string.","rawComments":"\n Format a gid_oid into a newly allocated c-string.\n @param oid the oid structure to format\n @return the c-string; NULL if memory is exhausted.  Caller must\n         deallocate the string with free().\n\n","args":[{"type":"const git_oid *","comment":"the oid structure to format","name":"oid"}],"sig":"const git_oid *","line":95,"return":{"type":"char *","comment":"the c-string; NULL if memory is exhausted.  Caller must          deallocate the string with free()."}},"git_tag_tagger":{"comments":"","file":"tag.h","argline":"git_tag *t","group":"tag","lineto":106,"description":"Get the tagger (author) of a tag @param tag a previously loaded tag.","rawComments":"\n Get the tagger (author) of a tag\n @param tag a previously loaded tag.\n @return reference to the tag's author\n\n","args":[{"type":"git_tag *","comment":"","name":"t"}],"sig":"git_tag *","line":101,"return":{"type":"const git_signature *","comment":"reference to the tag's author"}},"git_tree_remove_entry_byindex":{"comments":"Index must be >= 0 and < than git_tree_entrycount().\n\n This will mark the tree as modified; the modified entry will\n be written back to disk on the next git_object_write()","file":"tree.h","argline":"git_tree *tree, int idx","group":"tree","lineto":193,"description":"Remove an entry by its index.","rawComments":"\n Remove an entry by its index.\n\n Index must be >= 0 and < than git_tree_entrycount().\n\n This will mark the tree as modified; the modified entry will\n be written back to disk on the next git_object_write()\n\n @param tree Tree where to remove the entry\n @param idx index of the entry\n @return 0 on successful removal; GIT_ENOTFOUND if the entry wasn't found\n\n","args":[{"type":"git_tree *","comment":"Tree where to remove the entry","name":"tree"},{"type":"int","comment":"index of the entry","name":"idx"}],"sig":"git_tree *::int","line":181,"return":{"type":"int","comment":"0 on successful removal; GIT_ENOTFOUND if the entry wasn't found"}},"git_commit_committer":{"comments":"","file":"commit.h","argline":"git_commit *commit","group":"commit","lineto":114,"description":"Get the committer of a commit.","rawComments":"\n Get the committer of a commit.\n @param commit a previously loaded commit.\n @return the committer of a commit\n\n","args":[{"type":"git_commit *","comment":"a previously loaded commit.","name":"commit"}],"sig":"git_commit *","line":109,"return":{"type":"const git_signature *","comment":"the committer of a commit"}},"git_reference_resolve":{"comments":"Thie method iteratively peels a symbolic reference\n until it resolves to a direct reference to an OID.\n\n If a direct reference is passed as an argument,\n that reference is returned immediately","file":"refs.h","argline":"git_reference **resolved_ref, git_reference *ref","group":"reference","lineto":105,"description":"Resolve a symbolic reference","rawComments":"\n Resolve a symbolic reference\n\n Thie method iteratively peels a symbolic reference\n until it resolves to a direct reference to an OID.\n\n If a direct reference is passed as an argument,\n that reference is returned immediately\n\n @param resolved_ref Pointer to the peeled reference\n @param ref The reference\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_reference **","comment":"Pointer to the peeled reference","name":"resolved_ref"},{"type":"git_reference *","comment":"The reference","name":"ref"}],"sig":"git_reference **::git_reference *","line":92,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_object_free":{"comments":"Repository objects are managed automatically by the library,\n but this method can be used to force freeing one of the\n objects.\n\n Careful: freeing objects in the middle of a repository\n traversal will most likely cause errors.","file":"object.h","argline":"git_object *object","group":"object","lineto":99,"description":"Free a reference to one of the objects in the repository.","rawComments":"\n Free a reference to one of the objects in the repository.\n\n Repository objects are managed automatically by the library,\n but this method can be used to force freeing one of the\n objects.\n\n Careful: freeing objects in the middle of a repository\n traversal will most likely cause errors.\n\n @param object the object to free\n\n","args":[{"type":"git_object *","comment":"the object to free","name":"object"}],"sig":"git_object *","line":87,"return":{"type":"void","comment":""}},"git_tag_set_name":{"comments":"","file":"tag.h","argline":"git_tag *tag, const char *name","group":"tag","lineto":127,"description":"Set the name of a tag","rawComments":"\n Set the name of a tag\n @param tag The tag to modify\n @param name the new name for the tag\n\n","args":[{"type":"git_tag *","comment":"The tag to modify","name":"tag"},{"type":"const char *","comment":"the new name for the tag","name":"name"}],"sig":"git_tag *::const char *","line":122,"return":{"type":"void","comment":""}},"git_reference_name":{"comments":"","file":"refs.h","argline":"git_reference *ref","group":"reference","lineto":90,"description":"Get the full name of a reference","rawComments":"\n Get the full name of a reference\n\n @param ref The reference\n @return the full name for the ref\n\n","args":[{"type":"git_reference *","comment":"The reference","name":"ref"}],"sig":"git_reference *","line":84,"return":{"type":"const char *","comment":"the full name for the ref"}},"git_odb_exists":{"comments":"@return\n - true, if the object was found\n - false, otherwise","file":"odb.h","argline":"git_odb *db, const git_oid *id","group":"odb","lineto":151,"description":"Determine if the given object can be found in the object database.","rawComments":"\n Determine if the given object can be found in the object database.\n\n @param db database to be searched for the given object.\n @param id the object to search for.\n @return\n - true, if the object was found\n - false, otherwise\n\n","args":[{"type":"git_odb *","comment":"database to be searched for the given object.","name":"db"},{"type":"const git_oid *","comment":"the object to search for.","name":"id"}],"sig":"git_odb *::const git_oid *","line":142,"return":{"type":"int","comment":""}},"git_tag_message":{"comments":"","file":"tag.h","argline":"git_tag *t","group":"tag","lineto":113,"description":"Get the message of a tag @param tag a previously loaded tag.","rawComments":"\n Get the message of a tag\n @param tag a previously loaded tag.\n @return message of the tag\n\n","args":[{"type":"git_tag *","comment":"","name":"t"}],"sig":"git_tag *","line":108,"return":{"type":"const char *","comment":"message of the tag"}},"git_reference_owner":{"comments":"","file":"refs.h","argline":"git_reference *ref","group":"reference","lineto":129,"description":"Get the repository where a reference resides","rawComments":"\n Get the repository where a reference resides\n\n @param ref The reference\n @return a pointer to the repo\n\n","args":[{"type":"git_reference *","comment":"The reference","name":"ref"}],"sig":"git_reference *","line":123,"return":{"type":"git_repository *","comment":"a pointer to the repo"}},"git_strerror":{"comments":"","file":"errors.h","argline":"int num","group":"errors","lineto":41,"description":"strerror() for the Git library","rawComments":"\n strerror() for the Git library\n @param num The error code to explain\n @return a string explaining the error code\n\n","args":[{"type":"int","comment":"The error code to explain","name":"num"}],"sig":"int","line":36,"return":{"type":"const char *","comment":"a string explaining the error code"}},"git_blob_writefile":{"comments":"","file":"blob.h","argline":"git_oid *written_id, git_repository *repo, const char *path","group":"blob","lineto":124,"description":"Read a file from the working folder of a repository and write it to the Object Database as a loose blob, if such doesn't exist yet.","rawComments":"\n Read a file from the working folder of a repository\n and write it to the Object Database as a loose blob,\n if such doesn't exist yet.\n\n @param written_id return the id of the written blob\n @param repo repository where the blob will be written\n @param path file from which the blob will be created\n\n","args":[{"type":"git_oid *","comment":"return the id of the written blob","name":"written_id"},{"type":"git_repository *","comment":"repository where the blob will be written","name":"repo"},{"type":"const char *","comment":"file from which the blob will be created","name":"path"}],"sig":"git_oid *::git_repository *::const char *","line":115,"return":{"type":"int","comment":""}},"git_oid_pathfmt":{"comments":"","file":"oid.h","argline":"char *str, const git_oid *oid","group":"oid","lineto":93,"description":"Format a git_oid into a loose-object path string. <p> The resulting string is \"aa/...\", where \"aa\" is the first two hex digitis of the oid and \"...\" is the remaining 38 digits.","rawComments":"\n Format a git_oid into a loose-object path string.\n <p>\n The resulting string is \"aa/...\", where \"aa\" is the first two\n hex digitis of the oid and \"...\" is the remaining 38 digits.\n\n @param str output hex string; must be pointing at the start of\n        the hex sequence and have at least the number of bytes\n        needed for an oid encoded in hex (41 bytes).  Only the\n        oid digits are written; a '\\\\0' terminator must be added\n        by the caller if it is required.\n @param oid oid structure to format.\n\n","args":[{"type":"char *","comment":"output hex string; must be pointing at the start of         the hex sequence and have at least the number of bytes         needed for an oid encoded in hex (41 bytes).  Only the         oid digits are written; a '\\\\0' terminator must be added         by the caller if it is required.","name":"str"},{"type":"const git_oid *","comment":"oid structure to format.","name":"oid"}],"sig":"char *::const git_oid *","line":80,"return":{"type":"void","comment":""}},"git_index_remove":{"comments":"","file":"index.h","argline":"git_index *index, int position","group":"index","lineto":160,"description":"Remove an entry from the index","rawComments":"\n Remove an entry from the index\n\n @param index an existing index object\n @param position position of the entry to remove\n @return 0 on success, otherwise an error code\n\n","args":[{"type":"git_index *","comment":"an existing index object","name":"index"},{"type":"int","comment":"position of the entry to remove","name":"position"}],"sig":"git_index *::int","line":153,"return":{"type":"int","comment":"0 on success, otherwise an error code"}},"git_blob_rawsize":{"comments":"","file":"blob.h","argline":"git_blob *blob","group":"blob","lineto":113,"description":"Get the size in bytes of the contents of a blob","rawComments":"\n Get the size in bytes of the contents of a blob\n\n @param blob pointer to the blob\n @return size on bytes\n\n","args":[{"type":"git_blob *","comment":"pointer to the blob","name":"blob"}],"sig":"git_blob *","line":107,"return":{"type":"int","comment":"size on bytes"}},"git_revwalk_sorting":{"comments":"","file":"revwalk.h","argline":"git_revwalk *walk, unsigned int sort_mode","group":"revwalk","lineto":117,"description":"Change the sorting mode when iterating through the repository's contents. Changing the sorting mode resets the walker.","rawComments":"\n Change the sorting mode when iterating through the\n repository's contents.\n Changing the sorting mode resets the walker.\n @param walk the walker being used for the traversal.\n @param sort_mode combination of GIT_RPSORT_XXX flags\n\n","args":[{"type":"git_revwalk *","comment":"the walker being used for the traversal.","name":"walk"},{"type":"unsigned int","comment":"combination of GIT_RPSORT_XXX flags","name":"sort_mode"}],"sig":"git_revwalk *::unsigned int","line":110,"return":{"type":"int","comment":""}},"git_odb_backend_pack":{"comments":"","file":"odb_backend.h","argline":"git_odb_backend **backend_out, const char *objects_dir","group":"odb","lineto":69,"description":"An instance for a custom backend","rawComments":" An instance for a custom backend ","args":[{"type":"git_odb_backend **","comment":"","name":"backend_out"},{"type":"const char *","comment":"","name":"objects_dir"}],"sig":"git_odb_backend **::const char *","line":41,"return":{"type":"int","comment":""}},"git_tree_entry_set_name":{"comments":"This will mark the tree that contains the entry as modified;\n the modified entry will be written back to disk on the next git_object_write()\n\n @param oid new filename for the entry","file":"tree.h","argline":"git_tree_entry *entry, const char *name","group":"tree","lineto":237,"description":"Change the filename of a tree entry.","rawComments":"\n Change the filename of a tree entry.\n\n This will mark the tree that contains the entry as modified;\n the modified entry will be written back to disk on the next git_object_write()\n\n @param entry Entry object which will be modified\n @param oid new filename for the entry\n\n","args":[{"type":"git_tree_entry *","comment":"Entry object which will be modified","name":"entry"},{"type":"const char *","comment":"","name":"name"}],"sig":"git_tree_entry *::const char *","line":228,"return":{"type":"void","comment":""}},"git_commit_parent":{"comments":"","file":"commit.h","argline":"git_commit *commit, unsigned int n","group":"commit","lineto":144,"description":"Get the specified parent of the commit.","rawComments":"\n Get the specified parent of the commit.\n @param commit a previously loaded commit.\n @param n the position of the entry\n @return a pointer to the commit; NULL if out of bounds\n\n","args":[{"type":"git_commit *","comment":"a previously loaded commit.","name":"commit"},{"type":"unsigned int","comment":"the position of the entry","name":"n"}],"sig":"git_commit *::unsigned int","line":138,"return":{"type":"git_commit *","comment":"a pointer to the commit; NULL if out of bounds"}},"git_tag_lookup":{"comments":"","file":"tag.h","argline":"git_tag **tag, git_repository *repo, const git_oid *id","group":"tag","lineto":55,"description":"Lookup a tag object from the repository. The generated tag object is owned by the revision repo and shall not be freed by the user.","rawComments":"\n Lookup a tag object from the repository.\n The generated tag object is owned by the revision\n repo and shall not be freed by the user.\n\n @param tag pointer to the looked up tag\n @param repo the repo to use when locating the tag.\n @param id identity of the tag to locate.\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_tag **","comment":"pointer to the looked up tag","name":"tag"},{"type":"git_repository *","comment":"the repo to use when locating the tag.","name":"repo"},{"type":"const git_oid *","comment":"identity of the tag to locate.","name":"id"}],"sig":"git_tag **::git_repository *::const git_oid *","line":42,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_commit_id":{"comments":"","file":"commit.h","argline":"git_commit *commit","group":"commit","lineto":79,"description":"Get the id of a commit.","rawComments":"\n Get the id of a commit.\n @param commit a previously loaded commit.\n @return object identity for the commit.\n\n","args":[{"type":"git_commit *","comment":"a previously loaded commit.","name":"commit"}],"sig":"git_commit *","line":74,"return":{"type":"const git_oid *","comment":"object identity for the commit."}},"git_commit_set_author":{"comments":"","file":"commit.h","argline":"git_commit *commit, const git_signature *author_sig","group":"commit","lineto":173,"description":"Set the author of a commit","rawComments":"\n Set the author of a commit\n @param commit the commit object\n @param author_sig signature of the author\n\n","args":[{"type":"git_commit *","comment":"the commit object","name":"commit"},{"type":"const git_signature *","comment":"signature of the author","name":"author_sig"}],"sig":"git_commit *::const git_signature *","line":168,"return":{"type":"void","comment":""}},"git_tree_id":{"comments":"","file":"tree.h","argline":"git_tree *tree","group":"tree","lineto":78,"description":"Get the id of a tree.","rawComments":"\n Get the id of a tree.\n @param tree a previously loaded tree.\n @return object identity for the tree.\n\n","args":[{"type":"git_tree *","comment":"a previously loaded tree.","name":"tree"}],"sig":"git_tree *","line":73,"return":{"type":"const git_oid *","comment":"object identity for the tree."}},"git_index_find":{"comments":"","file":"index.h","argline":"git_index *index, const char *path","group":"index","lineto":141,"description":"Find the first index of any entires which point to given path in the Git index.","rawComments":"\n Find the first index of any entires which point to given\n path in the Git index.\n\n @param index an existing index object\n @param path path to search\n @return an index >= 0 if found, -1 otherwise\n\n","args":[{"type":"git_index *","comment":"an existing index object","name":"index"},{"type":"const char *","comment":"path to search","name":"path"}],"sig":"git_index *::const char *","line":133,"return":{"type":"int","comment":"an index >= 0 if found, -1 otherwise"}},"git_tree_entry_byindex":{"comments":"","file":"tree.h","argline":"git_tree *tree, int idx","group":"tree","lineto":102,"description":"Lookup a tree entry by its position in the tree","rawComments":"\n Lookup a tree entry by its position in the tree\n @param tree a previously loaded tree.\n @param idx the position in the entry list\n @return the tree entry; NULL if not found\n\n","args":[{"type":"git_tree *","comment":"a previously loaded tree.","name":"tree"},{"type":"int","comment":"the position in the entry list","name":"idx"}],"sig":"git_tree *::int","line":96,"return":{"type":"git_tree_entry *","comment":"the tree entry; NULL if not found"}},"git_odb_backend_loose":{"comments":"","file":"odb_backend.h","argline":"git_odb_backend **backend_out, const char *objects_dir","group":"odb","lineto":70,"description":"","rawComments":"","args":[{"type":"git_odb_backend **","comment":"","name":"backend_out"},{"type":"const char *","comment":"","name":"objects_dir"}],"sig":"git_odb_backend **::const char *","line":70,"return":{"type":"int","comment":""}},"git_odb_read_header":{"comments":"Only the 'type' and 'len' fields of the git_rawobj structure\n are filled. The 'data' pointer will always be NULL.\n\n The raw object pointed by 'out' doesn't need to be manually\n closed with git_rawobj_close().\n\n @return\n - GIT_SUCCESS if the object was read;\n - GIT_ENOTFOUND if the object is not in the database.","file":"odb.h","argline":"git_rawobj *out, git_odb *db, const git_oid *id","group":"odb","lineto":128,"description":"Read the header of an object from the database, without reading its full contents.","rawComments":"\n Read the header of an object from the database, without\n reading its full contents.\n\n Only the 'type' and 'len' fields of the git_rawobj structure\n are filled. The 'data' pointer will always be NULL.\n\n The raw object pointed by 'out' doesn't need to be manually\n closed with git_rawobj_close().\n\n @param out object descriptor to populate upon reading.\n @param db database to search for the object in.\n @param id identity of the object to read.\n @return\n - GIT_SUCCESS if the object was read;\n - GIT_ENOTFOUND if the object is not in the database.\n\n","args":[{"type":"git_rawobj *","comment":"object descriptor to populate upon reading.","name":"out"},{"type":"git_odb *","comment":"database to search for the object in.","name":"db"},{"type":"const git_oid *","comment":"identity of the object to read.","name":"id"}],"sig":"git_rawobj *::git_odb *::const git_oid *","line":111,"return":{"type":"int","comment":""}},"git_repository_open":{"comments":"The 'path' argument must point to an existing git repository\n folder, e.g.\n\n\t\t/path/to/my_repo/.git/\t(normal repository)\n\t\t\t\t\t\t\tobjects/\n\t\t\t\t\t\t\tindex\n\t\t\t\t\t\t\tHEAD\n\n\t\t/path/to/bare_repo/\t\t(bare repository)\n\t\t\t\t\t\tobjects/\n\t\t\t\t\t\tindex\n\t\t\t\t\t\tHEAD\n\n\tThe method will automatically detect if 'path' is a normal\n\tor bare repository or fail is 'path' is neither.","file":"repository.h","argline":"git_repository **repository, const char *path","group":"repository","lineto":64,"description":"Open a git repository.","rawComments":"\n Open a git repository.\n\n The 'path' argument must point to an existing git repository\n folder, e.g.\n\n\t\t/path/to/my_repo/.git/\t(normal repository)\n\t\t\t\t\t\t\tobjects/\n\t\t\t\t\t\t\tindex\n\t\t\t\t\t\t\tHEAD\n\n\t\t/path/to/bare_repo/\t\t(bare repository)\n\t\t\t\t\t\tobjects/\n\t\t\t\t\t\tindex\n\t\t\t\t\t\tHEAD\n\n\tThe method will automatically detect if 'path' is a normal\n\tor bare repository or fail is 'path' is neither.\n\n @param repository pointer to the repo which will be opened\n @param path the path to the repository\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_repository **","comment":"pointer to the repo which will be opened","name":"repository"},{"type":"const char *","comment":"the path to the repository","name":"path"}],"sig":"git_repository **::const char *","line":41,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_index_read":{"comments":"","file":"index.h","argline":"git_index *index","group":"index","lineto":122,"description":"Update the contents of an existing index object in memory by reading from the hard disk.","rawComments":"\n Update the contents of an existing index object in memory\n by reading from the hard disk.\n\n @param index an existing index object\n @return 0 on success, otherwise an error code\n\n","args":[{"type":"git_index *","comment":"an existing index object","name":"index"}],"sig":"git_index *","line":115,"return":{"type":"int","comment":"0 on success, otherwise an error code"}},"git_signature_free":{"comments":"@sig signature to free","file":"signature.h","argline":"git_signature *sig","group":"signature","lineto":66,"description":"Free an existing signature","rawComments":"\n Free an existing signature\n\n @sig signature to free\n\n","args":[{"type":"git_signature *","comment":"","name":"sig"}],"sig":"git_signature *","line":61,"return":{"type":"void","comment":""}},"git_commit_author":{"comments":"","file":"commit.h","argline":"git_commit *commit","group":"commit","lineto":121,"description":"Get the author of a commit.","rawComments":"\n Get the author of a commit.\n @param commit a previously loaded commit.\n @return the author of a commit\n\n","args":[{"type":"git_commit *","comment":"a previously loaded commit.","name":"commit"}],"sig":"git_commit *","line":116,"return":{"type":"const git_signature *","comment":"the author of a commit"}},"git_odb_write":{"comments":"@return\n - GIT_SUCCESS if the object was written;\n - GIT_ERROR otherwise.","file":"odb.h","argline":"git_oid *id, git_odb *db, git_rawobj *obj","group":"odb","lineto":140,"description":"Write an object to the database.","rawComments":"\n Write an object to the database.\n\n @param id identity of the object written.\n @param db database to which the object should be written.\n @param obj object descriptor for the object to write.\n @return\n - GIT_SUCCESS if the object was written;\n - GIT_ERROR otherwise.\n\n","args":[{"type":"git_oid *","comment":"identity of the object written.","name":"id"},{"type":"git_odb *","comment":"database to which the object should be written.","name":"db"},{"type":"git_rawobj *","comment":"object descriptor for the object to write.","name":"obj"}],"sig":"git_oid *::git_odb *::git_rawobj *","line":130,"return":{"type":"int","comment":""}},"git_commit_set_message":{"comments":"","file":"commit.h","argline":"git_commit *commit, const char *message","group":"commit","lineto":159,"description":"Set the message of a commit","rawComments":"\n Set the message of a commit\n @param commit the commit object\n @param message the new message\n\n","args":[{"type":"git_commit *","comment":"the commit object","name":"commit"},{"type":"const char *","comment":"the new message","name":"message"}],"sig":"git_commit *::const char *","line":154,"return":{"type":"void","comment":""}},"git_commit_new":{"comments":"The commit object must be manually filled using\n setter methods before it can be written to its\n repository.","file":"commit.h","argline":"git_commit **commit, git_repository *repo","group":"commit","lineto":72,"description":"Create a new in-memory git_commit.","rawComments":"\n Create a new in-memory git_commit.\n\n The commit object must be manually filled using\n setter methods before it can be written to its\n repository.\n\n @param commit pointer to the new commit\n @param repo The repository where the object will reside\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_commit **","comment":"pointer to the new commit","name":"commit"},{"type":"git_repository *","comment":"The repository where the object will reside","name":"repo"}],"sig":"git_commit **::git_repository *","line":58,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_odb_read":{"comments":"If GIT_ENOTFOUND then out->data is set to NULL.\n\n @return\n - GIT_SUCCESS if the object was read;\n - GIT_ENOTFOUND if the object is not in the database.","file":"odb.h","argline":"git_rawobj *out, git_odb *db, const git_oid *id","group":"odb","lineto":109,"description":"Read an object from the database.","rawComments":"\n Read an object from the database.\n\n If GIT_ENOTFOUND then out->data is set to NULL.\n\n @param out object descriptor to populate upon reading.\n @param db database to search for the object in.\n @param id identity of the object to read.\n @return\n - GIT_SUCCESS if the object was read;\n - GIT_ENOTFOUND if the object is not in the database.\n\n","args":[{"type":"git_rawobj *","comment":"object descriptor to populate upon reading.","name":"out"},{"type":"git_odb *","comment":"database to search for the object in.","name":"db"},{"type":"const git_oid *","comment":"identity of the object to read.","name":"id"}],"sig":"git_rawobj *::git_odb *::const git_oid *","line":97,"return":{"type":"int","comment":""}},"git_tag_type":{"comments":"","file":"tag.h","argline":"git_tag *t","group":"tag","lineto":92,"description":"Get the type of a tag's tagged object @param tag a previously loaded tag.","rawComments":"\n Get the type of a tag's tagged object\n @param tag a previously loaded tag.\n @return type of the tagged object\n\n","args":[{"type":"git_tag *","comment":"","name":"t"}],"sig":"git_tag *","line":87,"return":{"type":"git_otype","comment":"type of the tagged object"}},"git_blob_set_rawcontent":{"comments":"","file":"blob.h","argline":"git_blob *blob, const void *buffer, size_t len","group":"blob","lineto":92,"description":"Fill a blob with the contents inside the pointed buffer","rawComments":"\n Fill a blob with the contents inside\n the pointed buffer\n\n @param blob pointer to the blob\n @param buffer buffer with the contents for the blob\n @param len size of the buffer\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_blob *","comment":"pointer to the blob","name":"blob"},{"type":"const void *","comment":"buffer with the contents for the blob","name":"buffer"},{"type":"size_t","comment":"size of the buffer","name":"len"}],"sig":"git_blob *::const void *::size_t","line":83,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_reference_set_oid":{"comments":"This converts the reference into a direct\n reference.\n\n This marks the reference as modified; changes\n won't take effect until it is manually written back\n to disk.\n\n @param target The new target OID for the reference","file":"refs.h","argline":"git_reference *ref, const git_oid *id","group":"reference","lineto":171,"description":"Set the OID target of a reference.","rawComments":"\n Set the OID target of a reference.\n\n This converts the reference into a direct\n reference.\n\n This marks the reference as modified; changes\n won't take effect until it is manually written back\n to disk.\n\n @param ref The reference\n @param target The new target OID for the reference\n\n","args":[{"type":"git_reference *","comment":"The reference","name":"ref"},{"type":"const git_oid *","comment":"","name":"id"}],"sig":"git_reference *::const git_oid *","line":158,"return":{"type":"void","comment":""}},"git_reference_new":{"comments":"The reference will be empty and exclusively\n in-memory until it is filled with the setter\n methods and written back to disk using\n `git_reference_write`.","file":"refs.h","argline":"git_reference **ref_out, git_repository *repo","group":"reference","lineto":52,"description":"Create a new reference.","rawComments":"\n Create a new reference.\n\n The reference will be empty and exclusively\n in-memory until it is filled with the setter\n methods and written back to disk using\n `git_reference_write`.\n\n @param ref_out Pointer to the newly created reference\n @param repo Repository where that reference exists\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_reference **","comment":"Pointer to the newly created reference","name":"ref_out"},{"type":"git_repository *","comment":"Repository where that reference exists","name":"repo"}],"sig":"git_reference **::git_repository *","line":40,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_index_open_bare":{"comments":"Since there is no ODB behind this index, any Index methods\n which rely on the ODB (e.g. index_add) will fail with the\n GIT_EBAREINDEX error code.","file":"index.h","argline":"git_index **index, const char *index_path","group":"index","lineto":87,"description":"Create a new Git index object as a memory representation of the Git index file in 'index_path', without a repository to back it.","rawComments":"\n Create a new Git index object as a memory representation\n of the Git index file in 'index_path', without a repository\n to back it.\n\n Since there is no ODB behind this index, any Index methods\n which rely on the ODB (e.g. index_add) will fail with the\n GIT_EBAREINDEX error code.\n\n @param index the pointer for the new index\n @param index_path the path to the index file in disk\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_index **","comment":"the pointer for the new index","name":"index"},{"type":"const char *","comment":"the path to the index file in disk","name":"index_path"}],"sig":"git_index **::const char *","line":74,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_tree_entry_name":{"comments":"","file":"tree.h","argline":"git_tree_entry *entry","group":"tree","lineto":116,"description":"Get the filename of a tree entry","rawComments":"\n Get the filename of a tree entry\n @param entry a tree entry\n @return the name of the file\n\n","args":[{"type":"git_tree_entry *","comment":"a tree entry","name":"entry"}],"sig":"git_tree_entry *","line":111,"return":{"type":"const char *","comment":"the name of the file"}},"git_object__size":{"comments":"For all the core types, this would the equivalent\n of calling `sizeof(git_commit)` if the core types\n were not opaque on the external API.","file":"object.h","argline":"git_otype type","group":"object","lineto":141,"description":"Get the size in bytes for the structure which acts as an in-memory representation of any given object type.","rawComments":"\n Get the size in bytes for the structure which\n acts as an in-memory representation of any given\n object type.\n\n For all the core types, this would the equivalent\n of calling `sizeof(git_commit)` if the core types\n were not opaque on the external API.\n\n @param type object type to get its size\n @return size in bytes of the object\n\n","args":[{"type":"git_otype","comment":"object type to get its size","name":"type"}],"sig":"git_otype","line":129,"return":{"type":"size_t","comment":"size in bytes of the object"}},"git_commit_lookup":{"comments":"","file":"commit.h","argline":"git_commit **commit, git_repository *repo, const git_oid *id","group":"commit","lineto":56,"description":"Lookup a commit object from a repository. The generated commit object is owned by the revision repo and shall not be freed by the user.","rawComments":"\n Lookup a commit object from a repository.\n The generated commit object is owned by the revision\n repo and shall not be freed by the user.\n\n @param commit pointer to the looked up commit\n @param repo the repo to use when locating the commit.\n @param id identity of the commit to locate.  If the object is\n        an annotated tag it will be peeled back to the commit.\n @return 0 on success; error code otherwise\n\n","args":[{"type":"git_commit **","comment":"pointer to the looked up commit","name":"commit"},{"type":"git_repository *","comment":"the repo to use when locating the commit.","name":"repo"},{"type":"const git_oid *","comment":"identity of the commit to locate.  If the object is         an annotated tag it will be peeled back to the commit.","name":"id"}],"sig":"git_commit **::git_repository *::const git_oid *","line":42,"return":{"type":"int","comment":"0 on success; error code otherwise"}},"git_object_owner":{"comments":"","file":"object.h","argline":"git_object *obj","group":"object","lineto":85,"description":"Get the repository that owns this object","rawComments":"\n Get the repository that owns this object\n\n @param obj the object\n @return the repository who owns this object\n\n","args":[{"type":"git_object *","comment":"the object","name":"obj"}],"sig":"git_object *","line":79,"return":{"type":"git_repository *","comment":"the repository who owns this object"}},"git_commit_message_short":{"comments":"","file":"commit.h","argline":"git_commit *commit","group":"commit","lineto":86,"description":"Get the short (one line) message of a commit.","rawComments":"\n Get the short (one line) message of a commit.\n @param commit a previously loaded commit.\n @return the short message of a commit\n\n","args":[{"type":"git_commit *","comment":"a previously loaded commit.","name":"commit"}],"sig":"git_commit *","line":81,"return":{"type":"const char *","comment":"the short message of a commit"}},"git_oid_fmt":{"comments":"","file":"oid.h","argline":"char *str, const git_oid *oid","group":"oid","lineto":78,"description":"Format a git_oid into a hex string.","rawComments":"\n Format a git_oid into a hex string.\n @param str output hex string; must be pointing at the start of\n        the hex sequence and have at least the number of bytes\n        needed for an oid encoded in hex (40 bytes).  Only the\n        oid digits are written; a '\\\\0' terminator must be added\n        by the caller if it is required.\n @param oid oid structure to format.\n\n","args":[{"type":"char *","comment":"output hex string; must be pointing at the start of         the hex sequence and have at least the number of bytes         needed for an oid encoded in hex (40 bytes).  Only the         oid digits are written; a '\\\\0' terminator must be added         by the caller if it is required.","name":"str"},{"type":"const git_oid *","comment":"oid structure to format.","name":"oid"}],"sig":"char *::const git_oid *","line":69,"return":{"type":"void","comment":""}},"git_oid_to_string":{"comments":"","file":"oid.h","argline":"char *out, size_t n, const git_oid *oid","group":"oid","lineto":118,"description":"Format a git_oid into a buffer as a hex format c-string. <p> If the buffer is smaller than GIT_OID_HEXSZ+1, then the resulting oid c-string will be truncated to n-1 characters. If there are any input parameter errors (out == NULL, n == 0, oid == NULL), then a pointer to an empty string is returned, so that the return value can always be printed.","rawComments":"\n Format a git_oid into a buffer as a hex format c-string.\n <p>\n If the buffer is smaller than GIT_OID_HEXSZ+1, then the resulting\n oid c-string will be truncated to n-1 characters. If there are\n any input parameter errors (out == NULL, n == 0, oid == NULL),\n then a pointer to an empty string is returned, so that the return\n value can always be printed.\n\n @param out the buffer into which the oid string is output.\n @param n the size of the out buffer.\n @param oid the oid structure to format.\n @return the out buffer pointer, assuming no input parameter\n         errors, otherwise a pointer to an empty string.\n\n","args":[{"type":"char *","comment":"the buffer into which the oid string is output.","name":"out"},{"type":"size_t","comment":"the size of the out buffer.","name":"n"},{"type":"const git_oid *","comment":"the oid structure to format.","name":"oid"}],"sig":"char *::size_t::const git_oid *","line":103,"return":{"type":"char *","comment":"the out buffer pointer, assuming no input parameter          errors, otherwise a pointer to an empty string."}},"git_index_entrycount":{"comments":"","file":"index.h","argline":"git_index *index","group":"index","lineto":193,"description":"Get the count of entries currently in the index","rawComments":"\n Get the count of entries currently in the index\n\n @param index an existing index object\n @return integer of count of current entries\n\n","args":[{"type":"git_index *","comment":"an existing index object","name":"index"}],"sig":"git_index *","line":187,"return":{"type":"unsigned int","comment":"integer of count of current entries"}},"git_oid_mkraw":{"comments":"","file":"oid.h","argline":"git_oid *out, const unsigned char *raw","group":"oid","lineto":67,"description":"Copy an already raw oid into a git_oid structure.","rawComments":"\n Copy an already raw oid into a git_oid structure.\n @param out oid structure the result is written into.\n @param raw the raw input bytes to be copied.\n\n","args":[{"type":"git_oid *","comment":"oid structure the result is written into.","name":"out"},{"type":"const unsigned char *","comment":"the raw input bytes to be copied.","name":"raw"}],"sig":"git_oid *::const unsigned char *","line":62,"return":{"type":"void","comment":""}},"git_revwalk_reset":{"comments":"","file":"revwalk.h","argline":"git_revwalk *walker","group":"revwalk","lineto":82,"description":"Reset the walking machinery for reuse.","rawComments":"\n Reset the walking machinery for reuse.\n @param walker handle to reset.\n\n","args":[{"type":"git_revwalk *","comment":"handle to reset.","name":"walker"}],"sig":"git_revwalk *","line":78,"return":{"type":"void","comment":""}}},"globals":{"GIT_EOSERR":{"file":"common.h","value":"(GIT_ERROR - 4)","line":107},"GIT_ENOTFOUND":{"file":"common.h","value":"(GIT_ERROR - 2)","line":101},"GIT_IDXENTRY_VALID":{"file":"index.h","value":"(0x8000)","line":43},"GIT_EFLOCKFAIL":{"file":"common.h","value":"(GIT_ERROR - 11)","line":128},"GIT_IDXENTRY_STAGESHIFT":{"file":"index.h","value":"12","line":44},"GIT_SORT_TIME":{"file":"revwalk.h","value":"(1 << 1)","line":60},"GIT_SORT_NONE":{"file":"revwalk.h","value":"(0)","line":46},"GIT_ENOTAREPO":{"file":"common.h","value":"(GIT_ERROR - 7)","line":116},"GIT_SUCCESS":{"file":"common.h","value":"0","line":87},"GIT_IDXENTRY_STAGEMASK":{"file":"index.h","value":"(0x3000)","line":41},"GIT_OID_RAWSZ":{"file":"oid.h","value":"20","line":41},"GIT_EZLIB":{"file":"common.h","value":"(GIT_ERROR - 12)","line":131},"GIT_EPACKCORRUPTED":{"file":"common.h","value":"(GIT_ERROR - 10)","line":125},"GIT_EINVALIDTYPE":{"file":"common.h","value":"(GIT_ERROR - 8)","line":119},"GIT_EOBJTYPE":{"file":"common.h","value":"(GIT_ERROR - 5)","line":110},"GIT_SORT_REVERSE":{"file":"revwalk.h","value":"(1 << 2)","line":67},"GIT_EINVALIDPATH":{"file":"common.h","value":"(GIT_ERROR - 19)","line":152},"GIT_EPACKEDREFSCORRUPTED":{"file":"common.h","value":"(GIT_ERROR - 18)","line":149},"GIT_EBUSY":{"file":"common.h","value":"(GIT_ERROR - 13)","line":134},"GIT_EOBJCORRUPTED":{"file":"common.h","value":"(GIT_ERROR - 6)","line":113},"GIT_ENOTOID":{"file":"common.h","value":"(GIT_ERROR - 1)","line":98},"GIT_IDXENTRY_EXTENDED":{"file":"index.h","value":"(0x4000)","line":42},"GIT_OID_HEXSZ":{"file":"oid.h","value":"(GIT_OID_RAWSZ * 2)","line":44},"GIT_SORT_TOPOLOGICAL":{"file":"revwalk.h","value":"(1 << 0)","line":53},"GIT_EREFCORRUPTED":{"file":"common.h","value":"(GIT_ERROR - 16)","line":143},"GIT_ENOMEM":{"file":"common.h","value":"(GIT_ERROR - 3)","line":104},"GIT_HAS_PTHREAD":{"file":"thread-utils.h","value":"1","line":35},"GIT_ETOONESTEDSYMREF":{"file":"common.h","value":"(GIT_ERROR - 17)","line":146},"GIT_EINVALIDREFNAME":{"file":"common.h","value":"(GIT_ERROR - 15)","line":140},"GIT_ERROR":{"file":"common.h","value":"-1","line":95},"GIT_IDXENTRY_NAMEMASK":{"file":"index.h","value":"(0x0fff)","line":40},"GIT_HAS_TLS":{"file":"thread-utils.h","value":"1","line":34},"GIT_EREVWALKOVER":{"file":"common.h","value":"(GIT_ERROR - 20)","line":155},"GIT_EBAREINDEX":{"file":"common.h","value":"(GIT_ERROR - 14)","line":137},"GIT_EMISSINGOBJDATA":{"file":"common.h","value":"(GIT_ERROR - 9)","line":122}},"files":[{"functions":["git_strerror"],"file":"errors.h","meta":{"defgroup":null,"file":"git2/errors.h","ingroup":"Git","brief":"Git error handling routines and variables"},"lines":45},{"functions":["git_reference_new","git_reference_oid","git_reference_target","git_reference_type","git_reference_name","git_reference_resolve","git_reference_write","git_reference_owner","git_reference_set_name","git_reference_set_target","git_reference_set_oid"],"file":"refs.h","meta":{"defgroup":"git_reference Git reference management routines","file":"git2/refs.h","ingroup":"Git","brief":"Git reference management routines"},"lines":175},{"functions":["git_tag_lookup","git_tag_new","git_tag_id","git_tag_target","git_tag_type","git_tag_name","git_tag_tagger","git_tag_message","git_tag_set_target","git_tag_set_name","git_tag_set_tagger","git_tag_set_message"],"file":"tag.h","meta":{"defgroup":"git_tag Git tag management","file":"git2/tag.h","ingroup":"Git","brief":"Git tag parsing routines"},"lines":145},{"functions":["git_revwalk_new","git_revwalk_reset","git_revwalk_push","git_revwalk_hide","git_revwalk_next","git_revwalk_sorting","git_revwalk_free","git_revwalk_repository"],"file":"revwalk.h","meta":{"defgroup":"git_revwalk Git revision traversal routines","file":"git2/revwalk.h","ingroup":"Git","brief":"Git revision traversal routines"},"lines":136},{"functions":["git_odb_backend_pack","git_odb_backend_loose","git_odb_backend_sqlite"],"file":"odb_backend.h","meta":{"defgroup":"git_backend Git custom backend API","file":"git2/backend.h","ingroup":"Git","brief":"Git custom backend functions"},"lines":78},{"functions":["git_odb_new","git_odb_open","git_odb_add_backend","git_odb_close","git_odb_read","git_odb_read_header","git_odb_write","git_odb_exists","git_rawobj_hash","git_rawobj_close"],"file":"odb.h","meta":{"defgroup":"git_odb Git object database routines","file":"git2/odb.h","ingroup":"Git","brief":"Git object database routines"},"lines":184},{"functions":["git_object_write","git_object_id","git_object_type","git_object_owner","git_object_free","git_object_typeisloose","git_object__size"],"file":"object.h","meta":{"defgroup":"git_object Git revision object management routines","file":"git2/object.h","ingroup":"Git","brief":"Git revision object management routines"},"lines":146},{"functions":["git_blob_lookup","git_blob_new","git_blob_set_rawcontent_fromfile","git_blob_set_rawcontent","git_blob_rawcontent","git_blob_rawsize","git_blob_writefile"],"file":"blob.h","meta":{"defgroup":"git_blob Git blob load and write routines","file":"git2/blob.h","ingroup":"Git","brief":"Git blob load and write routines"},"lines":128},{"functions":["git_signature_new","git_signature_dup","git_signature_free"],"file":"signature.h","meta":{"defgroup":"git_signature Git signature creation","file":"git2/signature.h","ingroup":"Git","brief":"Git signature creation"},"lines":70},{"functions":["git_commit_lookup","git_commit_new","git_commit_id","git_commit_message_short","git_commit_message","git_commit_time","git_commit_time_offset","git_commit_committer","git_commit_author","git_commit_tree","git_commit_parentcount","git_commit_parent","git_commit_add_parent","git_commit_set_message","git_commit_set_committer","git_commit_set_author","git_commit_set_tree"],"file":"commit.h","meta":{"defgroup":"git_commit Git commit parsing, formatting routines","file":"git2/commit.h","ingroup":"Git","brief":"Git commit parsing, formatting routines"},"lines":184},{"functions":[],"file":"types.h","meta":{"defgroup":null,"file":"git2/types.h","ingroup":"Git","brief":"libgit2 base & compatibility types"},"lines":151},{"functions":["git_oid_mkstr","git_oid_mkraw","git_oid_fmt","git_oid_pathfmt","git_oid_allocfmt","git_oid_to_string","git_oid_cpy","git_oid_cmp"],"file":"oid.h","meta":{"defgroup":"git_oid Git object id routines","file":"git2/oid.h","ingroup":"Git","brief":"Git object id routines"},"lines":137},{"functions":["git_repository_open","git_repository_lookup","git_repository_database","git_repository_index","git_repository_newobject","git_repository_free","git_repository_init","git_repository_lookup_ref"],"file":"repository.h","meta":{"defgroup":"git_repository Git repository management routines","file":"git2/repository.h","ingroup":"Git","brief":"Git repository management routines"},"lines":239},{"functions":[],"file":"zlib.h","meta":{"defgroup":"git_zlib Git data compression routines","file":"git2/zlib.h","ingroup":"Git","brief":"Git data compression routines"},"lines":58},{"functions":[],"file":"thread-utils.h","meta":{"defgroup":null,"file":null,"ingroup":null,"brief":null},"lines":80},{"functions":["git_index_open_bare","git_index_open_inrepo","git_index_clear","git_index_free","git_index_read","git_index_write","git_index_find","git_index_add","git_index_remove","git_index_insert","git_index_get","git_index_entrycount"],"file":"index.h","meta":{"defgroup":"git_index Git index parsing and manipulation routines","file":"git2/index.h","ingroup":"Git","brief":"Git index parsing and manipulation routines"},"lines":198},{"functions":["git_tree_lookup","git_tree_new","git_tree_id","git_tree_entrycount","git_tree_entry_byname","git_tree_entry_byindex","git_tree_entry_attributes","git_tree_entry_name","git_tree_entry_id","git_tree_add_entry","git_tree_add_entry_unsorted","git_tree_sort_entries","git_tree_remove_entry_byindex","git_tree_remove_entry_byname","git_tree_clear_entries","git_tree_entry_set_id","git_tree_entry_set_name","git_tree_entry_set_attributes"],"file":"tree.h","meta":{"defgroup":"git_tree Git tree parsing, loading routines","file":"git2/tree.h","ingroup":"Git","brief":"Git tree parsing, loading routines"},"lines":252},{"functions":["__attribute__","__attribute__"],"file":"common.h","meta":{"defgroup":"git_common Git common platform definitions","file":"git2/common.h","ingroup":"Git","brief":"Git common platform definitions"},"lines":160}],"types":[["git_blob",{"file":"types.h","type":"struct","value":"git_blob","tdef":"typedef","used":{"returns":[],"needs":["git_blob_lookup","git_blob_new","git_blob_rawcontent","git_blob_rawsize","git_blob_set_rawcontent","git_blob_set_rawcontent_fromfile"]},"line":111}],["git_commit",{"file":"types.h","type":"struct","value":"git_commit","tdef":"typedef","used":{"returns":["git_commit_parent"],"needs":["git_commit_add_parent","git_commit_author","git_commit_committer","git_commit_id","git_commit_lookup","git_commit_message","git_commit_message_short","git_commit_new","git_commit_parent","git_commit_parentcount","git_commit_set_author","git_commit_set_committer","git_commit_set_message","git_commit_set_tree","git_commit_time","git_commit_time_offset","git_commit_tree","git_revwalk_hide","git_revwalk_next","git_revwalk_push"]},"line":114}],["git_index",{"file":"types.h","type":"struct","value":"git_index","tdef":"typedef","used":{"returns":[],"needs":["git_index_add","git_index_clear","git_index_entrycount","git_index_find","git_index_free","git_index_get","git_index_insert","git_index_open_bare","git_index_open_inrepo","git_index_read","git_index_remove","git_index_write","git_repository_index"]},"line":123}],["git_index_entry",{"file":"index.h","type":"struct","value":null,"tdef":"typedef","block":"git_index_time ctime;\ngit_index_time mtime;\n\nunsigned int dev;\nunsigned int ino;\nunsigned int mode;\nunsigned int uid;\nunsigned int gid;\ngit_off_t file_size;\n\ngit_oid oid;\n\nunsigned short flags;\nunsigned short flags_extended;\n\nchar *path;\n","used":{"returns":["git_index_get"],"needs":["git_index_insert"]},"lineto":71,"line":54}],["git_index_time",{"file":"index.h","type":"struct","value":null,"tdef":"typedef","block":"git_time_t seconds;\n/* nsec should not be stored as time_t compatible */\nunsigned int nanoseconds;\n","used":{"returns":[],"needs":[]},"lineto":51,"line":47}],["git_object",{"file":"types.h","type":"struct","value":"git_object","tdef":"typedef","used":{"returns":["git_tag_target"],"needs":["git_object_free","git_object_id","git_object_owner","git_object_type","git_object_write","git_repository_lookup","git_repository_newobject","git_tag_set_target"]},"line":102}],["git_odb",{"file":"types.h","type":"struct","value":"git_odb","tdef":"typedef","used":{"returns":["git_repository_database"],"needs":["git_odb_add_backend","git_odb_close","git_odb_exists","git_odb_new","git_odb_open","git_odb_read","git_odb_read_header","git_odb_write"]},"line":90}],["git_odb_backend",{"file":"types.h","type":"struct","value":"git_odb_backend","tdef":"typedef","used":{"returns":[],"needs":["git_odb_add_backend","git_odb_backend_loose","git_odb_backend_pack","git_odb_backend_sqlite"]},"line":93}],["git_oid",{"file":"oid.h","type":"struct","value":null,"tdef":"typedef","block":"/** raw binary formatted id */\nunsigned char id[GIT_OID_RAWSZ];\n","used":{"returns":["git_commit_id","git_object_id","git_reference_oid","git_tag_id","git_tree_entry_id","git_tree_id"],"needs":["git_blob_lookup","git_blob_writefile","git_commit_lookup","git_odb_exists","git_odb_read","git_odb_read_header","git_odb_write","git_oid_allocfmt","git_oid_cmp","git_oid_cpy","git_oid_fmt","git_oid_mkraw","git_oid_mkstr","git_oid_pathfmt","git_oid_to_string","git_rawobj_hash","git_reference_set_oid","git_repository_lookup","git_tag_lookup","git_tree_add_entry","git_tree_add_entry_unsorted","git_tree_entry_set_id","git_tree_lookup"]},"lineto":50,"line":47}],["git_otype",{"file":"types.h","type":"enum","value":null,"tdef":"typedef","block":"GIT_OBJ_ANY = -2,\t\t/**< Object can be any of the following */\nGIT_OBJ_BAD = -1,       /**< Object is invalid. */\nGIT_OBJ__EXT1 = 0,      /**< Reserved for future use. */\nGIT_OBJ_COMMIT = 1,     /**< A commit object. */\nGIT_OBJ_TREE = 2,       /**< A tree (directory listing) object. */\nGIT_OBJ_BLOB = 3,       /**< A file revision object. */\nGIT_OBJ_TAG = 4,        /**< An annotated tag object. */\nGIT_OBJ__EXT2 = 5,      /**< Reserved for future use. */\nGIT_OBJ_OFS_DELTA = 6,  /**< A delta, base is given by an offset. */\nGIT_OBJ_REF_DELTA = 7,  /**< A delta, base is given by object id. */\n","used":{"returns":[],"needs":["git_object__size","git_object_typeisloose","git_repository_lookup","git_repository_newobject"]},"lineto":87,"line":76}],["git_rawobj",{"file":"odb.h","type":"struct","value":null,"tdef":"typedef","block":"void *data;          /**< Raw, decompressed object data. */\nsize_t len;          /**< Total number of bytes in data. */\ngit_otype type;      /**< Type of this object. */\n","used":{"returns":[],"needs":["git_odb_read","git_odb_read_header","git_odb_write","git_rawobj_close","git_rawobj_hash"]},"lineto":95,"line":91}],["git_reference",{"file":"types.h","type":"struct","value":"git_reference","tdef":"typedef","used":{"returns":[],"needs":["git_reference_name","git_reference_new","git_reference_oid","git_reference_owner","git_reference_resolve","git_reference_set_name","git_reference_set_oid","git_reference_set_target","git_reference_target","git_reference_type","git_reference_write","git_repository_lookup_ref"]},"line":139}],["git_repository",{"file":"types.h","type":"struct","value":"git_repository","tdef":"typedef","used":{"returns":["git_object_owner","git_reference_owner","git_revwalk_repository"],"needs":["git_blob_lookup","git_blob_new","git_blob_writefile","git_commit_lookup","git_commit_new","git_index_open_inrepo","git_reference_new","git_repository_database","git_repository_free","git_repository_index","git_repository_init","git_repository_lookup","git_repository_lookup_ref","git_repository_newobject","git_repository_open","git_revwalk_new","git_tag_lookup","git_tag_new","git_tree_lookup","git_tree_new"]},"line":99}],["git_revwalk",{"file":"types.h","type":"struct","value":"git_revwalk","tdef":"typedef","used":{"returns":[],"needs":["git_revwalk_free","git_revwalk_hide","git_revwalk_new","git_revwalk_next","git_revwalk_push","git_revwalk_repository","git_revwalk_reset","git_revwalk_sorting"]},"line":105}],["git_rtype",{"file":"types.h","type":"enum","value":null,"tdef":"typedef","block":"GIT_REF_INVALID = -1, /** Invalid reference */\nGIT_REF_OID = 1, /** A reference which points at an object id */\nGIT_REF_SYMBOLIC = 2, /** A reference which points at another reference */\n","used":{"returns":[],"needs":[]},"lineto":146,"line":142}],["git_signature",{"file":"types.h","type":"struct","value":null,"tdef":"typedef","block":"char *name; /** full name of the author */\nchar *email; /** email of the author */\ngit_time when; /** time when the action happened */\n","used":{"returns":["git_commit_author","git_commit_committer","git_signature_dup","git_signature_new","git_tag_tagger"],"needs":["git_commit_set_author","git_commit_set_committer","git_signature_dup","git_signature_free","git_tag_set_tagger"]},"lineto":136,"line":132}],["git_tag",{"file":"types.h","type":"struct","value":"git_tag","tdef":"typedef","used":{"returns":[],"needs":["git_tag_id","git_tag_lookup","git_tag_message","git_tag_name","git_tag_new","git_tag_set_message","git_tag_set_name","git_tag_set_tagger","git_tag_set_target","git_tag_tagger","git_tag_target","git_tag_type"]},"line":108}],["git_time",{"file":"types.h","type":"struct","value":null,"tdef":"typedef","block":"time_t time; /** time in seconds from epoch */\nint offset; /** timezone offset, in minutes */\n","used":{"returns":[],"needs":[]},"lineto":129,"line":126}],["git_tree",{"file":"types.h","type":"struct","value":"git_tree","tdef":"typedef","used":{"returns":["git_commit_tree"],"needs":["git_commit_set_tree","git_tree_add_entry","git_tree_add_entry_unsorted","git_tree_clear_entries","git_tree_entry_byindex","git_tree_entry_byname","git_tree_entrycount","git_tree_id","git_tree_lookup","git_tree_new","git_tree_remove_entry_byindex","git_tree_remove_entry_byname","git_tree_sort_entries"]},"line":120}],["git_tree_entry",{"file":"types.h","type":"struct","value":"git_tree_entry","tdef":"typedef","used":{"returns":["git_tree_entry_byindex","git_tree_entry_byname"],"needs":["git_tree_add_entry","git_tree_add_entry_unsorted","git_tree_entry_attributes","git_tree_entry_id","git_tree_entry_name","git_tree_entry_set_attributes","git_tree_entry_set_id","git_tree_entry_set_name"]},"line":117}]],"groups":[["blob",["git_blob_lookup","git_blob_new","git_blob_rawcontent","git_blob_rawsize","git_blob_set_rawcontent","git_blob_set_rawcontent_fromfile","git_blob_writefile"]],["commit",["git_commit_add_parent","git_commit_author","git_commit_committer","git_commit_id","git_commit_lookup","git_commit_message","git_commit_message_short","git_commit_new","git_commit_parent","git_commit_parentcount","git_commit_set_author","git_commit_set_committer","git_commit_set_message","git_commit_set_tree","git_commit_time","git_commit_time_offset","git_commit_tree"]],["errors",["git_strerror"]],["index",["git_index_add","git_index_clear","git_index_entrycount","git_index_find","git_index_free","git_index_get","git_index_insert","git_index_open_bare","git_index_open_inrepo","git_index_read","git_index_remove","git_index_write"]],["object",["git_object__size","git_object_free","git_object_id","git_object_owner","git_object_type","git_object_typeisloose","git_object_write"]],["odb",["git_odb_add_backend","git_odb_backend_loose","git_odb_backend_pack","git_odb_backend_sqlite","git_odb_close","git_odb_exists","git_odb_new","git_odb_open","git_odb_read","git_odb_read_header","git_odb_write"]],["oid",["git_oid_allocfmt","git_oid_cmp","git_oid_cpy","git_oid_fmt","git_oid_mkraw","git_oid_mkstr","git_oid_pathfmt","git_oid_to_string"]],["rawobj",["git_rawobj_close","git_rawobj_hash"]],["reference",["git_reference_name","git_reference_new","git_reference_oid","git_reference_owner","git_reference_resolve","git_reference_set_name","git_reference_set_oid","git_reference_set_target","git_reference_target","git_reference_type","git_reference_write"]],["repository",["git_repository_database","git_repository_free","git_repository_index","git_repository_init","git_repository_lookup","git_repository_lookup_ref","git_repository_newobject","git_repository_open"]],["revwalk",["git_revwalk_free","git_revwalk_hide","git_revwalk_new","git_revwalk_next","git_revwalk_push","git_revwalk_repository","git_revwalk_reset","git_revwalk_sorting"]],["signature",["git_signature_dup","git_signature_free","git_signature_new"]],["tag",["git_tag_id","git_tag_lookup","git_tag_message","git_tag_name","git_tag_new","git_tag_set_message","git_tag_set_name","git_tag_set_tagger","git_tag_set_target","git_tag_tagger","git_tag_target","git_tag_type"]],["tree",["git_tree_add_entry","git_tree_add_entry_unsorted","git_tree_clear_entries","git_tree_entry_attributes","git_tree_entry_byindex","git_tree_entry_byname","git_tree_entry_id","git_tree_entry_name","git_tree_entry_set_attributes","git_tree_entry_set_id","git_tree_entry_set_name","git_tree_entrycount","git_tree_id","git_tree_lookup","git_tree_new","git_tree_remove_entry_byindex","git_tree_remove_entry_byname","git_tree_sort_entries"]]],"prefix":"src/git2"}
\ No newline at end of file