diff options
author | Carlos Martín Nieto <cmn@dwim.me> | 2012-11-02 12:51:35 +0100 |
---|---|---|
committer | Carlos Martín Nieto <cmn@dwim.me> | 2012-11-02 12:51:35 +0100 |
commit | 9930b01e61a69750d3bb37ee37bc8c08d407de60 (patch) | |
tree | efadaf15eb08a7fa4c09060b95479acee0a8d341 /v0.3.0.json | |
parent | 1d5dac64de88f0eaf4ebcc45beae7f39ceeaed76 (diff) | |
download | libgit2-9930b01e61a69750d3bb37ee37bc8c08d407de60.tar.gz |
generated docs
Diffstat (limited to 'v0.3.0.json')
-rw-r--r-- | v0.3.0.json | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/v0.3.0.json b/v0.3.0.json index d8f775304..00f69c1a0 100644 --- a/v0.3.0.json +++ b/v0.3.0.json @@ -1 +1 @@ -{"files":[{"file":"common.h","functions":[],"meta":{"brief":"Git common platform definitions","defgroup":"git_common Git common platform definitions","ingroup":"Git","comments":"\n"},"lines":160},{"file":"signature.h","functions":["git_signature_new","git_signature_dup","git_signature_free"],"meta":{"brief":"Git signature creation","defgroup":"git_signature Git signature creation","ingroup":"Git","comments":"\n"},"lines":70},{"file":"blob.h","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"],"meta":{"brief":"Git blob load and write routines","defgroup":"git_blob Git blob load and write routines","ingroup":"Git","comments":"\n"},"lines":128},{"file":"index.h","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"],"meta":{"brief":"Git index parsing and manipulation routines","defgroup":"git_index Git index parsing and manipulation routines","ingroup":"Git","comments":"\n"},"lines":198},{"file":"repository.h","functions":["git_repository_open","git_repository_open2","git_repository_open3","git_repository_lookup","git_repository_database","git_repository_index","git_repository_newobject","git_repository_free","git_repository_init","git_repository_lookup_ref"],"meta":{"brief":"Git repository management routines","defgroup":"git_repository Git repository management routines","ingroup":"Git","comments":"\n"},"lines":239},{"file":"tag.h","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"],"meta":{"brief":"Git tag parsing routines","defgroup":"git_tag Git tag management","ingroup":"Git","comments":"\n"},"lines":145},{"file":"odb_backend.h","functions":[],"meta":{"brief":"Git custom backend functions","defgroup":"git_backend Git custom backend API","ingroup":"Git","comments":"\n"},"lines":78},{"file":"commit.h","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"],"meta":{"brief":"Git commit parsing, formatting routines","defgroup":"git_commit Git commit parsing, formatting routines","ingroup":"Git","comments":"\n"},"lines":184},{"file":"types.h","functions":[],"meta":{"brief":"libgit2 base & compatibility types","ingroup":"Git","comments":"\n"},"lines":151},{"file":"zlib.h","functions":["deflateBound"],"meta":{"brief":"Git data compression routines","defgroup":"git_zlib Git data compression routines","ingroup":"Git","comments":"\n"},"lines":58},{"file":"tree.h","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_entry_2object","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"],"meta":{"brief":"Git tree parsing, loading routines","defgroup":"git_tree Git tree parsing, loading routines","ingroup":"Git","comments":"\n"},"lines":252},{"file":"odb.h","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"],"meta":{"brief":"Git object database routines","defgroup":"git_odb Git object database routines","ingroup":"Git","comments":"\n"},"lines":184},{"file":"thread-utils.h","functions":[],"meta":{},"lines":80},{"file":"oid.h","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"],"meta":{"brief":"Git object id routines","defgroup":"git_oid Git object id routines","ingroup":"Git","comments":"\n"},"lines":137},{"file":"errors.h","functions":["git_strerror"],"meta":{"brief":"Git error handling routines and variables","ingroup":"Git","comments":"\n"},"lines":45},{"file":"revwalk.h","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"],"meta":{"brief":"Git revision traversal routines","defgroup":"git_revwalk Git revision traversal routines","ingroup":"Git","comments":"\n"},"lines":136},{"file":"object.h","functions":["git_object_write","git_object_id","git_object_type","git_object_owner","git_object_free","git_object_type2string","git_object_string2type","git_object_typeisloose","git_object__size"],"meta":{"brief":"Git revision object management routines","defgroup":"git_object Git revision object management routines","ingroup":"Git","comments":"\n"},"lines":146},{"file":"refs.h","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"],"meta":{"brief":"Git reference management routines","defgroup":"git_reference Git reference management routines","ingroup":"Git","comments":"\n"},"lines":175}],"functions":{"git_signature_new":{"type":"function","file":"signature.h","line":50,"lineto":50,"args":[{"name":"name","type":"const char *"},{"name":"email","type":"const char *"},{"name":"time","type":"time_t"},{"name":"offset","type":"int"}],"argline":"const char *name, const char *email, time_t time, int offset","sig":"const char *::const char *::time_t::int","return":{"type":"git_signature *","comment":"the new sig, NULl on out of memory"},"description":"Create a new action signature. The signature must be freed\nmanually or using git_signature_free","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","group":"signature"},"git_signature_dup":{"type":"function","file":"signature.h","line":59,"lineto":59,"args":[{"name":"sig","type":"const git_signature *"}],"argline":"const git_signature *sig","sig":"const git_signature *","return":{"type":"git_signature *","comment":"a copy of sig, NULL on out of memory"},"description":"Create a copy of an existing signature.","comments":"All internal strings are also duplicated.\n@sig signature to duplicated","group":"signature"},"git_signature_free":{"type":"function","file":"signature.h","line":66,"lineto":66,"args":[{"name":"sig","type":"git_signature *"}],"argline":"git_signature *sig","sig":"git_signature *","return":{"type":"void"},"description":"Free an existing signature","comments":"@sig signature to free","group":"signature"},"git_blob_lookup":{"type":"function","file":"blob.h","line":52,"lineto":55,"args":[{"name":"blob","type":"git_blob **","comment":"pointer to the looked up blob"},{"name":"repo","type":"git_repository *","comment":"the repo to use when locating the blob."},{"name":"id","type":"const git_oid *","comment":"identity of the blob to locate."}],"argline":"git_blob **blob, git_repository *repo, const git_oid *id","sig":"git_blob **::git_repository *::const git_oid *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Lookup a blob object from a repository.\nThe generated blob object is owned by the revision\nrepo and shall not be freed by the user.","comments":"","group":"blob"},"git_blob_new":{"type":"function","file":"blob.h","line":68,"lineto":71,"args":[{"name":"blob","type":"git_blob **","comment":"pointer to the new blob"},{"name":"repo","type":"git_repository *","comment":"The repository where the object will reside"}],"argline":"git_blob **blob, git_repository *repo","sig":"git_blob **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Create a new in-memory git_blob.","comments":"The blob object must be manually filled using\nthe 'set_rawcontent' methods before it can\nbe written back to disk.\n","group":"blob"},"git_blob_set_rawcontent_fromfile":{"type":"function","file":"blob.h","line":81,"lineto":81,"args":[{"name":"blob","type":"git_blob *","comment":"pointer to the new blob"},{"name":"filename","type":"const char *","comment":"name of the file to read"}],"argline":"git_blob *blob, const char *filename","sig":"git_blob *::const char *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Fill a blob with the contents inside\nthe pointed file.","comments":"","group":"blob"},"git_blob_set_rawcontent":{"type":"function","file":"blob.h","line":92,"lineto":92,"args":[{"name":"blob","type":"git_blob *","comment":"pointer to the blob"},{"name":"buffer","type":"const void *","comment":"buffer with the contents for the blob"},{"name":"len","type":"size_t","comment":"size of the buffer"}],"argline":"git_blob *blob, const void *buffer, size_t len","sig":"git_blob *::const void *::size_t","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Fill a blob with the contents inside\nthe pointed buffer","comments":"","group":"blob"},"git_blob_rawcontent":{"type":"function","file":"blob.h","line":105,"lineto":105,"args":[{"name":"blob","type":"git_blob *","comment":"pointer to the blob"}],"argline":"git_blob *blob","sig":"git_blob *","return":{"type":"const char *","comment":"the pointer; NULL if the blob has no contents"},"description":"Get a read-only buffer with the raw content of a blob.","comments":"A pointer to the raw content of a blob is returned;\nthis pointer is owned internally by the object and shall\nnot be free'd. The pointer may be invalidated at a later\ntime (e.g. when changing the contents of the blob).\n","group":"blob"},"git_blob_rawsize":{"type":"function","file":"blob.h","line":113,"lineto":113,"args":[{"name":"blob","type":"git_blob *","comment":"pointer to the blob"}],"argline":"git_blob *blob","sig":"git_blob *","return":{"type":"int","comment":"size on bytes"},"description":"Get the size in bytes of the contents of a blob","comments":"","group":"blob"},"git_blob_writefile":{"type":"function","file":"blob.h","line":124,"lineto":124,"args":[{"name":"written_id","type":"git_oid *","comment":"return the id of the written blob"},{"name":"repo","type":"git_repository *","comment":"repository where the blob will be written"},{"name":"path","type":"const char *","comment":"file from which the blob will be created"}],"argline":"git_oid *written_id, git_repository *repo, const char *path","sig":"git_oid *::git_repository *::const char *","return":{"type":"int"},"description":"Read a file from the working folder of a repository\nand write it to the Object Database as a loose blob,\nif such doesn't exist yet.","comments":"","group":"blob"},"git_index_open_bare":{"type":"function","file":"index.h","line":87,"lineto":87,"args":[{"name":"index","type":"git_index **","comment":"the pointer for the new index"},{"name":"index_path","type":"const char *","comment":"the path to the index file in disk"}],"argline":"git_index **index, const char *index_path","sig":"git_index **::const char *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Create a new Git index object as a memory representation\nof the Git index file in 'index_path', without a repository\nto back it.","comments":"Since there is no ODB behind this index, any Index methods\nwhich rely on the ODB (e.g. index_add) will fail with the\nGIT_EBAREINDEX error code.\n","group":"index"},"git_index_open_inrepo":{"type":"function","file":"index.h","line":97,"lineto":97,"args":[{"name":"index","type":"git_index **","comment":"_path the path to the index file in disk"},{"name":"repo","type":"git_repository *","comment":"the git repo which owns the index"}],"argline":"git_index **index, git_repository *repo","sig":"git_index **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Open the Index inside the git repository pointed\nby 'repo'.","comments":"","group":"index"},"git_index_clear":{"type":"function","file":"index.h","line":106,"lineto":106,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"void"},"description":"Clear the contents (all the entries) of an index object.\nThis clears the index object in memory; changes must be manually\nwritten to disk for them to take effect.","comments":"","group":"index"},"git_index_free":{"type":"function","file":"index.h","line":113,"lineto":113,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"void"},"description":"Free an existing index object.","comments":"","group":"index"},"git_index_read":{"type":"function","file":"index.h","line":122,"lineto":122,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"int","comment":"0 on success, otherwise an error code"},"description":"Update the contents of an existing index object in memory\nby reading from the hard disk.","comments":"","group":"index"},"git_index_write":{"type":"function","file":"index.h","line":131,"lineto":131,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"int","comment":"0 on success, otherwise an error code"},"description":"Write an existing index object from memory back to disk\nusing an atomic file lock.","comments":"","group":"index"},"git_index_find":{"type":"function","file":"index.h","line":141,"lineto":141,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"path to search"}],"argline":"git_index *index, const char *path","sig":"git_index *::const char *","return":{"type":"int","comment":"an index >= 0 if found, -1 otherwise"},"description":"Find the first index of any entires which point to given\npath in the Git index.","comments":"","group":"index"},"git_index_add":{"type":"function","file":"index.h","line":151,"lineto":151,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"filename to add"},{"name":"stage","type":"int","comment":"stage for the entry"}],"argline":"git_index *index, const char *path, int stage","sig":"git_index *::const char *::int","return":{"type":"int","comment":"0 on success, otherwise an error code"},"description":"Add or update an index entry from a file in disk.","comments":"","group":"index"},"git_index_remove":{"type":"function","file":"index.h","line":160,"lineto":160,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"position","type":"int","comment":"position of the entry to remove"}],"argline":"git_index *index, int position","sig":"git_index *::int","return":{"type":"int","comment":"0 on success, otherwise an error code"},"description":"Remove an entry from the index","comments":"","group":"index"},"git_index_insert":{"type":"function","file":"index.h","line":173,"lineto":173,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"source_entry","type":"const git_index_entry *","comment":"new entry object"}],"argline":"git_index *index, const git_index_entry *source_entry","sig":"git_index *::const git_index_entry *","return":{"type":"int","comment":"0 on success, otherwise an error code"},"description":"Insert an entry into the index.\nA full copy (including the 'path' string) of the given\n'source_entry' will be inserted on the index; if the index\nalready contains an entry for the same path, the entry\nwill be updated.","comments":"","group":"index"},"git_index_get":{"type":"function","file":"index.h","line":185,"lineto":185,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"n","type":"int","comment":"the position of the entry"}],"argline":"git_index *index, int n","sig":"git_index *::int","return":{"type":"git_index_entry *","comment":"a pointer to the entry; NULL if out of bounds"},"description":"Get a pointer to one of the entries in the index","comments":"This entry can be modified, and the changes will be written\nback to disk on the next write() call.\n","group":"index"},"git_index_entrycount":{"type":"function","file":"index.h","line":193,"lineto":193,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"unsigned int","comment":"integer of count of current entries"},"description":"Get the count of entries currently in the index","comments":"","group":"index"},"git_repository_open":{"type":"function","file":"repository.h","line":64,"lineto":64,"args":[{"name":"repository","type":"git_repository **","comment":"pointer to the repo which will be opened"},{"name":"path","type":"const char *","comment":"the path to the repository"}],"argline":"git_repository **repository, const char *path","sig":"git_repository **::const char *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Open a git repository.","comments":"The 'path' argument must point to an existing git repository\nfolder, e.g.\n\n\t/path/to/my_repo/.git/\t(normal repository)\n\t\t\t\t\t\tobjects/\n\t\t\t\t\t\tindex\n\t\t\t\t\t\tHEAD\n\n\t/path/to/bare_repo/\t\t(bare repository)\n\t\t\t\t\tobjects/\n\t\t\t\t\tindex\n\t\t\t\t\tHEAD\n\nThe method will automatically detect if 'path' is a normal\nor bare repository or fail is 'path' is neither.\n","group":"repository"},"git_repository_open2":{"type":"function","file":"repository.h","line":93,"lineto":97,"args":[{"name":"repository","type":"git_repository **","comment":"pointer to the repo which will be opened"},{"name":"git_dir","type":"const char *","comment":"The full path to the repository folder e.g. a '.git' folder for live repos, any folder for bare Equivalent to $GIT_DIR. Cannot be NULL."},{"name":"git_object_directory","type":"const char *","comment":"The full path to the ODB folder. the folder where all the loose and packed objects are stored Equivalent to $GIT_OBJECT_DIRECTORY. If NULL, \"$GIT_DIR/objects/\" is assumed."},{"name":"git_index_file","type":"const char *","comment":"The full path to the index (dircache) file Equivalent to $GIT_INDEX_FILE. If NULL, \"$GIT_DIR/index\" is assumed."},{"name":"git_work_tree","type":"const char *","comment":"The full path to the working tree of the repository, if the repository is not bare. Equivalent to $GIT_WORK_TREE. If NULL, the repository is assumed to be bare."}],"argline":"git_repository **repository,\n\t\tconst char *git_dir,\n\t\tconst char *git_object_directory,\n\t\tconst char *git_index_file,\n\t\tconst char *git_work_tree","sig":"git_repository **::const char *::const char *::const char *::const char *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Open a git repository by manually specifying all its paths","comments":"","group":"repository"},"git_repository_open3":{"type":"function","file":"repository.h","line":128,"lineto":132,"args":[{"name":"repository","type":"git_repository **","comment":"pointer to the repo which will be opened"},{"name":"git_dir","type":"const char *","comment":"The full path to the repository folder e.g. a '.git' folder for live repos, any folder for bare Equivalent to $GIT_DIR. Cannot be NULL."},{"name":"object_database","type":"git_odb *","comment":"A pointer to a git_odb created & initialized by the user (e.g. with custom backends). This object database will be owned by the repository and will be automatically free'd. It should not be manually free'd by the user, or this git_repository object will become invalid."},{"name":"git_index_file","type":"const char *","comment":"The full path to the index (dircache) file Equivalent to $GIT_INDEX_FILE. If NULL, \"$GIT_DIR/index\" is assumed."},{"name":"git_work_tree","type":"const char *","comment":"The full path to the working tree of the repository, if the repository is not bare. Equivalent to $GIT_WORK_TREE. If NULL, the repository is assumed to be bare."}],"argline":"git_repository **repository,\n\t\tconst char *git_dir,\n\t\tgit_odb *object_database,\n\t\tconst char *git_index_file,\n\t\tconst char *git_work_tree","sig":"git_repository **::const char *::git_odb *::const char *::const char *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Open a git repository by manually specifying its paths and\nthe object database it will use.","comments":"","group":"repository"},"git_repository_lookup":{"type":"function","file":"repository.h","line":153,"lineto":153,"args":[{"name":"object","type":"git_object **","comment":"pointer to the looked-up object"},{"name":"repo","type":"git_repository *","comment":"the repository to look up the object"},{"name":"id","type":"const git_oid *","comment":"the unique identifier for the object"},{"name":"type","type":"git_otype","comment":"the type of the object"}],"argline":"git_object **object, git_repository *repo, const git_oid *id, git_otype type","sig":"git_object **::git_repository *::const git_oid *::git_otype","return":{"type":"int","comment":"a reference to the object"},"description":"Lookup a reference to one of the objects in the repostory.","comments":"The generated reference is owned by the repository and\nshould not be freed by the user.\n\nThe 'type' parameter must match the type of the object\nin the odb; the method will fail otherwise.\nThe special value 'GIT_OBJ_ANY' may be passed to let\nthe method guess the object's type.\n","group":"repository"},"git_repository_database":{"type":"function","file":"repository.h","line":161,"lineto":161,"args":[{"name":"repo","type":"git_repository *","comment":"a repository object"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"git_odb *","comment":"a pointer to the object db"},"description":"Get the object database behind a Git repository","comments":"","group":"repository"},"git_repository_index":{"type":"function","file":"repository.h","line":173,"lineto":173,"args":[{"name":"index","type":"git_index **","comment":"Pointer where to store the index"},{"name":"repo","type":"git_repository *","comment":"a repository object"}],"argline":"git_index **index, git_repository *repo","sig":"git_index **::git_repository *","return":{"type":"int","comment":"0 on success; error code if the index could not be opened"},"description":"Get the Index file of a Git repository","comments":"This is a cheap operation; the index is only opened on the first call,\nand subsequent calls only retrieve the previous pointer.\n","group":"repository"},"git_repository_newobject":{"type":"function","file":"repository.h","line":196,"lineto":196,"args":[{"name":"object","type":"git_object **","comment":"pointer to the new object @parem repo Repository where the object belongs"},{"name":"repo","type":"git_repository *"},{"name":"type","type":"git_otype","comment":"Type of the object to be created"}],"argline":"git_object **object, git_repository *repo, git_otype type","sig":"git_object **::git_repository *::git_otype","return":{"type":"int","comment":"the new object"},"description":"Create a new in-memory repository object with\nthe given type.","comments":"The object's attributes can be filled in using the\ncorresponding setter methods.\n\nThe object will be written back to given git_repository\nwhen the git_object_write() function is called; objects\ncannot be written to disk until all their main\nattributes have been properly filled.\n\nObjects are instantiated with no SHA1 id; their id\nwill be automatically generated when writing to the\nrepository.\n","group":"repository"},"git_repository_free":{"type":"function","file":"repository.h","line":202,"lineto":202,"args":[{"name":"repo","type":"git_repository *","comment":"repository handle to close. If NULL nothing occurs."}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"void"},"description":"Free a previously allocated repository\n@param repo repository handle to close. If NULL nothing occurs.","comments":"","group":"repository"},"git_repository_init":{"type":"function","file":"repository.h","line":219,"lineto":219,"args":[{"name":"repo_out","type":"git_repository **","comment":"pointer to the repo which will be created or reinitialized"},{"name":"path","type":"const char *","comment":"the path to the repository"},{"name":"is_bare","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."}],"argline":"git_repository **repo_out, const char *path, unsigned is_bare","sig":"git_repository **::const char *::unsigned","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Creates a new Git repository in the given folder.","comments":"TODO:\n- Reinit the repository\n- Create config files\n","group":"repository"},"git_repository_lookup_ref":{"type":"function","file":"repository.h","line":235,"lineto":235,"args":[{"name":"reference_out","type":"git_reference **","comment":"pointer to the looked-up reference"},{"name":"repo","type":"git_repository *","comment":"the repository to look up the reference"},{"name":"name","type":"const char *","comment":"the long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...)"}],"argline":"git_reference **reference_out, git_repository *repo, const char *name","sig":"git_reference **::git_repository *::const char *","return":{"type":"int","comment":"a reference to the reference"},"description":"Lookup a reference by its name in the repository.","comments":"The generated reference is owned by the repository and\nshould not be freed by the user.\n\nTODO:\n- Ensure the reference name is valid\n","group":"repository"},"git_tag_lookup":{"type":"function","file":"tag.h","line":52,"lineto":55,"args":[{"name":"tag","type":"git_tag **","comment":"pointer to the looked up tag"},{"name":"repo","type":"git_repository *","comment":"the repo to use when locating the tag."},{"name":"id","type":"const git_oid *","comment":"identity of the tag to locate."}],"argline":"git_tag **tag, git_repository *repo, const git_oid *id","sig":"git_tag **::git_repository *::const git_oid *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Lookup a tag object from the repository.\nThe generated tag object is owned by the revision\nrepo and shall not be freed by the user.","comments":"","group":"tag"},"git_tag_new":{"type":"function","file":"tag.h","line":68,"lineto":71,"args":[{"name":"tag","type":"git_tag **","comment":"pointer to the new tag"},{"name":"repo","type":"git_repository *","comment":"The repository where the object will reside"}],"argline":"git_tag **tag, git_repository *repo","sig":"git_tag **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Create a new in-memory git_tag.","comments":"The tag object must be manually filled using\nsetter methods before it can be written to its\nrepository.\n","group":"tag"},"git_tag_id":{"type":"function","file":"tag.h","line":78,"lineto":78,"args":[{"name":"tag","type":"git_tag *","comment":"a previously loaded tag."}],"argline":"git_tag *tag","sig":"git_tag *","return":{"type":"const git_oid *","comment":"object identity for the tag."},"description":"Get the id of a tag.\n@param tag a previously loaded tag.\n@return object identity for the tag.","comments":"","group":"tag"},"git_tag_target":{"type":"function","file":"tag.h","line":85,"lineto":85,"args":[{"name":"t","type":"git_tag *","comment":"ag a previously loaded tag."}],"argline":"git_tag *t","sig":"git_tag *","return":{"type":"const git_object *","comment":"reference to a repository object"},"description":"Get the tagged object of a tag\n@param tag a previously loaded tag.\n@return reference to a repository object","comments":"","group":"tag"},"git_tag_type":{"type":"function","file":"tag.h","line":92,"lineto":92,"args":[{"name":"t","type":"git_tag *","comment":"ag a previously loaded tag."}],"argline":"git_tag *t","sig":"git_tag *","return":{"type":"git_otype","comment":"type of the tagged object"},"description":"Get the type of a tag's tagged object\n@param tag a previously loaded tag.\n@return type of the tagged object","comments":"","group":"tag"},"git_tag_name":{"type":"function","file":"tag.h","line":99,"lineto":99,"args":[{"name":"t","type":"git_tag *","comment":"ag a previously loaded tag."}],"argline":"git_tag *t","sig":"git_tag *","return":{"type":"const char *","comment":"name of the tag"},"description":"Get the name of a tag\n@param tag a previously loaded tag.\n@return name of the tag","comments":"","group":"tag"},"git_tag_tagger":{"type":"function","file":"tag.h","line":106,"lineto":106,"args":[{"name":"t","type":"git_tag *","comment":"ag a previously loaded tag."}],"argline":"git_tag *t","sig":"git_tag *","return":{"type":"const git_signature *","comment":"reference to the tag's author"},"description":"Get the tagger (author) of a tag\n@param tag a previously loaded tag.\n@return reference to the tag's author","comments":"","group":"tag"},"git_tag_message":{"type":"function","file":"tag.h","line":113,"lineto":113,"args":[{"name":"t","type":"git_tag *","comment":"ag a previously loaded tag."}],"argline":"git_tag *t","sig":"git_tag *","return":{"type":"const char *","comment":"message of the tag"},"description":"Get the message of a tag\n@param tag a previously loaded tag.\n@return message of the tag","comments":"","group":"tag"},"git_tag_set_target":{"type":"function","file":"tag.h","line":120,"lineto":120,"args":[{"name":"tag","type":"git_tag *","comment":"The tag to modify"},{"name":"target","type":"git_object *","comment":"the new tagged target"}],"argline":"git_tag *tag, git_object *target","sig":"git_tag *::git_object *","return":{"type":"void"},"description":"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","comments":"","group":"tag"},"git_tag_set_name":{"type":"function","file":"tag.h","line":127,"lineto":127,"args":[{"name":"tag","type":"git_tag *","comment":"The tag to modify"},{"name":"name","type":"const char *","comment":"the new name for the tag"}],"argline":"git_tag *tag, const char *name","sig":"git_tag *::const char *","return":{"type":"void"},"description":"Set the name of a tag\n@param tag The tag to modify\n@param name the new name for the tag","comments":"","group":"tag"},"git_tag_set_tagger":{"type":"function","file":"tag.h","line":134,"lineto":134,"args":[{"name":"tag","type":"git_tag *","comment":"The tag to modify"},{"name":"tagger_sig","type":"const git_signature *","comment":"signature of the tagging action"}],"argline":"git_tag *tag, const git_signature *tagger_sig","sig":"git_tag *::const git_signature *","return":{"type":"void"},"description":"Set the tagger of a tag\n@param tag The tag to modify\n@param tagger_sig signature of the tagging action","comments":"","group":"tag"},"git_tag_set_message":{"type":"function","file":"tag.h","line":141,"lineto":141,"args":[{"name":"tag","type":"git_tag *","comment":"The tag to modify"},{"name":"message","type":"const char *","comment":"the new tagger for the tag"}],"argline":"git_tag *tag, const char *message","sig":"git_tag *::const char *","return":{"type":"void"},"description":"Set the message of a tag\n@param tag The tag to modify\n@param message the new tagger for the tag","comments":"","group":"tag"},"git_commit_lookup":{"type":"function","file":"commit.h","line":53,"lineto":56,"args":[{"name":"commit","type":"git_commit **","comment":"pointer to the looked up commit"},{"name":"repo","type":"git_repository *","comment":"the repo to use when locating the commit."},{"name":"id","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."}],"argline":"git_commit **commit, git_repository *repo, const git_oid *id","sig":"git_commit **::git_repository *::const git_oid *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Lookup a commit object from a repository.\nThe generated commit object is owned by the revision\nrepo and shall not be freed by the user.","comments":"","group":"commit"},"git_commit_new":{"type":"function","file":"commit.h","line":69,"lineto":72,"args":[{"name":"commit","type":"git_commit **","comment":"pointer to the new commit"},{"name":"repo","type":"git_repository *","comment":"The repository where the object will reside"}],"argline":"git_commit **commit, git_repository *repo","sig":"git_commit **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Create a new in-memory git_commit.","comments":"The commit object must be manually filled using\nsetter methods before it can be written to its\nrepository.\n","group":"commit"},"git_commit_id":{"type":"function","file":"commit.h","line":79,"lineto":79,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const git_oid *","comment":"object identity for the commit."},"description":"Get the id of a commit.\n@param commit a previously loaded commit.\n@return object identity for the commit.","comments":"","group":"commit"},"git_commit_message_short":{"type":"function","file":"commit.h","line":86,"lineto":86,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const char *","comment":"the short message of a commit"},"description":"Get the short (one line) message of a commit.\n@param commit a previously loaded commit.\n@return the short message of a commit","comments":"","group":"commit"},"git_commit_message":{"type":"function","file":"commit.h","line":93,"lineto":93,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const char *","comment":"the message of a commit"},"description":"Get the full message of a commit.\n@param commit a previously loaded commit.\n@return the message of a commit","comments":"","group":"commit"},"git_commit_time":{"type":"function","file":"commit.h","line":100,"lineto":100,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"time_t","comment":"the time of a commit"},"description":"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","comments":"","group":"commit"},"git_commit_time_offset":{"type":"function","file":"commit.h","line":107,"lineto":107,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"int","comment":"positive or negative timezone offset, in minutes from UTC"},"description":"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","comments":"","group":"commit"},"git_commit_committer":{"type":"function","file":"commit.h","line":114,"lineto":114,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const git_signature *","comment":"the committer of a commit"},"description":"Get the committer of a commit.\n@param commit a previously loaded commit.\n@return the committer of a commit","comments":"","group":"commit"},"git_commit_author":{"type":"function","file":"commit.h","line":121,"lineto":121,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const git_signature *","comment":"the author of a commit"},"description":"Get the author of a commit.\n@param commit a previously loaded commit.\n@return the author of a commit","comments":"","group":"commit"},"git_commit_tree":{"type":"function","file":"commit.h","line":128,"lineto":128,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const git_tree *","comment":"the tree of a commit"},"description":"Get the tree pointed to by a commit.\n@param commit a previously loaded commit.\n@return the tree of a commit","comments":"","group":"commit"},"git_commit_parentcount":{"type":"function","file":"commit.h","line":136,"lineto":136,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"unsigned int","comment":"integer of count of parents"},"description":"Get the number of parents of this commit","comments":"","group":"commit"},"git_commit_parent":{"type":"function","file":"commit.h","line":144,"lineto":144,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."},{"name":"n","type":"unsigned int","comment":"the position of the entry"}],"argline":"git_commit *commit, unsigned int n","sig":"git_commit *::unsigned int","return":{"type":"git_commit *","comment":"a pointer to the commit; NULL if out of bounds"},"description":"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","comments":"","group":"commit"},"git_commit_add_parent":{"type":"function","file":"commit.h","line":152,"lineto":152,"args":[{"name":"commit","type":"git_commit *","comment":"the commit object"},{"name":"new_parent","type":"git_commit *","comment":"the new commit which will be a parent"}],"argline":"git_commit *commit, git_commit *new_parent","sig":"git_commit *::git_commit *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"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","comments":"","group":"commit"},"git_commit_set_message":{"type":"function","file":"commit.h","line":159,"lineto":159,"args":[{"name":"commit","type":"git_commit *","comment":"the commit object"},{"name":"message","type":"const char *","comment":"the new message"}],"argline":"git_commit *commit, const char *message","sig":"git_commit *::const char *","return":{"type":"void"},"description":"Set the message of a commit\n@param commit the commit object\n@param message the new message","comments":"","group":"commit"},"git_commit_set_committer":{"type":"function","file":"commit.h","line":166,"lineto":166,"args":[{"name":"commit","type":"git_commit *","comment":"the commit object"},{"name":"committer_sig","type":"const git_signature *"}],"argline":"git_commit *commit, const git_signature *committer_sig","sig":"git_commit *::const git_signature *","return":{"type":"void"},"description":"Set the committer of a commit\n@param commit the commit object\n@param author_sig signature of the committer","comments":"","group":"commit"},"git_commit_set_author":{"type":"function","file":"commit.h","line":173,"lineto":173,"args":[{"name":"commit","type":"git_commit *","comment":"the commit object"},{"name":"author_sig","type":"const git_signature *","comment":"signature of the author"}],"argline":"git_commit *commit, const git_signature *author_sig","sig":"git_commit *::const git_signature *","return":{"type":"void"},"description":"Set the author of a commit\n@param commit the commit object\n@param author_sig signature of the author","comments":"","group":"commit"},"git_commit_set_tree":{"type":"function","file":"commit.h","line":180,"lineto":180,"args":[{"name":"commit","type":"git_commit *","comment":"the commit object"},{"name":"tree","type":"git_tree *","comment":"the new tree"}],"argline":"git_commit *commit, git_tree *tree","sig":"git_commit *::git_tree *","return":{"type":"void"},"description":"Set the tree which is pointed to by a commit\n@param commit the commit object\n@param tree the new tree","comments":"","group":"commit"},"deflateBound":{"type":"function","file":"zlib.h","line":50,"lineto":54,"args":[{"name":"stream","type":"z_streamp","comment":"the stream pointer."},{"name":"s","type":"size_t","comment":"tream the stream pointer."}],"argline":"z_streamp stream, size_t s","sig":"z_streamp::size_t","return":{"type":"size_t","comment":"maximum length of the compressed data."},"description":"deflateBound returns an upper bound on the compressed size.","comments":"This is a stub function used when zlib does not supply the\ndeflateBound() implementation itself.\n","group":"zlib"},"git_tree_lookup":{"type":"function","file":"tree.h","line":52,"lineto":55,"args":[{"name":"tree","type":"git_tree **","comment":"pointer to the looked up tree"},{"name":"repo","type":"git_repository *","comment":"the repo to use when locating the tree."},{"name":"id","type":"const git_oid *","comment":"identity of the tree to locate."}],"argline":"git_tree **tree, git_repository *repo, const git_oid *id","sig":"git_tree **::git_repository *::const git_oid *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Lookup a tree object from the repository.\nThe generated tree object is owned by the revision\nrepo and shall not be freed by the user.","comments":"","group":"tree"},"git_tree_new":{"type":"function","file":"tree.h","line":68,"lineto":71,"args":[{"name":"tree","type":"git_tree **","comment":"pointer to the new tree"},{"name":"repo","type":"git_repository *","comment":"The repository where the object will reside"}],"argline":"git_tree **tree, git_repository *repo","sig":"git_tree **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Create a new in-memory git_tree.","comments":"The tree object must be manually filled using\nsetter methods before it can be written to its\nrepository.\n","group":"tree"},"git_tree_id":{"type":"function","file":"tree.h","line":78,"lineto":78,"args":[{"name":"tree","type":"git_tree *","comment":"a previously loaded tree."}],"argline":"git_tree *tree","sig":"git_tree *","return":{"type":"const git_oid *","comment":"object identity for the tree."},"description":"Get the id of a tree.\n@param tree a previously loaded tree.\n@return object identity for the tree.","comments":"","group":"tree"},"git_tree_entrycount":{"type":"function","file":"tree.h","line":86,"lineto":86,"args":[{"name":"tree","type":"git_tree *","comment":"a previously loaded tree."}],"argline":"git_tree *tree","sig":"git_tree *","return":{"type":"size_t","comment":"the number of entries in the tree"},"description":"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","comments":"","group":"tree"},"git_tree_entry_byname":{"type":"function","file":"tree.h","line":94,"lineto":94,"args":[{"name":"tree","type":"git_tree *","comment":"a previously loaded tree."},{"name":"filename","type":"const char *","comment":"the filename of the desired entry"}],"argline":"git_tree *tree, const char *filename","sig":"git_tree *::const char *","return":{"type":"git_tree_entry *","comment":"the tree entry; NULL if not found"},"description":"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","comments":"","group":"tree"},"git_tree_entry_byindex":{"type":"function","file":"tree.h","line":102,"lineto":102,"args":[{"name":"tree","type":"git_tree *","comment":"a previously loaded tree."},{"name":"idx","type":"int","comment":"the position in the entry list"}],"argline":"git_tree *tree, int idx","sig":"git_tree *::int","return":{"type":"git_tree_entry *","comment":"the tree entry; NULL if not found"},"description":"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","comments":"","group":"tree"},"git_tree_entry_attributes":{"type":"function","file":"tree.h","line":109,"lineto":109,"args":[{"name":"entry","type":"git_tree_entry *","comment":"a tree entry"}],"argline":"git_tree_entry *entry","sig":"git_tree_entry *","return":{"type":"unsigned int","comment":"attributes as an integer"},"description":"Get the UNIX file attributes of a tree entry\n@param entry a tree entry\n@return attributes as an integer","comments":"","group":"tree"},"git_tree_entry_name":{"type":"function","file":"tree.h","line":116,"lineto":116,"args":[{"name":"entry","type":"git_tree_entry *","comment":"a tree entry"}],"argline":"git_tree_entry *entry","sig":"git_tree_entry *","return":{"type":"const char *","comment":"the name of the file"},"description":"Get the filename of a tree entry\n@param entry a tree entry\n@return the name of the file","comments":"","group":"tree"},"git_tree_entry_id":{"type":"function","file":"tree.h","line":123,"lineto":123,"args":[{"name":"entry","type":"git_tree_entry *","comment":"a tree entry"}],"argline":"git_tree_entry *entry","sig":"git_tree_entry *","return":{"type":"const git_oid *","comment":"the oid of the object"},"description":"Get the id of the object pointed by the entry\n@param entry a tree entry\n@return the oid of the object","comments":"","group":"tree"},"git_tree_entry_2object":{"type":"function","file":"tree.h","line":132,"lineto":132,"args":[{"name":"object","type":"git_object **","comment":"pointer to the converted object"},{"name":"entry","type":"git_tree_entry *","comment":"a tree entry"}],"argline":"git_object **object, git_tree_entry *entry","sig":"git_object **::git_tree_entry *","return":{"type":"int","comment":"a reference to the pointed object in the repository"},"description":"Convert a tree entry to the git_object it points too.","comments":"","group":"tree"},"git_tree_add_entry":{"type":"function","file":"tree.h","line":149,"lineto":149,"args":[{"name":"entry_out","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":"tree","type":"git_tree *","comment":"Tree object to store the entry @iparam id OID for the tree entry"},{"name":"id","type":"const git_oid *"},{"name":"filename","type":"const char *","comment":"Filename for the tree entry"},{"name":"attributes","type":"int","comment":"UNIX file attributes for the entry"}],"argline":"git_tree_entry **entry_out, git_tree *tree, const git_oid *id, const char *filename, int attributes","sig":"git_tree_entry **::git_tree *::const git_oid *::const char *::int","return":{"type":"int","comment":"0 on success; otherwise error code"},"description":"Add a new entry to a tree and return the new entry.","comments":"This will mark the tree as modified; the new entry will\nbe written back to disk on the next git_object_write()\n","group":"tree"},"git_tree_add_entry_unsorted":{"type":"function","file":"tree.h","line":166,"lineto":166,"args":[{"name":"entry","type":"git_tree_entry **","comment":"Entry object which will be created"},{"name":"tree","type":"git_tree *","comment":"Tree object to store the entry @iparam id OID for the tree entry"},{"name":"id","type":"const git_oid *"},{"name":"filename","type":"const char *","comment":"Filename for the tree entry"},{"name":"attributes","type":"int","comment":"UNIX file attributes for the entry"}],"argline":"git_tree_entry **entry, git_tree *tree, const git_oid *id, const char *filename, int attributes","sig":"git_tree_entry **::git_tree *::const git_oid *::const char *::int","return":{"type":"int","comment":"0 on success; otherwise error code"},"description":"Add a new entry to a tree, returning that new entry.\nThe only difference with this call is that it does not sort\ntree afterwards, this requirement is left to the caller.","comments":"This will mark the tree as modified; the new entry will\nbe written back to disk on the next git_object_write()\n","group":"tree"},"git_tree_sort_entries":{"type":"function","file":"tree.h","line":179,"lineto":179,"args":[{"name":"tree","type":"git_tree *","comment":"Tree object whose entries are to be sorted"}],"argline":"git_tree *tree","sig":"git_tree *","return":{"type":"int","comment":"0 on success; otherwise error code"},"description":"Sort the entries in a tree created using git_tree_add_entry2.","comments":"This does not mark the tree as modified. It is intended to be used\nafter several invocations of git_tree_add_entry2.\ngit_tree_add_entry, on the other hand, sorts after each entry is\nadded.\n","group":"tree"},"git_tree_remove_entry_byindex":{"type":"function","file":"tree.h","line":193,"lineto":193,"args":[{"name":"tree","type":"git_tree *","comment":"Tree where to remove the entry"},{"name":"idx","type":"int","comment":"index of the entry"}],"argline":"git_tree *tree, int idx","sig":"git_tree *::int","return":{"type":"int","comment":"0 on successful removal; GIT_ENOTFOUND if the entry wasn't found"},"description":"Remove an entry by its index.","comments":"Index must be >= 0 and < than git_tree_entrycount().\n\nThis will mark the tree as modified; the modified entry will\nbe written back to disk on the next git_object_write()\n","group":"tree"},"git_tree_remove_entry_byname":{"type":"function","file":"tree.h","line":205,"lineto":205,"args":[{"name":"tree","type":"git_tree *","comment":"Tree where to remove the entry"},{"name":"filename","type":"const char *","comment":"File name of the entry"}],"argline":"git_tree *tree, const char *filename","sig":"git_tree *::const char *","return":{"type":"int","comment":"0 on successful removal; GIT_ENOTFOUND if the entry wasn't found"},"description":"Remove an entry by its filename.","comments":"This will mark the tree as modified; the modified entry will\nbe written back to disk on the next git_object_write()\n","group":"tree"},"git_tree_clear_entries":{"type":"function","file":"tree.h","line":215,"lineto":215,"args":[{"name":"tree","type":"git_tree *","comment":"Tree object whose entries are to be sorted"}],"argline":"git_tree *tree","sig":"git_tree *","return":{"type":"void"},"description":"Clear all the entries in a tree.","comments":"This will mark the tree as modified; the modified entry will\nbe written back to disk on the next git_object_write().\n","group":"tree"},"git_tree_entry_set_id":{"type":"function","file":"tree.h","line":226,"lineto":226,"args":[{"name":"entry","type":"git_tree_entry *","comment":"Entry object which will be modified"},{"name":"oid","type":"const git_oid *","comment":"new SHA1 oid for the entry"}],"argline":"git_tree_entry *entry, const git_oid *oid","sig":"git_tree_entry *::const git_oid *","return":{"type":"void"},"description":"Change the SHA1 id of a tree entry.","comments":"This will mark the tree that contains the entry as modified;\nthe modified entry will be written back to disk on the next git_object_write()\n","group":"tree"},"git_tree_entry_set_name":{"type":"function","file":"tree.h","line":237,"lineto":237,"args":[{"name":"entry","type":"git_tree_entry *","comment":"Entry object which will be modified"},{"name":"name","type":"const char *"}],"argline":"git_tree_entry *entry, const char *name","sig":"git_tree_entry *::const char *","return":{"type":"void"},"description":"Change the filename of a tree entry.","comments":"This will mark the tree that contains the entry as modified;\nthe modified entry will be written back to disk on the next git_object_write()\n","group":"tree"},"git_tree_entry_set_attributes":{"type":"function","file":"tree.h","line":248,"lineto":248,"args":[{"name":"entry","type":"git_tree_entry *","comment":"Entry object which will be modified"},{"name":"attr","type":"int"}],"argline":"git_tree_entry *entry, int attr","sig":"git_tree_entry *::int","return":{"type":"void"},"description":"Change the attributes of a tree entry.","comments":"This will mark the tree that contains the entry as modified;\nthe modified entry will be written back to disk on the next git_object_write()\n","group":"tree"},"git_odb_new":{"type":"function","file":"odb.h","line":52,"lineto":52,"args":[{"name":"out","type":"git_odb **","comment":"location to store the database pointer, if opened. Set to NULL if the open failed."}],"argline":"git_odb **out","sig":"git_odb **","return":{"type":"int","comment":"GIT_SUCCESS if the database was created; otherwise an error code describing why the open was not possible."},"description":"Create a new object database with no backends.","comments":"Before the ODB can be used for read/writing, a custom database\nbackend must be manually added using `git_odb_add_backend()`\n","group":"odb"},"git_odb_open":{"type":"function","file":"odb.h","line":71,"lineto":71,"args":[{"name":"out","type":"git_odb **","comment":"location to store the database pointer, if opened. Set to NULL if the open failed."},{"name":"objects_dir","type":"const char *","comment":"path of the backends' \"objects\" directory."}],"argline":"git_odb **out, const char *objects_dir","sig":"git_odb **::const char *","return":{"type":"int","comment":"GIT_SUCCESS if the database opened; otherwise an error code describing why the open was not possible."},"description":"Create a new object database and automatically add\nthe two default backends:","comments":"- git_odb_backend_loose: read and write loose object files\n\tfrom disk, assuming `objects_dir` as the Objects folder\n\n- git_odb_backend_pack: read objects from packfiles,\n\tassuming `objects_dir` as the Objects folder which\n\tcontains a 'pack/' folder with the corresponding data\n","group":"odb"},"git_odb_add_backend":{"type":"function","file":"odb.h","line":82,"lineto":82,"args":[{"name":"odb","type":"git_odb *","comment":"database to add the backend to"},{"name":"backend","type":"git_odb_backend *"}],"argline":"git_odb *odb, git_odb_backend *backend","sig":"git_odb *::git_odb_backend *","return":{"type":"int","comment":"0 on sucess; error code otherwise"},"description":"Add a custom backend to an existing Object DB","comments":"Read <odb_backends.h> for more information.\n","group":"odb"},"git_odb_close":{"type":"function","file":"odb.h","line":88,"lineto":88,"args":[{"name":"db","type":"git_odb *","comment":"database pointer to close. If NULL no action is taken."}],"argline":"git_odb *db","sig":"git_odb *","return":{"type":"void"},"description":"Close an open object database.\n@param db database pointer to close. If NULL no action is taken.","comments":"","group":"odb"},"git_odb_read":{"type":"function","file":"odb.h","line":109,"lineto":109,"args":[{"name":"out","type":"git_rawobj *","comment":"object descriptor to populate upon reading."},{"name":"db","type":"git_odb *","comment":"database to search for the object in."},{"name":"id","type":"const git_oid *","comment":"identity of the object to read."}],"argline":"git_rawobj *out, git_odb *db, const git_oid *id","sig":"git_rawobj *::git_odb *::const git_oid *","return":{"type":"int","comment":"- GIT_SUCCESS if the object was read; - GIT_ENOTFOUND if the object is not in the database."},"description":"Read an object from the database.","comments":"If GIT_ENOTFOUND then out->data is set to NULL.\n","group":"odb"},"git_odb_read_header":{"type":"function","file":"odb.h","line":128,"lineto":128,"args":[{"name":"out","type":"git_rawobj *","comment":"object descriptor to populate upon reading."},{"name":"db","type":"git_odb *","comment":"database to search for the object in."},{"name":"id","type":"const git_oid *","comment":"identity of the object to read."}],"argline":"git_rawobj *out, git_odb *db, const git_oid *id","sig":"git_rawobj *::git_odb *::const git_oid *","return":{"type":"int","comment":"- GIT_SUCCESS if the object was read; - GIT_ENOTFOUND if the object is not in the database."},"description":"Read the header of an object from the database, without\nreading its full contents.","comments":"Only the 'type' and 'len' fields of the git_rawobj structure\nare filled. The 'data' pointer will always be NULL.\n\nThe raw object pointed by 'out' doesn't need to be manually\nclosed with git_rawobj_close().\n","group":"odb"},"git_odb_write":{"type":"function","file":"odb.h","line":140,"lineto":140,"args":[{"name":"id","type":"git_oid *","comment":"identity of the object written."},{"name":"db","type":"git_odb *","comment":"database to which the object should be written."},{"name":"obj","type":"git_rawobj *","comment":"object descriptor for the object to write."}],"argline":"git_oid *id, git_odb *db, git_rawobj *obj","sig":"git_oid *::git_odb *::git_rawobj *","return":{"type":"int","comment":"- GIT_SUCCESS if the object was written; - GIT_ERROR otherwise."},"description":"Write an object to the database.","comments":"","group":"odb"},"git_odb_exists":{"type":"function","file":"odb.h","line":151,"lineto":151,"args":[{"name":"db","type":"git_odb *","comment":"database to be searched for the given object."},{"name":"id","type":"const git_oid *","comment":"the object to search for."}],"argline":"git_odb *db, const git_oid *id","sig":"git_odb *::const git_oid *","return":{"type":"int","comment":"- true, if the object was found - false, otherwise"},"description":"Determine if the given object can be found in the object database.","comments":"","group":"odb"},"git_rawobj_hash":{"type":"function","file":"odb.h","line":169,"lineto":169,"args":[{"name":"id","type":"git_oid *","comment":"the resulting object-ID."},{"name":"obj","type":"git_rawobj *","comment":"the object whose hash is to be determined."}],"argline":"git_oid *id, git_rawobj *obj","sig":"git_oid *::git_rawobj *","return":{"type":"int","comment":"- GIT_SUCCESS if the object-ID was correctly determined. - GIT_ERROR if the given object is malformed."},"description":"Determine the object-ID (sha1 hash) of the given git_rawobj.","comments":"The input obj must be a valid loose object type and the data\npointer must not be NULL, unless the len field is also zero.\n","group":"rawobj"},"git_rawobj_close":{"type":"function","file":"odb.h","line":180,"lineto":180,"args":[{"name":"obj","type":"git_rawobj *","comment":"object descriptor to free."}],"argline":"git_rawobj *obj","sig":"git_rawobj *","return":{"type":"void"},"description":"Release all memory used by the obj structure.","comments":"As a result of this call, obj->data will be set to NULL.\n\nIf obj->data is already NULL, nothing happens.\n","group":"rawobj"},"git_oid_mkstr":{"type":"function","file":"oid.h","line":60,"lineto":60,"args":[{"name":"out","type":"git_oid *","comment":"oid structure the result is written into."},{"name":"str","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)."}],"argline":"git_oid *out, const char *str","sig":"git_oid *::const char *","return":{"type":"int","comment":"GIT_SUCCESS if valid; GIT_ENOTOID on failure."},"description":"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.","comments":"","group":"oid"},"git_oid_mkraw":{"type":"function","file":"oid.h","line":67,"lineto":67,"args":[{"name":"out","type":"git_oid *","comment":"oid structure the result is written into."},{"name":"raw","type":"const unsigned char *","comment":"the raw input bytes to be copied."}],"argline":"git_oid *out, const unsigned char *raw","sig":"git_oid *::const unsigned char *","return":{"type":"void"},"description":"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.","comments":"","group":"oid"},"git_oid_fmt":{"type":"function","file":"oid.h","line":78,"lineto":78,"args":[{"name":"str","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":"oid","type":"const git_oid *","comment":"oid structure to format."}],"argline":"char *str, const git_oid *oid","sig":"char *::const git_oid *","return":{"type":"void"},"description":"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.","comments":"","group":"oid"},"git_oid_pathfmt":{"type":"function","file":"oid.h","line":93,"lineto":93,"args":[{"name":"str","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":"oid","type":"const git_oid *","comment":"oid structure to format."}],"argline":"char *str, const git_oid *oid","sig":"char *::const git_oid *","return":{"type":"void"},"description":"Format a git_oid into a loose-object path string.\n<p>\nThe resulting string is \"aa/...\", where \"aa\" is the first two\nhex digitis of the oid and \"...\" is the remaining 38 digits.","comments":"","group":"oid"},"git_oid_allocfmt":{"type":"function","file":"oid.h","line":101,"lineto":101,"args":[{"name":"oid","type":"const git_oid *","comment":"the oid structure to format"}],"argline":"const git_oid *oid","sig":"const git_oid *","return":{"type":"char *","comment":"the c-string; NULL if memory is exhausted. Caller must deallocate the string with free()."},"description":"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().","comments":"","group":"oid"},"git_oid_to_string":{"type":"function","file":"oid.h","line":118,"lineto":118,"args":[{"name":"out","type":"char *","comment":"the buffer into which the oid string is output."},{"name":"n","type":"size_t","comment":"the size of the out buffer."},{"name":"oid","type":"const git_oid *","comment":"the oid structure to format."}],"argline":"char *out, size_t n, const git_oid *oid","sig":"char *::size_t::const git_oid *","return":{"type":"char *","comment":"the out buffer pointer, assuming no input parameter errors, otherwise a pointer to an empty string."},"description":"Format a git_oid into a buffer as a hex format c-string.\n<p>\nIf the buffer is smaller than GIT_OID_HEXSZ+1, then the resulting\noid c-string will be truncated to n-1 characters. If there are\nany input parameter errors (out == NULL, n == 0, oid == NULL),\nthen a pointer to an empty string is returned, so that the return\nvalue can always be printed.","comments":"","group":"oid"},"git_oid_cpy":{"type":"function","file":"oid.h","line":125,"lineto":125,"args":[{"name":"out","type":"git_oid *","comment":"oid structure the result is written into."},{"name":"src","type":"const git_oid *","comment":"oid structure to copy from."}],"argline":"git_oid *out, const git_oid *src","sig":"git_oid *::const git_oid *","return":{"type":"void"},"description":"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.","comments":"","group":"oid"},"git_oid_cmp":{"type":"function","file":"oid.h","line":133,"lineto":133,"args":[{"name":"a","type":"const git_oid *","comment":"first oid structure."},{"name":"b","type":"const git_oid *","comment":"second oid structure."}],"argline":"const git_oid *a, const git_oid *b","sig":"const git_oid *::const git_oid *","return":{"type":"int","comment":"<0, 0, >0 if a < b, a == b, a > b."},"description":"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.","comments":"","group":"oid"},"git_strerror":{"type":"function","file":"errors.h","line":41,"lineto":41,"args":[{"name":"num","type":"int","comment":"The error code to explain"}],"argline":"int num","sig":"int","return":{"type":"const char *","comment":"a string explaining the error code"},"description":"strerror() for the Git library\n@param num The error code to explain\n@return a string explaining the error code","comments":"","group":"errors"},"git_revwalk_new":{"type":"function","file":"revwalk.h","line":76,"lineto":76,"args":[{"name":"walker","type":"git_revwalk **","comment":"pointer to the new revision walker"},{"name":"repo","type":"git_repository *","comment":"the repo to walk through"}],"argline":"git_revwalk **walker, git_repository *repo","sig":"git_revwalk **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Allocate a new revision walker to iterate through a repo.","comments":"","group":"revwalk"},"git_revwalk_reset":{"type":"function","file":"revwalk.h","line":82,"lineto":82,"args":[{"name":"walker","type":"git_revwalk *","comment":"handle to reset."}],"argline":"git_revwalk *walker","sig":"git_revwalk *","return":{"type":"void"},"description":"Reset the walking machinery for reuse.\n@param walker handle to reset.","comments":"","group":"revwalk"},"git_revwalk_push":{"type":"function","file":"revwalk.h","line":91,"lineto":91,"args":[{"name":"walk","type":"git_revwalk *","comment":"er the walker being used for the traversal."},{"name":"commit","type":"git_commit *","comment":"the commit to start from."}],"argline":"git_revwalk *walk, git_commit *commit","sig":"git_revwalk *::git_commit *","return":{"type":"int"},"description":"Mark a commit to start traversal from.\nThe commit object must belong to the repo which is being walked through.","comments":"","group":"revwalk"},"git_revwalk_hide":{"type":"function","file":"revwalk.h","line":98,"lineto":98,"args":[{"name":"walk","type":"git_revwalk *","comment":"er the walker being used for the traversal."},{"name":"commit","type":"git_commit *","comment":"the commit that will be ignored during the traversal"}],"argline":"git_revwalk *walk, git_commit *commit","sig":"git_revwalk *::git_commit *","return":{"type":"int"},"description":"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","comments":"","group":"revwalk"},"git_revwalk_next":{"type":"function","file":"revwalk.h","line":108,"lineto":108,"args":[{"name":"commit","type":"git_commit **","comment":"Pointer where to store the next commit"},{"name":"walk","type":"git_revwalk *","comment":"the walker to pop the commit from."}],"argline":"git_commit **commit, git_revwalk *walk","sig":"git_commit **::git_revwalk *","return":{"type":"int","comment":"GIT_SUCCESS if the next commit was found; GIT_EREVWALKOVER if there are no commits left to iterate"},"description":"Get the next commit from the revision traversal.","comments":"","group":"revwalk"},"git_revwalk_sorting":{"type":"function","file":"revwalk.h","line":117,"lineto":117,"args":[{"name":"walk","type":"git_revwalk *","comment":"the walker being used for the traversal."},{"name":"sort_mode","type":"unsigned int","comment":"combination of GIT_RPSORT_XXX flags"}],"argline":"git_revwalk *walk, unsigned int sort_mode","sig":"git_revwalk *::unsigned int","return":{"type":"int"},"description":"Change the sorting mode when iterating through the\nrepository's contents.\nChanging 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","comments":"","group":"revwalk"},"git_revwalk_free":{"type":"function","file":"revwalk.h","line":123,"lineto":123,"args":[{"name":"walk","type":"git_revwalk *","comment":"traversal handle to close. If NULL nothing occurs."}],"argline":"git_revwalk *walk","sig":"git_revwalk *","return":{"type":"void"},"description":"Free a revwalk previously allocated.\n@param walk traversal handle to close. If NULL nothing occurs.","comments":"","group":"revwalk"},"git_revwalk_repository":{"type":"function","file":"revwalk.h","line":132,"lineto":132,"args":[{"name":"walk","type":"git_revwalk *","comment":"the revision walker"}],"argline":"git_revwalk *walk","sig":"git_revwalk *","return":{"type":"git_repository *","comment":"the repository being walked"},"description":"Return the repository on which this walker\nis operating.","comments":"","group":"revwalk"},"git_object_write":{"type":"function","file":"object.h","line":58,"lineto":58,"args":[{"name":"object","type":"git_object *","comment":"Git object to write back"}],"argline":"git_object *object","sig":"git_object *","return":{"type":"int","comment":"0 on success; otherwise an error code"},"description":"Write back an object to disk.","comments":"The object will be written to its corresponding\nrepository.\n\nIf the object has no changes since it was first\nread from the repository, no actions will take place.\n\nIf the object has been modified since it was read from\nthe repository, or it has been created from scratch\nin memory, it will be written to the repository and\nits SHA1 ID will be updated accordingly.\n","group":"object"},"git_object_id":{"type":"function","file":"object.h","line":69,"lineto":69,"args":[{"name":"obj","type":"git_object *","comment":"the repository object"}],"argline":"git_object *obj","sig":"git_object *","return":{"type":"const git_oid *","comment":"the SHA1 id"},"description":"Get the id (SHA1) of a repository object","comments":"In-memory objects created by git_object_new() do not\nhave a SHA1 ID until they are written on a repository.\n","group":"object"},"git_object_type":{"type":"function","file":"object.h","line":77,"lineto":77,"args":[{"name":"obj","type":"git_object *","comment":"the repository object"}],"argline":"git_object *obj","sig":"git_object *","return":{"type":"git_otype","comment":"the object's type"},"description":"Get the object type of an object","comments":"","group":"object"},"git_object_owner":{"type":"function","file":"object.h","line":85,"lineto":85,"args":[{"name":"obj","type":"git_object *","comment":"the object"}],"argline":"git_object *obj","sig":"git_object *","return":{"type":"git_repository *","comment":"the repository who owns this object"},"description":"Get the repository that owns this object","comments":"","group":"object"},"git_object_free":{"type":"function","file":"object.h","line":99,"lineto":99,"args":[{"name":"object","type":"git_object *","comment":"the object to free"}],"argline":"git_object *object","sig":"git_object *","return":{"type":"void"},"description":"Free a reference to one of the objects in the repository.","comments":"Repository objects are managed automatically by the library,\nbut this method can be used to force freeing one of the\nobjects.\n\nCareful: freeing objects in the middle of a repository\ntraversal will most likely cause errors.\n","group":"object"},"git_object_type2string":{"type":"function","file":"object.h","line":110,"lineto":110,"args":[{"name":"type","type":"git_otype","comment":"object type to convert."}],"argline":"git_otype type","sig":"git_otype","return":{"type":"const char *","comment":"the corresponding string representation."},"description":"Convert an object type to it's string representation.","comments":"The result is a pointer to a string in static memory and\nshould not be free()'ed.\n","group":"object"},"git_object_string2type":{"type":"function","file":"object.h","line":118,"lineto":118,"args":[{"name":"str","type":"const char *","comment":"the string to convert."}],"argline":"const char *str","sig":"const char *","return":{"type":"git_otype","comment":"the corresponding git_otype."},"description":"Convert a string object type representation to it's git_otype.","comments":"","group":"object"},"git_object_typeisloose":{"type":"function","file":"object.h","line":127,"lineto":127,"args":[{"name":"type","type":"git_otype","comment":"object type to test."}],"argline":"git_otype type","sig":"git_otype","return":{"type":"int","comment":"true if the type represents a valid loose object type, false otherwise."},"description":"Determine if the given git_otype is a valid loose object type.","comments":"","group":"object"},"git_object__size":{"type":"function","file":"object.h","line":141,"lineto":141,"args":[{"name":"type","type":"git_otype","comment":"object type to get its size"}],"argline":"git_otype type","sig":"git_otype","return":{"type":"size_t","comment":"size in bytes of the object"},"description":"Get the size in bytes for the structure which\nacts as an in-memory representation of any given\nobject type.","comments":"For all the core types, this would the equivalent\nof calling `sizeof(git_commit)` if the core types\nwere not opaque on the external API.\n","group":"object"},"git_reference_new":{"type":"function","file":"refs.h","line":52,"lineto":52,"args":[{"name":"ref_out","type":"git_reference **","comment":"Pointer to the newly created reference"},{"name":"repo","type":"git_repository *","comment":"Repository where that reference exists"}],"argline":"git_reference **ref_out, git_repository *repo","sig":"git_reference **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Create a new reference.","comments":"The reference will be empty and exclusively\nin-memory until it is filled with the setter\nmethods and written back to disk using\n`git_reference_write`.\n","group":"reference"},"git_reference_oid":{"type":"function","file":"refs.h","line":62,"lineto":62,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"const git_oid *","comment":"a pointer to the oid if available, NULL otherwise"},"description":"Get the OID pointed to by a reference.","comments":"Only available if the reference is direct (i.e. not symbolic)\n","group":"reference"},"git_reference_target":{"type":"function","file":"refs.h","line":72,"lineto":72,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"const char *","comment":"a pointer to the name if available, NULL otherwise"},"description":"Get full name to the reference pointed by this reference","comments":"Only available if the reference is symbolic\n","group":"reference"},"git_reference_type":{"type":"function","file":"refs.h","line":82,"lineto":82,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"git_rtype","comment":"the type"},"description":"Get the type of a reference","comments":"Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC)\n","group":"reference"},"git_reference_name":{"type":"function","file":"refs.h","line":90,"lineto":90,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"const char *","comment":"the full name for the ref"},"description":"Get the full name of a reference","comments":"","group":"reference"},"git_reference_resolve":{"type":"function","file":"refs.h","line":105,"lineto":105,"args":[{"name":"resolved_ref","type":"git_reference **","comment":"Pointer to the peeled reference"},{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference **resolved_ref, git_reference *ref","sig":"git_reference **::git_reference *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Resolve a symbolic reference","comments":"Thie method iteratively peels a symbolic reference\nuntil it resolves to a direct reference to an OID.\n\nIf a direct reference is passed as an argument,\nthat reference is returned immediately\n","group":"reference"},"git_reference_write":{"type":"function","file":"refs.h","line":121,"lineto":121,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Write a reference back to disk.","comments":"The reference must have a valid name and a valid target\n(either direct or symbolic).\n\nIf the reference has been loaded from disk and no changes\nhave been made, no action will take place.\n\nThe writing to disk is atomic.\n","group":"reference"},"git_reference_owner":{"type":"function","file":"refs.h","line":129,"lineto":129,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"git_repository *","comment":"a pointer to the repo"},"description":"Get the repository where a reference resides","comments":"","group":"reference"},"git_reference_set_name":{"type":"function","file":"refs.h","line":141,"lineto":141,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"},{"name":"name","type":"const char *","comment":"The new name for the reference"}],"argline":"git_reference *ref, const char *name","sig":"git_reference *::const char *","return":{"type":"void"},"description":"Set the name of a reference.","comments":"This marks the reference as modified; changes\nwon't take effect until it is manually written back\nto disk.\n","group":"reference"},"git_reference_set_target":{"type":"function","file":"refs.h","line":156,"lineto":156,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"},{"name":"target","type":"const char *","comment":"The new target for the reference"}],"argline":"git_reference *ref, const char *target","sig":"git_reference *::const char *","return":{"type":"void"},"description":"Set the target reference of a reference.","comments":"This converts the reference into a symbolic\nreference.\n\nThis marks the reference as modified; changes\nwon't take effect until it is manually written back\nto disk.\n","group":"reference"},"git_reference_set_oid":{"type":"function","file":"refs.h","line":171,"lineto":171,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"},{"name":"id","type":"const git_oid *"}],"argline":"git_reference *ref, const git_oid *id","sig":"git_reference *::const git_oid *","return":{"type":"void"},"description":"Set the OID target of a reference.","comments":"This converts the reference into a direct\nreference.\n\nThis marks the reference as modified; changes\nwon't take effect until it is manually written back\nto disk.\n","group":"reference"}},"globals":{"GIT_BEGIN_DECL":{"value":"","file":"common.h","line":36,"comments":"Start declarations in C mode"},"GIT_END_DECL":{"value":"","file":"common.h","line":38,"comments":"End declarations in C mode"},"GIT_EXTERN(type)":{"value":"extern __attribute__((visibility(\"default\"))) type","file":"common.h","line":42,"comments":"Declare a public function exported for application use."},"GIT_EXTERN_TLS(type)":{"value":"extern __attribute__((visibility(\"default\"))) GIT_TLS type","file":"common.h","line":53,"comments":"Declare a public TLS symbol exported for application use."},"GIT_INLINE(type)":{"value":"static __inline type","file":"common.h","line":65,"comments":"Declare a function as always inlined."},"GIT_FORMAT_PRINTF(a,b)":{"value":"__attribute__((format (printf, a, b)))","file":"common.h","line":72,"comments":"Declare a function's takes printf style arguments."},"GIT_SUCCESS":{"value":"0","file":"common.h","line":87,"comments":"Operation completed successfully."},"GIT_ERROR":{"value":"-1","file":"common.h","line":95,"comments":"Operation failed, with unspecified reason.\nThis value also serves as the base error code; all other\nerror codes are subtracted from it such that all errors\nare < 0, in typical POSIX C tradition."},"GIT_ENOTOID":{"value":"(GIT_ERROR - 1)","file":"common.h","line":98,"comments":"Input was not a properly formatted Git object id."},"GIT_ENOTFOUND":{"value":"(GIT_ERROR - 2)","file":"common.h","line":101,"comments":"Input does not exist in the scope searched."},"GIT_ENOMEM":{"value":"(GIT_ERROR - 3)","file":"common.h","line":104,"comments":"Not enough space available."},"GIT_EOSERR":{"value":"(GIT_ERROR - 4)","file":"common.h","line":107,"comments":"Consult the OS error information."},"GIT_EOBJTYPE":{"value":"(GIT_ERROR - 5)","file":"common.h","line":110,"comments":"The specified object is of invalid type"},"GIT_EOBJCORRUPTED":{"value":"(GIT_ERROR - 6)","file":"common.h","line":113,"comments":"The specified object has its data corrupted"},"GIT_ENOTAREPO":{"value":"(GIT_ERROR - 7)","file":"common.h","line":116,"comments":"The specified repository is invalid"},"GIT_EINVALIDTYPE":{"value":"(GIT_ERROR - 8)","file":"common.h","line":119,"comments":"The object type is invalid or doesn't match"},"GIT_EMISSINGOBJDATA":{"value":"(GIT_ERROR - 9)","file":"common.h","line":122,"comments":"The object cannot be written that because it's missing internal data"},"GIT_EPACKCORRUPTED":{"value":"(GIT_ERROR - 10)","file":"common.h","line":125,"comments":"The packfile for the ODB is corrupted"},"GIT_EFLOCKFAIL":{"value":"(GIT_ERROR - 11)","file":"common.h","line":128,"comments":"Failed to adquire or release a file lock"},"GIT_EZLIB":{"value":"(GIT_ERROR - 12)","file":"common.h","line":131,"comments":"The Z library failed to inflate/deflate an object's data"},"GIT_EBUSY":{"value":"(GIT_ERROR - 13)","file":"common.h","line":134,"comments":"The queried object is currently busy"},"GIT_EBAREINDEX":{"value":"(GIT_ERROR - 14)","file":"common.h","line":137,"comments":"The index file is not backed up by an existing repository"},"GIT_EINVALIDREFNAME":{"value":"(GIT_ERROR - 15)","file":"common.h","line":140,"comments":"The name of the reference is not valid"},"GIT_EREFCORRUPTED":{"value":"(GIT_ERROR - 16)","file":"common.h","line":143,"comments":"The specified reference has its data corrupted"},"GIT_ETOONESTEDSYMREF":{"value":"(GIT_ERROR - 17)","file":"common.h","line":146,"comments":"The specified symbolic reference is too deeply nested"},"GIT_EPACKEDREFSCORRUPTED":{"value":"(GIT_ERROR - 18)","file":"common.h","line":149,"comments":"The pack-refs file is either corrupted of its format is not currently supported"},"GIT_EINVALIDPATH":{"value":"(GIT_ERROR - 19)","file":"common.h","line":152,"comments":"The path is invalid"},"GIT_EREVWALKOVER":{"value":"(GIT_ERROR - 20)","file":"common.h","line":155,"comments":"The revision walker is empty; there are no more commits left to iterate"},"GIT_OID_RAWSZ":{"value":"20","file":"oid.h","line":41,"comments":"Size (in bytes) of a raw/binary oid"},"GIT_OID_HEXSZ":{"value":"(GIT_OID_RAWSZ * 2)","file":"oid.h","line":44,"comments":"Size (in bytes) of a hex formatted oid"},"GIT_SORT_NONE":{"value":"(0)","file":"revwalk.h","line":46,"comments":"Sort the repository contents in no particular ordering;\nthis sorting is arbitrary, implementation-specific\nand subject to change at any time.\nThis is the default sorting for new walkers."},"GIT_SORT_TOPOLOGICAL":{"value":"(1 << 0)","file":"revwalk.h","line":53,"comments":"Sort the repository contents in topological order\n(parents before children); this sorting mode\ncan be combined with time sorting."},"GIT_SORT_TIME":{"value":"(1 << 1)","file":"revwalk.h","line":60,"comments":"Sort the repository contents by commit time;\nthis sorting mode can be combined with\ntopological sorting."},"GIT_SORT_REVERSE":{"value":"(1 << 2)","file":"revwalk.h","line":67,"comments":"Iterate through the repository contents in reverse\norder; this sorting mode can be combined with\nany of the above."}},"types":[["git_blob",{"type":"struct","value":"git_blob","file":"types.h","line":111,"lineto":111,"block":"","tdef":"typedef","comments":"In-memory representation of a blob object.","used":{"returns":[],"needs":["git_blob_lookup","git_blob_new","git_blob_rawcontent","git_blob_rawsize","git_blob_set_rawcontent","git_blob_set_rawcontent_fromfile"]}}],["git_commit",{"type":"struct","value":"git_commit","file":"types.h","line":114,"lineto":114,"block":"","tdef":"typedef","comments":"Parsed representation of a commit object.","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"]}}],["git_index",{"type":"struct","value":"git_index","file":"types.h","line":123,"lineto":123,"block":"","tdef":"typedef","comments":"Memory representation of an index file.","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"]}}],["git_index_entry",{"type":"struct","value":"git_index_entry","file":"index.h","line":54,"lineto":71,"block":"git_index_time ctime\ngit_index_time mtime\nunsigned int dev\nunsigned int ino\nunsigned int mode\nunsigned int uid\nunsigned int gid\ngit_off_t file_size\ngit_oid oid\nunsigned short flags\nunsigned short flags_extended\nchar *path","tdef":"typedef","comments":"Memory representation of a file entry in the index.","used":{"returns":["git_index_get"],"needs":["git_index_insert"]}}],["git_index_time",{"type":"struct","value":"git_index_time","file":"index.h","line":47,"lineto":51,"block":"git_time_t seconds\nunsigned int nanoseconds","tdef":"typedef","comments":"Time used in a git index entry","used":{"returns":[],"needs":[]}}],["git_object",{"type":"struct","value":"git_object","file":"types.h","line":102,"lineto":102,"block":"","tdef":"typedef","comments":"Representation of a generic object in a repository","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","git_tree_entry_2object"]}}],["git_odb",{"type":"struct","value":"git_odb","file":"types.h","line":90,"lineto":90,"block":"","tdef":"typedef","comments":"An open object database handle.","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","git_repository_open3"]}}],["git_odb_backend",{"type":"struct","value":"git_odb_backend","file":"types.h","line":93,"lineto":93,"block":"","tdef":"typedef","comments":"A custom backend in an ODB","used":{"returns":[],"needs":["git_odb_add_backend"]}}],["git_oid",{"type":"struct","value":"git_oid","file":"oid.h","line":47,"lineto":50,"block":"unsigned char id[GIT_OID_RAWSZ]","tdef":"typedef","comments":"Unique identity of any object (commit, tree, blob, tag).","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"]}}],["git_otype",{"type":"enum","file":"types.h","line":76,"lineto":87,"block":"GIT_OBJ_ANY\nGIT_OBJ_BAD\nGIT_OBJ__EXT1\nGIT_OBJ_COMMIT\nGIT_OBJ_TREE\nGIT_OBJ_BLOB\nGIT_OBJ_TAG\nGIT_OBJ__EXT2\nGIT_OBJ_OFS_DELTA\nGIT_OBJ_REF_DELTA","tdef":"typedef","comments":"Basic type (loose or packed) of any Git object.","used":{"returns":[],"needs":["git_object__size","git_object_type2string","git_object_typeisloose","git_repository_lookup","git_repository_newobject"]}}],["git_rawobj",{"type":"struct","value":"git_rawobj","file":"odb.h","line":91,"lineto":95,"block":"void *data\nsize_t len\ngit_otype type","tdef":"typedef","comments":"An object read from the database.","used":{"returns":[],"needs":["git_odb_read","git_odb_read_header","git_odb_write","git_rawobj_close","git_rawobj_hash"]}}],["git_reference",{"type":"struct","value":"git_reference","file":"types.h","line":139,"lineto":139,"block":"","tdef":"typedef","comments":"In-memory representation of a reference.","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"]}}],["git_repository",{"type":"struct","value":"git_repository","file":"types.h","line":99,"lineto":99,"block":"","tdef":"typedef","comments":"Representation of an existing git repository,\nincluding all its object contents","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_repository_open2","git_repository_open3","git_revwalk_new","git_tag_lookup","git_tag_new","git_tree_lookup","git_tree_new"]}}],["git_revwalk",{"type":"struct","value":"git_revwalk","file":"types.h","line":105,"lineto":105,"block":"","tdef":"typedef","comments":"Representation of an in-progress walk through the commits in a repo","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"]}}],["git_rtype",{"type":"enum","file":"types.h","line":142,"lineto":146,"block":"GIT_REF_INVALID\nGIT_REF_OID\nGIT_REF_SYMBOLIC","tdef":"typedef","comments":"Basic type of any Git reference.","used":{"returns":[],"needs":[]}}],["git_signature",{"type":"struct","value":"git_signature","file":"types.h","line":132,"lineto":136,"block":"char *name\nchar *email\ngit_time when","tdef":"typedef","comments":"An action signature (e.g. for committers, taggers, etc)","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"]}}],["git_tag",{"type":"struct","value":"git_tag","file":"types.h","line":108,"lineto":108,"block":"","tdef":"typedef","comments":"Parsed representation of a tag object.","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"]}}],["git_time",{"type":"struct","value":"git_time","file":"types.h","line":126,"lineto":129,"block":"time_t time\nint offset","tdef":"typedef","comments":"Time in a signature","used":{"returns":[],"needs":[]}}],["git_tree",{"type":"struct","value":"git_tree","file":"types.h","line":120,"lineto":120,"block":"","tdef":"typedef","comments":"Representation of a tree object.","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"]}}],["git_tree_entry",{"type":"struct","value":"git_tree_entry","file":"types.h","line":117,"lineto":117,"block":"","tdef":"typedef","comments":"Representation of each one of the entries in a tree object.","used":{"returns":["git_tree_entry_byindex","git_tree_entry_byname"],"needs":["git_tree_add_entry","git_tree_add_entry_unsorted","git_tree_entry_2object","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"]}}]],"prefix":"src/git2","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_string2type","git_object_type","git_object_type2string","git_object_typeisloose","git_object_write"]],["odb",["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"]],["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","git_repository_open2","git_repository_open3"]],["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_2object","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"]],["zlib",["deflateBound"]]]}
\ No newline at end of file +{"files":[{"file":"zlib.h","functions":["deflateBound"],"meta":{"brief":"Git data compression routines","defgroup":"git_zlib Git data compression routines","ingroup":"Git","comments":"\n"},"lines":58},{"file":"types.h","functions":[],"meta":{"brief":"libgit2 base & compatibility types","ingroup":"Git","comments":"\n"},"lines":151},{"file":"tree.h","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_entry_2object","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"],"meta":{"brief":"Git tree parsing, loading routines","defgroup":"git_tree Git tree parsing, loading routines","ingroup":"Git","comments":"\n"},"lines":252},{"file":"thread-utils.h","functions":[],"meta":{},"lines":80},{"file":"tag.h","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"],"meta":{"brief":"Git tag parsing routines","defgroup":"git_tag Git tag management","ingroup":"Git","comments":"\n"},"lines":145},{"file":"signature.h","functions":["git_signature_new","git_signature_dup","git_signature_free"],"meta":{"brief":"Git signature creation","defgroup":"git_signature Git signature creation","ingroup":"Git","comments":"\n"},"lines":70},{"file":"revwalk.h","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"],"meta":{"brief":"Git revision traversal routines","defgroup":"git_revwalk Git revision traversal routines","ingroup":"Git","comments":"\n"},"lines":136},{"file":"repository.h","functions":["git_repository_open","git_repository_open2","git_repository_open3","git_repository_lookup","git_repository_database","git_repository_index","git_repository_newobject","git_repository_free","git_repository_init","git_repository_lookup_ref"],"meta":{"brief":"Git repository management routines","defgroup":"git_repository Git repository management routines","ingroup":"Git","comments":"\n"},"lines":239},{"file":"refs.h","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"],"meta":{"brief":"Git reference management routines","defgroup":"git_reference Git reference management routines","ingroup":"Git","comments":"\n"},"lines":175},{"file":"oid.h","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"],"meta":{"brief":"Git object id routines","defgroup":"git_oid Git object id routines","ingroup":"Git","comments":"\n"},"lines":137},{"file":"odb_backend.h","functions":[],"meta":{"brief":"Git custom backend functions","defgroup":"git_backend Git custom backend API","ingroup":"Git","comments":"\n"},"lines":78},{"file":"odb.h","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"],"meta":{"brief":"Git object database routines","defgroup":"git_odb Git object database routines","ingroup":"Git","comments":"\n"},"lines":184},{"file":"object.h","functions":["git_object_write","git_object_id","git_object_type","git_object_owner","git_object_free","git_object_type2string","git_object_string2type","git_object_typeisloose","git_object__size"],"meta":{"brief":"Git revision object management routines","defgroup":"git_object Git revision object management routines","ingroup":"Git","comments":"\n"},"lines":146},{"file":"index.h","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"],"meta":{"brief":"Git index parsing and manipulation routines","defgroup":"git_index Git index parsing and manipulation routines","ingroup":"Git","comments":"\n"},"lines":198},{"file":"errors.h","functions":["git_strerror"],"meta":{"brief":"Git error handling routines and variables","ingroup":"Git","comments":"\n"},"lines":45},{"file":"common.h","functions":[],"meta":{"brief":"Git common platform definitions","defgroup":"git_common Git common platform definitions","ingroup":"Git","comments":"\n"},"lines":160},{"file":"commit.h","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"],"meta":{"brief":"Git commit parsing, formatting routines","defgroup":"git_commit Git commit parsing, formatting routines","ingroup":"Git","comments":"\n"},"lines":184},{"file":"blob.h","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"],"meta":{"brief":"Git blob load and write routines","defgroup":"git_blob Git blob load and write routines","ingroup":"Git","comments":"\n"},"lines":128}],"functions":{"deflateBound":{"type":"function","file":"zlib.h","line":50,"lineto":54,"args":[{"name":"stream","type":"z_streamp","comment":"the stream pointer."},{"name":"s","type":"size_t","comment":"tream the stream pointer."}],"argline":"z_streamp stream, size_t s","sig":"z_streamp::size_t","return":{"type":"size_t","comment":"maximum length of the compressed data."},"description":"deflateBound returns an upper bound on the compressed size.","comments":"This is a stub function used when zlib does not supply the\ndeflateBound() implementation itself.\n","group":"zlib"},"git_tree_lookup":{"type":"function","file":"tree.h","line":52,"lineto":55,"args":[{"name":"tree","type":"git_tree **","comment":"pointer to the looked up tree"},{"name":"repo","type":"git_repository *","comment":"the repo to use when locating the tree."},{"name":"id","type":"const git_oid *","comment":"identity of the tree to locate."}],"argline":"git_tree **tree, git_repository *repo, const git_oid *id","sig":"git_tree **::git_repository *::const git_oid *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Lookup a tree object from the repository.\nThe generated tree object is owned by the revision\nrepo and shall not be freed by the user.","comments":"","group":"tree"},"git_tree_new":{"type":"function","file":"tree.h","line":68,"lineto":71,"args":[{"name":"tree","type":"git_tree **","comment":"pointer to the new tree"},{"name":"repo","type":"git_repository *","comment":"The repository where the object will reside"}],"argline":"git_tree **tree, git_repository *repo","sig":"git_tree **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Create a new in-memory git_tree.","comments":"The tree object must be manually filled using\nsetter methods before it can be written to its\nrepository.\n","group":"tree"},"git_tree_id":{"type":"function","file":"tree.h","line":78,"lineto":78,"args":[{"name":"tree","type":"git_tree *","comment":"a previously loaded tree."}],"argline":"git_tree *tree","sig":"git_tree *","return":{"type":"const git_oid *","comment":"object identity for the tree."},"description":"Get the id of a tree.\n@param tree a previously loaded tree.\n@return object identity for the tree.","comments":"","group":"tree"},"git_tree_entrycount":{"type":"function","file":"tree.h","line":86,"lineto":86,"args":[{"name":"tree","type":"git_tree *","comment":"a previously loaded tree."}],"argline":"git_tree *tree","sig":"git_tree *","return":{"type":"size_t","comment":"the number of entries in the tree"},"description":"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","comments":"","group":"tree"},"git_tree_entry_byname":{"type":"function","file":"tree.h","line":94,"lineto":94,"args":[{"name":"tree","type":"git_tree *","comment":"a previously loaded tree."},{"name":"filename","type":"const char *","comment":"the filename of the desired entry"}],"argline":"git_tree *tree, const char *filename","sig":"git_tree *::const char *","return":{"type":"git_tree_entry *","comment":"the tree entry; NULL if not found"},"description":"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","comments":"","group":"tree"},"git_tree_entry_byindex":{"type":"function","file":"tree.h","line":102,"lineto":102,"args":[{"name":"tree","type":"git_tree *","comment":"a previously loaded tree."},{"name":"idx","type":"int","comment":"the position in the entry list"}],"argline":"git_tree *tree, int idx","sig":"git_tree *::int","return":{"type":"git_tree_entry *","comment":"the tree entry; NULL if not found"},"description":"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","comments":"","group":"tree"},"git_tree_entry_attributes":{"type":"function","file":"tree.h","line":109,"lineto":109,"args":[{"name":"entry","type":"git_tree_entry *","comment":"a tree entry"}],"argline":"git_tree_entry *entry","sig":"git_tree_entry *","return":{"type":"unsigned int","comment":"attributes as an integer"},"description":"Get the UNIX file attributes of a tree entry\n@param entry a tree entry\n@return attributes as an integer","comments":"","group":"tree"},"git_tree_entry_name":{"type":"function","file":"tree.h","line":116,"lineto":116,"args":[{"name":"entry","type":"git_tree_entry *","comment":"a tree entry"}],"argline":"git_tree_entry *entry","sig":"git_tree_entry *","return":{"type":"const char *","comment":"the name of the file"},"description":"Get the filename of a tree entry\n@param entry a tree entry\n@return the name of the file","comments":"","group":"tree"},"git_tree_entry_id":{"type":"function","file":"tree.h","line":123,"lineto":123,"args":[{"name":"entry","type":"git_tree_entry *","comment":"a tree entry"}],"argline":"git_tree_entry *entry","sig":"git_tree_entry *","return":{"type":"const git_oid *","comment":"the oid of the object"},"description":"Get the id of the object pointed by the entry\n@param entry a tree entry\n@return the oid of the object","comments":"","group":"tree"},"git_tree_entry_2object":{"type":"function","file":"tree.h","line":132,"lineto":132,"args":[{"name":"object","type":"git_object **","comment":"pointer to the converted object"},{"name":"entry","type":"git_tree_entry *","comment":"a tree entry"}],"argline":"git_object **object, git_tree_entry *entry","sig":"git_object **::git_tree_entry *","return":{"type":"int","comment":"a reference to the pointed object in the repository"},"description":"Convert a tree entry to the git_object it points too.","comments":"","group":"tree"},"git_tree_add_entry":{"type":"function","file":"tree.h","line":149,"lineto":149,"args":[{"name":"entry_out","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":"tree","type":"git_tree *","comment":"Tree object to store the entry @iparam id OID for the tree entry"},{"name":"id","type":"const git_oid *"},{"name":"filename","type":"const char *","comment":"Filename for the tree entry"},{"name":"attributes","type":"int","comment":"UNIX file attributes for the entry"}],"argline":"git_tree_entry **entry_out, git_tree *tree, const git_oid *id, const char *filename, int attributes","sig":"git_tree_entry **::git_tree *::const git_oid *::const char *::int","return":{"type":"int","comment":"0 on success; otherwise error code"},"description":"Add a new entry to a tree and return the new entry.","comments":"This will mark the tree as modified; the new entry will\nbe written back to disk on the next git_object_write()\n","group":"tree"},"git_tree_add_entry_unsorted":{"type":"function","file":"tree.h","line":166,"lineto":166,"args":[{"name":"entry","type":"git_tree_entry **","comment":"Entry object which will be created"},{"name":"tree","type":"git_tree *","comment":"Tree object to store the entry @iparam id OID for the tree entry"},{"name":"id","type":"const git_oid *"},{"name":"filename","type":"const char *","comment":"Filename for the tree entry"},{"name":"attributes","type":"int","comment":"UNIX file attributes for the entry"}],"argline":"git_tree_entry **entry, git_tree *tree, const git_oid *id, const char *filename, int attributes","sig":"git_tree_entry **::git_tree *::const git_oid *::const char *::int","return":{"type":"int","comment":"0 on success; otherwise error code"},"description":"Add a new entry to a tree, returning that new entry.\nThe only difference with this call is that it does not sort\ntree afterwards, this requirement is left to the caller.","comments":"This will mark the tree as modified; the new entry will\nbe written back to disk on the next git_object_write()\n","group":"tree"},"git_tree_sort_entries":{"type":"function","file":"tree.h","line":179,"lineto":179,"args":[{"name":"tree","type":"git_tree *","comment":"Tree object whose entries are to be sorted"}],"argline":"git_tree *tree","sig":"git_tree *","return":{"type":"int","comment":"0 on success; otherwise error code"},"description":"Sort the entries in a tree created using git_tree_add_entry2.","comments":"This does not mark the tree as modified. It is intended to be used\nafter several invocations of git_tree_add_entry2.\ngit_tree_add_entry, on the other hand, sorts after each entry is\nadded.\n","group":"tree"},"git_tree_remove_entry_byindex":{"type":"function","file":"tree.h","line":193,"lineto":193,"args":[{"name":"tree","type":"git_tree *","comment":"Tree where to remove the entry"},{"name":"idx","type":"int","comment":"index of the entry"}],"argline":"git_tree *tree, int idx","sig":"git_tree *::int","return":{"type":"int","comment":"0 on successful removal; GIT_ENOTFOUND if the entry wasn't found"},"description":"Remove an entry by its index.","comments":"Index must be >= 0 and < than git_tree_entrycount().\n\nThis will mark the tree as modified; the modified entry will\nbe written back to disk on the next git_object_write()\n","group":"tree"},"git_tree_remove_entry_byname":{"type":"function","file":"tree.h","line":205,"lineto":205,"args":[{"name":"tree","type":"git_tree *","comment":"Tree where to remove the entry"},{"name":"filename","type":"const char *","comment":"File name of the entry"}],"argline":"git_tree *tree, const char *filename","sig":"git_tree *::const char *","return":{"type":"int","comment":"0 on successful removal; GIT_ENOTFOUND if the entry wasn't found"},"description":"Remove an entry by its filename.","comments":"This will mark the tree as modified; the modified entry will\nbe written back to disk on the next git_object_write()\n","group":"tree"},"git_tree_clear_entries":{"type":"function","file":"tree.h","line":215,"lineto":215,"args":[{"name":"tree","type":"git_tree *","comment":"Tree object whose entries are to be sorted"}],"argline":"git_tree *tree","sig":"git_tree *","return":{"type":"void"},"description":"Clear all the entries in a tree.","comments":"This will mark the tree as modified; the modified entry will\nbe written back to disk on the next git_object_write().\n","group":"tree"},"git_tree_entry_set_id":{"type":"function","file":"tree.h","line":226,"lineto":226,"args":[{"name":"entry","type":"git_tree_entry *","comment":"Entry object which will be modified"},{"name":"oid","type":"const git_oid *","comment":"new SHA1 oid for the entry"}],"argline":"git_tree_entry *entry, const git_oid *oid","sig":"git_tree_entry *::const git_oid *","return":{"type":"void"},"description":"Change the SHA1 id of a tree entry.","comments":"This will mark the tree that contains the entry as modified;\nthe modified entry will be written back to disk on the next git_object_write()\n","group":"tree"},"git_tree_entry_set_name":{"type":"function","file":"tree.h","line":237,"lineto":237,"args":[{"name":"entry","type":"git_tree_entry *","comment":"Entry object which will be modified"},{"name":"name","type":"const char *"}],"argline":"git_tree_entry *entry, const char *name","sig":"git_tree_entry *::const char *","return":{"type":"void"},"description":"Change the filename of a tree entry.","comments":"This will mark the tree that contains the entry as modified;\nthe modified entry will be written back to disk on the next git_object_write()\n","group":"tree"},"git_tree_entry_set_attributes":{"type":"function","file":"tree.h","line":248,"lineto":248,"args":[{"name":"entry","type":"git_tree_entry *","comment":"Entry object which will be modified"},{"name":"attr","type":"int"}],"argline":"git_tree_entry *entry, int attr","sig":"git_tree_entry *::int","return":{"type":"void"},"description":"Change the attributes of a tree entry.","comments":"This will mark the tree that contains the entry as modified;\nthe modified entry will be written back to disk on the next git_object_write()\n","group":"tree"},"git_tag_lookup":{"type":"function","file":"tag.h","line":52,"lineto":55,"args":[{"name":"tag","type":"git_tag **","comment":"pointer to the looked up tag"},{"name":"repo","type":"git_repository *","comment":"the repo to use when locating the tag."},{"name":"id","type":"const git_oid *","comment":"identity of the tag to locate."}],"argline":"git_tag **tag, git_repository *repo, const git_oid *id","sig":"git_tag **::git_repository *::const git_oid *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Lookup a tag object from the repository.\nThe generated tag object is owned by the revision\nrepo and shall not be freed by the user.","comments":"","group":"tag"},"git_tag_new":{"type":"function","file":"tag.h","line":68,"lineto":71,"args":[{"name":"tag","type":"git_tag **","comment":"pointer to the new tag"},{"name":"repo","type":"git_repository *","comment":"The repository where the object will reside"}],"argline":"git_tag **tag, git_repository *repo","sig":"git_tag **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Create a new in-memory git_tag.","comments":"The tag object must be manually filled using\nsetter methods before it can be written to its\nrepository.\n","group":"tag"},"git_tag_id":{"type":"function","file":"tag.h","line":78,"lineto":78,"args":[{"name":"tag","type":"git_tag *","comment":"a previously loaded tag."}],"argline":"git_tag *tag","sig":"git_tag *","return":{"type":"const git_oid *","comment":"object identity for the tag."},"description":"Get the id of a tag.\n@param tag a previously loaded tag.\n@return object identity for the tag.","comments":"","group":"tag"},"git_tag_target":{"type":"function","file":"tag.h","line":85,"lineto":85,"args":[{"name":"t","type":"git_tag *","comment":"ag a previously loaded tag."}],"argline":"git_tag *t","sig":"git_tag *","return":{"type":"const git_object *","comment":"reference to a repository object"},"description":"Get the tagged object of a tag\n@param tag a previously loaded tag.\n@return reference to a repository object","comments":"","group":"tag"},"git_tag_type":{"type":"function","file":"tag.h","line":92,"lineto":92,"args":[{"name":"t","type":"git_tag *","comment":"ag a previously loaded tag."}],"argline":"git_tag *t","sig":"git_tag *","return":{"type":"git_otype","comment":"type of the tagged object"},"description":"Get the type of a tag's tagged object\n@param tag a previously loaded tag.\n@return type of the tagged object","comments":"","group":"tag"},"git_tag_name":{"type":"function","file":"tag.h","line":99,"lineto":99,"args":[{"name":"t","type":"git_tag *","comment":"ag a previously loaded tag."}],"argline":"git_tag *t","sig":"git_tag *","return":{"type":"const char *","comment":"name of the tag"},"description":"Get the name of a tag\n@param tag a previously loaded tag.\n@return name of the tag","comments":"","group":"tag"},"git_tag_tagger":{"type":"function","file":"tag.h","line":106,"lineto":106,"args":[{"name":"t","type":"git_tag *","comment":"ag a previously loaded tag."}],"argline":"git_tag *t","sig":"git_tag *","return":{"type":"const git_signature *","comment":"reference to the tag's author"},"description":"Get the tagger (author) of a tag\n@param tag a previously loaded tag.\n@return reference to the tag's author","comments":"","group":"tag"},"git_tag_message":{"type":"function","file":"tag.h","line":113,"lineto":113,"args":[{"name":"t","type":"git_tag *","comment":"ag a previously loaded tag."}],"argline":"git_tag *t","sig":"git_tag *","return":{"type":"const char *","comment":"message of the tag"},"description":"Get the message of a tag\n@param tag a previously loaded tag.\n@return message of the tag","comments":"","group":"tag"},"git_tag_set_target":{"type":"function","file":"tag.h","line":120,"lineto":120,"args":[{"name":"tag","type":"git_tag *","comment":"The tag to modify"},{"name":"target","type":"git_object *","comment":"the new tagged target"}],"argline":"git_tag *tag, git_object *target","sig":"git_tag *::git_object *","return":{"type":"void"},"description":"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","comments":"","group":"tag"},"git_tag_set_name":{"type":"function","file":"tag.h","line":127,"lineto":127,"args":[{"name":"tag","type":"git_tag *","comment":"The tag to modify"},{"name":"name","type":"const char *","comment":"the new name for the tag"}],"argline":"git_tag *tag, const char *name","sig":"git_tag *::const char *","return":{"type":"void"},"description":"Set the name of a tag\n@param tag The tag to modify\n@param name the new name for the tag","comments":"","group":"tag"},"git_tag_set_tagger":{"type":"function","file":"tag.h","line":134,"lineto":134,"args":[{"name":"tag","type":"git_tag *","comment":"The tag to modify"},{"name":"tagger_sig","type":"const git_signature *","comment":"signature of the tagging action"}],"argline":"git_tag *tag, const git_signature *tagger_sig","sig":"git_tag *::const git_signature *","return":{"type":"void"},"description":"Set the tagger of a tag\n@param tag The tag to modify\n@param tagger_sig signature of the tagging action","comments":"","group":"tag"},"git_tag_set_message":{"type":"function","file":"tag.h","line":141,"lineto":141,"args":[{"name":"tag","type":"git_tag *","comment":"The tag to modify"},{"name":"message","type":"const char *","comment":"the new tagger for the tag"}],"argline":"git_tag *tag, const char *message","sig":"git_tag *::const char *","return":{"type":"void"},"description":"Set the message of a tag\n@param tag The tag to modify\n@param message the new tagger for the tag","comments":"","group":"tag"},"git_signature_new":{"type":"function","file":"signature.h","line":50,"lineto":50,"args":[{"name":"name","type":"const char *"},{"name":"email","type":"const char *"},{"name":"time","type":"time_t"},{"name":"offset","type":"int"}],"argline":"const char *name, const char *email, time_t time, int offset","sig":"const char *::const char *::time_t::int","return":{"type":"git_signature *","comment":"the new sig, NULl on out of memory"},"description":"Create a new action signature. The signature must be freed\nmanually or using git_signature_free","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","group":"signature"},"git_signature_dup":{"type":"function","file":"signature.h","line":59,"lineto":59,"args":[{"name":"sig","type":"const git_signature *"}],"argline":"const git_signature *sig","sig":"const git_signature *","return":{"type":"git_signature *","comment":"a copy of sig, NULL on out of memory"},"description":"Create a copy of an existing signature.","comments":"All internal strings are also duplicated.\n@sig signature to duplicated","group":"signature"},"git_signature_free":{"type":"function","file":"signature.h","line":66,"lineto":66,"args":[{"name":"sig","type":"git_signature *"}],"argline":"git_signature *sig","sig":"git_signature *","return":{"type":"void"},"description":"Free an existing signature","comments":"@sig signature to free","group":"signature"},"git_revwalk_new":{"type":"function","file":"revwalk.h","line":76,"lineto":76,"args":[{"name":"walker","type":"git_revwalk **","comment":"pointer to the new revision walker"},{"name":"repo","type":"git_repository *","comment":"the repo to walk through"}],"argline":"git_revwalk **walker, git_repository *repo","sig":"git_revwalk **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Allocate a new revision walker to iterate through a repo.","comments":"","group":"revwalk"},"git_revwalk_reset":{"type":"function","file":"revwalk.h","line":82,"lineto":82,"args":[{"name":"walker","type":"git_revwalk *","comment":"handle to reset."}],"argline":"git_revwalk *walker","sig":"git_revwalk *","return":{"type":"void"},"description":"Reset the walking machinery for reuse.\n@param walker handle to reset.","comments":"","group":"revwalk"},"git_revwalk_push":{"type":"function","file":"revwalk.h","line":91,"lineto":91,"args":[{"name":"walk","type":"git_revwalk *","comment":"er the walker being used for the traversal."},{"name":"commit","type":"git_commit *","comment":"the commit to start from."}],"argline":"git_revwalk *walk, git_commit *commit","sig":"git_revwalk *::git_commit *","return":{"type":"int"},"description":"Mark a commit to start traversal from.\nThe commit object must belong to the repo which is being walked through.","comments":"","group":"revwalk"},"git_revwalk_hide":{"type":"function","file":"revwalk.h","line":98,"lineto":98,"args":[{"name":"walk","type":"git_revwalk *","comment":"er the walker being used for the traversal."},{"name":"commit","type":"git_commit *","comment":"the commit that will be ignored during the traversal"}],"argline":"git_revwalk *walk, git_commit *commit","sig":"git_revwalk *::git_commit *","return":{"type":"int"},"description":"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","comments":"","group":"revwalk"},"git_revwalk_next":{"type":"function","file":"revwalk.h","line":108,"lineto":108,"args":[{"name":"commit","type":"git_commit **","comment":"Pointer where to store the next commit"},{"name":"walk","type":"git_revwalk *","comment":"the walker to pop the commit from."}],"argline":"git_commit **commit, git_revwalk *walk","sig":"git_commit **::git_revwalk *","return":{"type":"int","comment":"GIT_SUCCESS if the next commit was found; GIT_EREVWALKOVER if there are no commits left to iterate"},"description":"Get the next commit from the revision traversal.","comments":"","group":"revwalk"},"git_revwalk_sorting":{"type":"function","file":"revwalk.h","line":117,"lineto":117,"args":[{"name":"walk","type":"git_revwalk *","comment":"the walker being used for the traversal."},{"name":"sort_mode","type":"unsigned int","comment":"combination of GIT_RPSORT_XXX flags"}],"argline":"git_revwalk *walk, unsigned int sort_mode","sig":"git_revwalk *::unsigned int","return":{"type":"int"},"description":"Change the sorting mode when iterating through the\nrepository's contents.\nChanging 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","comments":"","group":"revwalk"},"git_revwalk_free":{"type":"function","file":"revwalk.h","line":123,"lineto":123,"args":[{"name":"walk","type":"git_revwalk *","comment":"traversal handle to close. If NULL nothing occurs."}],"argline":"git_revwalk *walk","sig":"git_revwalk *","return":{"type":"void"},"description":"Free a revwalk previously allocated.\n@param walk traversal handle to close. If NULL nothing occurs.","comments":"","group":"revwalk"},"git_revwalk_repository":{"type":"function","file":"revwalk.h","line":132,"lineto":132,"args":[{"name":"walk","type":"git_revwalk *","comment":"the revision walker"}],"argline":"git_revwalk *walk","sig":"git_revwalk *","return":{"type":"git_repository *","comment":"the repository being walked"},"description":"Return the repository on which this walker\nis operating.","comments":"","group":"revwalk"},"git_repository_open":{"type":"function","file":"repository.h","line":64,"lineto":64,"args":[{"name":"repository","type":"git_repository **","comment":"pointer to the repo which will be opened"},{"name":"path","type":"const char *","comment":"the path to the repository"}],"argline":"git_repository **repository, const char *path","sig":"git_repository **::const char *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Open a git repository.","comments":"The 'path' argument must point to an existing git repository\nfolder, e.g.\n\n\t/path/to/my_repo/.git/\t(normal repository)\n\t\t\t\t\t\tobjects/\n\t\t\t\t\t\tindex\n\t\t\t\t\t\tHEAD\n\n\t/path/to/bare_repo/\t\t(bare repository)\n\t\t\t\t\tobjects/\n\t\t\t\t\tindex\n\t\t\t\t\tHEAD\n\nThe method will automatically detect if 'path' is a normal\nor bare repository or fail is 'path' is neither.\n","group":"repository"},"git_repository_open2":{"type":"function","file":"repository.h","line":93,"lineto":97,"args":[{"name":"repository","type":"git_repository **","comment":"pointer to the repo which will be opened"},{"name":"git_dir","type":"const char *","comment":"The full path to the repository folder e.g. a '.git' folder for live repos, any folder for bare Equivalent to $GIT_DIR. Cannot be NULL."},{"name":"git_object_directory","type":"const char *","comment":"The full path to the ODB folder. the folder where all the loose and packed objects are stored Equivalent to $GIT_OBJECT_DIRECTORY. If NULL, \"$GIT_DIR/objects/\" is assumed."},{"name":"git_index_file","type":"const char *","comment":"The full path to the index (dircache) file Equivalent to $GIT_INDEX_FILE. If NULL, \"$GIT_DIR/index\" is assumed."},{"name":"git_work_tree","type":"const char *","comment":"The full path to the working tree of the repository, if the repository is not bare. Equivalent to $GIT_WORK_TREE. If NULL, the repository is assumed to be bare."}],"argline":"git_repository **repository,\n\t\tconst char *git_dir,\n\t\tconst char *git_object_directory,\n\t\tconst char *git_index_file,\n\t\tconst char *git_work_tree","sig":"git_repository **::const char *::const char *::const char *::const char *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Open a git repository by manually specifying all its paths","comments":"","group":"repository"},"git_repository_open3":{"type":"function","file":"repository.h","line":128,"lineto":132,"args":[{"name":"repository","type":"git_repository **","comment":"pointer to the repo which will be opened"},{"name":"git_dir","type":"const char *","comment":"The full path to the repository folder e.g. a '.git' folder for live repos, any folder for bare Equivalent to $GIT_DIR. Cannot be NULL."},{"name":"object_database","type":"git_odb *","comment":"A pointer to a git_odb created & initialized by the user (e.g. with custom backends). This object database will be owned by the repository and will be automatically free'd. It should not be manually free'd by the user, or this git_repository object will become invalid."},{"name":"git_index_file","type":"const char *","comment":"The full path to the index (dircache) file Equivalent to $GIT_INDEX_FILE. If NULL, \"$GIT_DIR/index\" is assumed."},{"name":"git_work_tree","type":"const char *","comment":"The full path to the working tree of the repository, if the repository is not bare. Equivalent to $GIT_WORK_TREE. If NULL, the repository is assumed to be bare."}],"argline":"git_repository **repository,\n\t\tconst char *git_dir,\n\t\tgit_odb *object_database,\n\t\tconst char *git_index_file,\n\t\tconst char *git_work_tree","sig":"git_repository **::const char *::git_odb *::const char *::const char *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Open a git repository by manually specifying its paths and\nthe object database it will use.","comments":"","group":"repository"},"git_repository_lookup":{"type":"function","file":"repository.h","line":153,"lineto":153,"args":[{"name":"object","type":"git_object **","comment":"pointer to the looked-up object"},{"name":"repo","type":"git_repository *","comment":"the repository to look up the object"},{"name":"id","type":"const git_oid *","comment":"the unique identifier for the object"},{"name":"type","type":"git_otype","comment":"the type of the object"}],"argline":"git_object **object, git_repository *repo, const git_oid *id, git_otype type","sig":"git_object **::git_repository *::const git_oid *::git_otype","return":{"type":"int","comment":"a reference to the object"},"description":"Lookup a reference to one of the objects in the repostory.","comments":"The generated reference is owned by the repository and\nshould not be freed by the user.\n\nThe 'type' parameter must match the type of the object\nin the odb; the method will fail otherwise.\nThe special value 'GIT_OBJ_ANY' may be passed to let\nthe method guess the object's type.\n","group":"repository"},"git_repository_database":{"type":"function","file":"repository.h","line":161,"lineto":161,"args":[{"name":"repo","type":"git_repository *","comment":"a repository object"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"git_odb *","comment":"a pointer to the object db"},"description":"Get the object database behind a Git repository","comments":"","group":"repository"},"git_repository_index":{"type":"function","file":"repository.h","line":173,"lineto":173,"args":[{"name":"index","type":"git_index **","comment":"Pointer where to store the index"},{"name":"repo","type":"git_repository *","comment":"a repository object"}],"argline":"git_index **index, git_repository *repo","sig":"git_index **::git_repository *","return":{"type":"int","comment":"0 on success; error code if the index could not be opened"},"description":"Get the Index file of a Git repository","comments":"This is a cheap operation; the index is only opened on the first call,\nand subsequent calls only retrieve the previous pointer.\n","group":"repository"},"git_repository_newobject":{"type":"function","file":"repository.h","line":196,"lineto":196,"args":[{"name":"object","type":"git_object **","comment":"pointer to the new object @parem repo Repository where the object belongs"},{"name":"repo","type":"git_repository *"},{"name":"type","type":"git_otype","comment":"Type of the object to be created"}],"argline":"git_object **object, git_repository *repo, git_otype type","sig":"git_object **::git_repository *::git_otype","return":{"type":"int","comment":"the new object"},"description":"Create a new in-memory repository object with\nthe given type.","comments":"The object's attributes can be filled in using the\ncorresponding setter methods.\n\nThe object will be written back to given git_repository\nwhen the git_object_write() function is called; objects\ncannot be written to disk until all their main\nattributes have been properly filled.\n\nObjects are instantiated with no SHA1 id; their id\nwill be automatically generated when writing to the\nrepository.\n","group":"repository"},"git_repository_free":{"type":"function","file":"repository.h","line":202,"lineto":202,"args":[{"name":"repo","type":"git_repository *","comment":"repository handle to close. If NULL nothing occurs."}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"void"},"description":"Free a previously allocated repository\n@param repo repository handle to close. If NULL nothing occurs.","comments":"","group":"repository"},"git_repository_init":{"type":"function","file":"repository.h","line":219,"lineto":219,"args":[{"name":"repo_out","type":"git_repository **","comment":"pointer to the repo which will be created or reinitialized"},{"name":"path","type":"const char *","comment":"the path to the repository"},{"name":"is_bare","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."}],"argline":"git_repository **repo_out, const char *path, unsigned is_bare","sig":"git_repository **::const char *::unsigned","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Creates a new Git repository in the given folder.","comments":"TODO:\n- Reinit the repository\n- Create config files\n","group":"repository"},"git_repository_lookup_ref":{"type":"function","file":"repository.h","line":235,"lineto":235,"args":[{"name":"reference_out","type":"git_reference **","comment":"pointer to the looked-up reference"},{"name":"repo","type":"git_repository *","comment":"the repository to look up the reference"},{"name":"name","type":"const char *","comment":"the long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...)"}],"argline":"git_reference **reference_out, git_repository *repo, const char *name","sig":"git_reference **::git_repository *::const char *","return":{"type":"int","comment":"a reference to the reference"},"description":"Lookup a reference by its name in the repository.","comments":"The generated reference is owned by the repository and\nshould not be freed by the user.\n\nTODO:\n- Ensure the reference name is valid\n","group":"repository"},"git_reference_new":{"type":"function","file":"refs.h","line":52,"lineto":52,"args":[{"name":"ref_out","type":"git_reference **","comment":"Pointer to the newly created reference"},{"name":"repo","type":"git_repository *","comment":"Repository where that reference exists"}],"argline":"git_reference **ref_out, git_repository *repo","sig":"git_reference **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Create a new reference.","comments":"The reference will be empty and exclusively\nin-memory until it is filled with the setter\nmethods and written back to disk using\n`git_reference_write`.\n","group":"reference"},"git_reference_oid":{"type":"function","file":"refs.h","line":62,"lineto":62,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"const git_oid *","comment":"a pointer to the oid if available, NULL otherwise"},"description":"Get the OID pointed to by a reference.","comments":"Only available if the reference is direct (i.e. not symbolic)\n","group":"reference"},"git_reference_target":{"type":"function","file":"refs.h","line":72,"lineto":72,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"const char *","comment":"a pointer to the name if available, NULL otherwise"},"description":"Get full name to the reference pointed by this reference","comments":"Only available if the reference is symbolic\n","group":"reference"},"git_reference_type":{"type":"function","file":"refs.h","line":82,"lineto":82,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"git_rtype","comment":"the type"},"description":"Get the type of a reference","comments":"Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC)\n","group":"reference"},"git_reference_name":{"type":"function","file":"refs.h","line":90,"lineto":90,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"const char *","comment":"the full name for the ref"},"description":"Get the full name of a reference","comments":"","group":"reference"},"git_reference_resolve":{"type":"function","file":"refs.h","line":105,"lineto":105,"args":[{"name":"resolved_ref","type":"git_reference **","comment":"Pointer to the peeled reference"},{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference **resolved_ref, git_reference *ref","sig":"git_reference **::git_reference *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Resolve a symbolic reference","comments":"Thie method iteratively peels a symbolic reference\nuntil it resolves to a direct reference to an OID.\n\nIf a direct reference is passed as an argument,\nthat reference is returned immediately\n","group":"reference"},"git_reference_write":{"type":"function","file":"refs.h","line":121,"lineto":121,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Write a reference back to disk.","comments":"The reference must have a valid name and a valid target\n(either direct or symbolic).\n\nIf the reference has been loaded from disk and no changes\nhave been made, no action will take place.\n\nThe writing to disk is atomic.\n","group":"reference"},"git_reference_owner":{"type":"function","file":"refs.h","line":129,"lineto":129,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"git_repository *","comment":"a pointer to the repo"},"description":"Get the repository where a reference resides","comments":"","group":"reference"},"git_reference_set_name":{"type":"function","file":"refs.h","line":141,"lineto":141,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"},{"name":"name","type":"const char *","comment":"The new name for the reference"}],"argline":"git_reference *ref, const char *name","sig":"git_reference *::const char *","return":{"type":"void"},"description":"Set the name of a reference.","comments":"This marks the reference as modified; changes\nwon't take effect until it is manually written back\nto disk.\n","group":"reference"},"git_reference_set_target":{"type":"function","file":"refs.h","line":156,"lineto":156,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"},{"name":"target","type":"const char *","comment":"The new target for the reference"}],"argline":"git_reference *ref, const char *target","sig":"git_reference *::const char *","return":{"type":"void"},"description":"Set the target reference of a reference.","comments":"This converts the reference into a symbolic\nreference.\n\nThis marks the reference as modified; changes\nwon't take effect until it is manually written back\nto disk.\n","group":"reference"},"git_reference_set_oid":{"type":"function","file":"refs.h","line":171,"lineto":171,"args":[{"name":"ref","type":"git_reference *","comment":"The reference"},{"name":"id","type":"const git_oid *"}],"argline":"git_reference *ref, const git_oid *id","sig":"git_reference *::const git_oid *","return":{"type":"void"},"description":"Set the OID target of a reference.","comments":"This converts the reference into a direct\nreference.\n\nThis marks the reference as modified; changes\nwon't take effect until it is manually written back\nto disk.\n","group":"reference"},"git_oid_mkstr":{"type":"function","file":"oid.h","line":60,"lineto":60,"args":[{"name":"out","type":"git_oid *","comment":"oid structure the result is written into."},{"name":"str","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)."}],"argline":"git_oid *out, const char *str","sig":"git_oid *::const char *","return":{"type":"int","comment":"GIT_SUCCESS if valid; GIT_ENOTOID on failure."},"description":"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.","comments":"","group":"oid"},"git_oid_mkraw":{"type":"function","file":"oid.h","line":67,"lineto":67,"args":[{"name":"out","type":"git_oid *","comment":"oid structure the result is written into."},{"name":"raw","type":"const unsigned char *","comment":"the raw input bytes to be copied."}],"argline":"git_oid *out, const unsigned char *raw","sig":"git_oid *::const unsigned char *","return":{"type":"void"},"description":"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.","comments":"","group":"oid"},"git_oid_fmt":{"type":"function","file":"oid.h","line":78,"lineto":78,"args":[{"name":"str","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":"oid","type":"const git_oid *","comment":"oid structure to format."}],"argline":"char *str, const git_oid *oid","sig":"char *::const git_oid *","return":{"type":"void"},"description":"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.","comments":"","group":"oid"},"git_oid_pathfmt":{"type":"function","file":"oid.h","line":93,"lineto":93,"args":[{"name":"str","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":"oid","type":"const git_oid *","comment":"oid structure to format."}],"argline":"char *str, const git_oid *oid","sig":"char *::const git_oid *","return":{"type":"void"},"description":"Format a git_oid into a loose-object path string.\n<p>\nThe resulting string is \"aa/...\", where \"aa\" is the first two\nhex digitis of the oid and \"...\" is the remaining 38 digits.","comments":"","group":"oid"},"git_oid_allocfmt":{"type":"function","file":"oid.h","line":101,"lineto":101,"args":[{"name":"oid","type":"const git_oid *","comment":"the oid structure to format"}],"argline":"const git_oid *oid","sig":"const git_oid *","return":{"type":"char *","comment":"the c-string; NULL if memory is exhausted. Caller must deallocate the string with free()."},"description":"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().","comments":"","group":"oid"},"git_oid_to_string":{"type":"function","file":"oid.h","line":118,"lineto":118,"args":[{"name":"out","type":"char *","comment":"the buffer into which the oid string is output."},{"name":"n","type":"size_t","comment":"the size of the out buffer."},{"name":"oid","type":"const git_oid *","comment":"the oid structure to format."}],"argline":"char *out, size_t n, const git_oid *oid","sig":"char *::size_t::const git_oid *","return":{"type":"char *","comment":"the out buffer pointer, assuming no input parameter errors, otherwise a pointer to an empty string."},"description":"Format a git_oid into a buffer as a hex format c-string.\n<p>\nIf the buffer is smaller than GIT_OID_HEXSZ+1, then the resulting\noid c-string will be truncated to n-1 characters. If there are\nany input parameter errors (out == NULL, n == 0, oid == NULL),\nthen a pointer to an empty string is returned, so that the return\nvalue can always be printed.","comments":"","group":"oid"},"git_oid_cpy":{"type":"function","file":"oid.h","line":125,"lineto":125,"args":[{"name":"out","type":"git_oid *","comment":"oid structure the result is written into."},{"name":"src","type":"const git_oid *","comment":"oid structure to copy from."}],"argline":"git_oid *out, const git_oid *src","sig":"git_oid *::const git_oid *","return":{"type":"void"},"description":"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.","comments":"","group":"oid"},"git_oid_cmp":{"type":"function","file":"oid.h","line":133,"lineto":133,"args":[{"name":"a","type":"const git_oid *","comment":"first oid structure."},{"name":"b","type":"const git_oid *","comment":"second oid structure."}],"argline":"const git_oid *a, const git_oid *b","sig":"const git_oid *::const git_oid *","return":{"type":"int","comment":"<0, 0, >0 if a < b, a == b, a > b."},"description":"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.","comments":"","group":"oid"},"git_odb_new":{"type":"function","file":"odb.h","line":52,"lineto":52,"args":[{"name":"out","type":"git_odb **","comment":"location to store the database pointer, if opened. Set to NULL if the open failed."}],"argline":"git_odb **out","sig":"git_odb **","return":{"type":"int","comment":"GIT_SUCCESS if the database was created; otherwise an error code describing why the open was not possible."},"description":"Create a new object database with no backends.","comments":"Before the ODB can be used for read/writing, a custom database\nbackend must be manually added using `git_odb_add_backend()`\n","group":"odb"},"git_odb_open":{"type":"function","file":"odb.h","line":71,"lineto":71,"args":[{"name":"out","type":"git_odb **","comment":"location to store the database pointer, if opened. Set to NULL if the open failed."},{"name":"objects_dir","type":"const char *","comment":"path of the backends' \"objects\" directory."}],"argline":"git_odb **out, const char *objects_dir","sig":"git_odb **::const char *","return":{"type":"int","comment":"GIT_SUCCESS if the database opened; otherwise an error code describing why the open was not possible."},"description":"Create a new object database and automatically add\nthe two default backends:","comments":"- git_odb_backend_loose: read and write loose object files\n\tfrom disk, assuming `objects_dir` as the Objects folder\n\n- git_odb_backend_pack: read objects from packfiles,\n\tassuming `objects_dir` as the Objects folder which\n\tcontains a 'pack/' folder with the corresponding data\n","group":"odb"},"git_odb_add_backend":{"type":"function","file":"odb.h","line":82,"lineto":82,"args":[{"name":"odb","type":"git_odb *","comment":"database to add the backend to"},{"name":"backend","type":"git_odb_backend *"}],"argline":"git_odb *odb, git_odb_backend *backend","sig":"git_odb *::git_odb_backend *","return":{"type":"int","comment":"0 on sucess; error code otherwise"},"description":"Add a custom backend to an existing Object DB","comments":"Read <odb_backends.h> for more information.\n","group":"odb"},"git_odb_close":{"type":"function","file":"odb.h","line":88,"lineto":88,"args":[{"name":"db","type":"git_odb *","comment":"database pointer to close. If NULL no action is taken."}],"argline":"git_odb *db","sig":"git_odb *","return":{"type":"void"},"description":"Close an open object database.\n@param db database pointer to close. If NULL no action is taken.","comments":"","group":"odb"},"git_odb_read":{"type":"function","file":"odb.h","line":109,"lineto":109,"args":[{"name":"out","type":"git_rawobj *","comment":"object descriptor to populate upon reading."},{"name":"db","type":"git_odb *","comment":"database to search for the object in."},{"name":"id","type":"const git_oid *","comment":"identity of the object to read."}],"argline":"git_rawobj *out, git_odb *db, const git_oid *id","sig":"git_rawobj *::git_odb *::const git_oid *","return":{"type":"int","comment":"- GIT_SUCCESS if the object was read; - GIT_ENOTFOUND if the object is not in the database."},"description":"Read an object from the database.","comments":"If GIT_ENOTFOUND then out->data is set to NULL.\n","group":"odb"},"git_odb_read_header":{"type":"function","file":"odb.h","line":128,"lineto":128,"args":[{"name":"out","type":"git_rawobj *","comment":"object descriptor to populate upon reading."},{"name":"db","type":"git_odb *","comment":"database to search for the object in."},{"name":"id","type":"const git_oid *","comment":"identity of the object to read."}],"argline":"git_rawobj *out, git_odb *db, const git_oid *id","sig":"git_rawobj *::git_odb *::const git_oid *","return":{"type":"int","comment":"- GIT_SUCCESS if the object was read; - GIT_ENOTFOUND if the object is not in the database."},"description":"Read the header of an object from the database, without\nreading its full contents.","comments":"Only the 'type' and 'len' fields of the git_rawobj structure\nare filled. The 'data' pointer will always be NULL.\n\nThe raw object pointed by 'out' doesn't need to be manually\nclosed with git_rawobj_close().\n","group":"odb"},"git_odb_write":{"type":"function","file":"odb.h","line":140,"lineto":140,"args":[{"name":"id","type":"git_oid *","comment":"identity of the object written."},{"name":"db","type":"git_odb *","comment":"database to which the object should be written."},{"name":"obj","type":"git_rawobj *","comment":"object descriptor for the object to write."}],"argline":"git_oid *id, git_odb *db, git_rawobj *obj","sig":"git_oid *::git_odb *::git_rawobj *","return":{"type":"int","comment":"- GIT_SUCCESS if the object was written; - GIT_ERROR otherwise."},"description":"Write an object to the database.","comments":"","group":"odb"},"git_odb_exists":{"type":"function","file":"odb.h","line":151,"lineto":151,"args":[{"name":"db","type":"git_odb *","comment":"database to be searched for the given object."},{"name":"id","type":"const git_oid *","comment":"the object to search for."}],"argline":"git_odb *db, const git_oid *id","sig":"git_odb *::const git_oid *","return":{"type":"int","comment":"- true, if the object was found - false, otherwise"},"description":"Determine if the given object can be found in the object database.","comments":"","group":"odb"},"git_rawobj_hash":{"type":"function","file":"odb.h","line":169,"lineto":169,"args":[{"name":"id","type":"git_oid *","comment":"the resulting object-ID."},{"name":"obj","type":"git_rawobj *","comment":"the object whose hash is to be determined."}],"argline":"git_oid *id, git_rawobj *obj","sig":"git_oid *::git_rawobj *","return":{"type":"int","comment":"- GIT_SUCCESS if the object-ID was correctly determined. - GIT_ERROR if the given object is malformed."},"description":"Determine the object-ID (sha1 hash) of the given git_rawobj.","comments":"The input obj must be a valid loose object type and the data\npointer must not be NULL, unless the len field is also zero.\n","group":"rawobj"},"git_rawobj_close":{"type":"function","file":"odb.h","line":180,"lineto":180,"args":[{"name":"obj","type":"git_rawobj *","comment":"object descriptor to free."}],"argline":"git_rawobj *obj","sig":"git_rawobj *","return":{"type":"void"},"description":"Release all memory used by the obj structure.","comments":"As a result of this call, obj->data will be set to NULL.\n\nIf obj->data is already NULL, nothing happens.\n","group":"rawobj"},"git_object_write":{"type":"function","file":"object.h","line":58,"lineto":58,"args":[{"name":"object","type":"git_object *","comment":"Git object to write back"}],"argline":"git_object *object","sig":"git_object *","return":{"type":"int","comment":"0 on success; otherwise an error code"},"description":"Write back an object to disk.","comments":"The object will be written to its corresponding\nrepository.\n\nIf the object has no changes since it was first\nread from the repository, no actions will take place.\n\nIf the object has been modified since it was read from\nthe repository, or it has been created from scratch\nin memory, it will be written to the repository and\nits SHA1 ID will be updated accordingly.\n","group":"object"},"git_object_id":{"type":"function","file":"object.h","line":69,"lineto":69,"args":[{"name":"obj","type":"git_object *","comment":"the repository object"}],"argline":"git_object *obj","sig":"git_object *","return":{"type":"const git_oid *","comment":"the SHA1 id"},"description":"Get the id (SHA1) of a repository object","comments":"In-memory objects created by git_object_new() do not\nhave a SHA1 ID until they are written on a repository.\n","group":"object"},"git_object_type":{"type":"function","file":"object.h","line":77,"lineto":77,"args":[{"name":"obj","type":"git_object *","comment":"the repository object"}],"argline":"git_object *obj","sig":"git_object *","return":{"type":"git_otype","comment":"the object's type"},"description":"Get the object type of an object","comments":"","group":"object"},"git_object_owner":{"type":"function","file":"object.h","line":85,"lineto":85,"args":[{"name":"obj","type":"git_object *","comment":"the object"}],"argline":"git_object *obj","sig":"git_object *","return":{"type":"git_repository *","comment":"the repository who owns this object"},"description":"Get the repository that owns this object","comments":"","group":"object"},"git_object_free":{"type":"function","file":"object.h","line":99,"lineto":99,"args":[{"name":"object","type":"git_object *","comment":"the object to free"}],"argline":"git_object *object","sig":"git_object *","return":{"type":"void"},"description":"Free a reference to one of the objects in the repository.","comments":"Repository objects are managed automatically by the library,\nbut this method can be used to force freeing one of the\nobjects.\n\nCareful: freeing objects in the middle of a repository\ntraversal will most likely cause errors.\n","group":"object"},"git_object_type2string":{"type":"function","file":"object.h","line":110,"lineto":110,"args":[{"name":"type","type":"git_otype","comment":"object type to convert."}],"argline":"git_otype type","sig":"git_otype","return":{"type":"const char *","comment":"the corresponding string representation."},"description":"Convert an object type to it's string representation.","comments":"The result is a pointer to a string in static memory and\nshould not be free()'ed.\n","group":"object"},"git_object_string2type":{"type":"function","file":"object.h","line":118,"lineto":118,"args":[{"name":"str","type":"const char *","comment":"the string to convert."}],"argline":"const char *str","sig":"const char *","return":{"type":"git_otype","comment":"the corresponding git_otype."},"description":"Convert a string object type representation to it's git_otype.","comments":"","group":"object"},"git_object_typeisloose":{"type":"function","file":"object.h","line":127,"lineto":127,"args":[{"name":"type","type":"git_otype","comment":"object type to test."}],"argline":"git_otype type","sig":"git_otype","return":{"type":"int","comment":"true if the type represents a valid loose object type, false otherwise."},"description":"Determine if the given git_otype is a valid loose object type.","comments":"","group":"object"},"git_object__size":{"type":"function","file":"object.h","line":141,"lineto":141,"args":[{"name":"type","type":"git_otype","comment":"object type to get its size"}],"argline":"git_otype type","sig":"git_otype","return":{"type":"size_t","comment":"size in bytes of the object"},"description":"Get the size in bytes for the structure which\nacts as an in-memory representation of any given\nobject type.","comments":"For all the core types, this would the equivalent\nof calling `sizeof(git_commit)` if the core types\nwere not opaque on the external API.\n","group":"object"},"git_index_open_bare":{"type":"function","file":"index.h","line":87,"lineto":87,"args":[{"name":"index","type":"git_index **","comment":"the pointer for the new index"},{"name":"index_path","type":"const char *","comment":"the path to the index file in disk"}],"argline":"git_index **index, const char *index_path","sig":"git_index **::const char *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Create a new Git index object as a memory representation\nof the Git index file in 'index_path', without a repository\nto back it.","comments":"Since there is no ODB behind this index, any Index methods\nwhich rely on the ODB (e.g. index_add) will fail with the\nGIT_EBAREINDEX error code.\n","group":"index"},"git_index_open_inrepo":{"type":"function","file":"index.h","line":97,"lineto":97,"args":[{"name":"index","type":"git_index **","comment":"_path the path to the index file in disk"},{"name":"repo","type":"git_repository *","comment":"the git repo which owns the index"}],"argline":"git_index **index, git_repository *repo","sig":"git_index **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Open the Index inside the git repository pointed\nby 'repo'.","comments":"","group":"index"},"git_index_clear":{"type":"function","file":"index.h","line":106,"lineto":106,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"void"},"description":"Clear the contents (all the entries) of an index object.\nThis clears the index object in memory; changes must be manually\nwritten to disk for them to take effect.","comments":"","group":"index"},"git_index_free":{"type":"function","file":"index.h","line":113,"lineto":113,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"void"},"description":"Free an existing index object.","comments":"","group":"index"},"git_index_read":{"type":"function","file":"index.h","line":122,"lineto":122,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"int","comment":"0 on success, otherwise an error code"},"description":"Update the contents of an existing index object in memory\nby reading from the hard disk.","comments":"","group":"index"},"git_index_write":{"type":"function","file":"index.h","line":131,"lineto":131,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"int","comment":"0 on success, otherwise an error code"},"description":"Write an existing index object from memory back to disk\nusing an atomic file lock.","comments":"","group":"index"},"git_index_find":{"type":"function","file":"index.h","line":141,"lineto":141,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"path to search"}],"argline":"git_index *index, const char *path","sig":"git_index *::const char *","return":{"type":"int","comment":"an index >= 0 if found, -1 otherwise"},"description":"Find the first index of any entires which point to given\npath in the Git index.","comments":"","group":"index"},"git_index_add":{"type":"function","file":"index.h","line":151,"lineto":151,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"filename to add"},{"name":"stage","type":"int","comment":"stage for the entry"}],"argline":"git_index *index, const char *path, int stage","sig":"git_index *::const char *::int","return":{"type":"int","comment":"0 on success, otherwise an error code"},"description":"Add or update an index entry from a file in disk.","comments":"","group":"index"},"git_index_remove":{"type":"function","file":"index.h","line":160,"lineto":160,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"position","type":"int","comment":"position of the entry to remove"}],"argline":"git_index *index, int position","sig":"git_index *::int","return":{"type":"int","comment":"0 on success, otherwise an error code"},"description":"Remove an entry from the index","comments":"","group":"index"},"git_index_insert":{"type":"function","file":"index.h","line":173,"lineto":173,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"source_entry","type":"const git_index_entry *","comment":"new entry object"}],"argline":"git_index *index, const git_index_entry *source_entry","sig":"git_index *::const git_index_entry *","return":{"type":"int","comment":"0 on success, otherwise an error code"},"description":"Insert an entry into the index.\nA full copy (including the 'path' string) of the given\n'source_entry' will be inserted on the index; if the index\nalready contains an entry for the same path, the entry\nwill be updated.","comments":"","group":"index"},"git_index_get":{"type":"function","file":"index.h","line":185,"lineto":185,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"n","type":"int","comment":"the position of the entry"}],"argline":"git_index *index, int n","sig":"git_index *::int","return":{"type":"git_index_entry *","comment":"a pointer to the entry; NULL if out of bounds"},"description":"Get a pointer to one of the entries in the index","comments":"This entry can be modified, and the changes will be written\nback to disk on the next write() call.\n","group":"index"},"git_index_entrycount":{"type":"function","file":"index.h","line":193,"lineto":193,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"unsigned int","comment":"integer of count of current entries"},"description":"Get the count of entries currently in the index","comments":"","group":"index"},"git_strerror":{"type":"function","file":"errors.h","line":41,"lineto":41,"args":[{"name":"num","type":"int","comment":"The error code to explain"}],"argline":"int num","sig":"int","return":{"type":"const char *","comment":"a string explaining the error code"},"description":"strerror() for the Git library\n@param num The error code to explain\n@return a string explaining the error code","comments":"","group":"errors"},"git_commit_lookup":{"type":"function","file":"commit.h","line":53,"lineto":56,"args":[{"name":"commit","type":"git_commit **","comment":"pointer to the looked up commit"},{"name":"repo","type":"git_repository *","comment":"the repo to use when locating the commit."},{"name":"id","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."}],"argline":"git_commit **commit, git_repository *repo, const git_oid *id","sig":"git_commit **::git_repository *::const git_oid *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Lookup a commit object from a repository.\nThe generated commit object is owned by the revision\nrepo and shall not be freed by the user.","comments":"","group":"commit"},"git_commit_new":{"type":"function","file":"commit.h","line":69,"lineto":72,"args":[{"name":"commit","type":"git_commit **","comment":"pointer to the new commit"},{"name":"repo","type":"git_repository *","comment":"The repository where the object will reside"}],"argline":"git_commit **commit, git_repository *repo","sig":"git_commit **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Create a new in-memory git_commit.","comments":"The commit object must be manually filled using\nsetter methods before it can be written to its\nrepository.\n","group":"commit"},"git_commit_id":{"type":"function","file":"commit.h","line":79,"lineto":79,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const git_oid *","comment":"object identity for the commit."},"description":"Get the id of a commit.\n@param commit a previously loaded commit.\n@return object identity for the commit.","comments":"","group":"commit"},"git_commit_message_short":{"type":"function","file":"commit.h","line":86,"lineto":86,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const char *","comment":"the short message of a commit"},"description":"Get the short (one line) message of a commit.\n@param commit a previously loaded commit.\n@return the short message of a commit","comments":"","group":"commit"},"git_commit_message":{"type":"function","file":"commit.h","line":93,"lineto":93,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const char *","comment":"the message of a commit"},"description":"Get the full message of a commit.\n@param commit a previously loaded commit.\n@return the message of a commit","comments":"","group":"commit"},"git_commit_time":{"type":"function","file":"commit.h","line":100,"lineto":100,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"time_t","comment":"the time of a commit"},"description":"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","comments":"","group":"commit"},"git_commit_time_offset":{"type":"function","file":"commit.h","line":107,"lineto":107,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"int","comment":"positive or negative timezone offset, in minutes from UTC"},"description":"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","comments":"","group":"commit"},"git_commit_committer":{"type":"function","file":"commit.h","line":114,"lineto":114,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const git_signature *","comment":"the committer of a commit"},"description":"Get the committer of a commit.\n@param commit a previously loaded commit.\n@return the committer of a commit","comments":"","group":"commit"},"git_commit_author":{"type":"function","file":"commit.h","line":121,"lineto":121,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const git_signature *","comment":"the author of a commit"},"description":"Get the author of a commit.\n@param commit a previously loaded commit.\n@return the author of a commit","comments":"","group":"commit"},"git_commit_tree":{"type":"function","file":"commit.h","line":128,"lineto":128,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const git_tree *","comment":"the tree of a commit"},"description":"Get the tree pointed to by a commit.\n@param commit a previously loaded commit.\n@return the tree of a commit","comments":"","group":"commit"},"git_commit_parentcount":{"type":"function","file":"commit.h","line":136,"lineto":136,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"unsigned int","comment":"integer of count of parents"},"description":"Get the number of parents of this commit","comments":"","group":"commit"},"git_commit_parent":{"type":"function","file":"commit.h","line":144,"lineto":144,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."},{"name":"n","type":"unsigned int","comment":"the position of the entry"}],"argline":"git_commit *commit, unsigned int n","sig":"git_commit *::unsigned int","return":{"type":"git_commit *","comment":"a pointer to the commit; NULL if out of bounds"},"description":"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","comments":"","group":"commit"},"git_commit_add_parent":{"type":"function","file":"commit.h","line":152,"lineto":152,"args":[{"name":"commit","type":"git_commit *","comment":"the commit object"},{"name":"new_parent","type":"git_commit *","comment":"the new commit which will be a parent"}],"argline":"git_commit *commit, git_commit *new_parent","sig":"git_commit *::git_commit *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"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","comments":"","group":"commit"},"git_commit_set_message":{"type":"function","file":"commit.h","line":159,"lineto":159,"args":[{"name":"commit","type":"git_commit *","comment":"the commit object"},{"name":"message","type":"const char *","comment":"the new message"}],"argline":"git_commit *commit, const char *message","sig":"git_commit *::const char *","return":{"type":"void"},"description":"Set the message of a commit\n@param commit the commit object\n@param message the new message","comments":"","group":"commit"},"git_commit_set_committer":{"type":"function","file":"commit.h","line":166,"lineto":166,"args":[{"name":"commit","type":"git_commit *","comment":"the commit object"},{"name":"committer_sig","type":"const git_signature *"}],"argline":"git_commit *commit, const git_signature *committer_sig","sig":"git_commit *::const git_signature *","return":{"type":"void"},"description":"Set the committer of a commit\n@param commit the commit object\n@param author_sig signature of the committer","comments":"","group":"commit"},"git_commit_set_author":{"type":"function","file":"commit.h","line":173,"lineto":173,"args":[{"name":"commit","type":"git_commit *","comment":"the commit object"},{"name":"author_sig","type":"const git_signature *","comment":"signature of the author"}],"argline":"git_commit *commit, const git_signature *author_sig","sig":"git_commit *::const git_signature *","return":{"type":"void"},"description":"Set the author of a commit\n@param commit the commit object\n@param author_sig signature of the author","comments":"","group":"commit"},"git_commit_set_tree":{"type":"function","file":"commit.h","line":180,"lineto":180,"args":[{"name":"commit","type":"git_commit *","comment":"the commit object"},{"name":"tree","type":"git_tree *","comment":"the new tree"}],"argline":"git_commit *commit, git_tree *tree","sig":"git_commit *::git_tree *","return":{"type":"void"},"description":"Set the tree which is pointed to by a commit\n@param commit the commit object\n@param tree the new tree","comments":"","group":"commit"},"git_blob_lookup":{"type":"function","file":"blob.h","line":52,"lineto":55,"args":[{"name":"blob","type":"git_blob **","comment":"pointer to the looked up blob"},{"name":"repo","type":"git_repository *","comment":"the repo to use when locating the blob."},{"name":"id","type":"const git_oid *","comment":"identity of the blob to locate."}],"argline":"git_blob **blob, git_repository *repo, const git_oid *id","sig":"git_blob **::git_repository *::const git_oid *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Lookup a blob object from a repository.\nThe generated blob object is owned by the revision\nrepo and shall not be freed by the user.","comments":"","group":"blob"},"git_blob_new":{"type":"function","file":"blob.h","line":68,"lineto":71,"args":[{"name":"blob","type":"git_blob **","comment":"pointer to the new blob"},{"name":"repo","type":"git_repository *","comment":"The repository where the object will reside"}],"argline":"git_blob **blob, git_repository *repo","sig":"git_blob **::git_repository *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Create a new in-memory git_blob.","comments":"The blob object must be manually filled using\nthe 'set_rawcontent' methods before it can\nbe written back to disk.\n","group":"blob"},"git_blob_set_rawcontent_fromfile":{"type":"function","file":"blob.h","line":81,"lineto":81,"args":[{"name":"blob","type":"git_blob *","comment":"pointer to the new blob"},{"name":"filename","type":"const char *","comment":"name of the file to read"}],"argline":"git_blob *blob, const char *filename","sig":"git_blob *::const char *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Fill a blob with the contents inside\nthe pointed file.","comments":"","group":"blob"},"git_blob_set_rawcontent":{"type":"function","file":"blob.h","line":92,"lineto":92,"args":[{"name":"blob","type":"git_blob *","comment":"pointer to the blob"},{"name":"buffer","type":"const void *","comment":"buffer with the contents for the blob"},{"name":"len","type":"size_t","comment":"size of the buffer"}],"argline":"git_blob *blob, const void *buffer, size_t len","sig":"git_blob *::const void *::size_t","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"Fill a blob with the contents inside\nthe pointed buffer","comments":"","group":"blob"},"git_blob_rawcontent":{"type":"function","file":"blob.h","line":105,"lineto":105,"args":[{"name":"blob","type":"git_blob *","comment":"pointer to the blob"}],"argline":"git_blob *blob","sig":"git_blob *","return":{"type":"const char *","comment":"the pointer; NULL if the blob has no contents"},"description":"Get a read-only buffer with the raw content of a blob.","comments":"A pointer to the raw content of a blob is returned;\nthis pointer is owned internally by the object and shall\nnot be free'd. The pointer may be invalidated at a later\ntime (e.g. when changing the contents of the blob).\n","group":"blob"},"git_blob_rawsize":{"type":"function","file":"blob.h","line":113,"lineto":113,"args":[{"name":"blob","type":"git_blob *","comment":"pointer to the blob"}],"argline":"git_blob *blob","sig":"git_blob *","return":{"type":"int","comment":"size on bytes"},"description":"Get the size in bytes of the contents of a blob","comments":"","group":"blob"},"git_blob_writefile":{"type":"function","file":"blob.h","line":124,"lineto":124,"args":[{"name":"written_id","type":"git_oid *","comment":"return the id of the written blob"},{"name":"repo","type":"git_repository *","comment":"repository where the blob will be written"},{"name":"path","type":"const char *","comment":"file from which the blob will be created"}],"argline":"git_oid *written_id, git_repository *repo, const char *path","sig":"git_oid *::git_repository *::const char *","return":{"type":"int"},"description":"Read a file from the working folder of a repository\nand write it to the Object Database as a loose blob,\nif such doesn't exist yet.","comments":"","group":"blob"}},"globals":{"GIT_SORT_NONE":{"value":"(0)","file":"revwalk.h","line":46,"comments":"Sort the repository contents in no particular ordering;\nthis sorting is arbitrary, implementation-specific\nand subject to change at any time.\nThis is the default sorting for new walkers."},"GIT_SORT_TOPOLOGICAL":{"value":"(1 << 0)","file":"revwalk.h","line":53,"comments":"Sort the repository contents in topological order\n(parents before children); this sorting mode\ncan be combined with time sorting."},"GIT_SORT_TIME":{"value":"(1 << 1)","file":"revwalk.h","line":60,"comments":"Sort the repository contents by commit time;\nthis sorting mode can be combined with\ntopological sorting."},"GIT_SORT_REVERSE":{"value":"(1 << 2)","file":"revwalk.h","line":67,"comments":"Iterate through the repository contents in reverse\norder; this sorting mode can be combined with\nany of the above."},"GIT_OID_RAWSZ":{"value":"20","file":"oid.h","line":41,"comments":"Size (in bytes) of a raw/binary oid"},"GIT_OID_HEXSZ":{"value":"(GIT_OID_RAWSZ * 2)","file":"oid.h","line":44,"comments":"Size (in bytes) of a hex formatted oid"},"GIT_BEGIN_DECL":{"value":"","file":"common.h","line":36,"comments":"Start declarations in C mode"},"GIT_END_DECL":{"value":"","file":"common.h","line":38,"comments":"End declarations in C mode"},"GIT_EXTERN(type)":{"value":"extern __attribute__((visibility(\"default\"))) type","file":"common.h","line":42,"comments":"Declare a public function exported for application use."},"GIT_EXTERN_TLS(type)":{"value":"extern __attribute__((visibility(\"default\"))) GIT_TLS type","file":"common.h","line":53,"comments":"Declare a public TLS symbol exported for application use."},"GIT_INLINE(type)":{"value":"static __inline type","file":"common.h","line":65,"comments":"Declare a function as always inlined."},"GIT_FORMAT_PRINTF(a,b)":{"value":"__attribute__((format (printf, a, b)))","file":"common.h","line":72,"comments":"Declare a function's takes printf style arguments."},"GIT_SUCCESS":{"value":"0","file":"common.h","line":87,"comments":"Operation completed successfully."},"GIT_ERROR":{"value":"-1","file":"common.h","line":95,"comments":"Operation failed, with unspecified reason.\nThis value also serves as the base error code; all other\nerror codes are subtracted from it such that all errors\nare < 0, in typical POSIX C tradition."},"GIT_ENOTOID":{"value":"(GIT_ERROR - 1)","file":"common.h","line":98,"comments":"Input was not a properly formatted Git object id."},"GIT_ENOTFOUND":{"value":"(GIT_ERROR - 2)","file":"common.h","line":101,"comments":"Input does not exist in the scope searched."},"GIT_ENOMEM":{"value":"(GIT_ERROR - 3)","file":"common.h","line":104,"comments":"Not enough space available."},"GIT_EOSERR":{"value":"(GIT_ERROR - 4)","file":"common.h","line":107,"comments":"Consult the OS error information."},"GIT_EOBJTYPE":{"value":"(GIT_ERROR - 5)","file":"common.h","line":110,"comments":"The specified object is of invalid type"},"GIT_EOBJCORRUPTED":{"value":"(GIT_ERROR - 6)","file":"common.h","line":113,"comments":"The specified object has its data corrupted"},"GIT_ENOTAREPO":{"value":"(GIT_ERROR - 7)","file":"common.h","line":116,"comments":"The specified repository is invalid"},"GIT_EINVALIDTYPE":{"value":"(GIT_ERROR - 8)","file":"common.h","line":119,"comments":"The object type is invalid or doesn't match"},"GIT_EMISSINGOBJDATA":{"value":"(GIT_ERROR - 9)","file":"common.h","line":122,"comments":"The object cannot be written that because it's missing internal data"},"GIT_EPACKCORRUPTED":{"value":"(GIT_ERROR - 10)","file":"common.h","line":125,"comments":"The packfile for the ODB is corrupted"},"GIT_EFLOCKFAIL":{"value":"(GIT_ERROR - 11)","file":"common.h","line":128,"comments":"Failed to adquire or release a file lock"},"GIT_EZLIB":{"value":"(GIT_ERROR - 12)","file":"common.h","line":131,"comments":"The Z library failed to inflate/deflate an object's data"},"GIT_EBUSY":{"value":"(GIT_ERROR - 13)","file":"common.h","line":134,"comments":"The queried object is currently busy"},"GIT_EBAREINDEX":{"value":"(GIT_ERROR - 14)","file":"common.h","line":137,"comments":"The index file is not backed up by an existing repository"},"GIT_EINVALIDREFNAME":{"value":"(GIT_ERROR - 15)","file":"common.h","line":140,"comments":"The name of the reference is not valid"},"GIT_EREFCORRUPTED":{"value":"(GIT_ERROR - 16)","file":"common.h","line":143,"comments":"The specified reference has its data corrupted"},"GIT_ETOONESTEDSYMREF":{"value":"(GIT_ERROR - 17)","file":"common.h","line":146,"comments":"The specified symbolic reference is too deeply nested"},"GIT_EPACKEDREFSCORRUPTED":{"value":"(GIT_ERROR - 18)","file":"common.h","line":149,"comments":"The pack-refs file is either corrupted of its format is not currently supported"},"GIT_EINVALIDPATH":{"value":"(GIT_ERROR - 19)","file":"common.h","line":152,"comments":"The path is invalid"},"GIT_EREVWALKOVER":{"value":"(GIT_ERROR - 20)","file":"common.h","line":155,"comments":"The revision walker is empty; there are no more commits left to iterate"}},"types":[["git_blob",{"type":"struct","value":"git_blob","file":"types.h","line":111,"lineto":111,"block":"","tdef":"typedef","comments":"In-memory representation of a blob object.","used":{"returns":[],"needs":["git_blob_lookup","git_blob_new","git_blob_rawcontent","git_blob_rawsize","git_blob_set_rawcontent","git_blob_set_rawcontent_fromfile"]}}],["git_commit",{"type":"struct","value":"git_commit","file":"types.h","line":114,"lineto":114,"block":"","tdef":"typedef","comments":"Parsed representation of a commit object.","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"]}}],["git_index",{"type":"struct","value":"git_index","file":"types.h","line":123,"lineto":123,"block":"","tdef":"typedef","comments":"Memory representation of an index file.","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"]}}],["git_index_entry",{"type":"struct","value":"git_index_entry","file":"index.h","line":54,"lineto":71,"block":"git_index_time ctime\ngit_index_time mtime\nunsigned int dev\nunsigned int ino\nunsigned int mode\nunsigned int uid\nunsigned int gid\ngit_off_t file_size\ngit_oid oid\nunsigned short flags\nunsigned short flags_extended\nchar *path","tdef":"typedef","comments":"Memory representation of a file entry in the index.","used":{"returns":["git_index_get"],"needs":["git_index_insert"]}}],["git_index_time",{"type":"struct","value":"git_index_time","file":"index.h","line":47,"lineto":51,"block":"git_time_t seconds\nunsigned int nanoseconds","tdef":"typedef","comments":"Time used in a git index entry","used":{"returns":[],"needs":[]}}],["git_object",{"type":"struct","value":"git_object","file":"types.h","line":102,"lineto":102,"block":"","tdef":"typedef","comments":"Representation of a generic object in a repository","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","git_tree_entry_2object"]}}],["git_odb",{"type":"struct","value":"git_odb","file":"types.h","line":90,"lineto":90,"block":"","tdef":"typedef","comments":"An open object database handle.","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","git_repository_open3"]}}],["git_odb_backend",{"type":"struct","value":"git_odb_backend","file":"odb_backend.h","line":42,"lineto":78,"block":"git_odb *odb\nint priority\nint (* read)(git_rawobj *, struct git_odb_backend *, const git_oid *)\nint (* read_header)(git_rawobj *, struct git_odb_backend *, const git_oid *)\nint (* write)(git_oid *id, struct git_odb_backend *, git_rawobj *obj)\nint (* exists)(struct git_odb_backend *, const git_oid *)\nvoid (* free)(struct git_odb_backend *)","tdef":null,"comments":"An instance for a custom backend","used":{"returns":[],"needs":["git_odb_add_backend"]}}],["git_oid",{"type":"struct","value":"git_oid","file":"oid.h","line":47,"lineto":50,"block":"unsigned char id[GIT_OID_RAWSZ]","tdef":"typedef","comments":"Unique identity of any object (commit, tree, blob, tag).","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"]}}],["git_otype",{"type":"enum","file":"types.h","line":76,"lineto":87,"block":"GIT_OBJ_ANY\nGIT_OBJ_BAD\nGIT_OBJ__EXT1\nGIT_OBJ_COMMIT\nGIT_OBJ_TREE\nGIT_OBJ_BLOB\nGIT_OBJ_TAG\nGIT_OBJ__EXT2\nGIT_OBJ_OFS_DELTA\nGIT_OBJ_REF_DELTA","tdef":"typedef","comments":"Basic type (loose or packed) of any Git object.","used":{"returns":[],"needs":["git_object__size","git_object_type2string","git_object_typeisloose","git_repository_lookup","git_repository_newobject"]}}],["git_rawobj",{"type":"struct","value":"git_rawobj","file":"odb.h","line":91,"lineto":95,"block":"void *data\nsize_t len\ngit_otype type","tdef":"typedef","comments":"An object read from the database.","used":{"returns":[],"needs":["git_odb_read","git_odb_read_header","git_odb_write","git_rawobj_close","git_rawobj_hash"]}}],["git_reference",{"type":"struct","value":"git_reference","file":"types.h","line":139,"lineto":139,"block":"","tdef":"typedef","comments":"In-memory representation of a reference.","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"]}}],["git_repository",{"type":"struct","value":"git_repository","file":"types.h","line":99,"lineto":99,"block":"","tdef":"typedef","comments":"Representation of an existing git repository,\nincluding all its object contents","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_repository_open2","git_repository_open3","git_revwalk_new","git_tag_lookup","git_tag_new","git_tree_lookup","git_tree_new"]}}],["git_revwalk",{"type":"struct","value":"git_revwalk","file":"types.h","line":105,"lineto":105,"block":"","tdef":"typedef","comments":"Representation of an in-progress walk through the commits in a repo","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"]}}],["git_rtype",{"type":"enum","file":"types.h","line":142,"lineto":146,"block":"GIT_REF_INVALID\nGIT_REF_OID\nGIT_REF_SYMBOLIC","tdef":"typedef","comments":"Basic type of any Git reference.","used":{"returns":[],"needs":[]}}],["git_signature",{"type":"struct","value":"git_signature","file":"types.h","line":132,"lineto":136,"block":"char *name\nchar *email\ngit_time when","tdef":"typedef","comments":"An action signature (e.g. for committers, taggers, etc)","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"]}}],["git_tag",{"type":"struct","value":"git_tag","file":"types.h","line":108,"lineto":108,"block":"","tdef":"typedef","comments":"Parsed representation of a tag object.","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"]}}],["git_time",{"type":"struct","value":"git_time","file":"types.h","line":126,"lineto":129,"block":"time_t time\nint offset","tdef":"typedef","comments":"Time in a signature","used":{"returns":[],"needs":[]}}],["git_tree",{"type":"struct","value":"git_tree","file":"types.h","line":120,"lineto":120,"block":"","tdef":"typedef","comments":"Representation of a tree object.","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"]}}],["git_tree_entry",{"type":"struct","value":"git_tree_entry","file":"types.h","line":117,"lineto":117,"block":"","tdef":"typedef","comments":"Representation of each one of the entries in a tree object.","used":{"returns":["git_tree_entry_byindex","git_tree_entry_byname"],"needs":["git_tree_add_entry","git_tree_add_entry_unsorted","git_tree_entry_2object","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"]}}]],"prefix":"src/git2","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_string2type","git_object_type","git_object_type2string","git_object_typeisloose","git_object_write"]],["odb",["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"]],["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","git_repository_open2","git_repository_open3"]],["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_2object","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"]],["zlib",["deflateBound"]]]}
\ No newline at end of file |