{"files":[{"file":"attr.h","functions":["git_attr_get","git_attr_get_many","git_attr_foreach","git_attr_cache_flush","git_attr_add_macro"],"meta":{"brief":"Git attribute management routines","defgroup":"git_attr Git attribute management routines","ingroup":"Git","comments":"\n"},"lines":240},{"file":"blob.h","functions":["git_blob_lookup","git_blob_lookup_prefix","git_blob_free","git_blob_id","git_blob_rawcontent","git_blob_rawsize","git_blob_create_fromworkdir","git_blob_create_fromdisk","git_blob_create_fromchunks","git_blob_create_frombuffer","git_blob_is_binary"],"meta":{"brief":"Git blob load and write routines","defgroup":"git_blob Git blob load and write routines","ingroup":"Git","comments":"\n"},"lines":201},{"file":"branch.h","functions":["git_branch_create","git_branch_delete","git_branch_foreach","git_branch_move","git_branch_lookup","git_branch_name","git_branch_upstream","git_branch_set_upstream","git_branch_upstream_name","git_branch_is_head","git_branch_remote_name"],"meta":{"brief":"Git branch parsing routines","defgroup":"git_branch Git branch management","ingroup":"Git","comments":"\n"},"lines":252},{"file":"checkout.h","functions":["git_checkout_head","git_checkout_index","git_checkout_tree"],"meta":{"brief":"Git checkout routines","defgroup":"git_checkout Git checkout routines","ingroup":"Git","comments":"\n"},"lines":285},{"file":"clone.h","functions":["git_clone"],"meta":{"brief":"Git cloning routines","defgroup":"git_clone Git cloning routines","ingroup":"Git","comments":"\n"},"lines":107},{"file":"commit.h","functions":["git_commit_lookup","git_commit_lookup_prefix","git_commit_free","git_commit_id","git_commit_message_encoding","git_commit_message","git_commit_time","git_commit_time_offset","git_commit_committer","git_commit_author","git_commit_tree","git_commit_tree_id","git_commit_parentcount","git_commit_parent","git_commit_parent_id","git_commit_nth_gen_ancestor","git_commit_create","git_commit_create_v"],"meta":{"brief":"Git commit parsing, formatting routines","defgroup":"git_commit Git commit parsing, formatting routines","ingroup":"Git","comments":"\n"},"lines":292},{"file":"common.h","functions":["git_libgit2_version","git_libgit2_capabilities","git_libgit2_opts"],"meta":{"brief":"Git common platform definitions","defgroup":"git_common Git common platform definitions","ingroup":"Git","comments":"\n"},"lines":190},{"file":"config.h","functions":["git_config_find_global","git_config_find_xdg","git_config_find_system","git_config_open_default","git_config_new","git_config_add_backend","git_config_add_file_ondisk","git_config_open_ondisk","git_config_open_level","git_config_refresh","git_config_free","git_config_get_entry","git_config_get_int32","git_config_get_int64","git_config_get_bool","git_config_get_string","git_config_get_multivar","git_config_set_int32","git_config_set_int64","git_config_set_bool","git_config_set_string","git_config_set_multivar","git_config_delete_entry","git_config_foreach","git_config_foreach_match","git_config_get_mapped","git_config_lookup_map_value","git_config_parse_bool","git_config_parse_int32","git_config_parse_int64"],"meta":{"brief":"Git config management routines","defgroup":"git_config Git config management routines","ingroup":"Git","comments":"\n"},"lines":554},{"file":"cred_helpers.h","functions":["git_cred_userpass"],"meta":{"brief":"Utility functions for credential management","defgroup":"git_cred_helpers credential management helpers","ingroup":"Git","comments":"\n"},"lines":53},{"file":"diff.h","functions":["git_diff_list_free","git_diff_tree_to_tree","git_diff_tree_to_index","git_diff_index_to_workdir","git_diff_tree_to_workdir","git_diff_merge","git_diff_find_similar","git_diff_foreach","git_diff_print_compact","git_diff_status_char","git_diff_print_patch","git_diff_num_deltas","git_diff_num_deltas_of_type","git_diff_get_patch","git_diff_patch_free","git_diff_patch_delta","git_diff_patch_num_hunks","git_diff_patch_line_stats","git_diff_patch_get_hunk","git_diff_patch_num_lines_in_hunk","git_diff_patch_get_line_in_hunk","git_diff_patch_print","git_diff_patch_to_str","git_diff_blobs","git_diff_blob_to_buffer"],"meta":{"brief":"Git tree and file differencing routines.","ingroup":"Git","comments":"\n"},"lines":948},{"file":"errors.h","functions":["giterr_last","giterr_clear","giterr_set_str","giterr_set_oom"],"meta":{"brief":"Git error handling routines and variables","ingroup":"Git","comments":"\n"},"lines":120},{"file":"graph.h","functions":["git_graph_ahead_behind"],"meta":{"brief":"Git graph traversal routines","defgroup":"git_revwalk Git graph traversal routines","ingroup":"Git","comments":"\n"},"lines":41},{"file":"ignore.h","functions":["git_ignore_add_rule","git_ignore_clear_internal_rules","git_ignore_path_is_ignored"],"meta":{},"lines":78},{"file":"index.h","functions":["git_index_open","git_index_new","git_index_free","git_index_owner","git_index_caps","git_index_set_caps","git_index_read","git_index_write","git_index_read_tree","git_index_write_tree","git_index_write_tree_to","git_index_entrycount","git_index_clear","git_index_get_byindex","git_index_get_bypath","git_index_remove","git_index_remove_directory","git_index_add","git_index_entry_stage","git_index_add_bypath","git_index_remove_bypath","git_index_find","git_index_conflict_add","git_index_conflict_get","git_index_conflict_remove","git_index_conflict_cleanup","git_index_has_conflicts","git_index_reuc_entrycount","git_index_reuc_find","git_index_reuc_get_bypath","git_index_reuc_get_byindex","git_index_reuc_add","git_index_reuc_remove","git_index_reuc_clear"],"meta":{"brief":"Git index parsing and manipulation routines","defgroup":"git_index Git index parsing and manipulation routines","ingroup":"Git","comments":"\n"},"lines":579},{"file":"indexer.h","functions":["git_indexer_stream_new","git_indexer_stream_add","git_indexer_stream_finalize","git_indexer_stream_hash","git_indexer_stream_free"],"meta":{},"lines":90},{"file":"inttypes.h","functions":[],"meta":{},"lines":309},{"file":"merge.h","functions":["git_merge_base","git_merge_base_many"],"meta":{"brief":"Git merge-base routines","defgroup":"git_revwalk Git merge-base routines","ingroup":"Git","comments":"\n"},"lines":55},{"file":"message.h","functions":["git_message_prettify"],"meta":{"brief":"Git message management routines","ingroup":"Git","comments":"\n"},"lines":49},{"file":"net.h","functions":[],"meta":{"brief":"Git networking declarations","ingroup":"Git","comments":"\n"},"lines":53},{"file":"notes.h","functions":["git_note_iterator_new","git_note_iterator_free","git_note_next","git_note_read","git_note_message","git_note_oid","git_note_create","git_note_remove","git_note_free","git_note_default_ref","git_note_foreach"],"meta":{"brief":"Git notes management routines","defgroup":"git_note Git notes management routines","ingroup":"Git","comments":"\n"},"lines":202},{"file":"object.h","functions":["git_object_lookup","git_object_lookup_prefix","git_object_id","git_object_type","git_object_owner","git_object_free","git_object_type2string","git_object_string2type","git_object_typeisloose","git_object__size","git_object_peel","git_object_dup"],"meta":{"brief":"Git revision object management routines","defgroup":"git_object Git revision object management routines","ingroup":"Git","comments":"\n"},"lines":203},{"file":"odb.h","functions":["git_odb_new","git_odb_open","git_odb_add_backend","git_odb_add_alternate","git_odb_add_disk_alternate","git_odb_free","git_odb_read","git_odb_read_prefix","git_odb_read_header","git_odb_exists","git_odb_refresh","git_odb_foreach","git_odb_write","git_odb_open_wstream","git_odb_open_rstream","git_odb_write_pack","git_odb_hash","git_odb_hashfile","git_odb_object_free","git_odb_object_id","git_odb_object_data","git_odb_object_size","git_odb_object_type"],"meta":{"brief":"Git object database routines","defgroup":"git_odb Git object database routines","ingroup":"Git","comments":"\n"},"lines":411},{"file":"odb_backend.h","functions":["git_odb_backend_pack"],"meta":{"brief":"Git custom backend functions","defgroup":"git_backend Git custom backend API","ingroup":"Git","comments":"\n"},"lines":149},{"file":"oid.h","functions":["git_oid_fromstr","git_oid_fromstrp","git_oid_fromstrn","git_oid_fromraw","git_oid_fmt","git_oid_pathfmt","git_oid_allocfmt","git_oid_tostr","git_oid_cpy","git_oid_cmp","git_oid_equal","git_oid_ncmp","git_oid_streq","git_oid_iszero","git_oid_shorten_new","git_oid_shorten_add","git_oid_shorten_free"],"meta":{"brief":"Git object id routines","defgroup":"git_oid Git object id routines","ingroup":"Git","comments":"\n"},"lines":258},{"file":"pack.h","functions":["git_packbuilder_new","git_packbuilder_set_threads","git_packbuilder_insert","git_packbuilder_insert_tree","git_packbuilder_write","git_packbuilder_foreach","git_packbuilder_object_count","git_packbuilder_written","git_packbuilder_free"],"meta":{"brief":"Git pack management routines","ingroup":"Git","comments":"\n"},"lines":143},{"file":"push.h","functions":["git_push_new","git_push_set_options","git_push_add_refspec","git_push_update_tips","git_push_finish","git_push_unpack_ok","git_push_status_foreach","git_push_free"],"meta":{"brief":"Git push management functions","defgroup":"git_push push management functions","ingroup":"Git","comments":"\n"},"lines":131},{"file":"refdb.h","functions":["git_reference__alloc","git_refdb_new","git_refdb_open","git_refdb_compress","git_refdb_free","git_refdb_set_backend"],"meta":{"brief":"Git custom refs backend functions","defgroup":"git_refdb Git custom refs backend API","ingroup":"Git","comments":"\n"},"lines":98},{"file":"refdb_backend.h","functions":["git_refdb_backend_fs"],"meta":{"brief":"Git custom refs backend functions","defgroup":"git_refdb_backend Git custom refs backend API","ingroup":"Git","comments":"\n"},"lines":109},{"file":"reflog.h","functions":["git_reflog_read","git_reflog_write","git_reflog_append","git_reflog_rename","git_reflog_delete","git_reflog_entrycount","git_reflog_entry_byindex","git_reflog_drop","git_reflog_entry_id_old","git_reflog_entry_id_new","git_reflog_entry_committer","git_reflog_entry_message","git_reflog_free"],"meta":{"brief":"Git reflog management routines","defgroup":"git_reflog Git reflog management routines","ingroup":"Git","comments":"\n"},"lines":167},{"file":"refs.h","functions":["git_reference_lookup","git_reference_name_to_id","git_reference_symbolic_create","git_reference_create","git_reference_target","git_reference_symbolic_target","git_reference_type","git_reference_name","git_reference_resolve","git_reference_owner","git_reference_symbolic_set_target","git_reference_set_target","git_reference_rename","git_reference_delete","git_reference_list","git_reference_foreach","git_reference_free","git_reference_cmp","git_reference_foreach_glob","git_reference_has_log","git_reference_is_branch","git_reference_is_remote","git_reference_normalize_name","git_reference_peel","git_reference_is_valid_name"],"meta":{"brief":"Git reference management routines","defgroup":"git_reference Git reference management routines","ingroup":"Git","comments":"\n"},"lines":480},{"file":"refspec.h","functions":["git_refspec_src","git_refspec_dst","git_refspec_force","git_refspec_src_matches","git_refspec_dst_matches","git_refspec_transform","git_refspec_rtransform"],"meta":{"brief":"Git refspec attributes","defgroup":"git_refspec Git refspec attributes","ingroup":"Git","comments":"\n"},"lines":88},{"file":"remote.h","functions":["git_remote_create","git_remote_create_inmemory","git_remote_load","git_remote_save","git_remote_name","git_remote_url","git_remote_pushurl","git_remote_set_url","git_remote_set_pushurl","git_remote_set_fetchspec","git_remote_fetchspec","git_remote_set_pushspec","git_remote_pushspec","git_remote_connect","git_remote_ls","git_remote_download","git_remote_connected","git_remote_stop","git_remote_disconnect","git_remote_free","git_remote_update_tips","git_remote_valid_url","git_remote_supported_url","git_remote_list","git_remote_check_cert","git_remote_set_cred_acquire_cb","git_remote_set_transport","git_remote_set_callbacks","git_remote_stats","git_remote_autotag","git_remote_set_autotag","git_remote_rename","git_remote_update_fetchhead","git_remote_set_update_fetchhead","git_remote_is_valid_name"],"meta":{"brief":"Git remote management functions","defgroup":"git_remote remote management functions","ingroup":"Git","comments":"\n"},"lines":463},{"file":"repository.h","functions":["git_repository_open","git_repository_wrap_odb","git_repository_discover","git_repository_open_ext","git_repository_free","git_repository_init","git_repository_init_ext","git_repository_head","git_repository_head_detached","git_repository_head_orphan","git_repository_is_empty","git_repository_path","git_repository_workdir","git_repository_set_workdir","git_repository_is_bare","git_repository_config","git_repository_set_config","git_repository_odb","git_repository_set_odb","git_repository_refdb","git_repository_set_refdb","git_repository_index","git_repository_set_index","git_repository_message","git_repository_message_remove","git_repository_merge_cleanup","git_repository_fetchhead_foreach","git_repository_mergehead_foreach","git_repository_hashfile","git_repository_set_head","git_repository_set_head_detached","git_repository_detach_head","git_repository_state"],"meta":{"brief":"Git repository management routines","defgroup":"git_repository Git repository management routines","ingroup":"Git","comments":"\n"},"lines":680},{"file":"reset.h","functions":["git_reset","git_reset_default"],"meta":{"brief":"Git reset management routines","ingroup":"Git","comments":"\n"},"lines":81},{"file":"revparse.h","functions":["git_revparse_single","git_revparse"],"meta":{"brief":"Git revision parsing routines","defgroup":"git_revparse Git revision parsing routines","ingroup":"Git","comments":"\n"},"lines":80},{"file":"revwalk.h","functions":["git_revwalk_new","git_revwalk_reset","git_revwalk_push","git_revwalk_push_glob","git_revwalk_push_head","git_revwalk_hide","git_revwalk_hide_glob","git_revwalk_hide_head","git_revwalk_push_ref","git_revwalk_hide_ref","git_revwalk_next","git_revwalk_sorting","git_revwalk_push_range","git_revwalk_free","git_revwalk_repository"],"meta":{"brief":"Git revision traversal routines","defgroup":"git_revwalk Git revision traversal routines","ingroup":"Git","comments":"\n"},"lines":252},{"file":"signature.h","functions":["git_signature_new","git_signature_now","git_signature_dup","git_signature_free"],"meta":{"brief":"Git signature creation","defgroup":"git_signature Git signature creation","ingroup":"Git","comments":"\n"},"lines":76},{"file":"stash.h","functions":["git_stash_save","git_stash_foreach","git_stash_drop"],"meta":{"brief":"Git stash management routines","ingroup":"Git","comments":"\n"},"lines":121},{"file":"status.h","functions":["git_status_foreach","git_status_foreach_ext","git_status_file","git_status_should_ignore"],"meta":{"brief":"Git file status routines","defgroup":"git_status Git file status routines","ingroup":"Git","comments":"\n"},"lines":241},{"file":"stdint.h","functions":[],"meta":{},"lines":247},{"file":"strarray.h","functions":["git_strarray_free","git_strarray_copy"],"meta":{"brief":"Git string array routines","defgroup":"git_strarray Git string array routines","ingroup":"Git","comments":"\n"},"lines":59},{"file":"submodule.h","functions":["git_submodule_lookup","git_submodule_foreach","git_submodule_add_setup","git_submodule_add_finalize","git_submodule_add_to_index","git_submodule_save","git_submodule_owner","git_submodule_name","git_submodule_path","git_submodule_url","git_submodule_set_url","git_submodule_index_id","git_submodule_head_id","git_submodule_wd_id","git_submodule_ignore","git_submodule_set_ignore","git_submodule_update","git_submodule_set_update","git_submodule_fetch_recurse_submodules","git_submodule_set_fetch_recurse_submodules","git_submodule_init","git_submodule_sync","git_submodule_open","git_submodule_reload","git_submodule_reload_all","git_submodule_status","git_submodule_location"],"meta":{"brief":"Git submodule management utilities","defgroup":"git_submodule Git submodule management routines","ingroup":"Git","comments":"\n"},"lines":544},{"file":"tag.h","functions":["git_tag_lookup","git_tag_lookup_prefix","git_tag_free","git_tag_id","git_tag_target","git_tag_target_id","git_tag_target_type","git_tag_name","git_tag_tagger","git_tag_message","git_tag_create","git_tag_create_frombuffer","git_tag_create_lightweight","git_tag_delete","git_tag_list","git_tag_list_match","git_tag_foreach","git_tag_peel"],"meta":{"brief":"Git tag parsing routines","defgroup":"git_tag Git tag management","ingroup":"Git","comments":"\n"},"lines":326},{"file":"threads.h","functions":["git_threads_init","git_threads_shutdown"],"meta":{"brief":"Library level thread functions","defgroup":"git_thread Threading functions","ingroup":"Git","comments":"\n"},"lines":49},{"file":"trace.h","functions":["git_trace_set"],"meta":{"brief":"Git tracing configuration routines","defgroup":"git_trace Git tracing configuration routines","ingroup":"Git","comments":"\n"},"lines":67},{"file":"transport.h","functions":["git_cred_userpass_plaintext_new","git_transport_new","git_transport_dummy","git_transport_local","git_transport_smart","git_smart_subtransport_http","git_smart_subtransport_git"],"meta":{"brief":"Git transport interfaces and functions","defgroup":"git_transport interfaces and functions","ingroup":"Git","comments":"\n"},"lines":328},{"file":"tree.h","functions":["git_tree_lookup","git_tree_lookup_prefix","git_tree_free","git_tree_id","git_tree_owner","git_tree_entrycount","git_tree_entry_byname","git_tree_entry_byindex","git_tree_entry_byoid","git_tree_entry_bypath","git_tree_entry_dup","git_tree_entry_free","git_tree_entry_name","git_tree_entry_id","git_tree_entry_type","git_tree_entry_filemode","git_tree_entry_cmp","git_tree_entry_to_object","git_treebuilder_create","git_treebuilder_clear","git_treebuilder_entrycount","git_treebuilder_free","git_treebuilder_get","git_treebuilder_insert","git_treebuilder_remove","git_treebuilder_filter","git_treebuilder_write","git_tree_walk"],"meta":{"brief":"Git tree parsing, loading routines","defgroup":"git_tree Git tree parsing, loading routines","ingroup":"Git","comments":"\n"},"lines":403},{"file":"types.h","functions":[],"meta":{"brief":"libgit2 base & compatibility types","ingroup":"Git","comments":"\n"},"lines":202},{"file":"version.h","functions":[],"meta":{},"lines":15}],"functions":{"git_attr_get":{"type":"function","file":"attr.h","line":142,"lineto":147,"args":[{"name":"value_out","type":"const char **","comment":"Output of the value of the attribute. Use the GIT_ATTR_... macros to test for TRUE, FALSE, UNSPECIFIED, etc. or just use the string value for attributes set to a value. You should NOT modify or free this value."},{"name":"repo","type":"git_repository *","comment":"The repository containing the path."},{"name":"flags","type":"uint32_t","comment":"A combination of GIT_ATTR_CHECK... flags."},{"name":"path","type":"const char *","comment":"The path to check for attributes. Relative paths are interpreted relative to the repo root. The file does not have to exist, but if it does not, then it will be treated as a plain file (not a directory)."},{"name":"name","type":"const char *","comment":"The name of the attribute to look up."}],"argline":"const char **value_out,\n git_repository *repo,\n\tuint32_t flags,\n\tconst char *path,\n\tconst char *name","sig":"const char **::git_repository *::uint32_t::const char *::const char *","return":{"type":"int"},"description":"<p>Look up the value of one git attribute for path.</p>\n","comments":"","group":"attr"},"git_attr_get_many":{"type":"function","file":"attr.h","line":178,"lineto":186,"args":[{"name":"values_out","type":"const char **"},{"name":"repo","type":"git_repository *","comment":"The repository containing the path."},{"name":"flags","type":"uint32_t","comment":"A combination of GIT_ATTR_CHECK... flags."},{"name":"path","type":"const char *","comment":"The path inside the repo to check attributes. This does not have to exist, but if it does not, then it will be treated as a plain file (i.e. not a directory)."},{"name":"num_attr","type":"size_t","comment":"The number of attributes being looked up"},{"name":"names","type":"const char **","comment":"An array of num_attr strings containing attribute names."}],"argline":"const char **values_out,\n\tgit_repository *repo,\n\tuint32_t flags,\n\tconst char *path,\n\tsize_t num_attr,\n\tconst char **names","sig":"const char **::git_repository *::uint32_t::const char *::size_t::const char **","return":{"type":"int"},"description":"<p>Look up a list of git attributes for path.</p>\n","comments":"<p>Use this if you have a known list of attributes that you want to\nlook up in a single call. This is somewhat more efficient than\ncalling <code>git_attr_get()</code> multiple times.</p>\n\n<p>For example, you might write:</p>\n\n<pre><code>const char *attrs[] = { &quot;crlf&quot;, &quot;diff&quot;, &quot;foo&quot; };\nconst char **values[3];\ngit_attr_get_many(values, repo, 0, &quot;my/fun/file.c&quot;, 3, attrs);\n</code></pre>\n\n<p>Then you could loop through the 3 values to get the settings for\nthe three attributes you asked about.</p>\n","group":"attr"},"git_attr_foreach":{"type":"function","file":"attr.h","line":205,"lineto":210,"args":[{"name":"repo","type":"git_repository *","comment":"The repository containing the path."},{"name":"flags","type":"uint32_t","comment":"A combination of GIT_ATTR_CHECK... flags."},{"name":"path","type":"const char *","comment":"Path inside the repo to check attributes. This does not have to exist, but if it does not, then it will be treated as a plain file (i.e. not a directory)."},{"name":"callback","type":"git_attr_foreach_cb","comment":"Function to invoke on each attribute name and value. The value may be NULL is the attribute is explicitly set to UNSPECIFIED using the '!' sign. Callback will be invoked only once per attribute name, even if there are multiple rules for a given file. The highest priority rule will be used. Return a non-zero value from this to stop looping."},{"name":"payload","type":"void *","comment":"Passed on as extra parameter to callback function."}],"argline":"git_repository *repo,\n\tuint32_t flags,\n\tconst char *path,\n\tgit_attr_foreach_cb callback,\n\tvoid *payload","sig":"git_repository *::uint32_t::const char *::git_attr_foreach_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Loop over all the git attributes for a path.</p>\n","comments":"","group":"attr"},"git_attr_cache_flush":{"type":"function","file":"attr.h","line":220,"lineto":221,"args":[{"name":"repo","type":"git_repository *"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"void"},"description":"<p>Flush the gitattributes cache.</p>\n","comments":"<p>Call this if you have reason to believe that the attributes files on\ndisk no longer match the cached contents of memory. This will cause\nthe attributes files to be reloaded the next time that an attribute\naccess function is called.</p>\n","group":"attr"},"git_attr_add_macro":{"type":"function","file":"attr.h","line":233,"lineto":236,"args":[{"name":"repo","type":"git_repository *"},{"name":"name","type":"const char *"},{"name":"values","type":"const char *"}],"argline":"git_repository *repo,\n\tconst char *name,\n\tconst char *values","sig":"git_repository *::const char *::const char *","return":{"type":"int"},"description":"<p>Add a macro definition.</p>\n","comments":"<p>Macros will automatically be loaded from the top level <code>.gitattributes</code>\nfile of the repository (plus the build-in &quot;binary&quot; macro). This\nfunction allows you to add others. For example, to add the default\nmacro, you would call:</p>\n\n<p>git_attr_add_macro(repo, &quot;binary&quot;, &quot;-diff -crlf&quot;);</p>\n","group":"attr"},"git_blob_lookup":{"type":"function","file":"blob.h","line":32,"lineto":35,"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 or an error code"},"description":"<p>Lookup a blob object from a repository.</p>\n","comments":"","group":"blob","examples":{"general.c":["ex/v0.18.0/general.html#git_blob_lookup-1"]}},"git_blob_lookup_prefix":{"type":"function","file":"blob.h","line":49,"lineto":52,"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."},{"name":"len","type":"size_t","comment":"the length of the short identifier"}],"argline":"git_blob **blob, git_repository *repo, const git_oid *id, size_t len","sig":"git_blob **::git_repository *::const git_oid *::size_t","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Lookup a blob object from a repository,\ngiven a prefix of its identifier (short id).</p>\n","comments":"<p>@see git_object_lookup_prefix</p>\n","group":"blob"},"git_blob_free":{"type":"function","file":"blob.h","line":65,"lineto":68,"args":[{"name":"blob","type":"git_blob *","comment":"the blob to close"}],"argline":"git_blob *blob","sig":"git_blob *","return":{"type":"void"},"description":"<p>Close an open blob</p>\n","comments":"<p>This is a wrapper around git_object_free()</p>\n\n<p>IMPORTANT:\nIt <em>is</em> necessary to call this method when you stop\nusing a blob. Failure to do so will cause a memory leak.</p>\n","group":"blob"},"git_blob_id":{"type":"function","file":"blob.h","line":77,"lineto":80,"args":[{"name":"blob","type":"const git_blob *","comment":"a previously loaded blob."}],"argline":"const git_blob *blob","sig":"const git_blob *","return":{"type":"const git_oid *","comment":"SHA1 hash for this blob."},"description":"<p>Get the id of a blob.</p>\n","comments":"","group":"blob"},"git_blob_rawcontent":{"type":"function","file":"blob.h","line":94,"lineto":94,"args":[{"name":"blob","type":"const git_blob *","comment":"pointer to the blob"}],"argline":"const git_blob *blob","sig":"const git_blob *","return":{"type":"const void *","comment":"the pointer; NULL if the blob has no contents"},"description":"<p>Get a read-only buffer with the raw content of a blob.</p>\n","comments":"<p>A pointer to the raw content of a blob is returned;\nthis pointer is owned internally by the object and shall\nnot be free&#39;d. The pointer may be invalidated at a later\ntime.</p>\n","group":"blob","examples":{"general.c":["ex/v0.18.0/general.html#git_blob_rawcontent-2"]}},"git_blob_rawsize":{"type":"function","file":"blob.h","line":102,"lineto":102,"args":[{"name":"blob","type":"const git_blob *","comment":"pointer to the blob"}],"argline":"const git_blob *blob","sig":"const git_blob *","return":{"type":"git_off_t","comment":"size on bytes"},"description":"<p>Get the size in bytes of the contents of a blob</p>\n","comments":"","group":"blob","examples":{"general.c":["ex/v0.18.0/general.html#git_blob_rawsize-3","ex/v0.18.0/general.html#git_blob_rawsize-4"]}},"git_blob_create_fromworkdir":{"type":"function","file":"blob.h","line":115,"lineto":115,"args":[{"name":"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. this repository cannot be bare"},{"name":"relative_path","type":"const char *","comment":"file from which the blob will be created, relative to the repository's working dir"}],"argline":"git_oid *id, git_repository *repo, const char *relative_path","sig":"git_oid *::git_repository *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Read a file from the working folder of a repository\nand write it to the Object Database as a loose blob</p>\n","comments":"","group":"blob"},"git_blob_create_fromdisk":{"type":"function","file":"blob.h","line":127,"lineto":130,"args":[{"name":"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. this repository can be bare or not"},{"name":"path","type":"const char *","comment":"file from which the blob will be created"}],"argline":"git_oid *id, git_repository *repo, const char *path","sig":"git_oid *::git_repository *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Read a file from the filesystem and write its content\nto the Object Database as a loose blob</p>\n","comments":"","group":"blob"},"git_blob_create_fromchunks":{"type":"function","file":"blob.h","line":168,"lineto":173,"args":[{"name":"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. This repository can be bare or not."},{"name":"hintpath","type":"const char *","comment":"if not NULL, will help selecting the filters to apply onto the content of the blob to be created."},{"name":"callback","type":"git_blob_chunk_cb"},{"name":"payload","type":"void *"}],"argline":"git_oid *id,\n\tgit_repository *repo,\n\tconst char *hintpath,\n\tgit_blob_chunk_cb callback,\n\tvoid *payload","sig":"git_oid *::git_repository *::const char *::git_blob_chunk_cb::void *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Write a loose blob to the Object Database from a\nprovider of chunks of data.</p>\n","comments":"<p>Provided the <code>hintpath</code> parameter is filled, its value\nwill help to determine what git filters should be applied\nto the object before it can be placed to the object database.</p>\n\n<p>The implementation of the callback has to respect the\nfollowing rules:</p>\n\n<ul>\n<li><p><code>content</code> will have to be filled by the consumer. The maximum number\nof bytes that the buffer can accept per call is defined by the\n<code>max_length</code> parameter. Allocation and freeing of the buffer will be taken\ncare of by the function.</p></li>\n<li><p>The callback is expected to return the number of bytes\nthat <code>content</code> have been filled with.</p></li>\n<li><p>When there is no more data to stream, the callback should\nreturn 0. This will prevent it from being invoked anymore.</p></li>\n<li><p>When an error occurs, the callback should return -1.</p></li>\n</ul>\n","group":"blob"},"git_blob_create_frombuffer":{"type":"function","file":"blob.h","line":184,"lineto":184,"args":[{"name":"oid","type":"git_oid *","comment":"return the oid of the written blob"},{"name":"repo","type":"git_repository *","comment":"repository where to blob will be written"},{"name":"buffer","type":"const void *","comment":"data to be written into the blob"},{"name":"len","type":"size_t","comment":"length of the data"}],"argline":"git_oid *oid, git_repository *repo, const void *buffer, size_t len","sig":"git_oid *::git_repository *::const void *::size_t","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Write an in-memory buffer to the ODB as a blob</p>\n","comments":"","group":"blob"},"git_blob_is_binary":{"type":"function","file":"blob.h","line":197,"lineto":197,"args":[{"name":"blob","type":"git_blob *","comment":"The blob which content should be analyzed"}],"argline":"git_blob *blob","sig":"git_blob *","return":{"type":"int","comment":"1 if the content of the blob is detected as binary; 0 otherwise."},"description":"<p>Determine if the blob content is most certainly binary or not.</p>\n","comments":"<p>The heuristic used to guess if a file is binary is taken from core git:\nSearching for NUL bytes and looking for a reasonable ratio of printable\nto non-printable characters among the first 4000 bytes.</p>\n","group":"blob"},"git_branch_create":{"type":"function","file":"branch.h","line":50,"lineto":55,"args":[{"name":"out","type":"git_reference **","comment":"Pointer where to store the underlying reference."},{"name":"repo","type":"git_repository *"},{"name":"branch_name","type":"const char *","comment":"Name for the branch; this name is validated for consistency. It should also not conflict with an already existing branch name."},{"name":"target","type":"const git_commit *","comment":"Commit to which this branch should point. This object must belong to the given `repo`."},{"name":"force","type":"int","comment":"Overwrite existing branch."}],"argline":"git_reference **out,\n\tgit_repository *repo,\n\tconst char *branch_name,\n\tconst git_commit *target,\n\tint force","sig":"git_reference **::git_repository *::const char *::const git_commit *::int","return":{"type":"int","comment":"0, GIT_EINVALIDSPEC or an error code. A proper reference is written in the refs/heads namespace pointing to the provided target commit."},"description":"<p>Create a new branch pointing at a target commit</p>\n","comments":"<p>A new direct reference will be created pointing to\nthis target commit. If <code>force</code> is true and a reference\nalready exists with the given name, it&#39;ll be replaced.</p>\n\n<p>The returned reference must be freed by the user.</p>\n\n<p>The branch name will be checked for validity.\nSee <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"branch"},"git_branch_delete":{"type":"function","file":"branch.h","line":66,"lineto":71,"args":[{"name":"branch","type":"git_reference *","comment":"A valid reference representing a branch"}],"argline":"git_reference *branch","sig":"git_reference *","return":{"type":"int","comment":"0 on success, or an error code."},"description":"<p>Delete an existing branch reference.</p>\n","comments":"<p>If the branch is successfully deleted, the passed reference\nobject will be freed and invalidated.</p>\n","group":"branch"},"git_branch_foreach":{"type":"function","file":"branch.h","line":90,"lineto":94,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where to find the branches."},{"name":"list_flags","type":"unsigned int","comment":"Filtering flags for the branch listing. Valid values are GIT_BRANCH_LOCAL, GIT_BRANCH_REMOTE or a combination of the two."},{"name":"branch_cb","type":"git_branch_foreach_cb","comment":"Callback to invoke per found branch."},{"name":"payload","type":"void *","comment":"Extra parameter to callback function."}],"argline":"git_repository *repo,\n\tunsigned int list_flags,\n\tgit_branch_foreach_cb branch_cb,\n\tvoid *payload","sig":"git_repository *::unsigned int::git_branch_foreach_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Loop over all the branches and issue a callback for each one.</p>\n","comments":"<p>If the callback returns a non-zero value, this will stop looping.</p>\n","group":"branch"},"git_branch_move":{"type":"function","file":"branch.h","line":111,"lineto":115,"args":[{"name":"out","type":"git_reference **"},{"name":"branch","type":"git_reference *","comment":"Current underlying reference of the branch."},{"name":"new_branch_name","type":"const char *","comment":"Target name of the branch once the move is performed; this name is validated for consistency."},{"name":"force","type":"int","comment":"Overwrite existing branch."}],"argline":"git_reference **out,\n\tgit_reference *branch,\n\tconst char *new_branch_name,\n\tint force","sig":"git_reference **::git_reference *::const char *::int","return":{"type":"int","comment":"0 on success, GIT_EINVALIDSPEC or an error code."},"description":"<p>Move/rename an existing local branch reference.</p>\n","comments":"<p>The new branch name will be checked for validity.\nSee <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"branch"},"git_branch_lookup":{"type":"function","file":"branch.h","line":138,"lineto":142,"args":[{"name":"out","type":"git_reference **","comment":"pointer to the looked-up branch reference"},{"name":"repo","type":"git_repository *","comment":"the repository to look up the branch"},{"name":"branch_name","type":"const char *","comment":"Name of the branch to be looked-up; this name is validated for consistency."},{"name":"branch_type","type":"git_branch_t","comment":"Type of the considered branch. This should be valued with either GIT_BRANCH_LOCAL or GIT_BRANCH_REMOTE."}],"argline":"git_reference **out,\n\tgit_repository *repo,\n\tconst char *branch_name,\n\tgit_branch_t branch_type","sig":"git_reference **::git_repository *::const char *::git_branch_t","return":{"type":"int","comment":"0 on success; GIT_ENOTFOUND when no matching branch exists, GIT_EINVALIDSPEC, otherwise an error code."},"description":"<p>Lookup a branch by its name in a repository.</p>\n","comments":"<p>The generated reference must be freed by the user.</p>\n\n<p>The branch name will be checked for validity.\nSee <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"branch"},"git_branch_name":{"type":"function","file":"branch.h","line":159,"lineto":160,"args":[{"name":"out","type":"const char **","comment":"where the pointer of branch name is stored; this is valid as long as the ref is not freed."},{"name":"ref","type":"git_reference *","comment":"the reference ideally pointing to a branch"}],"argline":"const char **out,\n\t\tgit_reference *ref","sig":"const char **::git_reference *","return":{"type":"int","comment":"0 on success; otherwise an error code (e.g., if the ref is no local or remote branch)."},"description":"<p>Return the name of the given local or remote branch.</p>\n","comments":"<p>The name of the branch matches the definition of the name\nfor git_branch_lookup. That is, if the returned name is given\nto git_branch_lookup() then the reference is returned that\nwas given to this function.</p>\n","group":"branch"},"git_branch_upstream":{"type":"function","file":"branch.h","line":174,"lineto":176,"args":[{"name":"out","type":"git_reference **","comment":"Pointer where to store the retrieved reference."},{"name":"branch","type":"git_reference *","comment":"Current underlying reference of the branch."}],"argline":"git_reference **out,\n\tgit_reference *branch","sig":"git_reference **::git_reference *","return":{"type":"int","comment":"0 on success; GIT_ENOTFOUND when no remote tracking reference exists, otherwise an error code."},"description":"<p>Return the reference supporting the remote tracking branch,\ngiven a local branch reference.</p>\n","comments":"","group":"branch"},"git_branch_set_upstream":{"type":"function","file":"branch.h","line":188,"lineto":188,"args":[{"name":"branch","type":"git_reference *","comment":"the branch to configure"},{"name":"upstream_name","type":"const char *","comment":"remote-tracking or local branch to set as upstream. Pass NULL to unset."}],"argline":"git_reference *branch, const char *upstream_name","sig":"git_reference *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Set the upstream configuration for a given local branch</p>\n","comments":"","group":"branch"},"git_branch_upstream_name":{"type":"function","file":"branch.h","line":208,"lineto":212,"args":[{"name":"tracking_branch_name_out","type":"char *","comment":"The user-allocated buffer which will be filled with the name of the reference. Pass NULL if you just want to get the needed size of the name of the reference as the output value."},{"name":"buffer_size","type":"size_t","comment":"Size of the `out` buffer in bytes."},{"name":"repo","type":"git_repository *","comment":"the repository where the branches live"},{"name":"canonical_branch_name","type":"const char *","comment":"name of the local branch."}],"argline":"char *tracking_branch_name_out,\n\tsize_t buffer_size,\n\tgit_repository *repo,\n\tconst char *canonical_branch_name","sig":"char *::size_t::git_repository *::const char *","return":{"type":"int","comment":"number of characters in the reference name including the trailing NUL byte; GIT_ENOTFOUND when no remote tracking reference exists, otherwise an error code."},"description":"<p>Return the name of the reference supporting the remote tracking branch,\ngiven the name of a local branch reference.</p>\n","comments":"","group":"branch"},"git_branch_is_head":{"type":"function","file":"branch.h","line":222,"lineto":223,"args":[{"name":"branch","type":"git_reference *","comment":"Current underlying reference of the branch."}],"argline":"git_reference *branch","sig":"git_reference *","return":{"type":"int","comment":"1 if HEAD points at the branch, 0 if it isn't, error code otherwise."},"description":"<p>Determine if the current local branch is pointed at by HEAD.</p>\n","comments":"","group":"branch"},"git_branch_remote_name":{"type":"function","file":"branch.h","line":244,"lineto":248,"args":[{"name":"remote_name_out","type":"char *","comment":"The user-allocated buffer which will be filled with the name of the remote. Pass NULL if you just want to get the needed size of the name of the remote as the output value."},{"name":"buffer_size","type":"size_t","comment":"Size of the `out` buffer in bytes."},{"name":"repo","type":"git_repository *","comment":"The repository where the branch lives."},{"name":"canonical_branch_name","type":"const char *","comment":"name of the remote tracking branch."}],"argline":"char *remote_name_out,\n\tsize_t buffer_size,\n\tgit_repository *repo,\n\tconst char *canonical_branch_name","sig":"char *::size_t::git_repository *::const char *","return":{"type":"int","comment":"Number of characters in the reference name including the trailing NUL byte; GIT_ENOTFOUND when no remote matching remote was gound, GIT_EAMBIGUOUS when the branch maps to several remotes, otherwise an error code."},"description":"<p>Return the name of remote that the remote tracking branch belongs to.</p>\n","comments":"","group":"branch"},"git_checkout_head":{"type":"function","file":"checkout.h","line":249,"lineto":251,"args":[{"name":"repo","type":"git_repository *","comment":"repository to check out (must be non-bare)"},{"name":"opts","type":"git_checkout_opts *","comment":"specifies checkout options (may be NULL)"}],"argline":"git_repository *repo,\n\tgit_checkout_opts *opts","sig":"git_repository *::git_checkout_opts *","return":{"type":"int","comment":"0 on success, GIT_EORPHANEDHEAD when HEAD points to a non existing branch, GIT_ERROR otherwise (use giterr_last for information about the error)"},"description":"<p>Updates files in the index and the working tree to match the content of\nthe commit pointed at by HEAD.</p>\n","comments":"","group":"checkout"},"git_checkout_index":{"type":"function","file":"checkout.h","line":262,"lineto":265,"args":[{"name":"repo","type":"git_repository *","comment":"repository into which to check out (must be non-bare)"},{"name":"index","type":"git_index *","comment":"index to be checked out (or NULL to use repository index)"},{"name":"opts","type":"git_checkout_opts *","comment":"specifies checkout options (may be NULL)"}],"argline":"git_repository *repo,\n\tgit_index *index,\n\tgit_checkout_opts *opts","sig":"git_repository *::git_index *::git_checkout_opts *","return":{"type":"int","comment":"0 on success, GIT_ERROR otherwise (use giterr_last for information about the error)"},"description":"<p>Updates files in the working tree to match the content of the index.</p>\n","comments":"","group":"checkout"},"git_checkout_tree":{"type":"function","file":"checkout.h","line":278,"lineto":281,"args":[{"name":"repo","type":"git_repository *","comment":"repository to check out (must be non-bare)"},{"name":"treeish","type":"const git_object *","comment":"a commit, tag or tree which content will be used to update the working directory"},{"name":"opts","type":"git_checkout_opts *","comment":"specifies checkout options (may be NULL)"}],"argline":"git_repository *repo,\n\tconst git_object *treeish,\n\tgit_checkout_opts *opts","sig":"git_repository *::const git_object *::git_checkout_opts *","return":{"type":"int","comment":"0 on success, GIT_ERROR otherwise (use giterr_last for information about the error)"},"description":"<p>Updates files in the index and working tree to match the content of the\ntree pointed at by the treeish.</p>\n","comments":"","group":"checkout"},"git_clone":{"type":"function","file":"clone.h","line":99,"lineto":103,"args":[{"name":"out","type":"git_repository **","comment":"pointer that will receive the resulting repository object"},{"name":"url","type":"const char *","comment":"the remote repository to clone"},{"name":"local_path","type":"const char *","comment":"local directory to clone to"},{"name":"options","type":"const git_clone_options *","comment":"configuration options for the clone. If NULL, the function works as though GIT_OPTIONS_INIT were passed."}],"argline":"git_repository **out,\n\t\tconst char *url,\n\t\tconst char *local_path,\n\t\tconst git_clone_options *options","sig":"git_repository **::const char *::const char *::const git_clone_options *","return":{"type":"int","comment":"0 on success, GIT_ERROR otherwise (use giterr_last for information about the error)"},"description":"<p>Clone a remote repository, and checkout the branch pointed to by the remote\nHEAD.</p>\n","comments":"","group":"clone","examples":{"network/clone.c":["ex/v0.18.0/network/clone.html#git_clone-1"]}},"git_commit_lookup":{"type":"function","file":"commit.h","line":33,"lineto":36,"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 or an error code"},"description":"<p>Lookup a commit object from a repository.</p>\n","comments":"","group":"commit","examples":{"general.c":["ex/v0.18.0/general.html#git_commit_lookup-5","ex/v0.18.0/general.html#git_commit_lookup-6","ex/v0.18.0/general.html#git_commit_lookup-7"]}},"git_commit_lookup_prefix":{"type":"function","file":"commit.h","line":51,"lineto":54,"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."},{"name":"len","type":"size_t","comment":"the length of the short identifier"}],"argline":"git_commit **commit, git_repository *repo, const git_oid *id, size_t len","sig":"git_commit **::git_repository *::const git_oid *::size_t","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Lookup a commit object from a repository,\ngiven a prefix of its identifier (short id).</p>\n","comments":"<p>@see git_object_lookup_prefix</p>\n","group":"commit"},"git_commit_free":{"type":"function","file":"commit.h","line":67,"lineto":70,"args":[{"name":"commit","type":"git_commit *","comment":"the commit to close"}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"void"},"description":"<p>Close an open commit</p>\n","comments":"<p>This is a wrapper around git_object_free()</p>\n\n<p>IMPORTANT:\nIt <em>is</em> necessary to call this method when you stop\nusing a commit. Failure to do so will cause a memory leak.</p>\n","group":"commit","examples":{"general.c":["ex/v0.18.0/general.html#git_commit_free-8","ex/v0.18.0/general.html#git_commit_free-9","ex/v0.18.0/general.html#git_commit_free-10","ex/v0.18.0/general.html#git_commit_free-11"]}},"git_commit_id":{"type":"function","file":"commit.h","line":79,"lineto":82,"args":[{"name":"commit","type":"const git_commit *","comment":"a previously loaded commit."}],"argline":"const git_commit *commit","sig":"const git_commit *","return":{"type":"const git_oid *","comment":"object identity for the commit."},"description":"<p>Get the id of a commit.</p>\n","comments":"","group":"commit","examples":{"general.c":["ex/v0.18.0/general.html#git_commit_id-12"]}},"git_commit_message_encoding":{"type":"function","file":"commit.h","line":94,"lineto":94,"args":[{"name":"commit","type":"const git_commit *","comment":"a previously loaded commit."}],"argline":"const git_commit *commit","sig":"const git_commit *","return":{"type":"const char *","comment":"NULL, or the encoding"},"description":"<p>Get the encoding for the message of a commit,\nas a string representing a standard encoding name.</p>\n","comments":"<p>The encoding may be NULL if the <code>encoding</code> header\nin the commit is missing; in that case UTF-8 is assumed.</p>\n","group":"commit"},"git_commit_message":{"type":"function","file":"commit.h","line":102,"lineto":102,"args":[{"name":"commit","type":"const git_commit *","comment":"a previously loaded commit."}],"argline":"const git_commit *commit","sig":"const git_commit *","return":{"type":"const char *","comment":"the message of a commit"},"description":"<p>Get the full message of a commit.</p>\n","comments":"","group":"commit","examples":{"general.c":["ex/v0.18.0/general.html#git_commit_message-13","ex/v0.18.0/general.html#git_commit_message-14","ex/v0.18.0/general.html#git_commit_message-15"]}},"git_commit_time":{"type":"function","file":"commit.h","line":110,"lineto":110,"args":[{"name":"commit","type":"const git_commit *","comment":"a previously loaded commit."}],"argline":"const git_commit *commit","sig":"const git_commit *","return":{"type":"git_time_t","comment":"the time of a commit"},"description":"<p>Get the commit time (i.e. committer time) of a commit.</p>\n","comments":"","group":"commit","examples":{"general.c":["ex/v0.18.0/general.html#git_commit_time-16","ex/v0.18.0/general.html#git_commit_time-17"]}},"git_commit_time_offset":{"type":"function","file":"commit.h","line":118,"lineto":118,"args":[{"name":"commit","type":"const git_commit *","comment":"a previously loaded commit."}],"argline":"const git_commit *commit","sig":"const git_commit *","return":{"type":"int","comment":"positive or negative timezone offset, in minutes from UTC"},"description":"<p>Get the commit timezone offset (i.e. committer&#39;s preferred timezone) of a commit.</p>\n","comments":"","group":"commit"},"git_commit_committer":{"type":"function","file":"commit.h","line":126,"lineto":126,"args":[{"name":"commit","type":"const git_commit *","comment":"a previously loaded commit."}],"argline":"const git_commit *commit","sig":"const git_commit *","return":{"type":"const git_signature *","comment":"the committer of a commit"},"description":"<p>Get the committer of a commit.</p>\n","comments":"","group":"commit","examples":{"general.c":["ex/v0.18.0/general.html#git_commit_committer-18"]}},"git_commit_author":{"type":"function","file":"commit.h","line":134,"lineto":134,"args":[{"name":"commit","type":"const git_commit *","comment":"a previously loaded commit."}],"argline":"const git_commit *commit","sig":"const git_commit *","return":{"type":"const git_signature *","comment":"the author of a commit"},"description":"<p>Get the author of a commit.</p>\n","comments":"","group":"commit","examples":{"general.c":["ex/v0.18.0/general.html#git_commit_author-19","ex/v0.18.0/general.html#git_commit_author-20"]}},"git_commit_tree":{"type":"function","file":"commit.h","line":143,"lineto":143,"args":[{"name":"tree_out","type":"git_tree **","comment":"pointer where to store the tree object"},{"name":"commit","type":"const git_commit *","comment":"a previously loaded commit."}],"argline":"git_tree **tree_out, const git_commit *commit","sig":"git_tree **::const git_commit *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Get the tree pointed to by a commit.</p>\n","comments":"","group":"commit"},"git_commit_tree_id":{"type":"function","file":"commit.h","line":153,"lineto":153,"args":[{"name":"commit","type":"const git_commit *","comment":"a previously loaded commit."}],"argline":"const git_commit *commit","sig":"const git_commit *","return":{"type":"const git_oid *","comment":"the id of tree pointed to by commit."},"description":"<p>Get the id of the tree pointed to by a commit. This differs from\n<code>git_commit_tree</code> in that no attempts are made to fetch an object\nfrom the ODB.</p>\n","comments":"","group":"commit"},"git_commit_parentcount":{"type":"function","file":"commit.h","line":161,"lineto":161,"args":[{"name":"commit","type":"const git_commit *","comment":"a previously loaded commit."}],"argline":"const git_commit *commit","sig":"const git_commit *","return":{"type":"unsigned int","comment":"integer of count of parents"},"description":"<p>Get the number of parents of this commit</p>\n","comments":"","group":"commit","examples":{"general.c":["ex/v0.18.0/general.html#git_commit_parentcount-21"]}},"git_commit_parent":{"type":"function","file":"commit.h","line":171,"lineto":171,"args":[{"name":"out","type":"git_commit **","comment":"Pointer where to store the parent commit"},{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."},{"name":"n","type":"unsigned int","comment":"the position of the parent (from 0 to `parentcount`)"}],"argline":"git_commit **out, git_commit *commit, unsigned int n","sig":"git_commit **::git_commit *::unsigned int","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Get the specified parent of the commit.</p>\n","comments":"","group":"commit","examples":{"general.c":["ex/v0.18.0/general.html#git_commit_parent-22"]}},"git_commit_parent_id":{"type":"function","file":"commit.h","line":182,"lineto":182,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."},{"name":"n","type":"unsigned int","comment":"the position of the parent (from 0 to `parentcount`)"}],"argline":"git_commit *commit, unsigned int n","sig":"git_commit *::unsigned int","return":{"type":"const git_oid *","comment":"the id of the parent, NULL on error."},"description":"<p>Get the oid of a specified parent for a commit. This is different from\n<code>git_commit_parent</code>, which will attempt to load the parent commit from\nthe ODB.</p>\n","comments":"","group":"commit"},"git_commit_nth_gen_ancestor":{"type":"function","file":"commit.h","line":198,"lineto":201,"args":[{"name":"ancestor","type":"git_commit **","comment":"Pointer where to store the ancestor commit"},{"name":"commit","type":"const git_commit *","comment":"a previously loaded commit."},{"name":"n","type":"unsigned int","comment":"the requested generation"}],"argline":"git_commit **ancestor,\n\tconst git_commit *commit,\n\tunsigned int n","sig":"git_commit **::const git_commit *::unsigned int","return":{"type":"int","comment":"0 on success; GIT_ENOTFOUND if no matching ancestor exists or an error code"},"description":"<p>Get the commit object that is the <n>th generation ancestor\nof the named commit object, following only the first parents.\nThe returned commit has to be freed by the caller.</p>\n","comments":"<p>Passing <code>0</code> as the generation number returns another instance of the\nbase commit itself.</p>\n","group":"commit"},"git_commit_create":{"type":"function","file":"commit.h","line":250,"lineto":260,"args":[{"name":"id","type":"git_oid *","comment":"Pointer where to store the OID of the newly created commit"},{"name":"repo","type":"git_repository *","comment":"Repository where to store the commit"},{"name":"update_ref","type":"const char *","comment":"If not NULL, name of the reference that will be updated to point to this commit. If the reference is not direct, it will be resolved to a direct reference. Use \"HEAD\" to update the HEAD of the current branch and make it point to this commit. If the reference doesn't exist yet, it will be created."},{"name":"author","type":"const git_signature *","comment":"Signature representing the author and the authory time of this commit"},{"name":"committer","type":"const git_signature *","comment":"Signature representing the committer and the commit time of this commit"},{"name":"message_encoding","type":"const char *","comment":"The encoding for the message in the commit, represented with a standard encoding name. E.g. \"UTF-8\". If NULL, no encoding header is written and UTF-8 is assumed."},{"name":"message","type":"const char *","comment":"_encoding The encoding for the message in the commit, represented with a standard encoding name. E.g. \"UTF-8\". If NULL, no encoding header is written and UTF-8 is assumed."},{"name":"tree","type":"const git_tree *","comment":"An instance of a `git_tree` object that will be used as the tree for the commit. This tree object must also be owned by the given `repo`."},{"name":"parent_count","type":"int","comment":"Number of parents for this commit"}],"argline":"git_oid *id,\n\t\tgit_repository *repo,\n\t\tconst char *update_ref,\n\t\tconst git_signature *author,\n\t\tconst git_signature *committer,\n\t\tconst char *message_encoding,\n\t\tconst char *message,\n\t\tconst git_tree *tree,\n\t\tint parent_count,\n\t\tconst git_commit *parents[]","sig":"git_oid *::git_repository *::const char *::const git_signature *::const git_signature *::const char *::const char *::const git_tree *::int","return":{"type":"int","comment":"0 or an error code The created commit will be written to the Object Database and the given reference will be updated to point to it"},"description":"<p>Create a new commit in the repository using <code>git_object</code>\ninstances as parameters.</p>\n","comments":"<p>The message will not be cleaned up. This can be achieved\nthrough <code>git_message_prettify()</code>.</p>\n","group":"commit"},"git_commit_create_v":{"type":"function","file":"commit.h","line":278,"lineto":288,"args":[{"name":"id","type":"git_oid *"},{"name":"repo","type":"git_repository *"},{"name":"update_ref","type":"const char *"},{"name":"author","type":"const git_signature *"},{"name":"committer","type":"const git_signature *"},{"name":"message_encoding","type":"const char *"},{"name":"message","type":"const char *"},{"name":"tree","type":"const git_tree *"},{"name":"parent_count","type":"int"}],"argline":"git_oid *id,\n\t\tgit_repository *repo,\n\t\tconst char *update_ref,\n\t\tconst git_signature *author,\n\t\tconst git_signature *committer,\n\t\tconst char *message_encoding,\n\t\tconst char *message,\n\t\tconst git_tree *tree,\n\t\tint parent_count,\n\t\t...","sig":"git_oid *::git_repository *::const char *::const git_signature *::const git_signature *::const char *::const char *::const git_tree *::int","return":{"type":"int"},"description":"<p>Create a new commit in the repository using a variable\nargument list.</p>\n","comments":"<p>The message will be cleaned up from excess whitespace\nit will be made sure that the last line ends with a &#39;\\n&#39;.</p>\n\n<p>The parents for the commit are specified as a variable\nlist of pointers to <code>const git_commit *</code>. Note that this\nis a convenience method which may not be safe to export\nfor certain languages or compilers</p>\n\n<p>All other parameters remain the same</p>\n\n<p>@see git_commit_create</p>\n","group":"commit","examples":{"general.c":["ex/v0.18.0/general.html#git_commit_create_v-23"]}},"git_libgit2_version":{"type":"function","file":"common.h","line":101,"lineto":101,"args":[{"name":"major","type":"int *","comment":"Store the major version number"},{"name":"minor","type":"int *","comment":"Store the minor version number"},{"name":"rev","type":"int *","comment":"Store the revision (patch) number"}],"argline":"int *major, int *minor, int *rev","sig":"int *::int *::int *","return":{"type":"void"},"description":"<p>Return the version of the libgit2 library\nbeing currently used.</p>\n","comments":"","group":"libgit2"},"git_libgit2_capabilities":{"type":"function","file":"common.h","line":124,"lineto":136,"args":[],"argline":"void","sig":"","return":{"type":"int","comment":"A combination of GIT_CAP_* values. - GIT_CAP_THREADS Libgit2 was compiled with thread support. Note that thread support is still to be seen as a 'work in progress'. - GIT_CAP_HTTPS Libgit2 supports the https:// protocol. This requires the open ssl library to be found when compiling libgit2."},"description":"<p>Query compile time options for libgit2.</p>\n","comments":"","group":"libgit2"},"git_libgit2_opts":{"type":"function","file":"common.h","line":185,"lineto":185,"args":[{"name":"option","type":"int","comment":"Option key"}],"argline":"int option, ...","sig":"int","return":{"type":"int","comment":"0 on success, <0 on failure"},"description":"<p>Set or query a library global option</p>\n","comments":"<p>Available options:</p>\n\n<p>opts(GIT_OPT_GET_MWINDOW_SIZE, size_t *):\n Get the maximum mmap window size</p>\n\n<p>opts(GIT_OPT_SET_MWINDOW_SIZE, size_t):\n Set the maximum mmap window size</p>\n\n<p>opts(GIT_OPT_GET_MWINDOW_MAPPED_LIMIT, size_t *):\n Get the maximum memory that will be mapped in total by the library</p>\n\n<p>opts(GIT_OPT_SET_MWINDOW_MAPPED_LIMIT, size_t):\n Set the maximum amount of memory that can be mapped at any time\n by the library</p>\n\n<p>opts(GIT_OPT_GET_SEARCH_PATH, int level, char *out, size_t len)\n Get the search path for a given level of config data. &quot;level&quot; must\n be one of GIT_CONFIG_LEVEL_SYSTEM, GIT_CONFIG_LEVEL_GLOBAL, or\n GIT_CONFIG_LEVEL_XDG. The search path is written to the <code>out</code>\n buffer up to size <code>len</code>. Returns GIT_EBUFS if buffer is too small.</p>\n\n<p>opts(GIT_OPT_SET_SEARCH_PATH, int level, const char *path)\n Set the search path for a level of config data. The search path\n applied to shared attributes and ignore files, too.\n - <code>path</code> lists directories delimited by GIT_PATH_LIST_SEPARATOR.\n Pass NULL to reset to the default (generally based on environment\n variables). Use magic path <code>$PATH</code> to include the old value\n of the path (if you want to prepend or append, for instance).\n - <code>level</code> must be GIT_CONFIG_LEVEL_SYSTEM, GIT_CONFIG_LEVEL_GLOBAL,\n or GIT_CONFIG_LEVEL_XDG.</p>\n\n<p>opts(GIT_OPT_GET_ODB_CACHE_SIZE):\n Get the size of the libgit2 odb cache.</p>\n\n<p>opts(GIT_OPT_SET_ODB_CACHE_SIZE):\n Set the size of the of the libgit2 odb cache. This needs\n to be done before git_repository_open is called, since\n git_repository_open initializes the odb layer. Defaults\n to 128.</p>\n","group":"libgit2"},"git_config_find_global":{"type":"function","file":"config.h","line":100,"lineto":100,"args":[{"name":"out","type":"char *","comment":"Buffer to store the path in"},{"name":"length","type":"size_t","comment":"size of the buffer in bytes"}],"argline":"char *out, size_t length","sig":"char *::size_t","return":{"type":"int","comment":"0 if a global configuration file has been found. Its path will be stored in `buffer`."},"description":"<p>Locate the path to the global configuration file</p>\n","comments":"<p>The user or global configuration file is usually\nlocated in <code>$HOME/.gitconfig</code>.</p>\n\n<p>This method will try to guess the full path to that\nfile, if the file exists. The returned path\nmay be used on any <code>git_config</code> call to load the\nglobal configuration file.</p>\n\n<p>This method will not guess the path to the xdg compatible\nconfig file (.config/git/config).</p>\n","group":"config"},"git_config_find_xdg":{"type":"function","file":"config.h","line":118,"lineto":118,"args":[{"name":"out","type":"char *","comment":"Buffer to store the path in"},{"name":"length","type":"size_t","comment":"size of the buffer in bytes"}],"argline":"char *out, size_t length","sig":"char *::size_t","return":{"type":"int","comment":"0 if a xdg compatible configuration file has been found. Its path will be stored in `buffer`."},"description":"<p>Locate the path to the global xdg compatible configuration file</p>\n","comments":"<p>The xdg compatible configuration file is usually\nlocated in <code>$HOME/.config/git/config</code>.</p>\n\n<p>This method will try to guess the full path to that\nfile, if the file exists. The returned path\nmay be used on any <code>git_config</code> call to load the\nxdg compatible configuration file.</p>\n","group":"config"},"git_config_find_system":{"type":"function","file":"config.h","line":131,"lineto":131,"args":[{"name":"out","type":"char *"},{"name":"length","type":"size_t","comment":"size of the buffer in bytes"}],"argline":"char *out, size_t length","sig":"char *::size_t","return":{"type":"int","comment":"0 if a system configuration file has been found. Its path will be stored in `buffer`."},"description":"<p>Locate the path to the system configuration file</p>\n","comments":"<p>If /etc/gitconfig doesn&#39;t exist, it will look for\n%PROGRAMFILES%\\Git\\etc\\gitconfig.</p>\n","group":"config"},"git_config_open_default":{"type":"function","file":"config.h","line":143,"lineto":143,"args":[{"name":"out","type":"git_config **","comment":"Pointer to store the config instance"}],"argline":"git_config **out","sig":"git_config **","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Open the global, XDG and system configuration files</p>\n","comments":"<p>Utility wrapper that finds the global, XDG and system configuration files\nand opens them into a single prioritized config object that can be\nused when accessing default config data outside a repository.</p>\n","group":"config"},"git_config_new":{"type":"function","file":"config.h","line":154,"lineto":154,"args":[{"name":"out","type":"git_config **","comment":"pointer to the new configuration"}],"argline":"git_config **out","sig":"git_config **","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Allocate a new configuration object</p>\n","comments":"<p>This object is empty, so you have to add a file to it before you\ncan do anything with it.</p>\n","group":"config"},"git_config_add_backend":{"type":"function","file":"config.h","line":174,"lineto":178,"args":[{"name":"cfg","type":"git_config *","comment":"the configuration to add the file to"},{"name":"file","type":"git_config_backend *","comment":"the configuration file (backend) to add"},{"name":"level","type":"unsigned int","comment":"the priority level of the backend"},{"name":"force","type":"int","comment":"if a config file already exists for the given priority level, replace it"}],"argline":"git_config *cfg,\n\tgit_config_backend *file,\n\tunsigned int level,\n\tint force","sig":"git_config *::git_config_backend *::unsigned int::int","return":{"type":"int","comment":"0 on success, GIT_EEXISTS when adding more than one file for a given priority level (and force_replace set to 0), or error code"},"description":"<p>Add a generic config file instance to an existing config</p>\n","comments":"<p>Note that the configuration object will free the file\nautomatically.</p>\n\n<p>Further queries on this config object will access each\nof the config file instances in order (instances with\na higher priority level will be accessed first).</p>\n","group":"config"},"git_config_add_file_ondisk":{"type":"function","file":"config.h","line":203,"lineto":207,"args":[{"name":"cfg","type":"git_config *","comment":"the configuration to add the file to"},{"name":"path","type":"const char *","comment":"path to the configuration file (backend) to add"},{"name":"level","type":"unsigned int","comment":"the priority level of the backend"},{"name":"force","type":"int","comment":"if a config file already exists for the given priority level, replace it"}],"argline":"git_config *cfg,\n\tconst char *path,\n\tunsigned int level,\n\tint force","sig":"git_config *::const char *::unsigned int::int","return":{"type":"int","comment":"0 on success, GIT_EEXISTS when adding more than one file for a given priority level (and force_replace set to 0), GIT_ENOTFOUND when the file doesn't exist or error code"},"description":"<p>Add an on-disk config file instance to an existing config</p>\n","comments":"<p>The on-disk file pointed at by <code>path</code> will be opened and\nparsed; it&#39;s expected to be a native Git config file following\nthe default Git config syntax (see man git-config).</p>\n\n<p>Note that the configuration object will free the file\nautomatically.</p>\n\n<p>Further queries on this config object will access each\nof the config file instances in order (instances with\na higher priority level will be accessed first).</p>\n","group":"config"},"git_config_open_ondisk":{"type":"function","file":"config.h","line":222,"lineto":222,"args":[{"name":"out","type":"git_config **","comment":"The configuration instance to create"},{"name":"path","type":"const char *","comment":"Path to the on-disk file to open"}],"argline":"git_config **out, const char *path","sig":"git_config **::const char *","return":{"type":"int","comment":"0 on success, GIT_ENOTFOUND when the file doesn't exist or an error code"},"description":"<p>Create a new config instance containing a single on-disk file</p>\n","comments":"<p>This method is a simple utility wrapper for the following sequence\nof calls:\n- git_config_new\n- git_config_add_file_ondisk</p>\n","group":"config","examples":{"general.c":["ex/v0.18.0/general.html#git_config_open_ondisk-24"]}},"git_config_open_level":{"type":"function","file":"config.h","line":240,"lineto":243,"args":[{"name":"out","type":"git_config **","comment":"The configuration instance to create"},{"name":"parent","type":"const git_config *","comment":"Multi-level config to search for the given level"},{"name":"level","type":"unsigned int","comment":"Configuration level to search for"}],"argline":"git_config **out,\n const git_config *parent,\n unsigned int level","sig":"git_config **::const git_config *::unsigned int","return":{"type":"int","comment":"0, GIT_ENOTFOUND if the passed level cannot be found in the multi-level parent config, or an error code"},"description":"<p>Build a single-level focused config object from a multi-level one.</p>\n","comments":"<p>The returned config object can be used to perform get/set/delete operations\non a single specific level.</p>\n\n<p>Getting several times the same level from the same parent multi-level config\nwill return different config instances, but containing the same config_file\ninstance.</p>\n","group":"config"},"git_config_refresh":{"type":"function","file":"config.h","line":256,"lineto":256,"args":[{"name":"cfg","type":"git_config *","comment":"The configuration to refresh"}],"argline":"git_config *cfg","sig":"git_config *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Reload changed config files</p>\n","comments":"<p>A config file may be changed on disk out from under the in-memory\nconfig object. This function causes us to look for files that have\nbeen modified since we last loaded them and refresh the config with\nthe latest information.</p>\n","group":"config"},"git_config_free":{"type":"function","file":"config.h","line":263,"lineto":263,"args":[{"name":"cfg","type":"git_config *","comment":"the configuration to free"}],"argline":"git_config *cfg","sig":"git_config *","return":{"type":"void"},"description":"<p>Free the configuration and its associated memory and files</p>\n","comments":"","group":"config"},"git_config_get_entry":{"type":"function","file":"config.h","line":276,"lineto":279,"args":[{"name":"out","type":"const git_config_entry **","comment":"pointer to the variable git_config_entry"},{"name":"cfg","type":"const git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"}],"argline":"const git_config_entry **out,\n\tconst git_config *cfg,\n\tconst char *name","sig":"const git_config_entry **::const git_config *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Get the git_config_entry of a config variable.</p>\n","comments":"<p>The git_config_entry is owned by the config and should not be freed by the\nuser.</p>\n","group":"config"},"git_config_get_int32":{"type":"function","file":"config.h","line":293,"lineto":293,"args":[{"name":"out","type":"int32_t *","comment":"pointer to the variable where the value should be stored"},{"name":"cfg","type":"const git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"}],"argline":"int32_t *out, const git_config *cfg, const char *name","sig":"int32_t *::const git_config *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Get the value of an integer config variable.</p>\n","comments":"<p>All config files will be looked into, in the order of their\ndefined level. A higher level means a higher priority. The\nfirst occurence of the variable will be returned here.</p>\n","group":"config","examples":{"general.c":["ex/v0.18.0/general.html#git_config_get_int32-25"]}},"git_config_get_int64":{"type":"function","file":"config.h","line":307,"lineto":307,"args":[{"name":"out","type":"int64_t *","comment":"pointer to the variable where the value should be stored"},{"name":"cfg","type":"const git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"}],"argline":"int64_t *out, const git_config *cfg, const char *name","sig":"int64_t *::const git_config *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Get the value of a long integer config variable.</p>\n","comments":"<p>All config files will be looked into, in the order of their\ndefined level. A higher level means a higher priority. The\nfirst occurrence of the variable will be returned here.</p>\n","group":"config"},"git_config_get_bool":{"type":"function","file":"config.h","line":324,"lineto":324,"args":[{"name":"out","type":"int *","comment":"pointer to the variable where the value should be stored"},{"name":"cfg","type":"const git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"}],"argline":"int *out, const git_config *cfg, const char *name","sig":"int *::const git_config *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Get the value of a boolean config variable.</p>\n","comments":"<p>This function uses the usual C convention of 0 being false and\nanything else true.</p>\n\n<p>All config files will be looked into, in the order of their\ndefined level. A higher level means a higher priority. The\nfirst occurrence of the variable will be returned here.</p>\n","group":"config"},"git_config_get_string":{"type":"function","file":"config.h","line":341,"lineto":341,"args":[{"name":"out","type":"const char **","comment":"pointer to the variable's value"},{"name":"cfg","type":"const git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"}],"argline":"const char **out, const git_config *cfg, const char *name","sig":"const char **::const git_config *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Get the value of a string config variable.</p>\n","comments":"<p>The string is owned by the variable and should not be freed by the\nuser.</p>\n\n<p>All config files will be looked into, in the order of their\ndefined level. A higher level means a higher priority. The\nfirst occurrence of the variable will be returned here.</p>\n","group":"config","examples":{"general.c":["ex/v0.18.0/general.html#git_config_get_string-26"]}},"git_config_get_multivar":{"type":"function","file":"config.h","line":355,"lineto":355,"args":[{"name":"cfg","type":"const git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"},{"name":"regexp","type":"const char *","comment":"regular expression to filter which variables we're interested in. Use NULL to indicate all"},{"name":"callback","type":"git_config_foreach_cb"},{"name":"payload","type":"void *"}],"argline":"const git_config *cfg, const char *name, const char *regexp, git_config_foreach_cb callback, void *payload","sig":"const git_config *::const char *::const char *::git_config_foreach_cb::void *","return":{"type":"int"},"description":"<p>Get each value of a multivar.</p>\n","comments":"<p>The callback will be called on each variable found</p>\n","group":"config"},"git_config_set_int32":{"type":"function","file":"config.h","line":366,"lineto":366,"args":[{"name":"cfg","type":"git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"},{"name":"value","type":"int32_t","comment":"Integer value for the variable"}],"argline":"git_config *cfg, const char *name, int32_t value","sig":"git_config *::const char *::int32_t","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Set the value of an integer config variable in the config file\nwith the highest level (usually the local one).</p>\n","comments":"","group":"config"},"git_config_set_int64":{"type":"function","file":"config.h","line":377,"lineto":377,"args":[{"name":"cfg","type":"git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"},{"name":"value","type":"int64_t","comment":"Long integer value for the variable"}],"argline":"git_config *cfg, const char *name, int64_t value","sig":"git_config *::const char *::int64_t","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Set the value of a long integer config variable in the config file\nwith the highest level (usually the local one).</p>\n","comments":"","group":"config"},"git_config_set_bool":{"type":"function","file":"config.h","line":388,"lineto":388,"args":[{"name":"cfg","type":"git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"},{"name":"value","type":"int","comment":"the value to store"}],"argline":"git_config *cfg, const char *name, int value","sig":"git_config *::const char *::int","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Set the value of a boolean config variable in the config file\nwith the highest level (usually the local one).</p>\n","comments":"","group":"config"},"git_config_set_string":{"type":"function","file":"config.h","line":402,"lineto":402,"args":[{"name":"cfg","type":"git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"},{"name":"value","type":"const char *","comment":"the string to store."}],"argline":"git_config *cfg, const char *name, const char *value","sig":"git_config *::const char *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Set the value of a string config variable in the config file\nwith the highest level (usually the local one).</p>\n","comments":"<p>A copy of the string is made and the user is free to use it\nafterwards.</p>\n","group":"config"},"git_config_set_multivar":{"type":"function","file":"config.h","line":412,"lineto":412,"args":[{"name":"cfg","type":"git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"},{"name":"regexp","type":"const char *","comment":"a regular expression to indicate which values to replace"},{"name":"value","type":"const char *","comment":"the new value."}],"argline":"git_config *cfg, const char *name, const char *regexp, const char *value","sig":"git_config *::const char *::const char *::const char *","return":{"type":"int"},"description":"<p>Set a multivar in the local config file.</p>\n","comments":"","group":"config"},"git_config_delete_entry":{"type":"function","file":"config.h","line":421,"lineto":421,"args":[{"name":"cfg","type":"git_config *","comment":"the configuration"},{"name":"name","type":"const char *","comment":"the variable to delete"}],"argline":"git_config *cfg, const char *name","sig":"git_config *::const char *","return":{"type":"int"},"description":"<p>Delete a config variable from the config file\nwith the highest level (usually the local one).</p>\n","comments":"","group":"config"},"git_config_foreach":{"type":"function","file":"config.h","line":436,"lineto":439,"args":[{"name":"cfg","type":"const git_config *","comment":"where to get the variables from"},{"name":"callback","type":"git_config_foreach_cb","comment":"the function to call on each variable"},{"name":"payload","type":"void *","comment":"the data to pass to the callback"}],"argline":"const git_config *cfg,\n\tgit_config_foreach_cb callback,\n\tvoid *payload","sig":"const git_config *::git_config_foreach_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Perform an operation on each config variable.</p>\n","comments":"<p>The callback receives the normalized name and value of each variable\nin the config backend, and the data pointer passed to this function.\nAs soon as one of the callback functions returns something other than 0,\nthis function stops iterating and returns <code>GIT_EUSER</code>.</p>\n","group":"config"},"git_config_foreach_match":{"type":"function","file":"config.h","line":454,"lineto":458,"args":[{"name":"cfg","type":"const git_config *","comment":"where to get the variables from"},{"name":"regexp","type":"const char *","comment":"regular expression to match against config names"},{"name":"callback","type":"git_config_foreach_cb","comment":"the function to call on each variable"},{"name":"payload","type":"void *","comment":"the data to pass to the callback"}],"argline":"const git_config *cfg,\n\tconst char *regexp,\n\tgit_config_foreach_cb callback,\n\tvoid *payload","sig":"const git_config *::const char *::git_config_foreach_cb::void *","return":{"type":"int","comment":"0 or the return value of the callback which didn't return 0"},"description":"<p>Perform an operation on each config variable matching a regular expression.</p>\n","comments":"<p>This behaviors like <code>git_config_foreach</code> with an additional filter of a\nregular expression that filters which config keys are passed to the\ncallback.</p>\n","group":"config"},"git_config_get_mapped":{"type":"function","file":"config.h","line":494,"lineto":499,"args":[{"name":"out","type":"int *","comment":"place to store the result of the mapping"},{"name":"cfg","type":"const git_config *","comment":"config file to get the variables from"},{"name":"name","type":"const char *","comment":"name of the config variable to lookup"},{"name":"maps","type":"const git_cvar_map *","comment":"array of `git_cvar_map` objects specifying the possible mappings"},{"name":"map_n","type":"size_t","comment":"number of mapping objects in `maps`"}],"argline":"int *out,\n const git_config *cfg,\n const char *name,\n const git_cvar_map *maps,\n size_t map_n","sig":"int *::const git_config *::const char *::const git_cvar_map *::size_t","return":{"type":"int","comment":"0 on success, error code otherwise"},"description":"<p>Query the value of a config variable and return it mapped to\nan integer constant.</p>\n","comments":"<p>This is a helper method to easily map different possible values\nto a variable to integer constants that easily identify them.</p>\n\n<p>A mapping array looks as follows:</p>\n\n<p>git_cvar_map autocrlf_mapping[] = {\n {GIT_CVAR_FALSE, NULL, GIT_AUTO_CRLF_FALSE},\n {GIT_CVAR_TRUE, NULL, GIT_AUTO_CRLF_TRUE},\n {GIT_CVAR_STRING, &quot;input&quot;, GIT_AUTO_CRLF_INPUT},\n {GIT_CVAR_STRING, &quot;default&quot;, GIT_AUTO_CRLF_DEFAULT}};</p>\n\n<p>On any &quot;false&quot; value for the variable (e.g. &quot;false&quot;, &quot;FALSE&quot;, &quot;no&quot;), the\nmapping will store <code>GIT_AUTO_CRLF_FALSE</code> in the <code>out</code> parameter.</p>\n\n<p>The same thing applies for any &quot;true&quot; value such as &quot;true&quot;, &quot;yes&quot; or &quot;1&quot;, storing\nthe <code>GIT_AUTO_CRLF_TRUE</code> variable.</p>\n\n<p>Otherwise, if the value matches the string &quot;input&quot; (with case insensitive comparison),\nthe given constant will be stored in <code>out</code>, and likewise for &quot;default&quot;.</p>\n\n<p>If not a single match can be made to store in <code>out</code>, an error code will be\nreturned.</p>\n","group":"config"},"git_config_lookup_map_value":{"type":"function","file":"config.h","line":509,"lineto":513,"args":[{"name":"out","type":"int *","comment":"place to store the result of the parsing"},{"name":"maps","type":"const git_cvar_map *","comment":"array of `git_cvar_map` objects specifying the possible mappings"},{"name":"map_n","type":"size_t","comment":"number of mapping objects in `maps`"},{"name":"value","type":"const char *","comment":"value to parse"}],"argline":"int *out,\n\tconst git_cvar_map *maps,\n\tsize_t map_n,\n\tconst char *value","sig":"int *::const git_cvar_map *::size_t::const char *","return":{"type":"int"},"description":"<p>Maps a string value to an integer constant</p>\n","comments":"","group":"config"},"git_config_parse_bool":{"type":"function","file":"config.h","line":525,"lineto":525,"args":[{"name":"out","type":"int *","comment":"place to store the result of the parsing"},{"name":"value","type":"const char *","comment":"value to parse"}],"argline":"int *out, const char *value","sig":"int *::const char *","return":{"type":"int"},"description":"<p>Parse a string value as a bool.</p>\n","comments":"<p>Valid values for true are: &#39;true&#39;, &#39;yes&#39;, &#39;on&#39;, 1 or any\n number different from 0\nValid values for false are: &#39;false&#39;, &#39;no&#39;, &#39;off&#39;, 0</p>\n","group":"config"},"git_config_parse_int32":{"type":"function","file":"config.h","line":537,"lineto":537,"args":[{"name":"out","type":"int32_t *","comment":"place to store the result of the parsing"},{"name":"value","type":"const char *","comment":"value to parse"}],"argline":"int32_t *out, const char *value","sig":"int32_t *::const char *","return":{"type":"int"},"description":"<p>Parse a string value as an int32.</p>\n","comments":"<p>An optional value suffix of &#39;k&#39;, &#39;m&#39;, or &#39;g&#39; will\ncause the value to be multiplied by 1024, 1048576,\nor 1073741824 prior to output.</p>\n","group":"config"},"git_config_parse_int64":{"type":"function","file":"config.h","line":549,"lineto":549,"args":[{"name":"out","type":"int64_t *","comment":"place to store the result of the parsing"},{"name":"value","type":"const char *","comment":"value to parse"}],"argline":"int64_t *out, const char *value","sig":"int64_t *::const char *","return":{"type":"int"},"description":"<p>Parse a string value as an int64.</p>\n","comments":"<p>An optional value suffix of &#39;k&#39;, &#39;m&#39;, or &#39;g&#39; will\ncause the value to be multiplied by 1024, 1048576,\nor 1073741824 prior to output.</p>\n","group":"config"},"git_cred_userpass":{"type":"function","file":"cred_helpers.h","line":43,"lineto":48,"args":[{"name":"cred","type":"git_cred **","comment":"The newly created credential object."},{"name":"url","type":"const char *","comment":"The resource for which we are demanding a credential."},{"name":"user_from_url","type":"const char *"},{"name":"allowed_types","type":"unsigned int","comment":"A bitmask stating which cred types are OK to return."},{"name":"payload","type":"void *","comment":"The payload provided when specifying this callback. (This is interpreted as a `git_cred_userpass_payload*`.)"}],"argline":"git_cred **cred,\n\t\tconst char *url,\n\t\tconst char *user_from_url,\n\t\tunsigned int allowed_types,\n\t\tvoid *payload","sig":"git_cred **::const char *::const char *::unsigned int::void *","return":{"type":"int"},"description":"<p>Stock callback usable as a git_cred_acquire_cb. This calls\ngit_cred_userpass_plaintext_new unless the protocol has not specified\nGIT_CREDTYPE_USERPASS_PLAINTEXT as an allowed type.</p>\n","comments":"","group":"cred"},"git_diff_list_free":{"type":"function","file":"diff.h","line":473,"lineto":473,"args":[{"name":"diff","type":"git_diff_list *"}],"argline":"git_diff_list *diff","sig":"git_diff_list *","return":{"type":"void"},"description":"<p>Deallocate a diff list.</p>\n","comments":"","group":"diff"},"git_diff_tree_to_tree":{"type":"function","file":"diff.h","line":489,"lineto":494,"args":[{"name":"diff","type":"git_diff_list **","comment":"Output pointer to a git_diff_list pointer to be allocated."},{"name":"repo","type":"git_repository *","comment":"The repository containing the trees."},{"name":"old_tree","type":"git_tree *","comment":"A git_tree object to diff from."},{"name":"new_tree","type":"git_tree *","comment":"A git_tree object to diff to."},{"name":"opts","type":"const git_diff_options *","comment":"Structure with options to influence diff or NULL for defaults."}],"argline":"git_diff_list **diff,\n\tgit_repository *repo,\n\tgit_tree *old_tree,\n\tgit_tree *new_tree,\n\tconst git_diff_options *opts","sig":"git_diff_list **::git_repository *::git_tree *::git_tree *::const git_diff_options *","return":{"type":"int"},"description":"<p>Create a diff list with the difference between two tree objects.</p>\n","comments":"<p>This is equivalent to <code>git diff &lt;old-tree&gt; &lt;new-tree&gt;</code></p>\n\n<p>The first tree will be used for the &quot;old_file&quot; side of the delta and the\nsecond tree will be used for the &quot;new_file&quot; side of the delta.</p>\n","group":"diff"},"git_diff_tree_to_index":{"type":"function","file":"diff.h","line":511,"lineto":516,"args":[{"name":"diff","type":"git_diff_list **","comment":"Output pointer to a git_diff_list pointer to be allocated."},{"name":"repo","type":"git_repository *","comment":"The repository containing the tree and index."},{"name":"old_tree","type":"git_tree *","comment":"A git_tree object to diff from."},{"name":"index","type":"git_index *","comment":"The index to diff with; repo index used if NULL."},{"name":"opts","type":"const git_diff_options *","comment":"Structure with options to influence diff or NULL for defaults."}],"argline":"git_diff_list **diff,\n\tgit_repository *repo,\n\tgit_tree *old_tree,\n\tgit_index *index,\n\tconst git_diff_options *opts","sig":"git_diff_list **::git_repository *::git_tree *::git_index *::const git_diff_options *","return":{"type":"int"},"description":"<p>Create a diff list between a tree and repository index.</p>\n","comments":"<p>This is equivalent to <code>git diff --cached &lt;treeish&gt;</code> or if you pass\nthe HEAD tree, then like <code>git diff --cached</code>.</p>\n\n<p>The tree you pass will be used for the &quot;old_file&quot; side of the delta, and\nthe index will be used for the &quot;new_file&quot; side of the delta.</p>\n","group":"diff"},"git_diff_index_to_workdir":{"type":"function","file":"diff.h","line":534,"lineto":538,"args":[{"name":"diff","type":"git_diff_list **","comment":"Output pointer to a git_diff_list pointer to be allocated."},{"name":"repo","type":"git_repository *","comment":"The repository."},{"name":"index","type":"git_index *","comment":"The index to diff from; repo index used if NULL."},{"name":"opts","type":"const git_diff_options *","comment":"Structure with options to influence diff or NULL for defaults."}],"argline":"git_diff_list **diff,\n\tgit_repository *repo,\n\tgit_index *index,\n\tconst git_diff_options *opts","sig":"git_diff_list **::git_repository *::git_index *::const git_diff_options *","return":{"type":"int"},"description":"<p>Create a diff list between the repository index and the workdir directory.</p>\n","comments":"<p>This matches the <code>git diff</code> command. See the note below on\n<code>git_diff_tree_to_workdir</code> for a discussion of the difference between\n<code>git diff</code> and <code>git diff HEAD</code> and how to emulate a <code>git diff &lt;treeish&gt;</code>\nusing libgit2.</p>\n\n<p>The index will be used for the &quot;old_file&quot; side of the delta, and the\nworking directory will be used for the &quot;new_file&quot; side of the delta.</p>\n","group":"diff"},"git_diff_tree_to_workdir":{"type":"function","file":"diff.h","line":569,"lineto":573,"args":[{"name":"diff","type":"git_diff_list **","comment":"A pointer to a git_diff_list pointer that will be allocated."},{"name":"repo","type":"git_repository *","comment":"The repository containing the tree."},{"name":"old_tree","type":"git_tree *","comment":"A git_tree object to diff from."},{"name":"opts","type":"const git_diff_options *","comment":"Structure with options to influence diff or NULL for defaults."}],"argline":"git_diff_list **diff,\n\tgit_repository *repo,\n\tgit_tree *old_tree,\n\tconst git_diff_options *opts","sig":"git_diff_list **::git_repository *::git_tree *::const git_diff_options *","return":{"type":"int"},"description":"<p>Create a diff list between a tree and the working directory.</p>\n","comments":"<p>The tree you provide will be used for the &quot;old_file&quot; side of the delta,\nand the working directory will be used for the &quot;new_file&quot; side.</p>\n\n<p>Please note: this is <em>NOT</em> the same as <code>git diff &lt;treeish&gt;</code>. Running\n<code>git diff HEAD</code> or the like actually uses information from the index,\nalong with the tree and working directory info.</p>\n\n<p>This function returns strictly the differences between the tree and the\nfiles contained in the working directory, regardless of the state of\nfiles in the index. It may come as a surprise, but there is no direct\nequivalent in core git.</p>\n\n<p>To emulate <code>git diff &lt;treeish&gt;</code>, call both <code>git_diff_tree_to_index</code> and\n<code>git_diff_index_to_workdir</code>, then call <code>git_diff_merge</code> on the results.\nThat will yield a <code>git_diff_list</code> that matches the git output.</p>\n\n<p>If this seems confusing, take the case of a file with a staged deletion\nwhere the file has then been put back into the working dir and modified.\nThe tree-to-workdir diff for that file is &#39;modified&#39;, but core git would\nshow status &#39;deleted&#39; since there is a pending deletion in the index.</p>\n","group":"diff"},"git_diff_merge":{"type":"function","file":"diff.h","line":588,"lineto":590,"args":[{"name":"onto","type":"git_diff_list *","comment":"Diff to merge into."},{"name":"from","type":"const git_diff_list *","comment":"Diff to merge."}],"argline":"git_diff_list *onto,\n\tconst git_diff_list *from","sig":"git_diff_list *::const git_diff_list *","return":{"type":"int"},"description":"<p>Merge one diff list into another.</p>\n","comments":"<p>This merges items from the &quot;from&quot; list into the &quot;onto&quot; list. The\nresulting diff list will have all items that appear in either list.\nIf an item appears in both lists, then it will be &quot;merged&quot; to appear\nas if the old version was from the &quot;onto&quot; list and the new version\nis from the &quot;from&quot; list (with the exception that if the item has a\npending DELETE in the middle, then it will show as deleted).</p>\n","group":"diff"},"git_diff_find_similar":{"type":"function","file":"diff.h","line":604,"lineto":606,"args":[{"name":"diff","type":"git_diff_list *","comment":"Diff list to run detection algorithms on"},{"name":"options","type":"git_diff_find_options *","comment":"Control how detection should be run, NULL for defaults"}],"argline":"git_diff_list *diff,\n\tgit_diff_find_options *options","sig":"git_diff_list *::git_diff_find_options *","return":{"type":"int","comment":"0 on success, -1 on failure"},"description":"<p>Transform a diff list marking file renames, copies, etc.</p>\n","comments":"<p>This modifies a diff list in place, replacing old entries that look\nlike renames or copies with new entries reflecting those changes.\nThis also will, if requested, break modified files into add/remove\npairs if the amount of change is above a threshold.</p>\n","group":"diff"},"git_diff_foreach":{"type":"function","file":"diff.h","line":643,"lineto":648,"args":[{"name":"diff","type":"git_diff_list *","comment":"A git_diff_list generated by one of the above functions."},{"name":"file_cb","type":"git_diff_file_cb","comment":"Callback function to make per file in the diff."},{"name":"hunk_cb","type":"git_diff_hunk_cb","comment":"Optional callback to make per hunk of text diff. This callback is called to describe a range of lines in the diff. It will not be issued for binary files."},{"name":"line_cb","type":"git_diff_data_cb","comment":"Optional callback to make per line of diff text. This same callback will be made for context lines, added, and removed lines, and even for a deleted trailing newline."},{"name":"payload","type":"void *","comment":"Reference pointer that will be passed to your callbacks."}],"argline":"git_diff_list *diff,\n\tgit_diff_file_cb file_cb,\n\tgit_diff_hunk_cb hunk_cb,\n\tgit_diff_data_cb line_cb,\n\tvoid *payload","sig":"git_diff_list *::git_diff_file_cb::git_diff_hunk_cb::git_diff_data_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Loop over all deltas in a diff list issuing callbacks.</p>\n","comments":"<p>This will iterate through all of the files described in a diff. You\nshould provide a file callback to learn about each file.</p>\n\n<p>The &quot;hunk&quot; and &quot;line&quot; callbacks are optional, and the text diff of the\nfiles will only be calculated if they are not NULL. Of course, these\ncallbacks will not be invoked for binary files on the diff list or for\nfiles whose only changed is a file mode change.</p>\n\n<p>Returning a non-zero value from any of the callbacks will terminate\nthe iteration and cause this return <code>GIT_EUSER</code>.</p>\n","group":"diff"},"git_diff_print_compact":{"type":"function","file":"diff.h","line":661,"lineto":664,"args":[{"name":"diff","type":"git_diff_list *","comment":"A git_diff_list generated by one of the above functions."},{"name":"print_cb","type":"git_diff_data_cb","comment":"Callback to make per line of diff text."},{"name":"payload","type":"void *","comment":"Reference pointer that will be passed to your callback."}],"argline":"git_diff_list *diff,\n\tgit_diff_data_cb print_cb,\n\tvoid *payload","sig":"git_diff_list *::git_diff_data_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Iterate over a diff generating text output like &quot;git diff --name-status&quot;.</p>\n","comments":"<p>Returning a non-zero value from the callbacks will terminate the\niteration and cause this return <code>GIT_EUSER</code>.</p>\n","group":"diff"},"git_diff_status_char":{"type":"function","file":"diff.h","line":678,"lineto":678,"args":[{"name":"status","type":"git_delta_t"}],"argline":"git_delta_t status","sig":"git_delta_t","return":{"type":"char","comment":"The single character label for that code"},"description":"<p>Look up the single character abbreviation for a delta status code.</p>\n","comments":"<p>When you call <code>git_diff_print_compact</code> it prints single letter codes into\nthe output such as &#39;A&#39; for added, &#39;D&#39; for deleted, &#39;M&#39; for modified, etc.\nIt is sometimes convenient to convert a git_delta_t value into these\nletters for your own purposes. This function does just that. By the\nway, unmodified will return a space (i.e. &#39; &#39;).</p>\n","group":"diff"},"git_diff_print_patch":{"type":"function","file":"diff.h","line":697,"lineto":700,"args":[{"name":"diff","type":"git_diff_list *","comment":"A git_diff_list generated by one of the above functions."},{"name":"print_cb","type":"git_diff_data_cb","comment":"Callback function to output lines of the diff. This same function will be called for file headers, hunk headers, and diff lines. Fortunately, you can probably use various GIT_DIFF_LINE constants to determine what text you are given."},{"name":"payload","type":"void *","comment":"Reference pointer that will be passed to your callbacks."}],"argline":"git_diff_list *diff,\n\tgit_diff_data_cb print_cb,\n\tvoid *payload","sig":"git_diff_list *::git_diff_data_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Iterate over a diff generating text output like &quot;git diff&quot;.</p>\n","comments":"<p>This is a super easy way to generate a patch from a diff.</p>\n\n<p>Returning a non-zero value from the callbacks will terminate the\niteration and cause this return <code>GIT_EUSER</code>.</p>\n","group":"diff"},"git_diff_num_deltas":{"type":"function","file":"diff.h","line":708,"lineto":708,"args":[{"name":"diff","type":"git_diff_list *","comment":"A git_diff_list generated by one of the above functions"}],"argline":"git_diff_list *diff","sig":"git_diff_list *","return":{"type":"size_t","comment":"Count of number of deltas in the list"},"description":"<p>Query how many diff records are there in a diff list.</p>\n","comments":"","group":"diff"},"git_diff_num_deltas_of_type":{"type":"function","file":"diff.h","line":721,"lineto":723,"args":[{"name":"diff","type":"git_diff_list *","comment":"A git_diff_list generated by one of the above functions"},{"name":"type","type":"git_delta_t","comment":"A git_delta_t value to filter the count"}],"argline":"git_diff_list *diff,\n\tgit_delta_t type","sig":"git_diff_list *::git_delta_t","return":{"type":"size_t","comment":"Count of number of deltas matching delta_t type"},"description":"<p>Query how many diff deltas are there in a diff list filtered by type.</p>\n","comments":"<p>This works just like <code>git_diff_entrycount()</code> with an extra parameter\nthat is a <code>git_delta_t</code> and returns just the count of how many deltas\nmatch that particular type.</p>\n","group":"diff"},"git_diff_get_patch":{"type":"function","file":"diff.h","line":750,"lineto":754,"args":[{"name":"patch_out","type":"git_diff_patch **","comment":"Output parameter for the delta patch object"},{"name":"delta_out","type":"const git_diff_delta **","comment":"Output parameter for the delta object"},{"name":"diff","type":"git_diff_list *","comment":"Diff list object"},{"name":"idx","type":"size_t","comment":"Index into diff list"}],"argline":"git_diff_patch **patch_out,\n\tconst git_diff_delta **delta_out,\n\tgit_diff_list *diff,\n\tsize_t idx","sig":"git_diff_patch **::const git_diff_delta **::git_diff_list *::size_t","return":{"type":"int","comment":"0 on success, other value < 0 on error"},"description":"<p>Return the diff delta and patch for an entry in the diff list.</p>\n","comments":"<p>The <code>git_diff_patch</code> is a newly created object contains the text diffs\nfor the delta. You have to call <code>git_diff_patch_free()</code> when you are\ndone with it. You can use the patch object to loop over all the hunks\nand lines in the diff of the one delta.</p>\n\n<p>For an unchanged file or a binary file, no <code>git_diff_patch</code> will be\ncreated, the output will be set to NULL, and the <code>binary</code> flag will be\nset true in the <code>git_diff_delta</code> structure.</p>\n\n<p>The <code>git_diff_delta</code> pointer points to internal data and you do not have\nto release it when you are done with it. It will go away when the\n<code>git_diff_list</code> and <code>git_diff_patch</code> go away.</p>\n\n<p>It is okay to pass NULL for either of the output parameters; if you pass\nNULL for the <code>git_diff_patch</code>, then the text diff will not be calculated.</p>\n","group":"diff"},"git_diff_patch_free":{"type":"function","file":"diff.h","line":759,"lineto":760,"args":[{"name":"patch","type":"git_diff_patch *"}],"argline":"git_diff_patch *patch","sig":"git_diff_patch *","return":{"type":"void"},"description":"<p>Free a git_diff_patch object.</p>\n","comments":"","group":"diff"},"git_diff_patch_delta":{"type":"function","file":"diff.h","line":765,"lineto":766,"args":[{"name":"patch","type":"git_diff_patch *"}],"argline":"git_diff_patch *patch","sig":"git_diff_patch *","return":{"type":"const git_diff_delta *"},"description":"<p>Get the delta associated with a patch</p>\n","comments":"","group":"diff"},"git_diff_patch_num_hunks":{"type":"function","file":"diff.h","line":771,"lineto":772,"args":[{"name":"patch","type":"git_diff_patch *"}],"argline":"git_diff_patch *patch","sig":"git_diff_patch *","return":{"type":"size_t"},"description":"<p>Get the number of hunks in a patch</p>\n","comments":"","group":"diff"},"git_diff_patch_line_stats":{"type":"function","file":"diff.h","line":790,"lineto":794,"args":[{"name":"total_context","type":"size_t *","comment":"Count of context lines in output, can be NULL."},{"name":"total_additions","type":"size_t *","comment":"Count of addition lines in output, can be NULL."},{"name":"total_deletions","type":"size_t *","comment":"Count of deletion lines in output, can be NULL."},{"name":"patch","type":"const git_diff_patch *","comment":"The git_diff_patch object"}],"argline":"size_t *total_context,\n\tsize_t *total_additions,\n\tsize_t *total_deletions,\n\tconst git_diff_patch *patch","sig":"size_t *::size_t *::size_t *::const git_diff_patch *","return":{"type":"int","comment":"Number of lines in hunk or -1 if invalid hunk index"},"description":"<p>Get line counts of each type in a patch.</p>\n","comments":"<p>This helps imitate a diff --numstat type of output. For that purpose,\nyou only need the <code>total_additions</code> and <code>total_deletions</code> values, but we\ninclude the <code>total_context</code> line count in case you want the total number\nof lines of diff output that will be generated.</p>\n\n<p>All outputs are optional. Pass NULL if you don&#39;t need a particular count.</p>\n","group":"diff"},"git_diff_patch_get_hunk":{"type":"function","file":"diff.h","line":812,"lineto":818,"args":[{"name":"range","type":"const git_diff_range **","comment":"Output pointer to git_diff_range of hunk"},{"name":"header","type":"const char **","comment":"Output pointer to header string for hunk. Unlike the content pointer for each line, this will be NUL-terminated"},{"name":"header_len","type":"size_t *","comment":"Output value of characters in header string"},{"name":"lines_in_hunk","type":"size_t *","comment":"Output count of total lines in this hunk"},{"name":"patch","type":"git_diff_patch *","comment":"Input pointer to patch object"},{"name":"hunk_idx","type":"size_t","comment":"Input index of hunk to get information about"}],"argline":"const git_diff_range **range,\n\tconst char **header,\n\tsize_t *header_len,\n\tsize_t *lines_in_hunk,\n\tgit_diff_patch *patch,\n\tsize_t hunk_idx","sig":"const git_diff_range **::const char **::size_t *::size_t *::git_diff_patch *::size_t","return":{"type":"int","comment":"0 on success, GIT_ENOTFOUND if hunk_idx out of range, <0 on error"},"description":"<p>Get the information about a hunk in a patch</p>\n","comments":"<p>Given a patch and a hunk index into the patch, this returns detailed\ninformation about that hunk. Any of the output pointers can be passed\nas NULL if you don&#39;t care about that particular piece of information.</p>\n","group":"diff"},"git_diff_patch_num_lines_in_hunk":{"type":"function","file":"diff.h","line":827,"lineto":829,"args":[{"name":"patch","type":"git_diff_patch *","comment":"The git_diff_patch object"},{"name":"hunk_idx","type":"size_t","comment":"Index of the hunk"}],"argline":"git_diff_patch *patch,\n\tsize_t hunk_idx","sig":"git_diff_patch *::size_t","return":{"type":"int","comment":"Number of lines in hunk or -1 if invalid hunk index"},"description":"<p>Get the number of lines in a hunk.</p>\n","comments":"","group":"diff"},"git_diff_patch_get_line_in_hunk":{"type":"function","file":"diff.h","line":849,"lineto":857,"args":[{"name":"line_origin","type":"char *","comment":"A GIT_DIFF_LINE constant from above"},{"name":"content","type":"const char **","comment":"Pointer to content of diff line, not NUL-terminated"},{"name":"content_len","type":"size_t *","comment":"Number of characters in content"},{"name":"old_lineno","type":"int *","comment":"Line number in old file or -1 if line is added"},{"name":"new_lineno","type":"int *","comment":"Line number in new file or -1 if line is deleted"},{"name":"patch","type":"git_diff_patch *","comment":"The patch to look in"},{"name":"hunk_idx","type":"size_t","comment":"The index of the hunk"},{"name":"line_of_hunk","type":"size_t"}],"argline":"char *line_origin,\n\tconst char **content,\n\tsize_t *content_len,\n\tint *old_lineno,\n\tint *new_lineno,\n\tgit_diff_patch *patch,\n\tsize_t hunk_idx,\n\tsize_t line_of_hunk","sig":"char *::const char **::size_t *::int *::int *::git_diff_patch *::size_t::size_t","return":{"type":"int","comment":"0 on success, <0 on failure"},"description":"<p>Get data about a line in a hunk of a patch.</p>\n","comments":"<p>Given a patch, a hunk index, and a line index in the hunk, this\nwill return a lot of details about that line. If you pass a hunk\nindex larger than the number of hunks or a line index larger than\nthe number of lines in the hunk, this will return -1.</p>\n","group":"diff"},"git_diff_patch_print":{"type":"function","file":"diff.h","line":871,"lineto":874,"args":[{"name":"patch","type":"git_diff_patch *","comment":"A git_diff_patch representing changes to one file"},{"name":"print_cb","type":"git_diff_data_cb","comment":"Callback function to output lines of the patch. Will be called for file headers, hunk headers, and diff lines."},{"name":"payload","type":"void *","comment":"Reference pointer that will be passed to your callbacks."}],"argline":"git_diff_patch *patch,\n\tgit_diff_data_cb print_cb,\n\tvoid *payload","sig":"git_diff_patch *::git_diff_data_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Serialize the patch to text via callback.</p>\n","comments":"<p>Returning a non-zero value from the callback will terminate the iteration\nand cause this return <code>GIT_EUSER</code>.</p>\n","group":"diff"},"git_diff_patch_to_str":{"type":"function","file":"diff.h","line":883,"lineto":885,"args":[{"name":"string","type":"char **","comment":"Allocated string; caller must free."},{"name":"patch","type":"git_diff_patch *","comment":"A git_diff_patch representing changes to one file"}],"argline":"char **string,\n\tgit_diff_patch *patch","sig":"char **::git_diff_patch *","return":{"type":"int","comment":"0 on success, <0 on failure."},"description":"<p>Get the content of a patch as a single diff text.</p>\n","comments":"","group":"diff"},"git_diff_blobs":{"type":"function","file":"diff.h","line":912,"lineto":919,"args":[{"name":"old_blob","type":"const git_blob *"},{"name":"new_blob","type":"const git_blob *"},{"name":"options","type":"const git_diff_options *"},{"name":"file_cb","type":"git_diff_file_cb"},{"name":"hunk_cb","type":"git_diff_hunk_cb"},{"name":"line_cb","type":"git_diff_data_cb"},{"name":"payload","type":"void *"}],"argline":"const git_blob *old_blob,\n\tconst git_blob *new_blob,\n\tconst git_diff_options *options,\n\tgit_diff_file_cb file_cb,\n\tgit_diff_hunk_cb hunk_cb,\n\tgit_diff_data_cb line_cb,\n\tvoid *payload","sig":"const git_blob *::const git_blob *::const git_diff_options *::git_diff_file_cb::git_diff_hunk_cb::git_diff_data_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Directly run a diff on two blobs.</p>\n","comments":"<p>Compared to a file, a blob lacks some contextual information. As such,\nthe <code>git_diff_file</code> given to the callback will have some fake data; i.e.\n<code>mode</code> will be 0 and <code>path</code> will be NULL.</p>\n\n<p>NULL is allowed for either <code>old_blob</code> or <code>new_blob</code> and will be treated\nas an empty blob, with the <code>oid</code> set to NULL in the <code>git_diff_file</code> data.\nPassing NULL for both blobs is a noop; no callbacks will be made at all.</p>\n\n<p>We do run a binary content check on the blob content and if either blob\nlooks like binary data, the <code>git_diff_delta</code> binary attribute will be set\nto 1 and no call to the hunk_cb nor line_cb will be made (unless you pass\n<code>GIT_DIFF_FORCE_TEXT</code> of course).</p>\n","group":"diff"},"git_diff_blob_to_buffer":{"type":"function","file":"diff.h","line":935,"lineto":945,"args":[{"name":"old_blob","type":"const git_blob *"},{"name":"buffer","type":"const char *"},{"name":"buffer_len","type":"size_t"},{"name":"options","type":"const git_diff_options *"},{"name":"file_cb","type":"git_diff_file_cb"},{"name":"hunk_cb","type":"git_diff_hunk_cb"},{"name":"data_cb","type":"git_diff_data_cb"},{"name":"payload","type":"void *"}],"argline":"const git_blob *old_blob,\n\tconst char *buffer,\n\tsize_t buffer_len,\n\tconst git_diff_options *options,\n\tgit_diff_file_cb file_cb,\n\tgit_diff_hunk_cb hunk_cb,\n\tgit_diff_data_cb data_cb,\n\tvoid *payload","sig":"const git_blob *::const char *::size_t::const git_diff_options *::git_diff_file_cb::git_diff_hunk_cb::git_diff_data_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Directly run a diff between a blob and a buffer.</p>\n","comments":"<p>As with <code>git_diff_blobs</code>, comparing a blob and buffer lacks some context,\nso the <code>git_diff_file</code> parameters to the callbacks will be faked a la the\nrules for <code>git_diff_blobs()</code>.</p>\n\n<p>Passing NULL for <code>old_blob</code> will be treated as an empty blob (i.e. the\n<code>file_cb</code> will be invoked with GIT_DELTA_ADDED and the diff will be the\nentire content of the buffer added). Passing NULL to the buffer will do\nthe reverse, with GIT_DELTA_REMOVED and blob content removed.</p>\n","group":"diff"},"giterr_last":{"type":"function","file":"errors.h","line":77,"lineto":77,"args":[],"argline":"void","sig":"","return":{"type":"const git_error *","comment":"A git_error object."},"description":"<p>Return the last <code>git_error</code> object that was generated for the\ncurrent thread or NULL if no error has occurred.</p>\n","comments":"","group":"giterr","examples":{"general.c":["ex/v0.18.0/general.html#giterr_last-27"],"network/clone.c":["ex/v0.18.0/network/clone.html#giterr_last-2"],"network/git2.c":["ex/v0.18.0/network/git2.html#giterr_last-1","ex/v0.18.0/network/git2.html#giterr_last-2"]}},"giterr_clear":{"type":"function","file":"errors.h","line":82,"lineto":82,"args":[],"argline":"void","sig":"","return":{"type":"void"},"description":"<p>Clear the last library error that occurred for this thread.</p>\n","comments":"","group":"giterr"},"giterr_set_str":{"type":"function","file":"errors.h","line":105,"lineto":105,"args":[{"name":"error_class","type":"int","comment":"One of the `git_error_t` enum above describing the general subsystem that is responsible for the error."},{"name":"string","type":"const char *"}],"argline":"int error_class, const char *string","sig":"int::const char *","return":{"type":"void"},"description":"<p>Set the error message string for this thread.</p>\n","comments":"<p>This function is public so that custom ODB backends and the like can\nrelay an error message through libgit2. Most regular users of libgit2\nwill never need to call this function -- actually, calling it in most\ncircumstances (for example, calling from within a callback function)\nwill just end up having the value overwritten by libgit2 internals.</p>\n\n<p>This error message is stored in thread-local storage and only applies\nto the particular thread that this libgit2 call is made from.</p>\n\n<p>NOTE: Passing the <code>error_class</code> as GITERR_OS has a special behavior: we\nattempt to append the system default error message for the last OS error\nthat occurred and then clear the last error. The specific implementation\nof looking up and clearing this last OS error will vary by platform.</p>\n","group":"giterr"},"giterr_set_oom":{"type":"function","file":"errors.h","line":116,"lineto":116,"args":[],"argline":"void","sig":"","return":{"type":"void"},"description":"<p>Set the error message to a special value for memory allocation failure.</p>\n","comments":"<p>The normal <code>giterr_set_str()</code> function attempts to <code>strdup()</code> the string\nthat is passed in. This is not a good idea when the error in question\nis a memory allocation failure. That circumstance has a special setter\nfunction that sets the error string to a known and statically allocated\ninternal value.</p>\n","group":"giterr"},"git_graph_ahead_behind":{"type":"function","file":"graph.h","line":37,"lineto":37,"args":[{"name":"ahead","type":"size_t *","comment":"number of unique from commits in `upstream`"},{"name":"behind","type":"size_t *","comment":"number of unique from commits in `local`"},{"name":"repo","type":"git_repository *","comment":"the repository where the commits exist"},{"name":"local","type":"const git_oid *","comment":"the commit for local"},{"name":"upstream","type":"const git_oid *","comment":"the commit for upstream"}],"argline":"size_t *ahead, size_t *behind, git_repository *repo, const git_oid *local, const git_oid *upstream","sig":"size_t *::size_t *::git_repository *::const git_oid *::const git_oid *","return":{"type":"int"},"description":"<p>Count the number of unique commits between two commit objects</p>\n","comments":"<p>There is no need for branches containing the commits to have any\nupstream relationship, but it helps to think of one as a branch and\nthe other as its upstream, the <code>ahead</code> and <code>behind</code> values will be\nwhat git would report for the branches.</p>\n","group":"graph"},"git_ignore_add_rule":{"type":"function","file":"ignore.h","line":37,"lineto":39,"args":[{"name":"repo","type":"git_repository *","comment":"The repository to add ignore rules to."},{"name":"rules","type":"const char *","comment":"Text of rules, a la the contents of a .gitignore file. It is okay to have multiple rules in the text; if so, each rule should be terminated with a newline."}],"argline":"git_repository *repo,\n\tconst char *rules","sig":"git_repository *::const char *","return":{"type":"int","comment":"0 on success"},"description":"<p>Add ignore rules for a repository.</p>\n","comments":"<p>Excludesfile rules (i.e. .gitignore rules) are generally read from\n.gitignore files in the repository tree or from a shared system file\nonly if a &quot;core.excludesfile&quot; config value is set. The library also\nkeeps a set of per-repository internal ignores that can be configured\nin-memory and will not persist. This function allows you to add to\nthat internal rules list.</p>\n\n<p>Example usage:</p>\n\n<pre><code>error = git_ignore_add_rule(myrepo, &quot;*.c\\ndir/\\nFile with space\\n&quot;);\n</code></pre>\n\n<p>This would add three rules to the ignores.</p>\n","group":"ignore"},"git_ignore_clear_internal_rules":{"type":"function","file":"ignore.h","line":52,"lineto":53,"args":[{"name":"repo","type":"git_repository *","comment":"The repository to remove ignore rules from."}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"int","comment":"0 on success"},"description":"<p>Clear ignore rules that were explicitly added.</p>\n","comments":"<p>Resets to the default internal ignore rules. This will not turn off\nrules in .gitignore files that actually exist in the filesystem.</p>\n\n<p>The default internal ignores ignore &quot;.&quot;, &quot;..&quot; and &quot;.git&quot; entries.</p>\n","group":"ignore"},"git_ignore_path_is_ignored":{"type":"function","file":"ignore.h","line":71,"lineto":78,"args":[{"name":"ignored","type":"int *","comment":"boolean returning 0 if the file is not ignored, 1 if it is"},{"name":"repo","type":"git_repository *","comment":"a repository object"},{"name":"path","type":"const char *","comment":"the file to check ignores for, relative to the repo's workdir."}],"argline":"int *ignored,\n\tgit_repository *repo,\n\tconst char *path","sig":"int *::git_repository *::const char *","return":{"type":"int","comment":"0 if ignore rules could be processed for the file (regardless of whether it exists or not), or an error < 0 if they could not."},"description":"<p>Test if the ignore rules apply to a given path.</p>\n","comments":"<p>This function checks the ignore rules to see if they would apply to the\ngiven file. This indicates if the file would be ignored regardless of\nwhether the file is already in the index or committed to the repository.</p>\n\n<p>One way to think of this is if you were to do &quot;git add .&quot; on the\ndirectory containing the file, would it be added or not?</p>\n","group":"ignore"},"git_index_open":{"type":"function","file":"index.h","line":126,"lineto":126,"args":[{"name":"out","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 **out, const char *index_path","sig":"git_index **::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create a new bare Git index object as a memory representation\nof the Git index file in &#39;index_path&#39;, without a repository\nto back it.</p>\n","comments":"<p>Since there is no ODB or working directory behind this index,\nany Index methods which rely on these (e.g. index_add) will\nfail with the GIT_EBAREINDEX error code.</p>\n\n<p>If you need to access the index of an actual repository,\nuse the <code>git_repository_index</code> wrapper.</p>\n\n<p>The index must be freed once it&#39;s no longer in use.</p>\n","group":"index"},"git_index_new":{"type":"function","file":"index.h","line":139,"lineto":139,"args":[{"name":"out","type":"git_index **","comment":"the pointer for the new index"}],"argline":"git_index **out","sig":"git_index **","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create an in-memory index object.</p>\n","comments":"<p>This index object cannot be read/written to the filesystem,\nbut may be used to perform in-memory index operations.</p>\n\n<p>The index must be freed once it&#39;s no longer in use.</p>\n","group":"index"},"git_index_free":{"type":"function","file":"index.h","line":146,"lineto":146,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"void"},"description":"<p>Free an existing index object.</p>\n","comments":"","group":"index","examples":{"general.c":["ex/v0.18.0/general.html#git_index_free-28"]}},"git_index_owner":{"type":"function","file":"index.h","line":154,"lineto":154,"args":[{"name":"index","type":"const git_index *","comment":"The index"}],"argline":"const git_index *index","sig":"const git_index *","return":{"type":"git_repository *","comment":"A pointer to the repository"},"description":"<p>Get the repository this index relates to</p>\n","comments":"","group":"index"},"git_index_caps":{"type":"function","file":"index.h","line":162,"lineto":162,"args":[{"name":"index","type":"const git_index *","comment":"An existing index object"}],"argline":"const git_index *index","sig":"const git_index *","return":{"type":"unsigned int","comment":"A combination of GIT_INDEXCAP values"},"description":"<p>Read index capabilities flags.</p>\n","comments":"","group":"index"},"git_index_set_caps":{"type":"function","file":"index.h","line":175,"lineto":175,"args":[{"name":"index","type":"git_index *","comment":"An existing index object"},{"name":"caps","type":"unsigned int","comment":"A combination of GIT_INDEXCAP values"}],"argline":"git_index *index, unsigned int caps","sig":"git_index *::unsigned int","return":{"type":"int","comment":"0 on success, -1 on failure"},"description":"<p>Set index capabilities flags.</p>\n","comments":"<p>If you pass <code>GIT_INDEXCAP_FROM_OWNER</code> for the caps, then the\ncapabilities will be read from the config of the owner object,\nlooking at <code>core.ignorecase</code>, <code>core.filemode</code>, <code>core.symlinks</code>.</p>\n","group":"index"},"git_index_read":{"type":"function","file":"index.h","line":184,"lineto":184,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Update the contents of an existing index object in memory\nby reading from the hard disk.</p>\n","comments":"","group":"index"},"git_index_write":{"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":"int","comment":"0 or an error code"},"description":"<p>Write an existing index object from memory back to disk\nusing an atomic file lock.</p>\n","comments":"","group":"index"},"git_index_read_tree":{"type":"function","file":"index.h","line":204,"lineto":204,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"tree","type":"const git_tree *","comment":"tree to read"}],"argline":"git_index *index, const git_tree *tree","sig":"git_index *::const git_tree *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Read a tree into the index file with stats</p>\n","comments":"<p>The current index contents will be replaced by the specified tree.</p>\n","group":"index"},"git_index_write_tree":{"type":"function","file":"index.h","line":225,"lineto":225,"args":[{"name":"out","type":"git_oid *","comment":"Pointer where to store the OID of the written tree"},{"name":"index","type":"git_index *","comment":"Index to write"}],"argline":"git_oid *out, git_index *index","sig":"git_oid *::git_index *","return":{"type":"int","comment":"0 on success, GIT_EUNMERGED when the index is not clean or an error code"},"description":"<p>Write the index as a tree</p>\n","comments":"<p>This method will scan the index and write a representation\nof its current state back to disk; it recursively creates\ntree objects for each of the subtrees stored in the index,\nbut only returns the OID of the root tree. This is the OID\nthat can be used e.g. to create a commit.</p>\n\n<p>The index instance cannot be bare, and needs to be associated\nto an existing repository.</p>\n\n<p>The index must not contain any file in conflict.</p>\n","group":"index"},"git_index_write_tree_to":{"type":"function","file":"index.h","line":242,"lineto":242,"args":[{"name":"out","type":"git_oid *","comment":"Pointer where to store OID of the the written tree"},{"name":"index","type":"git_index *","comment":"Index to write"},{"name":"repo","type":"git_repository *","comment":"Repository where to write the tree"}],"argline":"git_oid *out, git_index *index, git_repository *repo","sig":"git_oid *::git_index *::git_repository *","return":{"type":"int","comment":"0 on success, GIT_EUNMERGED when the index is not clean or an error code"},"description":"<p>Write the index as a tree to the given repository</p>\n","comments":"<p>This method will do the same as <code>git_index_write_tree</code>, but\nletting the user choose the repository where the tree will\nbe written.</p>\n\n<p>The index must not contain any file in conflict.</p>\n","group":"index"},"git_index_entrycount":{"type":"function","file":"index.h","line":261,"lineto":261,"args":[{"name":"index","type":"const git_index *","comment":"an existing index object"}],"argline":"const git_index *index","sig":"const git_index *","return":{"type":"size_t","comment":"integer of count of current entries"},"description":"<p>Get the count of entries currently in the index</p>\n","comments":"","group":"index","examples":{"general.c":["ex/v0.18.0/general.html#git_index_entrycount-29"]}},"git_index_clear":{"type":"function","file":"index.h","line":270,"lineto":270,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"void"},"description":"<p>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.</p>\n","comments":"","group":"index"},"git_index_get_byindex":{"type":"function","file":"index.h","line":285,"lineto":286,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"n","type":"size_t","comment":"the position of the entry"}],"argline":"git_index *index, size_t n","sig":"git_index *::size_t","return":{"type":"const git_index_entry *","comment":"a pointer to the entry; NULL if out of bounds"},"description":"<p>Get a pointer to one of the entries in the index</p>\n","comments":"<p>The values of this entry can be modified (except the path)\nand the changes will be written back to disk on the next\nwrite() call.</p>\n\n<p>The entry should not be freed by the caller.</p>\n","group":"index","examples":{"general.c":["ex/v0.18.0/general.html#git_index_get_byindex-30"]}},"git_index_get_bypath":{"type":"function","file":"index.h","line":302,"lineto":303,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"path to search"},{"name":"stage","type":"int","comment":"stage to search"}],"argline":"git_index *index, const char *path, int stage","sig":"git_index *::const char *::int","return":{"type":"const git_index_entry *","comment":"a pointer to the entry; NULL if it was not found"},"description":"<p>Get a pointer to one of the entries in the index</p>\n","comments":"<p>The values of this entry can be modified (except the path)\nand the changes will be written back to disk on the next\nwrite() call.</p>\n\n<p>The entry should not be freed by the caller.</p>\n","group":"index"},"git_index_remove":{"type":"function","file":"index.h","line":313,"lineto":313,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"path to search"},{"name":"stage","type":"int","comment":"stage to search"}],"argline":"git_index *index, const char *path, int stage","sig":"git_index *::const char *::int","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Remove an entry from the index</p>\n","comments":"","group":"index"},"git_index_remove_directory":{"type":"function","file":"index.h","line":323,"lineto":324,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"dir","type":"const char *","comment":"container directory path"},{"name":"stage","type":"int","comment":"stage to search"}],"argline":"git_index *index, const char *dir, int stage","sig":"git_index *::const char *::int","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Remove all entries from the index under a given directory</p>\n","comments":"","group":"index"},"git_index_add":{"type":"function","file":"index.h","line":340,"lineto":340,"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 or an error code"},"description":"<p>Add or update an index entry from an in-memory struct</p>\n","comments":"<p>If a previous index entry exists that has the same path and stage\nas the given &#39;source_entry&#39;, it will be replaced. Otherwise, the\n&#39;source_entry&#39; will be added.</p>\n\n<p>A full copy (including the &#39;path&#39; string) of the given\n&#39;source_entry&#39; will be inserted on the index.</p>\n","group":"index"},"git_index_entry_stage":{"type":"function","file":"index.h","line":353,"lineto":353,"args":[{"name":"entry","type":"const git_index_entry *","comment":"The entry"}],"argline":"const git_index_entry *entry","sig":"const git_index_entry *","return":{"type":"int"},"description":"<p>Return the stage number from a git index entry</p>\n","comments":"<p>This entry is calculated from the entry&#39;s flag\nattribute like this:</p>\n\n<p>(entry->flags &amp; GIT_IDXENTRY_STAGEMASK) &gt;&gt; GIT_IDXENTRY_STAGESHIFT</p>\n","group":"index"},"git_index_add_bypath":{"type":"function","file":"index.h","line":384,"lineto":384,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"filename to add"}],"argline":"git_index *index, const char *path","sig":"git_index *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Add or update an index entry from a file on disk</p>\n","comments":"<p>The file <code>path</code> must be relative to the repository&#39;s\nworking folder and must be readable.</p>\n\n<p>This method will fail in bare index instances.</p>\n\n<p>This forces the file to be added to the index, not looking\nat gitignore rules. Those rules can be evaluated through\nthe git_status APIs (in status.h) before calling this.</p>\n\n<p>If this file currently is the result of a merge conflict, this\nfile will no longer be marked as conflicting. The data about\nthe conflict will be moved to the &quot;resolve undo&quot; (REUC) section.</p>\n","group":"index"},"git_index_remove_bypath":{"type":"function","file":"index.h","line":400,"lineto":400,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"filename to remove"}],"argline":"git_index *index, const char *path","sig":"git_index *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Remove an index entry corresponding to a file on disk</p>\n","comments":"<p>The file <code>path</code> must be relative to the repository&#39;s\nworking folder. It may exist.</p>\n\n<p>If this file currently is the result of a merge conflict, this\nfile will no longer be marked as conflicting. The data about\nthe conflict will be moved to the &quot;resolve undo&quot; (REUC) section.</p>\n","group":"index"},"git_index_find":{"type":"function","file":"index.h","line":412,"lineto":412,"args":[{"name":"at_pos","type":"size_t *","comment":"the address to which the position of the index entry is written (optional)"},{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"path to search"}],"argline":"size_t *at_pos, git_index *index, const char *path","sig":"size_t *::git_index *::const char *","return":{"type":"int","comment":"a zero-based position in the index if found; GIT_ENOTFOUND otherwise"},"description":"<p>Find the first position of any entries which point to given\npath in the Git index.</p>\n","comments":"","group":"index"},"git_index_conflict_add":{"type":"function","file":"index.h","line":436,"lineto":440,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"ancestor_entry","type":"const git_index_entry *","comment":"the entry data for the ancestor of the conflict"},{"name":"our_entry","type":"const git_index_entry *","comment":"the entry data for our side of the merge conflict"},{"name":"their_entry","type":"const git_index_entry *","comment":"the entry data for their side of the merge conflict"}],"argline":"git_index *index,\n\tconst git_index_entry *ancestor_entry,\n\tconst git_index_entry *our_entry,\n\tconst git_index_entry *their_entry","sig":"git_index *::const git_index_entry *::const git_index_entry *::const git_index_entry *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Add or update index entries to represent a conflict</p>\n","comments":"<p>The entries are the entries from the tree included in the merge. Any\nentry may be null to indicate that that file was not present in the\ntrees during the merge. For example, ancestor_entry may be NULL to\nindicate that a file was added in both branches and must be resolved.</p>\n","group":"index"},"git_index_conflict_get":{"type":"function","file":"index.h","line":455,"lineto":455,"args":[{"name":"ancestor_out","type":"git_index_entry **","comment":"Pointer to store the ancestor entry"},{"name":"our_out","type":"git_index_entry **","comment":"Pointer to store the our entry"},{"name":"their_out","type":"git_index_entry **","comment":"Pointer to store the their entry"},{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"path to search"}],"argline":"git_index_entry **ancestor_out, git_index_entry **our_out, git_index_entry **their_out, git_index *index, const char *path","sig":"git_index_entry **::git_index_entry **::git_index_entry **::git_index *::const char *","return":{"type":"int"},"description":"<p>Get the index entries that represent a conflict of a single file.</p>\n","comments":"<p>The values of this entry can be modified (except the paths)\nand the changes will be written back to disk on the next\nwrite() call.</p>\n","group":"index"},"git_index_conflict_remove":{"type":"function","file":"index.h","line":463,"lineto":463,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"to search"}],"argline":"git_index *index, const char *path","sig":"git_index *::const char *","return":{"type":"int"},"description":"<p>Removes the index entries that represent a conflict of a single file.</p>\n","comments":"","group":"index"},"git_index_conflict_cleanup":{"type":"function","file":"index.h","line":470,"lineto":470,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"void"},"description":"<p>Remove all conflicts in the index (entries with a stage greater than 0.)</p>\n","comments":"","group":"index"},"git_index_has_conflicts":{"type":"function","file":"index.h","line":477,"lineto":477,"args":[{"name":"index","type":"const git_index *"}],"argline":"const git_index *index","sig":"const git_index *","return":{"type":"int","comment":"1 if at least one conflict is found, 0 otherwise."},"description":"<p>Determine if the index contains entries representing file conflicts.</p>\n","comments":"","group":"index"},"git_index_reuc_entrycount":{"type":"function","file":"index.h","line":494,"lineto":494,"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 resolve undo entries"},"description":"<p>Get the count of resolve undo entries currently in the index.</p>\n","comments":"","group":"index"},"git_index_reuc_find":{"type":"function","file":"index.h","line":505,"lineto":505,"args":[{"name":"at_pos","type":"size_t *","comment":"the address to which the position of the reuc entry is written (optional)"},{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"path to search"}],"argline":"size_t *at_pos, git_index *index, const char *path","sig":"size_t *::git_index *::const char *","return":{"type":"int","comment":"0 if found, < 0 otherwise (GIT_ENOTFOUND)"},"description":"<p>Finds the resolve undo entry that points to the given path in the Git\nindex.</p>\n","comments":"","group":"index"},"git_index_reuc_get_bypath":{"type":"function","file":"index.h","line":517,"lineto":517,"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":"const git_index_reuc_entry *","comment":"the resolve undo entry; NULL if not found"},"description":"<p>Get a resolve undo entry from the index.</p>\n","comments":"<p>The returned entry is read-only and should not be modified\nor freed by the caller.</p>\n","group":"index"},"git_index_reuc_get_byindex":{"type":"function","file":"index.h","line":529,"lineto":529,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"n","type":"size_t","comment":"the position of the entry"}],"argline":"git_index *index, size_t n","sig":"git_index *::size_t","return":{"type":"const git_index_reuc_entry *","comment":"a pointer to the resolve undo entry; NULL if out of bounds"},"description":"<p>Get a resolve undo entry from the index.</p>\n","comments":"<p>The returned entry is read-only and should not be modified\nor freed by the caller.</p>\n","group":"index"},"git_index_reuc_add":{"type":"function","file":"index.h","line":553,"lineto":556,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"filename to add"},{"name":"ancestor_mode","type":"int","comment":"mode of the ancestor file"},{"name":"ancestor_id","type":"git_oid *","comment":"oid of the ancestor file"},{"name":"our_mode","type":"int","comment":"mode of our file"},{"name":"our_id","type":"git_oid *","comment":"oid of our file"},{"name":"their_mode","type":"int","comment":"mode of their file"},{"name":"their_id","type":"git_oid *","comment":"oid of their file"}],"argline":"git_index *index, const char *path,\n\tint ancestor_mode, git_oid *ancestor_id,\n\tint our_mode, git_oid *our_id,\n\tint their_mode, git_oid *their_id","sig":"git_index *::const char *::int::git_oid *::int::git_oid *::int::git_oid *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Adds a resolve undo entry for a file based on the given parameters.</p>\n","comments":"<p>The resolve undo entry contains the OIDs of files that were involved\nin a merge conflict after the conflict has been resolved. This allows\nconflicts to be re-resolved later.</p>\n\n<p>If there exists a resolve undo entry for the given path in the index,\nit will be removed.</p>\n\n<p>This method will fail in bare index instances.</p>\n","group":"index"},"git_index_reuc_remove":{"type":"function","file":"index.h","line":565,"lineto":565,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"n","type":"size_t","comment":"position of the resolve undo entry to remove"}],"argline":"git_index *index, size_t n","sig":"git_index *::size_t","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Remove an resolve undo entry from the index</p>\n","comments":"","group":"index"},"git_index_reuc_clear":{"type":"function","file":"index.h","line":573,"lineto":573,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"void","comment":"0 or an error code"},"description":"<p>Remove all resolve undo entries from the index</p>\n","comments":"","group":"index"},"git_indexer_stream_new":{"type":"function","file":"indexer.h","line":46,"lineto":50,"args":[{"name":"out","type":"git_indexer_stream **","comment":"where to store the indexer instance"},{"name":"path","type":"const char *","comment":"to the directory where the packfile should be stored"},{"name":"progress_cb","type":"git_transfer_progress_callback","comment":"function to call with progress information"},{"name":"progress_cb_payload","type":"void *"}],"argline":"git_indexer_stream **out,\n\t\tconst char *path,\n\t\tgit_transfer_progress_callback progress_cb,\n\t\tvoid *progress_cb_payload","sig":"git_indexer_stream **::const char *::git_transfer_progress_callback::void *","return":{"type":"int"},"description":"<p>Create a new streaming indexer instance</p>\n","comments":"","group":"indexer","examples":{"network/index-pack.c":["ex/v0.18.0/network/index-pack.html#git_indexer_stream_new-1"]}},"git_indexer_stream_add":{"type":"function","file":"indexer.h","line":60,"lineto":60,"args":[{"name":"idx","type":"git_indexer_stream *","comment":"the indexer"},{"name":"data","type":"const void *","comment":"the data to add"},{"name":"size","type":"size_t","comment":"the size of the data in bytes"},{"name":"stats","type":"git_transfer_progress *","comment":"stat storage"}],"argline":"git_indexer_stream *idx, const void *data, size_t size, git_transfer_progress *stats","sig":"git_indexer_stream *::const void *::size_t::git_transfer_progress *","return":{"type":"int"},"description":"<p>Add data to the indexer</p>\n","comments":"","group":"indexer","examples":{"network/index-pack.c":["ex/v0.18.0/network/index-pack.html#git_indexer_stream_add-2"]}},"git_indexer_stream_finalize":{"type":"function","file":"indexer.h","line":69,"lineto":69,"args":[{"name":"idx","type":"git_indexer_stream *","comment":"the indexer"},{"name":"stats","type":"git_transfer_progress *"}],"argline":"git_indexer_stream *idx, git_transfer_progress *stats","sig":"git_indexer_stream *::git_transfer_progress *","return":{"type":"int"},"description":"<p>Finalize the pack and index</p>\n","comments":"<p>Resolve any pending deltas and write out the index file</p>\n","group":"indexer","examples":{"network/index-pack.c":["ex/v0.18.0/network/index-pack.html#git_indexer_stream_finalize-3"]}},"git_indexer_stream_hash":{"type":"function","file":"indexer.h","line":79,"lineto":79,"args":[{"name":"idx","type":"const git_indexer_stream *","comment":"the indexer instance"}],"argline":"const git_indexer_stream *idx","sig":"const git_indexer_stream *","return":{"type":"const git_oid *"},"description":"<p>Get the packfile&#39;s hash</p>\n","comments":"<p>A packfile&#39;s name is derived from the sorted hashing of all object\nnames. This is only correct after the index has been finalized.</p>\n","group":"indexer","examples":{"network/index-pack.c":["ex/v0.18.0/network/index-pack.html#git_indexer_stream_hash-4"]}},"git_indexer_stream_free":{"type":"function","file":"indexer.h","line":86,"lineto":90,"args":[{"name":"idx","type":"git_indexer_stream *","comment":"the indexer to free"}],"argline":"git_indexer_stream *idx","sig":"git_indexer_stream *","return":{"type":"void"},"description":"<p>Free the indexer and its resources</p>\n","comments":"","group":"indexer","examples":{"network/index-pack.c":["ex/v0.18.0/network/index-pack.html#git_indexer_stream_free-5"]}},"git_merge_base":{"type":"function","file":"merge.h","line":32,"lineto":36,"args":[{"name":"out","type":"git_oid *","comment":"the OID of a merge base between 'one' and 'two'"},{"name":"repo","type":"git_repository *","comment":"the repository where the commits exist"},{"name":"one","type":"const git_oid *","comment":"one of the commits"},{"name":"two","type":"const git_oid *","comment":"the other commit"}],"argline":"git_oid *out,\n\tgit_repository *repo,\n\tconst git_oid *one,\n\tconst git_oid *two","sig":"git_oid *::git_repository *::const git_oid *::const git_oid *","return":{"type":"int","comment":"Zero on success; GIT_ENOTFOUND or -1 on failure."},"description":"<p>Find a merge base between two commits</p>\n","comments":"","group":"merge"},"git_merge_base_many":{"type":"function","file":"merge.h","line":47,"lineto":51,"args":[{"name":"out","type":"git_oid *","comment":"the OID of a merge base considering all the commits"},{"name":"repo","type":"git_repository *","comment":"the repository where the commits exist"},{"name":"length","type":"size_t","comment":"The number of commits in the provided `input_array`"}],"argline":"git_oid *out,\n\tgit_repository *repo,\n\tconst git_oid input_array[],\n\tsize_t length","sig":"git_oid *::git_repository *::size_t","return":{"type":"int","comment":"Zero on success; GIT_ENOTFOUND or -1 on failure."},"description":"<p>Find a merge base given a list of commits</p>\n","comments":"","group":"merge"},"git_message_prettify":{"type":"function","file":"message.h","line":40,"lineto":44,"args":[{"name":"out","type":"char *","comment":"The user-allocated buffer which will be filled with the cleaned up message. Pass NULL if you just want to get the needed size of the prettified message as the output value."},{"name":"out_size","type":"size_t","comment":"Size of the `out` buffer in bytes."},{"name":"message","type":"const char *","comment":"The message to be prettified."},{"name":"strip_comments","type":"int","comment":"Non-zero to remove lines starting with \"#\", 0 to leave them in."}],"argline":"char *out,\n\tsize_t out_size,\n\tconst char *message,\n\tint strip_comments","sig":"char *::size_t::const char *::int","return":{"type":"int","comment":"-1 on error, else number of characters in prettified message including the trailing NUL byte"},"description":"<p>Clean up message from excess whitespace and make sure that the last line\nends with a &#39;\\n&#39;.</p>\n","comments":"<p>Optionally, can remove lines starting with a &quot;#&quot;.</p>\n","group":"message"},"git_note_iterator_new":{"type":"function","file":"notes.h","line":49,"lineto":52,"args":[{"name":"out","type":"git_note_iterator **","comment":"pointer to the iterator"},{"name":"repo","type":"git_repository *","comment":"repository where to look up the note"},{"name":"notes_ref","type":"const char *","comment":"canonical name of the reference to use (optional); defaults to \"refs/notes/commits\""}],"argline":"git_note_iterator **out,\n\tgit_repository *repo,\n\tconst char *notes_ref","sig":"git_note_iterator **::git_repository *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Creates a new iterator for notes</p>\n","comments":"<p>The iterator must be freed manually by the user.</p>\n","group":"note"},"git_note_iterator_free":{"type":"function","file":"notes.h","line":59,"lineto":59,"args":[{"name":"it","type":"git_note_iterator *","comment":"pointer to the iterator"}],"argline":"git_note_iterator *it","sig":"git_note_iterator *","return":{"type":"void"},"description":"<p>Frees an git_note_iterator</p>\n","comments":"","group":"note"},"git_note_next":{"type":"function","file":"notes.h","line":74,"lineto":77,"args":[{"name":"note_id","type":"git_oid*","comment":"id of blob containing the message"},{"name":"annotated_id","type":"git_oid*","comment":"id of the git object being annotated"},{"name":"it","type":"git_note_iterator *","comment":"pointer to the iterator"}],"argline":"git_oid* note_id,\n\tgit_oid* annotated_id,\n\tgit_note_iterator *it","sig":"git_oid*::git_oid*::git_note_iterator *","return":{"type":"int","comment":"0 (no error), GIT_ITEROVER (iteration is done) or an error code (negative value)"},"description":"<p>Returns the current item (note_id and annotated_id) and advance the iterator\ninternally to the next value</p>\n","comments":"<p>The notes must not be freed manually by the user.</p>\n","group":"note"},"git_note_read":{"type":"function","file":"notes.h","line":93,"lineto":97,"args":[{"name":"out","type":"git_note **","comment":"pointer to the read note; NULL in case of error"},{"name":"repo","type":"git_repository *","comment":"repository where to look up the note"},{"name":"notes_ref","type":"const char *","comment":"canonical name of the reference to use (optional); defaults to \"refs/notes/commits\""},{"name":"oid","type":"const git_oid *","comment":"OID of the git object to read the note from"}],"argline":"git_note **out,\n\tgit_repository *repo,\n\tconst char *notes_ref,\n\tconst git_oid *oid","sig":"git_note **::git_repository *::const char *::const git_oid *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Read the note for an object</p>\n","comments":"<p>The note must be freed manually by the user.</p>\n","group":"note"},"git_note_message":{"type":"function","file":"notes.h","line":105,"lineto":105,"args":[{"name":"note","type":"const git_note *","comment":""}],"argline":"const git_note *note","sig":"const git_note *","return":{"type":"const char *","comment":"the note message"},"description":"<p>Get the note message</p>\n","comments":"","group":"note"},"git_note_oid":{"type":"function","file":"notes.h","line":114,"lineto":114,"args":[{"name":"note","type":"const git_note *","comment":""}],"argline":"const git_note *note","sig":"const git_note *","return":{"type":"const git_oid *","comment":"the note object OID"},"description":"<p>Get the note object OID</p>\n","comments":"","group":"note"},"git_note_create":{"type":"function","file":"notes.h","line":131,"lineto":139,"args":[{"name":"out","type":"git_oid *","comment":"pointer to store the OID (optional); NULL in case of error"},{"name":"repo","type":"git_repository *","comment":"repository where to store the note"},{"name":"author","type":"const git_signature *","comment":"signature of the notes commit author"},{"name":"committer","type":"const git_signature *","comment":"signature of the notes commit committer"},{"name":"notes_ref","type":"const char *","comment":"canonical name of the reference to use (optional); defaults to \"refs/notes/commits\""},{"name":"oid","type":"const git_oid *","comment":"OID of the git object to decorate"},{"name":"note","type":"const char *","comment":"s_ref canonical name of the reference to use (optional); defaults to \"refs/notes/commits\""},{"name":"force","type":"int","comment":"Overwrite existing note"}],"argline":"git_oid *out,\n\tgit_repository *repo,\n\tconst git_signature *author,\n\tconst git_signature *committer,\n\tconst char *notes_ref,\n\tconst git_oid *oid,\n\tconst char *note,\n\tint force","sig":"git_oid *::git_repository *::const git_signature *::const git_signature *::const char *::const git_oid *::const char *::int","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Add a note for an object</p>\n","comments":"","group":"note"},"git_note_remove":{"type":"function","file":"notes.h","line":154,"lineto":159,"args":[{"name":"repo","type":"git_repository *","comment":"repository where the note lives"},{"name":"notes_ref","type":"const char *","comment":"canonical name of the reference to use (optional); defaults to \"refs/notes/commits\""},{"name":"author","type":"const git_signature *","comment":"signature of the notes commit author"},{"name":"committer","type":"const git_signature *","comment":"signature of the notes commit committer"},{"name":"oid","type":"const git_oid *","comment":"OID of the git object to remove the note from"}],"argline":"git_repository *repo,\n\tconst char *notes_ref,\n\tconst git_signature *author,\n\tconst git_signature *committer,\n\tconst git_oid *oid","sig":"git_repository *::const char *::const git_signature *::const git_signature *::const git_oid *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Remove the note for an object</p>\n","comments":"","group":"note"},"git_note_free":{"type":"function","file":"notes.h","line":166,"lineto":166,"args":[{"name":"note","type":"git_note *","comment":"git_note object"}],"argline":"git_note *note","sig":"git_note *","return":{"type":"void"},"description":"<p>Free a git_note object</p>\n","comments":"","group":"note"},"git_note_default_ref":{"type":"function","file":"notes.h","line":176,"lineto":176,"args":[{"name":"out","type":"const char **","comment":"Pointer to the default notes reference"},{"name":"repo","type":"git_repository *","comment":"The Git repository"}],"argline":"const char **out, git_repository *repo","sig":"const char **::git_repository *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Get the default notes reference for a repository</p>\n","comments":"","group":"note"},"git_note_foreach":{"type":"function","file":"notes.h","line":194,"lineto":198,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where to find the notes."},{"name":"notes_ref","type":"const char *","comment":"Reference to read from (optional); defaults to \"refs/notes/commits\"."},{"name":"note_cb","type":"git_note_foreach_cb","comment":"Callback to invoke per found annotation. Return non-zero to stop looping."},{"name":"payload","type":"void *","comment":"Extra parameter to callback function."}],"argline":"git_repository *repo,\n\tconst char *notes_ref,\n\tgit_note_foreach_cb note_cb,\n\tvoid *payload","sig":"git_repository *::const char *::git_note_foreach_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Loop over all the notes within a specified namespace\nand issue a callback for each one.</p>\n","comments":"","group":"note"},"git_object_lookup":{"type":"function","file":"object.h","line":41,"lineto":45,"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,\n\t\tgit_repository *repo,\n\t\tconst git_oid *id,\n\t\tgit_otype type","sig":"git_object **::git_repository *::const git_oid *::git_otype","return":{"type":"int","comment":"a reference to the object"},"description":"<p>Lookup a reference to one of the objects in a repository.</p>\n","comments":"<p>The generated reference is owned by the repository and\nshould be closed with the <code>git_object_free</code> method\ninstead of free&#39;d manually.</p>\n\n<p>The &#39;type&#39; parameter must match the type of the object\nin the odb; the method will fail otherwise.\nThe special value &#39;GIT_OBJ_ANY&#39; may be passed to let\nthe method guess the object&#39;s type.</p>\n","group":"object"},"git_object_lookup_prefix":{"type":"function","file":"object.h","line":74,"lineto":79,"args":[{"name":"object_out","type":"git_object **","comment":"pointer where to store the looked-up object"},{"name":"repo","type":"git_repository *","comment":"the repository to look up the object"},{"name":"id","type":"const git_oid *","comment":"a short identifier for the object"},{"name":"len","type":"size_t","comment":"the length of the short identifier"},{"name":"type","type":"git_otype","comment":"the type of the object"}],"argline":"git_object **object_out,\n\t\tgit_repository *repo,\n\t\tconst git_oid *id,\n\t\tsize_t len,\n\t\tgit_otype type","sig":"git_object **::git_repository *::const git_oid *::size_t::git_otype","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Lookup a reference to one of the objects in a repository,\ngiven a prefix of its identifier (short id).</p>\n","comments":"<p>The object obtained will be so that its identifier\nmatches the first &#39;len&#39; hexadecimal characters\n(packets of 4 bits) of the given &#39;id&#39;.\n&#39;len&#39; must be at least GIT_OID_MINPREFIXLEN, and\nlong enough to identify a unique object matching\nthe prefix; otherwise the method will fail.</p>\n\n<p>The generated reference is owned by the repository and\nshould be closed with the <code>git_object_free</code> method\ninstead of free&#39;d manually.</p>\n\n<p>The &#39;type&#39; parameter must match the type of the object\nin the odb; the method will fail otherwise.\nThe special value &#39;GIT_OBJ_ANY&#39; may be passed to let\nthe method guess the object&#39;s type.</p>\n","group":"object"},"git_object_id":{"type":"function","file":"object.h","line":87,"lineto":87,"args":[{"name":"obj","type":"const git_object *","comment":"the repository object"}],"argline":"const git_object *obj","sig":"const git_object *","return":{"type":"const git_oid *","comment":"the SHA1 id"},"description":"<p>Get the id (SHA1) of a repository object</p>\n","comments":"","group":"object"},"git_object_type":{"type":"function","file":"object.h","line":95,"lineto":95,"args":[{"name":"obj","type":"const git_object *","comment":"the repository object"}],"argline":"const git_object *obj","sig":"const git_object *","return":{"type":"git_otype","comment":"the object's type"},"description":"<p>Get the object type of an object</p>\n","comments":"","group":"object"},"git_object_owner":{"type":"function","file":"object.h","line":109,"lineto":109,"args":[{"name":"obj","type":"const git_object *","comment":"the object"}],"argline":"const git_object *obj","sig":"const git_object *","return":{"type":"git_repository *","comment":"the repository who owns this object"},"description":"<p>Get the repository that owns this object</p>\n","comments":"<p>Freeing or calling <code>git_repository_close</code> on the\nreturned pointer will invalidate the actual object.</p>\n\n<p>Any other operation may be run on the repository without\naffecting the object.</p>\n","group":"object"},"git_object_free":{"type":"function","file":"object.h","line":126,"lineto":126,"args":[{"name":"object","type":"git_object *","comment":"the object to close"}],"argline":"git_object *object","sig":"git_object *","return":{"type":"void"},"description":"<p>Close an open object</p>\n","comments":"<p>This method instructs the library to close an existing\nobject; note that git_objects are owned and cached by the repository\nso the object may or may not be freed after this library call,\ndepending on how aggressive is the caching mechanism used\nby the repository.</p>\n\n<p>IMPORTANT:\nIt <em>is</em> necessary to call this method when you stop using\nan object. Failure to do so will cause a memory leak.</p>\n","group":"object","examples":{"general.c":["ex/v0.18.0/general.html#git_object_free-31"]}},"git_object_type2string":{"type":"function","file":"object.h","line":137,"lineto":137,"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":"<p>Convert an object type to it&#39;s string representation.</p>\n","comments":"<p>The result is a pointer to a string in static memory and\nshould not be free()&#39;ed.</p>\n","group":"object","examples":{"general.c":["ex/v0.18.0/general.html#git_object_type2string-32"]}},"git_object_string2type":{"type":"function","file":"object.h","line":145,"lineto":145,"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":"<p>Convert a string object type representation to it&#39;s git_otype.</p>\n","comments":"","group":"object"},"git_object_typeisloose":{"type":"function","file":"object.h","line":154,"lineto":154,"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":"<p>Determine if the given git_otype is a valid loose object type.</p>\n","comments":"","group":"object"},"git_object__size":{"type":"function","file":"object.h","line":168,"lineto":168,"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":"<p>Get the size in bytes for the structure which\nacts as an in-memory representation of any given\nobject type.</p>\n","comments":"<p>For all the core types, this would the equivalent\nof calling <code>sizeof(git_commit)</code> if the core types\nwere not opaque on the external API.</p>\n","group":"object"},"git_object_peel":{"type":"function","file":"object.h","line":186,"lineto":189,"args":[{"name":"peeled","type":"git_object **","comment":"Pointer to the peeled git_object"},{"name":"object","type":"const git_object *","comment":"The object to be processed"},{"name":"target_type","type":"git_otype","comment":"The type of the requested object (GIT_OBJ_COMMIT, GIT_OBJ_TAG, GIT_OBJ_TREE, GIT_OBJ_BLOB or GIT_OBJ_ANY)."}],"argline":"git_object **peeled,\n\tconst git_object *object,\n\tgit_otype target_type","sig":"git_object **::const git_object *::git_otype","return":{"type":"int","comment":"0 on success, GIT_EAMBIGUOUS, GIT_ENOTFOUND or an error code"},"description":"<p>Recursively peel an object until an object of the specified type is met.</p>\n","comments":"<p>The retrieved <code>peeled</code> object is owned by the repository and should be\nclosed with the <code>git_object_free</code> method.</p>\n\n<p>If you pass <code>GIT_OBJ_ANY</code> as the target type, then the object will be\npeeled until the type changes (e.g. a tag will be chased until the\nreferenced object is no longer a tag).</p>\n","group":"object"},"git_object_dup":{"type":"function","file":"object.h","line":198,"lineto":198,"args":[{"name":"dest","type":"git_object **","comment":"Pointer to store the copy of the object"},{"name":"source","type":"git_object *","comment":"Original object to copy"}],"argline":"git_object **dest, git_object *source","sig":"git_object **::git_object *","return":{"type":"int"},"description":"<p>Create an in-memory copy of a Git object. The copy must be\nexplicitly free&#39;d or it will leak.</p>\n","comments":"","group":"object"},"git_odb_new":{"type":"function","file":"odb.h","line":35,"lineto":35,"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":"0 or an error code"},"description":"<p>Create a new object database with no backends.</p>\n","comments":"<p>Before the ODB can be used for read/writing, a custom database\nbackend must be manually added using <code>git_odb_add_backend()</code></p>\n","group":"odb"},"git_odb_open":{"type":"function","file":"odb.h","line":53,"lineto":53,"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":"0 or an error code"},"description":"<p>Create a new object database and automatically add\nthe two default backends:</p>\n","comments":"<ul>\n<li><p>git_odb_backend_loose: read and write loose object files\nfrom disk, assuming <code>objects_dir</code> as the Objects folder</p></li>\n<li><p>git_odb_backend_pack: read objects from packfiles,\nassuming <code>objects_dir</code> as the Objects folder which\ncontains a &#39;pack/&#39; folder with the corresponding data</p></li>\n</ul>\n","group":"odb"},"git_odb_add_backend":{"type":"function","file":"odb.h","line":68,"lineto":68,"args":[{"name":"odb","type":"git_odb *","comment":"database to add the backend to"},{"name":"backend","type":"git_odb_backend *","comment":"pointer to a git_odb_backend instance"},{"name":"priority","type":"int","comment":"Value for ordering the backends queue"}],"argline":"git_odb *odb, git_odb_backend *backend, int priority","sig":"git_odb *::git_odb_backend *::int","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"<p>Add a custom backend to an existing Object DB</p>\n","comments":"<p>The backends are checked in relative ordering, based on the\nvalue of the <code>priority</code> parameter.</p>\n\n<p>Read <odb_backends.h> for more information.</p>\n","group":"odb"},"git_odb_add_alternate":{"type":"function","file":"odb.h","line":89,"lineto":89,"args":[{"name":"odb","type":"git_odb *","comment":"database to add the backend to"},{"name":"backend","type":"git_odb_backend *","comment":"pointer to a git_odb_backend instance"},{"name":"priority","type":"int","comment":"Value for ordering the backends queue"}],"argline":"git_odb *odb, git_odb_backend *backend, int priority","sig":"git_odb *::git_odb_backend *::int","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"<p>Add a custom backend to an existing Object DB; this\nbackend will work as an alternate.</p>\n","comments":"<p>Alternate backends are always checked for objects <em>after</em>\nall the main backends have been exhausted.</p>\n\n<p>The backends are checked in relative ordering, based on the\nvalue of the <code>priority</code> parameter.</p>\n\n<p>Writing is disabled on alternate backends.</p>\n\n<p>Read <odb_backends.h> for more information.</p>\n","group":"odb"},"git_odb_add_disk_alternate":{"type":"function","file":"odb.h","line":106,"lineto":106,"args":[{"name":"odb","type":"git_odb *","comment":"database to add the backend to"},{"name":"path","type":"const char *","comment":"path to the objects folder for the alternate"}],"argline":"git_odb *odb, const char *path","sig":"git_odb *::const char *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"<p>Add an on-disk alternate to an existing Object DB.</p>\n","comments":"<p>Note that the added path must point to an <code>objects</code>, not\nto a full repository, to use it as an alternate store.</p>\n\n<p>Alternate backends are always checked for objects <em>after</em>\nall the main backends have been exhausted.</p>\n\n<p>Writing is disabled on alternate backends.</p>\n","group":"odb"},"git_odb_free":{"type":"function","file":"odb.h","line":113,"lineto":113,"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":"<p>Close an open object database.</p>\n","comments":"","group":"odb"},"git_odb_read":{"type":"function","file":"odb.h","line":132,"lineto":132,"args":[{"name":"out","type":"git_odb_object **","comment":"pointer where to store the read object"},{"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_odb_object **out, git_odb *db, const git_oid *id","sig":"git_odb_object **::git_odb *::const git_oid *","return":{"type":"int","comment":"- 0 if the object was read; - GIT_ENOTFOUND if the object is not in the database."},"description":"<p>Read an object from the database.</p>\n","comments":"<p>This method queries all available ODB backends\ntrying to read the given OID.</p>\n\n<p>The returned object is reference counted and\ninternally cached, so it should be closed\nby the user once it&#39;s no longer in use.</p>\n","group":"odb","examples":{"general.c":["ex/v0.18.0/general.html#git_odb_read-33"]}},"git_odb_read_prefix":{"type":"function","file":"odb.h","line":161,"lineto":161,"args":[{"name":"out","type":"git_odb_object **","comment":"pointer where to store the read object"},{"name":"db","type":"git_odb *","comment":"database to search for the object in."},{"name":"short_id","type":"const git_oid *","comment":"a prefix of the id of the object to read."},{"name":"len","type":"size_t","comment":"the length of the prefix"}],"argline":"git_odb_object **out, git_odb *db, const git_oid *short_id, size_t len","sig":"git_odb_object **::git_odb *::const git_oid *::size_t","return":{"type":"int","comment":"- 0 if the object was read; - GIT_ENOTFOUND if the object is not in the database. - GIT_EAMBIGUOUS if the prefix is ambiguous (several objects match the prefix)"},"description":"<p>Read an object from the database, given a prefix\nof its identifier.</p>\n","comments":"<p>This method queries all available ODB backends\ntrying to match the &#39;len&#39; first hexadecimal\ncharacters of the &#39;short_id&#39;.\nThe remaining (GIT_OID_HEXSZ-len)*4 bits of\n&#39;short_id&#39; must be 0s.\n&#39;len&#39; must be at least GIT_OID_MINPREFIXLEN,\nand the prefix must be long enough to identify\na unique object in all the backends; the\nmethod will fail otherwise.</p>\n\n<p>The returned object is reference counted and\ninternally cached, so it should be closed\nby the user once it&#39;s no longer in use.</p>\n","group":"odb"},"git_odb_read_header":{"type":"function","file":"odb.h","line":181,"lineto":181,"args":[{"name":"len_out","type":"size_t *","comment":"pointer where to store the length"},{"name":"type_out","type":"git_otype *","comment":"pointer where to store the type"},{"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":"size_t *len_out, git_otype *type_out, git_odb *db, const git_oid *id","sig":"size_t *::git_otype *::git_odb *::const git_oid *","return":{"type":"int","comment":"- 0 if the object was read; - GIT_ENOTFOUND if the object is not in the database."},"description":"<p>Read the header of an object from the database, without\nreading its full contents.</p>\n","comments":"<p>The header includes the length and the type of an object.</p>\n\n<p>Note that most backends do not support reading only the header\nof an object, so the whole object will be read and then the\nheader will be returned.</p>\n","group":"odb"},"git_odb_exists":{"type":"function","file":"odb.h","line":192,"lineto":192,"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":"- 1, if the object was found - 0, otherwise"},"description":"<p>Determine if the given object can be found in the object database.</p>\n","comments":"","group":"odb"},"git_odb_refresh":{"type":"function","file":"odb.h","line":212,"lineto":212,"args":[{"name":"db","type":"struct git_odb *","comment":"database to refresh"}],"argline":"struct git_odb *db","sig":"struct git_odb *","return":{"type":"int","comment":"0 on success, error code otherwise"},"description":"<p>Refresh the object database to load newly added files.</p>\n","comments":"<p>If the object databases have changed on disk while the library\nis running, this function will force a reload of the underlying\nindexes.</p>\n\n<p>Use this function when you&#39;re confident that an external\napplication has tampered with the ODB.</p>\n\n<p>NOTE that it is not necessary to call this function at all. The\nlibrary will automatically attempt to refresh the ODB\nwhen a lookup fails, to see if the looked up object exists\non disk but hasn&#39;t been loaded yet.</p>\n","group":"odb"},"git_odb_foreach":{"type":"function","file":"odb.h","line":227,"lineto":227,"args":[{"name":"db","type":"git_odb *","comment":"database to use"},{"name":"cb","type":"git_odb_foreach_cb","comment":"the callback to call for each object"},{"name":"payload","type":"void *","comment":"data to pass to the callback"}],"argline":"git_odb *db, git_odb_foreach_cb cb, void *payload","sig":"git_odb *::git_odb_foreach_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>List all objects available in the database</p>\n","comments":"<p>The callback will be called for each object available in the\ndatabase. Note that the objects are likely to be returned in the index\norder, which would make accessing the objects in that order inefficient.\nReturn a non-zero value from the callback to stop looping.</p>\n","group":"odb"},"git_odb_write":{"type":"function","file":"odb.h","line":247,"lineto":247,"args":[{"name":"out","type":"git_oid *","comment":"pointer to store the OID result of the write"},{"name":"odb","type":"git_odb *","comment":"object database where to store the object"},{"name":"data","type":"const void *","comment":"buffer with the data to store"},{"name":"len","type":"size_t","comment":"size of the buffer"},{"name":"type","type":"git_otype","comment":"type of the data to store"}],"argline":"git_oid *out, git_odb *odb, const void *data, size_t len, git_otype type","sig":"git_oid *::git_odb *::const void *::size_t::git_otype","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Write an object directly into the ODB</p>\n","comments":"<p>This method writes a full object straight into the ODB.\nFor most cases, it is preferred to write objects through a write\nstream, which is both faster and less memory intensive, specially\nfor big objects.</p>\n\n<p>This method is provided for compatibility with custom backends\nwhich are not able to support streaming writes</p>\n","group":"odb","examples":{"general.c":["ex/v0.18.0/general.html#git_odb_write-34"]}},"git_odb_open_wstream":{"type":"function","file":"odb.h","line":276,"lineto":276,"args":[{"name":"out","type":"git_odb_stream **","comment":"pointer where to store the stream"},{"name":"db","type":"git_odb *","comment":"object database where the stream will write"},{"name":"size","type":"size_t","comment":"final size of the object that will be written"},{"name":"type","type":"git_otype","comment":"type of the object that will be written"}],"argline":"git_odb_stream **out, git_odb *db, size_t size, git_otype type","sig":"git_odb_stream **::git_odb *::size_t::git_otype","return":{"type":"int","comment":"0 if the stream was created; error code otherwise"},"description":"<p>Open a stream to write an object into the ODB</p>\n","comments":"<p>The type and final length of the object must be specified\nwhen opening the stream.</p>\n\n<p>The returned stream will be of type <code>GIT_STREAM_WRONLY</code> and\nwill have the following methods:</p>\n\n<pre><code>- stream->write: write `n` bytes into the stream\n- stream->finalize_write: close the stream and store the object in\n the odb\n- stream->free: free the stream\n</code></pre>\n\n<p>The streaming write won&#39;t be effective until <code>stream->finalize_write</code>\nis called and returns without an error</p>\n\n<p>The stream must always be free&#39;d or will leak memory.</p>\n\n<p>@see git_odb_stream</p>\n","group":"odb"},"git_odb_open_rstream":{"type":"function","file":"odb.h","line":302,"lineto":302,"args":[{"name":"out","type":"git_odb_stream **","comment":"pointer where to store the stream"},{"name":"db","type":"git_odb *","comment":"object database where the stream will read from"},{"name":"oid","type":"const git_oid *","comment":"oid of the object the stream will read from"}],"argline":"git_odb_stream **out, git_odb *db, const git_oid *oid","sig":"git_odb_stream **::git_odb *::const git_oid *","return":{"type":"int","comment":"0 if the stream was created; error code otherwise"},"description":"<p>Open a stream to read an object from the ODB</p>\n","comments":"<p>Note that most backends do <em>not</em> support streaming reads\nbecause they store their objects as compressed/delta&#39;ed blobs.</p>\n\n<p>It&#39;s recommended to use <code>git_odb_read</code> instead, which is\nassured to work on all backends.</p>\n\n<p>The returned stream will be of type <code>GIT_STREAM_RDONLY</code> and\nwill have the following methods:</p>\n\n<pre><code>- stream->read: read `n` bytes from the stream\n- stream->free: free the stream\n</code></pre>\n\n<p>The stream must always be free&#39;d or will leak memory.</p>\n\n<p>@see git_odb_stream</p>\n","group":"odb"},"git_odb_write_pack":{"type":"function","file":"odb.h","line":322,"lineto":326,"args":[{"name":"out","type":"git_odb_writepack **","comment":"pointer to the writepack functions"},{"name":"db","type":"git_odb *","comment":"object database where the stream will read from"},{"name":"progress_cb","type":"git_transfer_progress_callback","comment":"function to call with progress information. Be aware that this is called inline with network and indexing operations, so performance may be affected."},{"name":"progress_payload","type":"void *","comment":"payload for the progress callback"}],"argline":"git_odb_writepack **out,\n\tgit_odb *db,\n\tgit_transfer_progress_callback progress_cb,\n\tvoid *progress_payload","sig":"git_odb_writepack **::git_odb *::git_transfer_progress_callback::void *","return":{"type":"int"},"description":"<p>Open a stream for writing a pack file to the ODB.</p>\n","comments":"<p>If the ODB layer understands pack files, then the given\npackfile will likely be streamed directly to disk (and a\ncorresponding index created). If the ODB layer does not\nunderstand pack files, the objects will be stored in whatever\nformat the ODB layer uses.</p>\n\n<p>@see git_odb_writepack</p>\n","group":"odb"},"git_odb_hash":{"type":"function","file":"odb.h","line":340,"lineto":340,"args":[{"name":"out","type":"git_oid *","comment":"the resulting object-ID."},{"name":"data","type":"const void *","comment":"data to hash"},{"name":"len","type":"size_t","comment":"size of the data"},{"name":"type","type":"git_otype","comment":"of the data to hash"}],"argline":"git_oid *out, const void *data, size_t len, git_otype type","sig":"git_oid *::const void *::size_t::git_otype","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Determine the object-ID (sha1 hash) of a data buffer</p>\n","comments":"<p>The resulting SHA-1 OID will be the identifier for the data\nbuffer as if the data buffer it were to written to the ODB.</p>\n","group":"odb"},"git_odb_hashfile":{"type":"function","file":"odb.h","line":355,"lineto":355,"args":[{"name":"out","type":"git_oid *","comment":"oid structure the result is written into."},{"name":"path","type":"const char *","comment":"file to read and determine object id for"},{"name":"type","type":"git_otype","comment":"the type of the object that will be hashed"}],"argline":"git_oid *out, const char *path, git_otype type","sig":"git_oid *::const char *::git_otype","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Read a file from disk and fill a git_oid with the object id\nthat the file would have if it were written to the Object\nDatabase as an object of the given type (w/o applying filters).\nSimilar functionality to git.git&#39;s <code>git hash-object</code> without\nthe <code>-w</code> flag, however, with the --no-filters flag.\nIf you need filters, see git_repository_hashfile.</p>\n","comments":"","group":"odb"},"git_odb_object_free":{"type":"function","file":"odb.h","line":365,"lineto":365,"args":[{"name":"object","type":"git_odb_object *","comment":"object to close"}],"argline":"git_odb_object *object","sig":"git_odb_object *","return":{"type":"void"},"description":"<p>Close an ODB object</p>\n","comments":"<p>This method must always be called once a <code>git_odb_object</code> is no\nlonger needed, otherwise memory will leak.</p>\n","group":"odb","examples":{"general.c":["ex/v0.18.0/general.html#git_odb_object_free-35"]}},"git_odb_object_id":{"type":"function","file":"odb.h","line":375,"lineto":375,"args":[{"name":"object","type":"git_odb_object *","comment":"the object"}],"argline":"git_odb_object *object","sig":"git_odb_object *","return":{"type":"const git_oid *","comment":"a pointer to the OID"},"description":"<p>Return the OID of an ODB object</p>\n","comments":"<p>This is the OID from which the object was read from</p>\n","group":"odb"},"git_odb_object_data":{"type":"function","file":"odb.h","line":388,"lineto":388,"args":[{"name":"object","type":"git_odb_object *","comment":"the object"}],"argline":"git_odb_object *object","sig":"git_odb_object *","return":{"type":"const void *","comment":"a pointer to the data"},"description":"<p>Return the data of an ODB object</p>\n","comments":"<p>This is the uncompressed, raw data as read from the ODB,\nwithout the leading header.</p>\n\n<p>This pointer is owned by the object and shall not be free&#39;d.</p>\n","group":"odb","examples":{"general.c":["ex/v0.18.0/general.html#git_odb_object_data-36"]}},"git_odb_object_size":{"type":"function","file":"odb.h","line":399,"lineto":399,"args":[{"name":"object","type":"git_odb_object *","comment":"the object"}],"argline":"git_odb_object *object","sig":"git_odb_object *","return":{"type":"size_t","comment":"the size"},"description":"<p>Return the size of an ODB object</p>\n","comments":"<p>This is the real size of the <code>data</code> buffer, not the\nactual size of the object.</p>\n","group":"odb","examples":{"general.c":["ex/v0.18.0/general.html#git_odb_object_size-37"]}},"git_odb_object_type":{"type":"function","file":"odb.h","line":407,"lineto":407,"args":[{"name":"object","type":"git_odb_object *","comment":"the object"}],"argline":"git_odb_object *object","sig":"git_odb_object *","return":{"type":"git_otype","comment":"the type"},"description":"<p>Return the type of an ODB object</p>\n","comments":"","group":"odb","examples":{"general.c":["ex/v0.18.0/general.html#git_odb_object_type-38"]}},"git_odb_backend_pack":{"type":"function","file":"odb_backend.h","line":143,"lineto":149,"args":[{"name":"out","type":"git_odb_backend **"},{"name":"objects_dir","type":"const char *"}],"argline":"git_odb_backend **out, const char *objects_dir","sig":"git_odb_backend **::const char *","return":{"type":"int"},"description":"<p>Constructors for in-box ODB backends.</p>\n","comments":"","group":"odb"},"git_oid_fromstr":{"type":"function","file":"oid.h","line":47,"lineto":47,"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":"0 or an error code"},"description":"<p>Parse a hex formatted object id into a git_oid.</p>\n","comments":"","group":"oid","examples":{"general.c":["ex/v0.18.0/general.html#git_oid_fromstr-39","ex/v0.18.0/general.html#git_oid_fromstr-40","ex/v0.18.0/general.html#git_oid_fromstr-41","ex/v0.18.0/general.html#git_oid_fromstr-42","ex/v0.18.0/general.html#git_oid_fromstr-43","ex/v0.18.0/general.html#git_oid_fromstr-44","ex/v0.18.0/general.html#git_oid_fromstr-45","ex/v0.18.0/general.html#git_oid_fromstr-46"]}},"git_oid_fromstrp":{"type":"function","file":"oid.h","line":57,"lineto":57,"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 at least 4 characters long and null-terminated."}],"argline":"git_oid *out, const char *str","sig":"git_oid *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Parse a hex formatted null-terminated string into a git_oid.</p>\n","comments":"","group":"oid"},"git_oid_fromstrn":{"type":"function","file":"oid.h","line":70,"lineto":70,"args":[{"name":"out","type":"git_oid *","comment":"oid structure the result is written into."},{"name":"str","type":"const char *","comment":"input hex string of at least size `length`"},{"name":"length","type":"size_t","comment":"length of the input string"}],"argline":"git_oid *out, const char *str, size_t length","sig":"git_oid *::const char *::size_t","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Parse N characters of a hex formatted object id into a git_oid</p>\n","comments":"<p>If N is odd, N-1 characters will be parsed instead.\nThe remaining space in the git_oid will be set to zero.</p>\n","group":"oid"},"git_oid_fromraw":{"type":"function","file":"oid.h","line":78,"lineto":78,"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":"<p>Copy an already raw oid into a git_oid structure.</p>\n","comments":"","group":"oid"},"git_oid_fmt":{"type":"function","file":"oid.h","line":90,"lineto":90,"args":[{"name":"out","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":"id","type":"const git_oid *"}],"argline":"char *out, const git_oid *id","sig":"char *::const git_oid *","return":{"type":"void"},"description":"<p>Format a git_oid into a hex string.</p>\n","comments":"","group":"oid","examples":{"general.c":["ex/v0.18.0/general.html#git_oid_fmt-47","ex/v0.18.0/general.html#git_oid_fmt-48","ex/v0.18.0/general.html#git_oid_fmt-49","ex/v0.18.0/general.html#git_oid_fmt-50","ex/v0.18.0/general.html#git_oid_fmt-51"],"network/fetch.c":["ex/v0.18.0/network/fetch.html#git_oid_fmt-1","ex/v0.18.0/network/fetch.html#git_oid_fmt-2"],"network/index-pack.c":["ex/v0.18.0/network/index-pack.html#git_oid_fmt-6"],"network/ls-remote.c":["ex/v0.18.0/network/ls-remote.html#git_oid_fmt-1"]}},"git_oid_pathfmt":{"type":"function","file":"oid.h","line":105,"lineto":105,"args":[{"name":"out","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":"id","type":"const git_oid *","comment":"oid structure to format."}],"argline":"char *out, const git_oid *id","sig":"char *::const git_oid *","return":{"type":"void"},"description":"<p>Format a git_oid into a loose-object path string.</p>\n","comments":"<p>The resulting string is &quot;aa/...&quot;, where &quot;aa&quot; is the first two\nhex digits of the oid and &quot;...&quot; is the remaining 38 digits.</p>\n","group":"oid"},"git_oid_allocfmt":{"type":"function","file":"oid.h","line":114,"lineto":114,"args":[{"name":"id","type":"const git_oid *"}],"argline":"const git_oid *id","sig":"const git_oid *","return":{"type":"char *","comment":"the c-string; NULL if memory is exhausted. Caller must deallocate the string with git__free()."},"description":"<p>Format a git_oid into a newly allocated c-string.</p>\n","comments":"","group":"oid"},"git_oid_tostr":{"type":"function","file":"oid.h","line":131,"lineto":131,"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":"id","type":"const git_oid *","comment":"the oid structure to format."}],"argline":"char *out, size_t n, const git_oid *id","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":"<p>Format a git_oid into a buffer as a hex format c-string.</p>\n","comments":"<p>If 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.</p>\n","group":"oid"},"git_oid_cpy":{"type":"function","file":"oid.h","line":139,"lineto":139,"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":"<p>Copy an oid from one structure to another.</p>\n","comments":"","group":"oid"},"git_oid_cmp":{"type":"function","file":"oid.h","line":148,"lineto":160,"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":"<p>Compare two oid structures.</p>\n","comments":"","group":"oid"},"git_oid_equal":{"type":"function","file":"oid.h","line":169,"lineto":172,"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":"true if equal, false otherwise"},"description":"<p>Compare two oid structures for equality</p>\n","comments":"","group":"oid"},"git_oid_ncmp":{"type":"function","file":"oid.h","line":183,"lineto":183,"args":[{"name":"a","type":"const git_oid *","comment":"first oid structure."},{"name":"b","type":"const git_oid *","comment":"second oid structure."},{"name":"len","type":"size_t","comment":"the number of hex chars to compare"}],"argline":"const git_oid *a, const git_oid *b, size_t len","sig":"const git_oid *::const git_oid *::size_t","return":{"type":"int","comment":"0 in case of a match"},"description":"<p>Compare the first &#39;len&#39; hexadecimal characters (packets of 4 bits)\nof two oid structures.</p>\n","comments":"","group":"oid"},"git_oid_streq":{"type":"function","file":"oid.h","line":193,"lineto":193,"args":[{"name":"id","type":"const git_oid *","comment":"oid structure."},{"name":"str","type":"const char *","comment":"input hex string of an object id."}],"argline":"const git_oid *id, const char *str","sig":"const git_oid *::const char *","return":{"type":"int","comment":"GIT_ENOTOID if str is not a valid hex string, 0 in case of a match, GIT_ERROR otherwise."},"description":"<p>Check if an oid equals an hex formatted object id.</p>\n","comments":"","group":"oid"},"git_oid_iszero":{"type":"function","file":"oid.h","line":200,"lineto":200,"args":[{"name":"id","type":"const git_oid *"}],"argline":"const git_oid *id","sig":"const git_oid *","return":{"type":"int","comment":"1 if all zeros, 0 otherwise."},"description":"<p>Check is an oid is all zeros.</p>\n","comments":"","group":"oid","examples":{"network/fetch.c":["ex/v0.18.0/network/fetch.html#git_oid_iszero-3"]}},"git_oid_shorten_new":{"type":"function","file":"oid.h","line":221,"lineto":221,"args":[{"name":"min_length","type":"size_t","comment":"The minimal length for all identifiers, which will be used even if shorter OIDs would still be unique."}],"argline":"size_t min_length","sig":"size_t","return":{"type":"git_oid_shorten *","comment":"a `git_oid_shorten` instance, NULL if OOM"},"description":"<p>Create a new OID shortener.</p>\n","comments":"<p>The OID shortener is used to process a list of OIDs\nin text form and return the shortest length that would\nuniquely identify all of them.</p>\n\n<p>E.g. look at the result of <code>git log --abbrev</code>.</p>\n","group":"oid"},"git_oid_shorten_add":{"type":"function","file":"oid.h","line":247,"lineto":247,"args":[{"name":"os","type":"git_oid_shorten *","comment":"a `git_oid_shorten` instance"},{"name":"text_id","type":"const char *","comment":"an OID in text form"}],"argline":"git_oid_shorten *os, const char *text_id","sig":"git_oid_shorten *::const char *","return":{"type":"int","comment":"the minimal length to uniquely identify all OIDs added so far to the set; or an error code (<0) if an error occurs."},"description":"<p>Add a new OID to set of shortened OIDs and calculate\nthe minimal length to uniquely identify all the OIDs in\nthe set.</p>\n","comments":"<p>The OID is expected to be a 40-char hexadecimal string.\nThe OID is owned by the user and will not be modified\nor freed.</p>\n\n<p>For performance reasons, there is a hard-limit of how many\nOIDs can be added to a single set (around ~22000, assuming\na mostly randomized distribution), which should be enough\nfor any kind of program, and keeps the algorithm fast and\nmemory-efficient.</p>\n\n<p>Attempting to add more than those OIDs will result in a\nGIT_ENOMEM error</p>\n","group":"oid"},"git_oid_shorten_free":{"type":"function","file":"oid.h","line":254,"lineto":254,"args":[{"name":"os","type":"git_oid_shorten *","comment":"a `git_oid_shorten` instance"}],"argline":"git_oid_shorten *os","sig":"git_oid_shorten *","return":{"type":"void"},"description":"<p>Free an OID shortener instance</p>\n","comments":"","group":"oid"},"git_packbuilder_new":{"type":"function","file":"pack.h","line":56,"lineto":56,"args":[{"name":"out","type":"git_packbuilder **","comment":"The new packbuilder object"},{"name":"repo","type":"git_repository *","comment":"The repository"}],"argline":"git_packbuilder **out, git_repository *repo","sig":"git_packbuilder **::git_repository *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Initialize a new packbuilder</p>\n","comments":"","group":"packbuilder"},"git_packbuilder_set_threads":{"type":"function","file":"pack.h","line":69,"lineto":69,"args":[{"name":"pb","type":"git_packbuilder *","comment":"The packbuilder"},{"name":"n","type":"unsigned int","comment":"Number of threads to spawn"}],"argline":"git_packbuilder *pb, unsigned int n","sig":"git_packbuilder *::unsigned int","return":{"type":"unsigned int","comment":"number of actual threads to be used"},"description":"<p>Set number of threads to spawn</p>\n","comments":"<p>By default, libgit2 won&#39;t spawn any threads at all;\nwhen set to 0, libgit2 will autodetect the number of\nCPUs.</p>\n","group":"packbuilder"},"git_packbuilder_insert":{"type":"function","file":"pack.h","line":83,"lineto":83,"args":[{"name":"pb","type":"git_packbuilder *","comment":"The packbuilder"},{"name":"id","type":"const git_oid *","comment":"The oid of the commit"},{"name":"name","type":"const char *","comment":"The name; might be NULL"}],"argline":"git_packbuilder *pb, const git_oid *id, const char *name","sig":"git_packbuilder *::const git_oid *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Insert a single object</p>\n","comments":"<p>For an optimal pack it&#39;s mandatory to insert objects in recency order,\ncommits followed by trees and blobs.</p>\n","group":"packbuilder"},"git_packbuilder_insert_tree":{"type":"function","file":"pack.h","line":95,"lineto":95,"args":[{"name":"pb","type":"git_packbuilder *","comment":"The packbuilder"},{"name":"id","type":"const git_oid *","comment":"The oid of the root tree"}],"argline":"git_packbuilder *pb, const git_oid *id","sig":"git_packbuilder *::const git_oid *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Insert a root tree object</p>\n","comments":"<p>This will add the tree as well as all referenced trees and blobs.</p>\n","group":"packbuilder"},"git_packbuilder_write":{"type":"function","file":"pack.h","line":105,"lineto":107,"args":[{"name":"pb","type":"git_packbuilder *","comment":"The packbuilder"},{"name":"file","type":"const char *"}],"argline":"git_packbuilder *pb, const char *file","sig":"git_packbuilder *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Write the new pack and the corresponding index to path</p>\n","comments":"","group":"packbuilder"},"git_packbuilder_foreach":{"type":"function","file":"pack.h","line":116,"lineto":116,"args":[{"name":"pb","type":"git_packbuilder *","comment":"the packbuilder"},{"name":"cb","type":"git_packbuilder_foreach_cb","comment":"the callback to call with each packed object's buffer"},{"name":"payload","type":"void *","comment":"the callback's data"}],"argline":"git_packbuilder *pb, git_packbuilder_foreach_cb cb, void *payload","sig":"git_packbuilder *::git_packbuilder_foreach_cb::void *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create the new pack and pass each object to the callback</p>\n","comments":"","group":"packbuilder"},"git_packbuilder_object_count":{"type":"function","file":"pack.h","line":124,"lineto":124,"args":[{"name":"pb","type":"git_packbuilder *","comment":"the packbuilder"}],"argline":"git_packbuilder *pb","sig":"git_packbuilder *","return":{"type":"uint32_t"},"description":"<p>Get the total number of objects the packbuilder will write out</p>\n","comments":"","group":"packbuilder"},"git_packbuilder_written":{"type":"function","file":"pack.h","line":132,"lineto":132,"args":[{"name":"pb","type":"git_packbuilder *","comment":"the packbuilder"}],"argline":"git_packbuilder *pb","sig":"git_packbuilder *","return":{"type":"uint32_t"},"description":"<p>Get the number of objects the packbuilder has already written out</p>\n","comments":"","group":"packbuilder"},"git_packbuilder_free":{"type":"function","file":"pack.h","line":139,"lineto":139,"args":[{"name":"pb","type":"git_packbuilder *","comment":"The packbuilder"}],"argline":"git_packbuilder *pb","sig":"git_packbuilder *","return":{"type":"void"},"description":"<p>Free the packbuilder and all associated data</p>\n","comments":"","group":"packbuilder"},"git_push_new":{"type":"function","file":"push.h","line":49,"lineto":49,"args":[{"name":"out","type":"git_push **","comment":"New push object"},{"name":"remote","type":"git_remote *","comment":"Remote instance"}],"argline":"git_push **out, git_remote *remote","sig":"git_push **::git_remote *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create a new push object</p>\n","comments":"","group":"push"},"git_push_set_options":{"type":"function","file":"push.h","line":59,"lineto":61,"args":[{"name":"push","type":"git_push *","comment":"The push object"},{"name":"opts","type":"const git_push_options *","comment":"The options to set on the push object"}],"argline":"git_push *push,\n\tconst git_push_options *opts","sig":"git_push *::const git_push_options *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Set options on a push object</p>\n","comments":"","group":"push"},"git_push_add_refspec":{"type":"function","file":"push.h","line":71,"lineto":71,"args":[{"name":"push","type":"git_push *","comment":"The push object"},{"name":"refspec","type":"const char *","comment":"Refspec string"}],"argline":"git_push *push, const char *refspec","sig":"git_push *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Add a refspec to be pushed</p>\n","comments":"","group":"push"},"git_push_update_tips":{"type":"function","file":"push.h","line":80,"lineto":80,"args":[{"name":"push","type":"git_push *","comment":"The push object"}],"argline":"git_push *push","sig":"git_push *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Update remote tips after a push</p>\n","comments":"","group":"push"},"git_push_finish":{"type":"function","file":"push.h","line":94,"lineto":94,"args":[{"name":"push","type":"git_push *","comment":"The push object"}],"argline":"git_push *push","sig":"git_push *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Actually push all given refspecs</p>\n","comments":"<p>Note: To check if the push was successful (i.e. all remote references\nhave been updated as requested), you need to call both\n<code>git_push_unpack_ok</code> and <code>git_push_status_foreach</code>. The remote\nrepository might have refused to update some or all of the references.</p>\n","group":"push"},"git_push_unpack_ok":{"type":"function","file":"push.h","line":103,"lineto":103,"args":[{"name":"push","type":"git_push *","comment":"The push object"}],"argline":"git_push *push","sig":"git_push *","return":{"type":"int","comment":"true if equal, false otherwise"},"description":"<p>Check if remote side successfully unpacked</p>\n","comments":"","group":"push"},"git_push_status_foreach":{"type":"function","file":"push.h","line":118,"lineto":120,"args":[{"name":"push","type":"git_push *","comment":"The push object"},{"name":"cb","type":"int (*)(const char *ref, const char *msg, void *data)","comment":"The callback to call on each object"},{"name":"data","type":"void *"}],"argline":"git_push *push,\n\t\t\tint (*cb)(const char *ref, const char *msg, void *data),\n\t\t\tvoid *data","sig":"git_push *::int (*)(const char *ref, const char *msg, void *data)::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Call callback `cb&#39; on each status</p>\n","comments":"<p>For each of the updated references, we receive a status report in the\nform of <code>ok refs/heads/master</code> or <code>ng refs/heads/master &lt;msg&gt;</code>.\n<code>msg != NULL</code> means the reference has not been updated for the given\nreason.</p>\n","group":"push"},"git_push_free":{"type":"function","file":"push.h","line":127,"lineto":127,"args":[{"name":"push","type":"git_push *","comment":"The push object"}],"argline":"git_push *push","sig":"git_push *","return":{"type":"void"},"description":"<p>Free the given push object</p>\n","comments":"","group":"push"},"git_reference__alloc":{"type":"function","file":"refdb.h","line":34,"lineto":38,"args":[{"name":"refdb","type":"git_refdb *","comment":"the reference database to associate with this reference"},{"name":"name","type":"const char *","comment":"the reference name"},{"name":"oid","type":"const git_oid *","comment":"the object id for a direct reference"},{"name":"symbolic","type":"const char *","comment":"the target for a symbolic reference"}],"argline":"git_refdb *refdb,\n\tconst char *name,\n\tconst git_oid *oid,\n\tconst char *symbolic","sig":"git_refdb *::const char *::const git_oid *::const char *","return":{"type":"git_reference *","comment":"the created git_reference or NULL on error"},"description":"<p>Create a new reference. Either an oid or a symbolic target must be\nspecified.</p>\n","comments":"","group":"reference"},"git_refdb_new":{"type":"function","file":"refdb.h","line":51,"lineto":51,"args":[{"name":"out","type":"git_refdb **","comment":"location to store the database pointer, if opened. Set to NULL if the open failed."},{"name":"repo","type":"git_repository *","comment":"the repository"}],"argline":"git_refdb **out, git_repository *repo","sig":"git_refdb **::git_repository *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create a new reference database with no backends.</p>\n","comments":"<p>Before the Ref DB can be used for read/writing, a custom database\nbackend must be manually set using <code>git_refdb_set_backend()</code></p>\n","group":"refdb"},"git_refdb_open":{"type":"function","file":"refdb.h","line":65,"lineto":65,"args":[{"name":"out","type":"git_refdb **","comment":"location to store the database pointer, if opened. Set to NULL if the open failed."},{"name":"repo","type":"git_repository *","comment":"the repository"}],"argline":"git_refdb **out, git_repository *repo","sig":"git_refdb **::git_repository *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create a new reference database and automatically add\nthe default backends:</p>\n","comments":"<ul>\n<li>git_refdb_dir: read and write loose and packed refs\n from disk, assuming the repository dir as the folder</li>\n</ul>\n","group":"refdb"},"git_refdb_compress":{"type":"function","file":"refdb.h","line":72,"lineto":72,"args":[{"name":"refdb","type":"git_refdb *"}],"argline":"git_refdb *refdb","sig":"git_refdb *","return":{"type":"int"},"description":"<p>Suggests that the given refdb compress or optimize its references.\nThis mechanism is implementation specific. For on-disk reference\ndatabases, for example, this may pack all loose references.</p>\n","comments":"","group":"refdb"},"git_refdb_free":{"type":"function","file":"refdb.h","line":79,"lineto":79,"args":[{"name":"refdb","type":"git_refdb *","comment":"reference database pointer or NULL"}],"argline":"git_refdb *refdb","sig":"git_refdb *","return":{"type":"void"},"description":"<p>Close an open reference database.</p>\n","comments":"","group":"refdb"},"git_refdb_set_backend":{"type":"function","file":"refdb.h","line":91,"lineto":93,"args":[{"name":"refdb","type":"git_refdb *","comment":"database to add the backend to"},{"name":"backend","type":"git_refdb_backend *","comment":"pointer to a git_refdb_backend instance"}],"argline":"git_refdb *refdb,\n\tgit_refdb_backend *backend","sig":"git_refdb *::git_refdb_backend *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"<p>Sets the custom backend to an existing reference DB</p>\n","comments":"<p>Read <refdb_backends.h> for more information.</p>\n","group":"refdb"},"git_refdb_backend_fs":{"type":"function","file":"refdb_backend.h","line":102,"lineto":109,"args":[{"name":"backend_out","type":"struct git_refdb_backend **"},{"name":"repo","type":"git_repository *"},{"name":"refdb","type":"git_refdb *"}],"argline":"struct git_refdb_backend **backend_out,\n\tgit_repository *repo,\n\tgit_refdb *refdb","sig":"struct git_refdb_backend **::git_repository *::git_refdb *","return":{"type":"int"},"description":"<p>Constructors for default refdb backends.</p>\n","comments":"","group":"refdb"},"git_reflog_read":{"type":"function","file":"reflog.h","line":37,"lineto":37,"args":[{"name":"out","type":"git_reflog **","comment":"pointer to reflog"},{"name":"ref","type":"const git_reference *","comment":"reference to read the reflog for"}],"argline":"git_reflog **out, const git_reference *ref","sig":"git_reflog **::const git_reference *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Read the reflog for the given reference</p>\n","comments":"<p>If there is no reflog file for the given\nreference yet, an empty reflog object will\nbe returned.</p>\n\n<p>The reflog must be freed manually by using\ngit_reflog_free().</p>\n","group":"reflog"},"git_reflog_write":{"type":"function","file":"reflog.h","line":46,"lineto":46,"args":[{"name":"reflog","type":"git_reflog *","comment":"an existing reflog object"}],"argline":"git_reflog *reflog","sig":"git_reflog *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Write an existing in-memory reflog object back to disk\nusing an atomic file lock.</p>\n","comments":"","group":"reflog"},"git_reflog_append":{"type":"function","file":"reflog.h","line":59,"lineto":59,"args":[{"name":"reflog","type":"git_reflog *","comment":"an existing reflog object"},{"name":"id","type":"const git_oid *","comment":"the OID the reference is now pointing to"},{"name":"committer","type":"const git_signature *","comment":"the signature of the committer"},{"name":"msg","type":"const char *","comment":"the reflog message"}],"argline":"git_reflog *reflog, const git_oid *id, const git_signature *committer, const char *msg","sig":"git_reflog *::const git_oid *::const git_signature *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Add a new entry to the reflog.</p>\n","comments":"<p><code>msg</code> is optional and can be NULL.</p>\n","group":"reflog"},"git_reflog_rename":{"type":"function","file":"reflog.h","line":73,"lineto":73,"args":[{"name":"ref","type":"git_reference *","comment":"the reference"},{"name":"name","type":"const char *","comment":"the new name of the reference"}],"argline":"git_reference *ref, const char *name","sig":"git_reference *::const char *","return":{"type":"int","comment":"0 on success, GIT_EINVALIDSPEC or an error code"},"description":"<p>Rename the reflog for the given reference</p>\n","comments":"<p>The reflog to be renamed is expected to already exist</p>\n\n<p>The new name will be checked for validity.\nSee <code>git_reference_create_symbolic()</code> for rules about valid names.</p>\n","group":"reflog"},"git_reflog_delete":{"type":"function","file":"reflog.h","line":81,"lineto":81,"args":[{"name":"ref","type":"git_reference *","comment":"the reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Delete the reflog for the given reference</p>\n","comments":"","group":"reflog"},"git_reflog_entrycount":{"type":"function","file":"reflog.h","line":89,"lineto":89,"args":[{"name":"reflog","type":"git_reflog *","comment":"the previously loaded reflog"}],"argline":"git_reflog *reflog","sig":"git_reflog *","return":{"type":"size_t","comment":"the number of log entries"},"description":"<p>Get the number of log entries in a reflog</p>\n","comments":"","group":"reflog"},"git_reflog_entry_byindex":{"type":"function","file":"reflog.h","line":102,"lineto":102,"args":[{"name":"reflog","type":"git_reflog *","comment":"a previously loaded reflog"},{"name":"idx","type":"size_t","comment":"the position of the entry to lookup. Should be greater than or equal to 0 (zero) and less than `git_reflog_entrycount()`."}],"argline":"git_reflog *reflog, size_t idx","sig":"git_reflog *::size_t","return":{"type":"const git_reflog_entry *","comment":"the entry; NULL if not found"},"description":"<p>Lookup an entry by its index</p>\n","comments":"<p>Requesting the reflog entry with an index of 0 (zero) will\nreturn the most recently created entry.</p>\n","group":"reflog"},"git_reflog_drop":{"type":"function","file":"reflog.h","line":121,"lineto":124,"args":[{"name":"reflog","type":"git_reflog *","comment":"a previously loaded reflog."},{"name":"idx","type":"size_t","comment":"the position of the entry to remove. Should be greater than or equal to 0 (zero) and less than `git_reflog_entrycount()`."},{"name":"rewrite_previous_entry","type":"int","comment":"1 to rewrite the history; 0 otherwise."}],"argline":"git_reflog *reflog,\n\tsize_t idx,\n\tint rewrite_previous_entry","sig":"git_reflog *::size_t::int","return":{"type":"int","comment":"0 on success, GIT_ENOTFOUND if the entry doesn't exist or an error code."},"description":"<p>Remove an entry from the reflog by its index</p>\n","comments":"<p>To ensure there&#39;s no gap in the log history, set <code>rewrite_previous_entry</code>\nparam value to 1. When deleting entry <code>n</code>, member old_oid of entry <code>n-1</code>\n(if any) will be updated with the value of member new_oid of entry <code>n+1</code>.</p>\n","group":"reflog"},"git_reflog_entry_id_old":{"type":"function","file":"reflog.h","line":132,"lineto":132,"args":[{"name":"entry","type":"const git_reflog_entry *","comment":"a reflog entry"}],"argline":"const git_reflog_entry *entry","sig":"const git_reflog_entry *","return":{"type":"const git_oid *","comment":"the old oid"},"description":"<p>Get the old oid</p>\n","comments":"","group":"reflog"},"git_reflog_entry_id_new":{"type":"function","file":"reflog.h","line":140,"lineto":140,"args":[{"name":"entry","type":"const git_reflog_entry *","comment":"a reflog entry"}],"argline":"const git_reflog_entry *entry","sig":"const git_reflog_entry *","return":{"type":"const git_oid *","comment":"the new oid at this time"},"description":"<p>Get the new oid</p>\n","comments":"","group":"reflog"},"git_reflog_entry_committer":{"type":"function","file":"reflog.h","line":148,"lineto":148,"args":[{"name":"entry","type":"const git_reflog_entry *","comment":"a reflog entry"}],"argline":"const git_reflog_entry *entry","sig":"const git_reflog_entry *","return":{"type":"const git_signature *","comment":"the committer"},"description":"<p>Get the committer of this entry</p>\n","comments":"","group":"reflog"},"git_reflog_entry_message":{"type":"function","file":"reflog.h","line":156,"lineto":156,"args":[{"name":"entry","type":"const git_reflog_entry *","comment":"a reflog entry"}],"argline":"const git_reflog_entry *entry","sig":"const git_reflog_entry *","return":{"type":"const char *","comment":"the log msg"},"description":"<p>Get the log message</p>\n","comments":"","group":"reflog"},"git_reflog_free":{"type":"function","file":"reflog.h","line":163,"lineto":163,"args":[{"name":"reflog","type":"git_reflog *","comment":"reflog to free"}],"argline":"git_reflog *reflog","sig":"git_reflog *","return":{"type":"void"},"description":"<p>Free the reflog</p>\n","comments":"","group":"reflog"},"git_reference_lookup":{"type":"function","file":"refs.h","line":37,"lineto":37,"args":[{"name":"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, refs/heads/master, refs/tags/v0.1.0, ...)"}],"argline":"git_reference **out, git_repository *repo, const char *name","sig":"git_reference **::git_repository *::const char *","return":{"type":"int","comment":"0 on success, ENOTFOUND, EINVALIDSPEC or an error code."},"description":"<p>Lookup a reference by name in a repository.</p>\n","comments":"<p>The returned reference must be freed by the user.</p>\n\n<p>The name will be checked for validity.\nSee <code>git_reference_create_symbolic()</code> for rules about valid names.</p>\n","group":"reference","examples":{"general.c":["ex/v0.18.0/general.html#git_reference_lookup-52"]}},"git_reference_name_to_id":{"type":"function","file":"refs.h","line":54,"lineto":55,"args":[{"name":"out","type":"git_oid *","comment":"Pointer to oid to be filled in"},{"name":"repo","type":"git_repository *","comment":"The repository in which to look up the reference"},{"name":"name","type":"const char *","comment":"The long name for the reference"}],"argline":"git_oid *out, git_repository *repo, const char *name","sig":"git_oid *::git_repository *::const char *","return":{"type":"int","comment":"0 on success, ENOTFOUND, EINVALIDSPEC or an error code."},"description":"<p>Lookup a reference by name and resolve immediately to OID.</p>\n","comments":"<p>This function provides a quick way to resolve a reference name straight\nthrough to the object id that it refers to. This avoids having to\nallocate or free any <code>git_reference</code> objects for simple situations.</p>\n\n<p>The name will be checked for validity.\nSee <code>git_reference_symbolic_create()</code> for rules about valid names.</p>\n","group":"reference"},"git_reference_symbolic_create":{"type":"function","file":"refs.h","line":86,"lineto":86,"args":[{"name":"out","type":"git_reference **","comment":"Pointer to the newly created reference"},{"name":"repo","type":"git_repository *","comment":"Repository where that reference will live"},{"name":"name","type":"const char *","comment":"The name of the reference"},{"name":"target","type":"const char *","comment":"The target of the reference"},{"name":"force","type":"int","comment":"Overwrite existing references"}],"argline":"git_reference **out, git_repository *repo, const char *name, const char *target, int force","sig":"git_reference **::git_repository *::const char *::const char *::int","return":{"type":"int","comment":"0 on success, EEXISTS, EINVALIDSPEC or an error code"},"description":"<p>Create a new symbolic reference.</p>\n","comments":"<p>A symbolic reference is a reference name that refers to another\nreference name. If the other name moves, the symbolic name will move,\ntoo. As a simple example, the &quot;HEAD&quot; reference might refer to\n&quot;refs/heads/master&quot; while on the &quot;master&quot; branch of a repository.</p>\n\n<p>The symbolic reference will be created in the repository and written to\nthe disk. The generated reference object must be freed by the user.</p>\n\n<p>Valid reference names must follow one of two patterns:</p>\n\n<ol>\n<li>Top-level names must contain only capital letters and underscores,\nand must begin and end with a letter. (e.g. &quot;HEAD&quot;, &quot;ORIG_HEAD&quot;).</li>\n<li>Names prefixed with &quot;refs/&quot; can be almost anything. You must avoid\nthe characters &#39;~&#39;, &#39;^&#39;, &#39;:&#39;, &#39;\\&#39;, &#39;?&#39;, &#39;[&#39;, and &#39;*&#39;, and the\nsequences &quot;..&quot; and &quot;@{&quot; which have special meaning to revparse.</li>\n</ol>\n\n<p>This function will return an error if a reference already exists with the\ngiven name unless <code>force</code> is true, in which case it will be overwritten.</p>\n","group":"reference"},"git_reference_create":{"type":"function","file":"refs.h","line":118,"lineto":118,"args":[{"name":"out","type":"git_reference **","comment":"Pointer to the newly created reference"},{"name":"repo","type":"git_repository *","comment":"Repository where that reference will live"},{"name":"name","type":"const char *","comment":"The name of the reference"},{"name":"id","type":"const git_oid *","comment":"The object id pointed to by the reference."},{"name":"force","type":"int","comment":"Overwrite existing references"}],"argline":"git_reference **out, git_repository *repo, const char *name, const git_oid *id, int force","sig":"git_reference **::git_repository *::const char *::const git_oid *::int","return":{"type":"int","comment":"0 on success, EEXISTS, EINVALIDSPEC or an error code"},"description":"<p>Create a new direct reference.</p>\n","comments":"<p>A direct reference (also called an object id reference) refers directly\nto a specific object id (a.k.a. OID or SHA) in the repository. The id\npermanently refers to the object (although the reference itself can be\nmoved). For example, in libgit2 the direct ref &quot;refs/tags/v0.17.0&quot;\nrefers to OID 5b9fac39d8a76b9139667c26a63e6b3f204b3977.</p>\n\n<p>The direct reference will be created in the repository and written to\nthe disk. The generated reference object must be freed by the user.</p>\n\n<p>Valid reference names must follow one of two patterns:</p>\n\n<ol>\n<li>Top-level names must contain only capital letters and underscores,\nand must begin and end with a letter. (e.g. &quot;HEAD&quot;, &quot;ORIG_HEAD&quot;).</li>\n<li>Names prefixed with &quot;refs/&quot; can be almost anything. You must avoid\nthe characters &#39;~&#39;, &#39;^&#39;, &#39;:&#39;, &#39;\\&#39;, &#39;?&#39;, &#39;[&#39;, and &#39;*&#39;, and the\nsequences &quot;..&quot; and &quot;@{&quot; which have special meaning to revparse.</li>\n</ol>\n\n<p>This function will return an error if a reference already exists with the\ngiven name unless <code>force</code> is true, in which case it will be overwritten.</p>\n","group":"reference"},"git_reference_target":{"type":"function","file":"refs.h","line":133,"lineto":133,"args":[{"name":"ref","type":"const git_reference *","comment":"The reference"}],"argline":"const git_reference *ref","sig":"const git_reference *","return":{"type":"const git_oid *","comment":"a pointer to the oid if available, NULL otherwise"},"description":"<p>Get the OID pointed to by a direct reference.</p>\n","comments":"<p>Only available if the reference is direct (i.e. an object id reference,\nnot a symbolic one).</p>\n\n<p>To find the OID of a symbolic ref, call <code>git_reference_resolve()</code> and\nthen this function (or maybe use <code>git_reference_name_to_id()</code> to\ndirectly resolve a reference name all the way through to an OID).</p>\n","group":"reference","examples":{"general.c":["ex/v0.18.0/general.html#git_reference_target-53"]}},"git_reference_symbolic_target":{"type":"function","file":"refs.h","line":143,"lineto":143,"args":[{"name":"ref","type":"const git_reference *","comment":"The reference"}],"argline":"const git_reference *ref","sig":"const git_reference *","return":{"type":"const char *","comment":"a pointer to the name if available, NULL otherwise"},"description":"<p>Get full name to the reference pointed to by a symbolic reference.</p>\n","comments":"<p>Only available if the reference is symbolic.</p>\n","group":"reference","examples":{"general.c":["ex/v0.18.0/general.html#git_reference_symbolic_target-54"]}},"git_reference_type":{"type":"function","file":"refs.h","line":153,"lineto":153,"args":[{"name":"ref","type":"const git_reference *","comment":"The reference"}],"argline":"const git_reference *ref","sig":"const git_reference *","return":{"type":"git_ref_t","comment":"the type"},"description":"<p>Get the type of a reference.</p>\n","comments":"<p>Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC)</p>\n","group":"reference","examples":{"general.c":["ex/v0.18.0/general.html#git_reference_type-55"]}},"git_reference_name":{"type":"function","file":"refs.h","line":163,"lineto":163,"args":[{"name":"ref","type":"const git_reference *","comment":"The reference"}],"argline":"const git_reference *ref","sig":"const git_reference *","return":{"type":"const char *","comment":"the full name for the ref"},"description":"<p>Get the full name of a reference.</p>\n","comments":"<p>See <code>git_reference_create_symbolic()</code> for rules about valid names.</p>\n","group":"reference"},"git_reference_resolve":{"type":"function","file":"refs.h","line":181,"lineto":181,"args":[{"name":"out","type":"git_reference **"},{"name":"ref","type":"const git_reference *","comment":"The reference"}],"argline":"git_reference **out, const git_reference *ref","sig":"git_reference **::const git_reference *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Resolve a symbolic reference to a direct reference.</p>\n","comments":"<p>This method iteratively peels a symbolic reference until it resolves to\na direct reference to an OID.</p>\n\n<p>The peeled reference is returned in the <code>resolved_ref</code> argument, and\nmust be freed manually once it&#39;s no longer needed.</p>\n\n<p>If a direct reference is passed as an argument, a copy of that\nreference is returned. This copy must be manually freed too.</p>\n","group":"reference"},"git_reference_owner":{"type":"function","file":"refs.h","line":189,"lineto":189,"args":[{"name":"ref","type":"const git_reference *","comment":"The reference"}],"argline":"const git_reference *ref","sig":"const git_reference *","return":{"type":"git_repository *","comment":"a pointer to the repo"},"description":"<p>Get the repository where a reference resides.</p>\n","comments":"","group":"reference"},"git_reference_symbolic_set_target":{"type":"function","file":"refs.h","line":206,"lineto":209,"args":[{"name":"out","type":"git_reference **","comment":"Pointer to the newly created reference"},{"name":"ref","type":"git_reference *","comment":"The reference"},{"name":"target","type":"const char *","comment":"The new target for the reference"}],"argline":"git_reference **out,\n\tgit_reference *ref,\n\tconst char *target","sig":"git_reference **::git_reference *::const char *","return":{"type":"int","comment":"0 on success, EINVALIDSPEC or an error code"},"description":"<p>Create a new reference with the same name as the given reference but a\ndifferent symbolic target. The reference must be a symbolic reference,\notherwise this will fail.</p>\n","comments":"<p>The new reference will be written to disk, overwriting the given reference.</p>\n\n<p>The target name will be checked for validity.\nSee <code>git_reference_create_symbolic()</code> for rules about valid names.</p>\n","group":"reference"},"git_reference_set_target":{"type":"function","file":"refs.h","line":223,"lineto":226,"args":[{"name":"out","type":"git_reference **","comment":"Pointer to the newly created reference"},{"name":"ref","type":"git_reference *","comment":"The reference"},{"name":"id","type":"const git_oid *","comment":"The new target OID for the reference"}],"argline":"git_reference **out,\n\tgit_reference *ref,\n\tconst git_oid *id","sig":"git_reference **::git_reference *::const git_oid *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create a new reference with the same name as the given reference but a\ndifferent OID target. The reference must be a direct reference, otherwise\nthis will fail.</p>\n","comments":"<p>The new reference will be written to disk, overwriting the given reference.</p>\n","group":"reference"},"git_reference_rename":{"type":"function","file":"refs.h","line":255,"lineto":259,"args":[{"name":"out","type":"git_reference **"},{"name":"ref","type":"git_reference *","comment":"The reference to rename"},{"name":"new_name","type":"const char *"},{"name":"force","type":"int","comment":"Overwrite an existing reference"}],"argline":"git_reference **out,\n\tgit_reference *ref,\n\tconst char *new_name,\n\tint force","sig":"git_reference **::git_reference *::const char *::int","return":{"type":"int","comment":"0 on success, EINVALIDSPEC, EEXISTS or an error code"},"description":"<p>Rename an existing reference.</p>\n","comments":"<p>This method works for both direct and symbolic references.</p>\n\n<p>The new name will be checked for validity.\nSee <code>git_reference_create_symbolic()</code> for rules about valid names.</p>\n\n<p>On success, the given git_reference will be deleted from disk and a\nnew <code>git_reference</code> will be returned.</p>\n\n<p>The reference will be immediately renamed in-memory and on disk.</p>\n\n<p>If the <code>force</code> flag is not enabled, and there&#39;s already\na reference with the given name, the renaming will fail.</p>\n\n<p>IMPORTANT:\nThe user needs to write a proper reflog entry if the\nreflog is enabled for the repository. We only rename\nthe reflog if it exists.</p>\n","group":"reference"},"git_reference_delete":{"type":"function","file":"refs.h","line":271,"lineto":271,"args":[{"name":"ref","type":"git_reference *","comment":"The reference to remove"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Delete an existing reference.</p>\n","comments":"<p>This method works for both direct and symbolic references. The reference\nwill be immediately removed on disk but the memory will not be freed.\nCallers must call <code>git_reference_free</code>.</p>\n","group":"reference"},"git_reference_list":{"type":"function","file":"refs.h","line":292,"lineto":294,"args":[{"name":"array","type":"git_strarray *","comment":"Pointer to a git_strarray structure where the reference names will be stored"},{"name":"repo","type":"git_repository *","comment":"Repository where to find the refs"},{"name":"list_flags","type":"unsigned int","comment":"Filtering flags for the reference listing"}],"argline":"git_strarray *array, git_repository *repo, unsigned int list_flags","sig":"git_strarray *::git_repository *::unsigned int","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Fill a list with all the references that can be found in a repository.</p>\n","comments":"<p>Using the <code>list_flags</code> parameter, the listed references may be filtered\nby type (<code>GIT_REF_OID</code> or <code>GIT_REF_SYMBOLIC</code>) or using a bitwise OR of\n<code>git_ref_t</code> values. To include packed refs, include <code>GIT_REF_PACKED</code>.\nFor convenience, use the value <code>GIT_REF_LISTALL</code> to obtain all\nreferences, including packed ones.</p>\n\n<p>The string array will be filled with the names of all references; these\nvalues are owned by the user and should be free&#39;d manually when no\nlonger needed, using <code>git_strarray_free()</code>.</p>\n","group":"reference","examples":{"general.c":["ex/v0.18.0/general.html#git_reference_list-56"]}},"git_reference_foreach":{"type":"function","file":"refs.h","line":316,"lineto":320,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where to find the refs"},{"name":"list_flags","type":"unsigned int","comment":"Filtering flags for the reference listing."},{"name":"callback","type":"git_reference_foreach_cb","comment":"Function which will be called for every listed ref"},{"name":"payload","type":"void *","comment":"Additional data to pass to the callback"}],"argline":"git_repository *repo,\n\tunsigned int list_flags,\n\tgit_reference_foreach_cb callback,\n\tvoid *payload","sig":"git_repository *::unsigned int::git_reference_foreach_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Perform a callback on each reference in the repository.</p>\n","comments":"<p>Using the <code>list_flags</code> parameter, the references may be filtered by\ntype (<code>GIT_REF_OID</code> or <code>GIT_REF_SYMBOLIC</code>) or using a bitwise OR of\n<code>git_ref_t</code> values. To include packed refs, include <code>GIT_REF_PACKED</code>.\nFor convenience, use the value <code>GIT_REF_LISTALL</code> to obtain all\nreferences, including packed ones.</p>\n\n<p>The <code>callback</code> function will be called for each reference in the\nrepository, receiving the name of the reference and the <code>payload</code> value\npassed to this method. Returning a non-zero value from the callback\nwill terminate the iteration.</p>\n","group":"reference"},"git_reference_free":{"type":"function","file":"refs.h","line":327,"lineto":327,"args":[{"name":"ref","type":"git_reference *","comment":"git_reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"void"},"description":"<p>Free the given reference.</p>\n","comments":"","group":"reference"},"git_reference_cmp":{"type":"function","file":"refs.h","line":336,"lineto":336,"args":[{"name":"ref1","type":"git_reference *","comment":"The first git_reference"},{"name":"ref2","type":"git_reference *","comment":"The second git_reference"}],"argline":"git_reference *ref1, git_reference *ref2","sig":"git_reference *::git_reference *","return":{"type":"int","comment":"0 if the same, else a stable but meaningless ordering."},"description":"<p>Compare two references.</p>\n","comments":"","group":"reference"},"git_reference_foreach_glob":{"type":"function","file":"refs.h","line":357,"lineto":362,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where to find the refs"},{"name":"glob","type":"const char *","comment":"Pattern to match (fnmatch-style) against reference name."},{"name":"list_flags","type":"unsigned int","comment":"Filtering flags for the reference listing."},{"name":"callback","type":"git_reference_foreach_cb","comment":"Function which will be called for every listed ref"},{"name":"payload","type":"void *","comment":"Additional data to pass to the callback"}],"argline":"git_repository *repo,\n\tconst char *glob,\n\tunsigned int list_flags,\n\tgit_reference_foreach_cb callback,\n\tvoid *payload","sig":"git_repository *::const char *::unsigned int::git_reference_foreach_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Perform a callback on each reference in the repository whose name\nmatches the given pattern.</p>\n","comments":"<p>This function acts like <code>git_reference_foreach()</code> with an additional\npattern match being applied to the reference name before issuing the\ncallback function. See that function for more information.</p>\n\n<p>The pattern is matched using fnmatch or &quot;glob&quot; style where a &#39;*&#39; matches\nany sequence of letters, a &#39;?&#39; matches any letter, and square brackets\ncan be used to define character ranges (such as &quot;[0-9]&quot; for digits).</p>\n","group":"reference"},"git_reference_has_log":{"type":"function","file":"refs.h","line":372,"lineto":372,"args":[{"name":"ref","type":"git_reference *","comment":"A git reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"int","comment":"0 when no reflog can be found, 1 when it exists; otherwise an error code."},"description":"<p>Check if a reflog exists for the specified reference.</p>\n","comments":"","group":"reference"},"git_reference_is_branch":{"type":"function","file":"refs.h","line":382,"lineto":382,"args":[{"name":"ref","type":"git_reference *","comment":"A git reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"int","comment":"1 when the reference lives in the refs/heads namespace; 0 otherwise."},"description":"<p>Check if a reference is a local branch.</p>\n","comments":"","group":"reference"},"git_reference_is_remote":{"type":"function","file":"refs.h","line":392,"lineto":396,"args":[{"name":"ref","type":"git_reference *","comment":"A git reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"int","comment":"1 when the reference lives in the refs/remotes namespace; 0 otherwise."},"description":"<p>Check if a reference is a remote tracking branch</p>\n","comments":"","group":"reference"},"git_reference_normalize_name":{"type":"function","file":"refs.h","line":436,"lineto":440,"args":[{"name":"buffer_out","type":"char *","comment":"User allocated buffer to store normalized name"},{"name":"buffer_size","type":"size_t","comment":"Size of buffer_out"},{"name":"name","type":"const char *","comment":"Reference name to be checked."},{"name":"flags","type":"unsigned int","comment":"Flags to constrain name validation rules - see the GIT_REF_FORMAT constants above."}],"argline":"char *buffer_out,\n\tsize_t buffer_size,\n\tconst char *name,\n\tunsigned int flags","sig":"char *::size_t::const char *::unsigned int","return":{"type":"int","comment":"0 on success, GIT_EBUFS if buffer is too small, EINVALIDSPEC or an error code."},"description":"<p>Normalize reference name and check validity.</p>\n","comments":"<p>This will normalize the reference name by removing any leading slash\n&#39;/&#39; characters and collapsing runs of adjacent slashes between name\ncomponents into a single slash.</p>\n\n<p>Once normalized, if the reference name is valid, it will be returned in\nthe user allocated buffer.</p>\n\n<p>See <code>git_reference_create_symbolic()</code> for rules about valid names.</p>\n","group":"reference"},"git_reference_peel":{"type":"function","file":"refs.h","line":457,"lineto":460,"args":[{"name":"out","type":"git_object **"},{"name":"ref","type":"git_reference *","comment":"The reference to be processed"},{"name":"type","type":"git_otype"}],"argline":"git_object **out,\n\tgit_reference *ref,\n\tgit_otype type","sig":"git_object **::git_reference *::git_otype","return":{"type":"int","comment":"0 on success, GIT_EAMBIGUOUS, GIT_ENOTFOUND or an error code"},"description":"<p>Recursively peel reference until object of the specified type is found.</p>\n","comments":"<p>The retrieved <code>peeled</code> object is owned by the repository\nand should be closed with the <code>git_object_free</code> method.</p>\n\n<p>If you pass <code>GIT_OBJ_ANY</code> as the target type, then the object\nwill be peeled until a non-tag object is met.</p>\n","group":"reference"},"git_reference_is_valid_name":{"type":"function","file":"refs.h","line":476,"lineto":476,"args":[{"name":"refname","type":"const char *","comment":"name to be checked."}],"argline":"const char *refname","sig":"const char *","return":{"type":"int","comment":"1 if the reference name is acceptable; 0 if it isn't"},"description":"<p>Ensure the reference name is well-formed.</p>\n","comments":"<p>Valid reference names must follow one of two patterns:</p>\n\n<ol>\n<li>Top-level names must contain only capital letters and underscores,\nand must begin and end with a letter. (e.g. &quot;HEAD&quot;, &quot;ORIG_HEAD&quot;).</li>\n<li>Names prefixed with &quot;refs/&quot; can be almost anything. You must avoid\nthe characters &#39;~&#39;, &#39;^&#39;, &#39;:&#39;, &#39;\\&#39;, &#39;?&#39;, &#39;[&#39;, and &#39;*&#39;, and the\nsequences &quot;..&quot; and &quot;@{&quot; which have special meaning to revparse.</li>\n</ol>\n","group":"reference"},"git_refspec_src":{"type":"function","file":"refspec.h","line":28,"lineto":28,"args":[{"name":"refspec","type":"const git_refspec *","comment":"the refspec"}],"argline":"const git_refspec *refspec","sig":"const git_refspec *","return":{"type":"const char *","comment":"the refspec's source specifier"},"description":"<p>Get the source specifier</p>\n","comments":"","group":"refspec"},"git_refspec_dst":{"type":"function","file":"refspec.h","line":36,"lineto":36,"args":[{"name":"refspec","type":"const git_refspec *","comment":"the refspec"}],"argline":"const git_refspec *refspec","sig":"const git_refspec *","return":{"type":"const char *","comment":"the refspec's destination specifier"},"description":"<p>Get the destination specifier</p>\n","comments":"","group":"refspec"},"git_refspec_force":{"type":"function","file":"refspec.h","line":44,"lineto":44,"args":[{"name":"refspec","type":"const git_refspec *","comment":"the refspec"}],"argline":"const git_refspec *refspec","sig":"const git_refspec *","return":{"type":"int","comment":"1 if force update has been set, 0 otherwise"},"description":"<p>Get the force update setting</p>\n","comments":"","group":"refspec"},"git_refspec_src_matches":{"type":"function","file":"refspec.h","line":53,"lineto":53,"args":[{"name":"refspec","type":"const git_refspec *","comment":"the refspec"},{"name":"refname","type":"const char *","comment":"the name of the reference to check"}],"argline":"const git_refspec *refspec, const char *refname","sig":"const git_refspec *::const char *","return":{"type":"int","comment":"1 if the refspec matches, 0 otherwise"},"description":"<p>Check if a refspec&#39;s source descriptor matches a reference</p>\n","comments":"","group":"refspec"},"git_refspec_dst_matches":{"type":"function","file":"refspec.h","line":62,"lineto":62,"args":[{"name":"refspec","type":"const git_refspec *","comment":"the refspec"},{"name":"refname","type":"const char *","comment":"the name of the reference to check"}],"argline":"const git_refspec *refspec, const char *refname","sig":"const git_refspec *::const char *","return":{"type":"int","comment":"1 if the refspec matches, 0 otherwise"},"description":"<p>Check if a refspec&#39;s destination descriptor matches a reference</p>\n","comments":"","group":"refspec"},"git_refspec_transform":{"type":"function","file":"refspec.h","line":73,"lineto":73,"args":[{"name":"out","type":"char *","comment":"where to store the target name"},{"name":"outlen","type":"size_t","comment":"the size of the `out` buffer"},{"name":"spec","type":"const git_refspec *","comment":"the refspec"},{"name":"name","type":"const char *","comment":"the name of the reference to transform"}],"argline":"char *out, size_t outlen, const git_refspec *spec, const char *name","sig":"char *::size_t::const git_refspec *::const char *","return":{"type":"int","comment":"0, GIT_EBUFS or another error"},"description":"<p>Transform a reference to its target following the refspec&#39;s rules</p>\n","comments":"","group":"refspec"},"git_refspec_rtransform":{"type":"function","file":"refspec.h","line":84,"lineto":88,"args":[{"name":"out","type":"char *","comment":"where to store the source reference name"},{"name":"outlen","type":"size_t","comment":"the size of the `out` buffer"},{"name":"spec","type":"const git_refspec *","comment":"the refspec"},{"name":"name","type":"const char *","comment":"the name of the reference to transform"}],"argline":"char *out, size_t outlen, const git_refspec *spec, const char *name","sig":"char *::size_t::const git_refspec *::const char *","return":{"type":"int","comment":"0, GIT_EBUFS or another error"},"description":"<p>Transform a target reference to its source reference following the refspec&#39;s rules</p>\n","comments":"","group":"refspec"},"git_remote_create":{"type":"function","file":"remote.h","line":46,"lineto":50,"args":[{"name":"out","type":"git_remote **","comment":"the resulting remote"},{"name":"repo","type":"git_repository *","comment":"the repository in which to create the remote"},{"name":"name","type":"const char *","comment":"the remote's name"},{"name":"url","type":"const char *","comment":"the remote's url"}],"argline":"git_remote **out,\n\t\tgit_repository *repo,\n\t\tconst char *name,\n\t\tconst char *url","sig":"git_remote **::git_repository *::const char *::const char *","return":{"type":"int","comment":"0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code"},"description":"<p>Add a remote with the default fetch refspec to the repository&#39;s configuration. This\ncalls git_remote_save before returning.</p>\n","comments":"","group":"remote"},"git_remote_create_inmemory":{"type":"function","file":"remote.h","line":68,"lineto":72,"args":[{"name":"out","type":"git_remote **","comment":"pointer to the new remote object"},{"name":"repo","type":"git_repository *","comment":"the associated repository"},{"name":"fetch","type":"const char *","comment":"the fetch refspec to use for this remote. May be NULL for defaults."},{"name":"url","type":"const char *","comment":"the remote repository's URL"}],"argline":"git_remote **out,\n\t\tgit_repository *repo,\n\t\tconst char *fetch,\n\t\tconst char *url","sig":"git_remote **::git_repository *::const char *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create a remote in memory</p>\n","comments":"<p>Create a remote with the given refspec in memory. You can use\nthis when you have a URL instead of a remote&#39;s name. Note that in-memory\nremotes cannot be converted to persisted remotes.</p>\n\n<p>The name, when provided, will be checked for validity.\nSee <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"remote","examples":{"network/fetch.c":["ex/v0.18.0/network/fetch.html#git_remote_create_inmemory-4"],"network/ls-remote.c":["ex/v0.18.0/network/ls-remote.html#git_remote_create_inmemory-2"]}},"git_remote_load":{"type":"function","file":"remote.h","line":85,"lineto":85,"args":[{"name":"out","type":"git_remote **","comment":"pointer to the new remote object"},{"name":"repo","type":"git_repository *","comment":"the associated repository"},{"name":"name","type":"const char *","comment":"the remote's name"}],"argline":"git_remote **out, git_repository *repo, const char *name","sig":"git_remote **::git_repository *::const char *","return":{"type":"int","comment":"0, GIT_ENOTFOUND, GIT_EINVALIDSPEC or an error code"},"description":"<p>Get the information for a particular remote</p>\n","comments":"<p>The name will be checked for validity.\nSee <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"remote","examples":{"network/fetch.c":["ex/v0.18.0/network/fetch.html#git_remote_load-5"],"network/ls-remote.c":["ex/v0.18.0/network/ls-remote.html#git_remote_load-3"]}},"git_remote_save":{"type":"function","file":"remote.h","line":96,"lineto":96,"args":[{"name":"remote","type":"const git_remote *","comment":"the remote to save to config"}],"argline":"const git_remote *remote","sig":"const git_remote *","return":{"type":"int","comment":"0, GIT_EINVALIDSPEC or an error code"},"description":"<p>Save a remote to its repository&#39;s configuration</p>\n","comments":"<p>One can&#39;t save a in-memory remote. Doing so will\nresult in a GIT_EINVALIDSPEC being returned.</p>\n","group":"remote"},"git_remote_name":{"type":"function","file":"remote.h","line":104,"lineto":104,"args":[{"name":"remote","type":"const git_remote *","comment":"the remote"}],"argline":"const git_remote *remote","sig":"const git_remote *","return":{"type":"const char *","comment":"a pointer to the name or NULL for in-memory remotes"},"description":"<p>Get the remote&#39;s name</p>\n","comments":"","group":"remote"},"git_remote_url":{"type":"function","file":"remote.h","line":112,"lineto":112,"args":[{"name":"remote","type":"const git_remote *","comment":"the remote"}],"argline":"const git_remote *remote","sig":"const git_remote *","return":{"type":"const char *","comment":"a pointer to the url"},"description":"<p>Get the remote&#39;s url</p>\n","comments":"","group":"remote"},"git_remote_pushurl":{"type":"function","file":"remote.h","line":120,"lineto":120,"args":[{"name":"remote","type":"const git_remote *","comment":"the remote"}],"argline":"const git_remote *remote","sig":"const git_remote *","return":{"type":"const char *","comment":"a pointer to the url or NULL if no special url for pushing is set"},"description":"<p>Get the remote&#39;s url for pushing</p>\n","comments":"","group":"remote"},"git_remote_set_url":{"type":"function","file":"remote.h","line":131,"lineto":131,"args":[{"name":"remote","type":"git_remote *","comment":"the remote"},{"name":"url","type":"const char*","comment":"the url to set"}],"argline":"git_remote *remote, const char* url","sig":"git_remote *::const char*","return":{"type":"int","comment":"0 or an error value"},"description":"<p>Set the remote&#39;s url</p>\n","comments":"<p>Existing connections will not be updated.</p>\n","group":"remote"},"git_remote_set_pushurl":{"type":"function","file":"remote.h","line":142,"lineto":142,"args":[{"name":"remote","type":"git_remote *","comment":"the remote"},{"name":"url","type":"const char*","comment":"the url to set or NULL to clear the pushurl"}],"argline":"git_remote *remote, const char* url","sig":"git_remote *::const char*","return":{"type":"int","comment":"0 or an error value"},"description":"<p>Set the remote&#39;s url for pushing</p>\n","comments":"<p>Existing connections will not be updated.</p>\n","group":"remote"},"git_remote_set_fetchspec":{"type":"function","file":"remote.h","line":151,"lineto":151,"args":[{"name":"remote","type":"git_remote *","comment":"the remote @apram spec the new fetch refspec"},{"name":"spec","type":"const char *"}],"argline":"git_remote *remote, const char *spec","sig":"git_remote *::const char *","return":{"type":"int","comment":"0 or an error value"},"description":"<p>Set the remote&#39;s fetch refspec</p>\n","comments":"","group":"remote"},"git_remote_fetchspec":{"type":"function","file":"remote.h","line":159,"lineto":159,"args":[{"name":"remote","type":"const git_remote *","comment":"the remote"}],"argline":"const git_remote *remote","sig":"const git_remote *","return":{"type":"const git_refspec *","comment":"a pointer to the fetch refspec or NULL if it doesn't exist"},"description":"<p>Get the fetch refspec</p>\n","comments":"","group":"remote"},"git_remote_set_pushspec":{"type":"function","file":"remote.h","line":168,"lineto":168,"args":[{"name":"remote","type":"git_remote *","comment":"the remote"},{"name":"spec","type":"const char *","comment":"the new push refspec"}],"argline":"git_remote *remote, const char *spec","sig":"git_remote *::const char *","return":{"type":"int","comment":"0 or an error value"},"description":"<p>Set the remote&#39;s push refspec</p>\n","comments":"","group":"remote"},"git_remote_pushspec":{"type":"function","file":"remote.h","line":176,"lineto":176,"args":[{"name":"remote","type":"const git_remote *","comment":"the remote"}],"argline":"const git_remote *remote","sig":"const git_remote *","return":{"type":"const git_refspec *","comment":"a pointer to the push refspec or NULL if it doesn't exist"},"description":"<p>Get the push refspec</p>\n","comments":"","group":"remote"},"git_remote_connect":{"type":"function","file":"remote.h","line":190,"lineto":190,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to connect to"},{"name":"direction","type":"git_direction","comment":"whether you want to receive or send data"}],"argline":"git_remote *remote, git_direction direction","sig":"git_remote *::git_direction","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Open a connection to a remote</p>\n","comments":"<p>The transport is selected based on the URL. The direction argument\nis due to a limitation of the git protocol (over TCP or SSH) which\nstarts up a specific binary which can only do the one or the other.</p>\n","group":"remote","examples":{"network/fetch.c":["ex/v0.18.0/network/fetch.html#git_remote_connect-6"],"network/ls-remote.c":["ex/v0.18.0/network/ls-remote.html#git_remote_connect-4","ex/v0.18.0/network/ls-remote.html#git_remote_connect-5"]}},"git_remote_ls":{"type":"function","file":"remote.h","line":206,"lineto":206,"args":[{"name":"remote","type":"git_remote *","comment":"the remote"},{"name":"list_cb","type":"git_headlist_cb","comment":"function to call with each ref discovered at the remote"},{"name":"payload","type":"void *","comment":"additional data to pass to the callback"}],"argline":"git_remote *remote, git_headlist_cb list_cb, void *payload","sig":"git_remote *::git_headlist_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Get a list of refs at the remote</p>\n","comments":"<p>The remote (or more exactly its transport) must be connected. The\nmemory belongs to the remote.</p>\n\n<p>If you a return a non-zero value from the callback, this will stop\nlooping over the refs.</p>\n","group":"remote","examples":{"network/ls-remote.c":["ex/v0.18.0/network/ls-remote.html#git_remote_ls-6","ex/v0.18.0/network/ls-remote.html#git_remote_ls-7"]}},"git_remote_download":{"type":"function","file":"remote.h","line":224,"lineto":227,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to download from"},{"name":"progress_cb","type":"git_transfer_progress_callback","comment":"function to call with progress information. Be aware that this is called inline with network and indexing operations, so performance may be affected."},{"name":"payload","type":"void *"}],"argline":"git_remote *remote,\n\t\tgit_transfer_progress_callback progress_cb,\n\t\tvoid *payload","sig":"git_remote *::git_transfer_progress_callback::void *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Download the packfile</p>\n","comments":"<p>Negotiate what objects should be downloaded and download the\npackfile with those objects. The packfile is downloaded with a\ntemporary filename, as it&#39;s final name is not known yet. If there\nwas no packfile needed (all the objects were available locally),\nfilename will be NULL and the function will return success.</p>\n","group":"remote","examples":{"network/fetch.c":["ex/v0.18.0/network/fetch.html#git_remote_download-7"]}},"git_remote_connected":{"type":"function","file":"remote.h","line":238,"lineto":238,"args":[{"name":"remote","type":"git_remote *","comment":"the remote"}],"argline":"git_remote *remote","sig":"git_remote *","return":{"type":"int","comment":"1 if it's connected, 0 otherwise."},"description":"<p>Check whether the remote is connected</p>\n","comments":"<p>Check whether the remote&#39;s underlying transport is connected to the\nremote host.</p>\n","group":"remote"},"git_remote_stop":{"type":"function","file":"remote.h","line":248,"lineto":248,"args":[{"name":"remote","type":"git_remote *","comment":"the remote"}],"argline":"git_remote *remote","sig":"git_remote *","return":{"type":"void"},"description":"<p>Cancel the operation</p>\n","comments":"<p>At certain points in its operation, the network code checks whether\nthe operation has been cancelled and if so stops the operation.</p>\n","group":"remote"},"git_remote_disconnect":{"type":"function","file":"remote.h","line":258,"lineto":258,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to disconnect from"}],"argline":"git_remote *remote","sig":"git_remote *","return":{"type":"void"},"description":"<p>Disconnect from the remote</p>\n","comments":"<p>Close the connection to the remote and free the underlying\ntransport.</p>\n","group":"remote","examples":{"network/fetch.c":["ex/v0.18.0/network/fetch.html#git_remote_disconnect-8"]}},"git_remote_free":{"type":"function","file":"remote.h","line":268,"lineto":268,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to free"}],"argline":"git_remote *remote","sig":"git_remote *","return":{"type":"void"},"description":"<p>Free the memory associated with a remote</p>\n","comments":"<p>This also disconnects from the remote, if the connection\nhas not been closed yet (using git_remote_disconnect).</p>\n","group":"remote","examples":{"network/fetch.c":["ex/v0.18.0/network/fetch.html#git_remote_free-9","ex/v0.18.0/network/fetch.html#git_remote_free-10"],"network/ls-remote.c":["ex/v0.18.0/network/ls-remote.html#git_remote_free-8","ex/v0.18.0/network/ls-remote.html#git_remote_free-9"]}},"git_remote_update_tips":{"type":"function","file":"remote.h","line":276,"lineto":276,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to update"}],"argline":"git_remote *remote","sig":"git_remote *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Update the tips to the new state</p>\n","comments":"","group":"remote","examples":{"network/fetch.c":["ex/v0.18.0/network/fetch.html#git_remote_update_tips-11"]}},"git_remote_valid_url":{"type":"function","file":"remote.h","line":284,"lineto":284,"args":[{"name":"url","type":"const char *","comment":"the url to check"}],"argline":"const char *url","sig":"const char *","return":{"type":"int"},"description":"<p>Return whether a string is a valid remote URL</p>\n","comments":"","group":"remote"},"git_remote_supported_url":{"type":"function","file":"remote.h","line":292,"lineto":292,"args":[{"name":"url","type":"const char*","comment":"the url to check"}],"argline":"const char* url","sig":"const char*","return":{"type":"int","comment":"1 if the url is supported, 0 otherwise"},"description":"<p>Return whether the passed URL is supported by this version of the library.</p>\n","comments":"","group":"remote"},"git_remote_list":{"type":"function","file":"remote.h","line":303,"lineto":303,"args":[{"name":"out","type":"git_strarray *","comment":"a string array which receives the names of the remotes"},{"name":"repo","type":"git_repository *","comment":"the repository to query"}],"argline":"git_strarray *out, git_repository *repo","sig":"git_strarray *::git_repository *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Get a list of the configured remotes for a repo</p>\n","comments":"<p>The string array must be freed by the user.</p>\n","group":"remote"},"git_remote_check_cert":{"type":"function","file":"remote.h","line":311,"lineto":311,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to configure"},{"name":"check","type":"int","comment":"whether to check the server's certificate (defaults to yes)"}],"argline":"git_remote *remote, int check","sig":"git_remote *::int","return":{"type":"void"},"description":"<p>Choose whether to check the server&#39;s certificate (applies to HTTPS only)</p>\n","comments":"","group":"remote"},"git_remote_set_cred_acquire_cb":{"type":"function","file":"remote.h","line":323,"lineto":326,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to configure"},{"name":"cred_acquire_cb","type":"git_cred_acquire_cb","comment":"The credentials acquisition callback to use (defaults to NULL)"},{"name":"payload","type":"void *"}],"argline":"git_remote *remote,\n\tgit_cred_acquire_cb cred_acquire_cb,\n\tvoid *payload","sig":"git_remote *::git_cred_acquire_cb::void *","return":{"type":"void"},"description":"<p>Set a credentials acquisition callback for this remote. If the remote is\nnot available for anonymous access, then you must set this callback in order\nto provide credentials to the transport at the time of authentication\nfailure so that retry can be performed.</p>\n","comments":"","group":"remote"},"git_remote_set_transport":{"type":"function","file":"remote.h","line":340,"lineto":342,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to configure"},{"name":"transport","type":"git_transport *","comment":"the transport object for the remote to use"}],"argline":"git_remote *remote,\n\tgit_transport *transport","sig":"git_remote *::git_transport *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Sets a custom transport for the remote. The caller can use this function\nto bypass the automatic discovery of a transport by URL scheme (i.e.\nhttp://, https://, git://) and supply their own transport to be used\ninstead. After providing the transport to a remote using this function,\nthe transport object belongs exclusively to that remote, and the remote will\nfree it when it is freed with git_remote_free.</p>\n","comments":"","group":"remote"},"git_remote_set_callbacks":{"type":"function","file":"remote.h","line":380,"lineto":380,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to configure"},{"name":"callbacks","type":"git_remote_callbacks *","comment":"a pointer to the user's callback settings"}],"argline":"git_remote *remote, git_remote_callbacks *callbacks","sig":"git_remote *::git_remote_callbacks *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Set the callbacks for a remote</p>\n","comments":"<p>Note that the remote keeps its own copy of the data and you need to\ncall this function again if you want to change the callbacks.</p>\n","group":"remote","examples":{"network/fetch.c":["ex/v0.18.0/network/fetch.html#git_remote_set_callbacks-12"]}},"git_remote_stats":{"type":"function","file":"remote.h","line":385,"lineto":392,"args":[{"name":"remote","type":"git_remote *"}],"argline":"git_remote *remote","sig":"git_remote *","return":{"type":"const git_transfer_progress *"},"description":"<p>Get the statistics structure that is filled in by the fetch operation.</p>\n","comments":"","group":"remote","examples":{"network/fetch.c":["ex/v0.18.0/network/fetch.html#git_remote_stats-13"]}},"git_remote_autotag":{"type":"function","file":"remote.h","line":400,"lineto":400,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to query"}],"argline":"git_remote *remote","sig":"git_remote *","return":{"type":"git_remote_autotag_option_t","comment":"the auto-follow setting"},"description":"<p>Retrieve the tag auto-follow setting</p>\n","comments":"","group":"remote"},"git_remote_set_autotag":{"type":"function","file":"remote.h","line":408,"lineto":410,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to configure"},{"name":"value","type":"git_remote_autotag_option_t","comment":"a GIT_REMOTE_DOWNLOAD_TAGS value"}],"argline":"git_remote *remote,\n\tgit_remote_autotag_option_t value","sig":"git_remote *::git_remote_autotag_option_t","return":{"type":"void"},"description":"<p>Set the tag auto-follow setting</p>\n","comments":"","group":"remote"},"git_remote_rename":{"type":"function","file":"remote.h","line":430,"lineto":434,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to rename"},{"name":"new_name","type":"const char *","comment":"the new name the remote should bear"},{"name":"callback","type":"git_remote_rename_problem_cb","comment":"Optional callback to notify the consumer of fetch refspecs that haven't been automatically updated and need potential manual tweaking."},{"name":"payload","type":"void *","comment":"Additional data to pass to the callback"}],"argline":"git_remote *remote,\n\tconst char *new_name,\n\tgit_remote_rename_problem_cb callback,\n\tvoid *payload","sig":"git_remote *::const char *::git_remote_rename_problem_cb::void *","return":{"type":"int","comment":"0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code"},"description":"<p>Give the remote a new name</p>\n","comments":"<p>All remote-tracking branches and configuration settings\nfor the remote are updated.</p>\n\n<p>The new name will be checked for validity.\nSee <code>git_tag_create()</code> for rules about valid names.</p>\n\n<p>A temporary in-memory remote cannot be given a name with this method.</p>\n","group":"remote"},"git_remote_update_fetchhead":{"type":"function","file":"remote.h","line":442,"lineto":442,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to query"}],"argline":"git_remote *remote","sig":"git_remote *","return":{"type":"int","comment":"the update FETCH_HEAD setting"},"description":"<p>Retrieve the update FETCH_HEAD setting.</p>\n","comments":"","group":"remote"},"git_remote_set_update_fetchhead":{"type":"function","file":"remote.h","line":451,"lineto":451,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to configure"},{"name":"value","type":"int","comment":"0 to disable updating FETCH_HEAD"}],"argline":"git_remote *remote, int value","sig":"git_remote *::int","return":{"type":"void"},"description":"<p>Sets the update FETCH_HEAD setting. By default, FETCH_HEAD will be\nupdated on every fetch. Set to 0 to disable.</p>\n","comments":"","group":"remote"},"git_remote_is_valid_name":{"type":"function","file":"remote.h","line":459,"lineto":459,"args":[{"name":"remote_name","type":"const char *","comment":"name to be checked."}],"argline":"const char *remote_name","sig":"const char *","return":{"type":"int","comment":"1 if the reference name is acceptable; 0 if it isn't"},"description":"<p>Ensure the remote name is well-formed.</p>\n","comments":"","group":"remote"},"git_repository_open":{"type":"function","file":"repository.h","line":36,"lineto":36,"args":[{"name":"out","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 **out, const char *path","sig":"git_repository **::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Open a git repository.</p>\n","comments":"<p>The &#39;path&#39; argument must point to either a git repository\nfolder, or an existing work dir.</p>\n\n<p>The method will automatically detect if &#39;path&#39; is a normal\nor bare repository or fail is &#39;path&#39; is neither.</p>\n","group":"repository","examples":{"general.c":["ex/v0.18.0/general.html#git_repository_open-57"],"network/git2.c":["ex/v0.18.0/network/git2.html#git_repository_open-3"]}},"git_repository_wrap_odb":{"type":"function","file":"repository.h","line":49,"lineto":49,"args":[{"name":"out","type":"git_repository **","comment":"pointer to the repo"},{"name":"odb","type":"git_odb *","comment":"the object database to wrap"}],"argline":"git_repository **out, git_odb *odb","sig":"git_repository **::git_odb *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create a &quot;fake&quot; repository to wrap an object database</p>\n","comments":"<p>Create a repository object to wrap an object database to be used\nwith the API when all you have is an object database. This doesn&#39;t\nhave any paths associated with it, so use with care.</p>\n","group":"repository"},"git_repository_discover":{"type":"function","file":"repository.h","line":79,"lineto":84,"args":[{"name":"path_out","type":"char *","comment":"The user allocated buffer which will contain the found path."},{"name":"path_size","type":"size_t","comment":"repository_path size"},{"name":"start_path","type":"const char *","comment":"The base path where the lookup starts."},{"name":"across_fs","type":"int","comment":"If true, then the lookup will not stop when a filesystem device change is detected while exploring parent directories."},{"name":"ceiling_dirs","type":"const char *","comment":"A GIT_PATH_LIST_SEPARATOR separated list of absolute symbolic link free paths. The lookup will stop when any of this paths is reached. Note that the lookup always performs on start_path no matter start_path appears in ceiling_dirs ceiling_dirs might be NULL (which is equivalent to an empty string)"}],"argline":"char *path_out,\n\t\tsize_t path_size,\n\t\tconst char *start_path,\n\t\tint across_fs,\n\t\tconst char *ceiling_dirs","sig":"char *::size_t::const char *::int::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Look for a git repository and copy its path in the given buffer.\nThe lookup start from base_path and walk across parent directories\nif nothing has been found. The lookup ends when the first repository\nis found, or when reaching a directory referenced in ceiling_dirs\nor when the filesystem changes (in case across_fs is true).</p>\n","comments":"<p>The method will automatically detect if the repository is bare\n(if there is a repository).</p>\n","group":"repository"},"git_repository_open_ext":{"type":"function","file":"repository.h","line":120,"lineto":124,"args":[{"name":"out","type":"git_repository **","comment":"Pointer to the repo which will be opened. This can actually be NULL if you only want to use the error code to see if a repo at this path could be opened."},{"name":"path","type":"const char *","comment":"Path to open as git repository. If the flags permit \"searching\", then this can be a path to a subdirectory inside the working directory of the repository."},{"name":"flags","type":"unsigned int","comment":"A combination of the GIT_REPOSITORY_OPEN flags above."},{"name":"ceiling_dirs","type":"const char *","comment":"A GIT_PATH_LIST_SEPARATOR delimited list of path prefixes at which the search for a containing repository should terminate."}],"argline":"git_repository **out,\n\tconst char *path,\n\tunsigned int flags,\n\tconst char *ceiling_dirs","sig":"git_repository **::const char *::unsigned int::const char *","return":{"type":"int","comment":"0 on success, GIT_ENOTFOUND if no repository could be found, or -1 if there was a repository but open failed for some reason (such as repo corruption or system errors)."},"description":"<p>Find and open a repository with extended controls.</p>\n","comments":"","group":"repository"},"git_repository_free":{"type":"function","file":"repository.h","line":137,"lineto":137,"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":"<p>Free a previously allocated repository</p>\n","comments":"<p>Note that after a repository is free&#39;d, all the objects it has spawned\nwill still exist until they are manually closed by the user\nwith <code>git_object_free</code>, but accessing any of the attributes of\nan object without a backing repository will result in undefined\nbehavior</p>\n","group":"repository","examples":{"general.c":["ex/v0.18.0/general.html#git_repository_free-58"],"network/clone.c":["ex/v0.18.0/network/clone.html#git_repository_free-3"],"network/git2.c":["ex/v0.18.0/network/git2.html#git_repository_free-4"]}},"git_repository_init":{"type":"function","file":"repository.h","line":154,"lineto":157,"args":[{"name":"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 **out,\n\tconst char *path,\n\tunsigned is_bare","sig":"git_repository **::const char *::unsigned","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Creates a new Git repository in the given folder.</p>\n","comments":"<p>TODO:\n- Reinit the repository</p>\n","group":"repository"},"git_repository_init_ext":{"type":"function","file":"repository.h","line":268,"lineto":271,"args":[{"name":"out","type":"git_repository **","comment":"Pointer to the repo which will be created or reinitialized."},{"name":"repo_path","type":"const char *","comment":"The path to the repository."},{"name":"opts","type":"git_repository_init_options *","comment":"Pointer to git_repository_init_options struct."}],"argline":"git_repository **out,\n\tconst char *repo_path,\n\tgit_repository_init_options *opts","sig":"git_repository **::const char *::git_repository_init_options *","return":{"type":"int","comment":"0 or an error code on failure."},"description":"<p>Create a new Git repository in the given folder with extended controls.</p>\n","comments":"<p>This will initialize a new git repository (creating the repo_path\nif requested by flags) and working directory as needed. It will\nauto-detect the case sensitivity of the file system and if the\nfile system supports file mode bits correctly.</p>\n","group":"repository"},"git_repository_head":{"type":"function","file":"repository.h","line":286,"lineto":286,"args":[{"name":"out","type":"git_reference **","comment":"pointer to the reference which will be retrieved"},{"name":"repo","type":"git_repository *","comment":"a repository object"}],"argline":"git_reference **out, git_repository *repo","sig":"git_reference **::git_repository *","return":{"type":"int","comment":"0 on success, GIT_EORPHANEDHEAD when HEAD points to a non existing branch, GIT_ENOTFOUND when HEAD is missing; an error code otherwise"},"description":"<p>Retrieve and resolve the reference pointed at by HEAD.</p>\n","comments":"<p>The returned <code>git_reference</code> will be owned by caller and\n<code>git_reference_free()</code> must be called when done with it to release the\nallocated memory and prevent a leak.</p>\n","group":"repository"},"git_repository_head_detached":{"type":"function","file":"repository.h","line":298,"lineto":298,"args":[{"name":"repo","type":"git_repository *","comment":"Repo to test"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"int","comment":"1 if HEAD is detached, 0 if it's not; error code if there was an error."},"description":"<p>Check if a repository&#39;s HEAD is detached</p>\n","comments":"<p>A repository&#39;s HEAD is detached when it points directly to a commit\ninstead of a branch.</p>\n","group":"repository"},"git_repository_head_orphan":{"type":"function","file":"repository.h","line":310,"lineto":310,"args":[{"name":"repo","type":"git_repository *","comment":"Repo to test"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"int","comment":"1 if the current branch is an orphan, 0 if it's not; error code if there was an error"},"description":"<p>Check if the current branch is an orphan</p>\n","comments":"<p>An orphan branch is one named from HEAD but which doesn&#39;t exist in\nthe refs namespace, because it doesn&#39;t have any commit to point to.</p>\n","group":"repository"},"git_repository_is_empty":{"type":"function","file":"repository.h","line":322,"lineto":322,"args":[{"name":"repo","type":"git_repository *","comment":"Repo to test"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"int","comment":"1 if the repository is empty, 0 if it isn't, error code if the repository is corrupted"},"description":"<p>Check if a repository is empty</p>\n","comments":"<p>An empty repository has just been initialized and contains\nno references.</p>\n","group":"repository"},"git_repository_path":{"type":"function","file":"repository.h","line":333,"lineto":333,"args":[{"name":"repo","type":"git_repository *","comment":"A repository object"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"const char *","comment":"the path to the repository"},"description":"<p>Get the path of this repository</p>\n","comments":"<p>This is the path of the <code>.git</code> folder for normal repositories,\nor of the repository itself for bare repositories.</p>\n","group":"repository"},"git_repository_workdir":{"type":"function","file":"repository.h","line":344,"lineto":344,"args":[{"name":"repo","type":"git_repository *","comment":"A repository object"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"const char *","comment":"the path to the working dir, if it exists"},"description":"<p>Get the path of the working directory for this repository</p>\n","comments":"<p>If the repository is bare, this function will always return\nNULL.</p>\n","group":"repository"},"git_repository_set_workdir":{"type":"function","file":"repository.h","line":363,"lineto":364,"args":[{"name":"repo","type":"git_repository *","comment":"A repository object"},{"name":"workdir","type":"const char *","comment":"The path to a working directory"},{"name":"update_gitlink","type":"int","comment":"Create/update gitlink in workdir and set config \"core.worktree\" (if workdir is not the parent of the .git directory)"}],"argline":"git_repository *repo, const char *workdir, int update_gitlink","sig":"git_repository *::const char *::int","return":{"type":"int","comment":"0, or an error code"},"description":"<p>Set the path to the working directory for this repository</p>\n","comments":"<p>The working directory doesn&#39;t need to be the same one\nthat contains the <code>.git</code> folder for this repository.</p>\n\n<p>If this repository is bare, setting its working directory\nwill turn it into a normal repository, capable of performing\nall the common workdir operations (checkout, status, index\nmanipulation, etc).</p>\n","group":"repository"},"git_repository_is_bare":{"type":"function","file":"repository.h","line":372,"lineto":372,"args":[{"name":"repo","type":"git_repository *","comment":"Repo to test"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"int","comment":"1 if the repository is bare, 0 otherwise."},"description":"<p>Check if a repository is bare</p>\n","comments":"","group":"repository"},"git_repository_config":{"type":"function","file":"repository.h","line":388,"lineto":388,"args":[{"name":"out","type":"git_config **","comment":"Pointer to store the loaded config file"},{"name":"repo","type":"git_repository *","comment":"A repository object"}],"argline":"git_config **out, git_repository *repo","sig":"git_config **::git_repository *","return":{"type":"int","comment":"0, or an error code"},"description":"<p>Get the configuration file for this repository.</p>\n","comments":"<p>If a configuration file has not been set, the default\nconfig set for the repository will be returned, including\nglobal and system configurations (if they are available).</p>\n\n<p>The configuration file must be freed once it&#39;s no longer\nbeing used by the user.</p>\n","group":"repository"},"git_repository_set_config":{"type":"function","file":"repository.h","line":403,"lineto":403,"args":[{"name":"repo","type":"git_repository *","comment":"A repository object"},{"name":"config","type":"git_config *","comment":"A Config object"}],"argline":"git_repository *repo, git_config *config","sig":"git_repository *::git_config *","return":{"type":"void"},"description":"<p>Set the configuration file for this repository</p>\n","comments":"<p>This configuration file will be used for all configuration\nqueries involving this repository.</p>\n\n<p>The repository will keep a reference to the config file;\nthe user must still free the config after setting it\nto the repository, or it will leak.</p>\n","group":"repository"},"git_repository_odb":{"type":"function","file":"repository.h","line":419,"lineto":419,"args":[{"name":"out","type":"git_odb **","comment":"Pointer to store the loaded ODB"},{"name":"repo","type":"git_repository *","comment":"A repository object"}],"argline":"git_odb **out, git_repository *repo","sig":"git_odb **::git_repository *","return":{"type":"int","comment":"0, or an error code"},"description":"<p>Get the Object Database for this repository.</p>\n","comments":"<p>If a custom ODB has not been set, the default\ndatabase for the repository will be returned (the one\nlocated in <code>.git/objects</code>).</p>\n\n<p>The ODB must be freed once it&#39;s no longer being used by\nthe user.</p>\n","group":"repository","examples":{"general.c":["ex/v0.18.0/general.html#git_repository_odb-59"]}},"git_repository_set_odb":{"type":"function","file":"repository.h","line":434,"lineto":434,"args":[{"name":"repo","type":"git_repository *","comment":"A repository object"},{"name":"odb","type":"git_odb *","comment":"An ODB object"}],"argline":"git_repository *repo, git_odb *odb","sig":"git_repository *::git_odb *","return":{"type":"void"},"description":"<p>Set the Object Database for this repository</p>\n","comments":"<p>The ODB will be used for all object-related operations\ninvolving this repository.</p>\n\n<p>The repository will keep a reference to the ODB; the user\nmust still free the ODB object after setting it to the\nrepository, or it will leak.</p>\n","group":"repository"},"git_repository_refdb":{"type":"function","file":"repository.h","line":450,"lineto":450,"args":[{"name":"out","type":"git_refdb **","comment":"Pointer to store the loaded refdb"},{"name":"repo","type":"git_repository *","comment":"A repository object"}],"argline":"git_refdb **out, git_repository *repo","sig":"git_refdb **::git_repository *","return":{"type":"int","comment":"0, or an error code"},"description":"<p>Get the Reference Database Backend for this repository.</p>\n","comments":"<p>If a custom refsdb has not been set, the default database for\nthe repository will be returned (the one that manipulates loose\nand packed references in the <code>.git</code> directory).</p>\n\n<p>The refdb must be freed once it&#39;s no longer being used by\nthe user.</p>\n","group":"repository"},"git_repository_set_refdb":{"type":"function","file":"repository.h","line":465,"lineto":467,"args":[{"name":"repo","type":"git_repository *","comment":"A repository object"},{"name":"refdb","type":"git_refdb *","comment":"An refdb object"}],"argline":"git_repository *repo,\n\tgit_refdb *refdb","sig":"git_repository *::git_refdb *","return":{"type":"void"},"description":"<p>Set the Reference Database Backend for this repository</p>\n","comments":"<p>The refdb will be used for all reference related operations\ninvolving this repository.</p>\n\n<p>The repository will keep a reference to the refdb; the user\nmust still free the refdb object after setting it to the\nrepository, or it will leak.</p>\n","group":"repository"},"git_repository_index":{"type":"function","file":"repository.h","line":483,"lineto":483,"args":[{"name":"out","type":"git_index **","comment":"Pointer to store the loaded index"},{"name":"repo","type":"git_repository *","comment":"A repository object"}],"argline":"git_index **out, git_repository *repo","sig":"git_index **::git_repository *","return":{"type":"int","comment":"0, or an error code"},"description":"<p>Get the Index file for this repository.</p>\n","comments":"<p>If a custom index has not been set, the default\nindex for the repository will be returned (the one\nlocated in <code>.git/index</code>).</p>\n\n<p>The index must be freed once it&#39;s no longer being used by\nthe user.</p>\n","group":"repository","examples":{"general.c":["ex/v0.18.0/general.html#git_repository_index-60"]}},"git_repository_set_index":{"type":"function","file":"repository.h","line":498,"lineto":498,"args":[{"name":"repo","type":"git_repository *","comment":"A repository object"},{"name":"index","type":"git_index *","comment":"An index object"}],"argline":"git_repository *repo, git_index *index","sig":"git_repository *::git_index *","return":{"type":"void"},"description":"<p>Set the index file for this repository</p>\n","comments":"<p>This index will be used for all index-related operations\ninvolving this repository.</p>\n\n<p>The repository will keep a reference to the index file;\nthe user must still free the index after setting it\nto the repository, or it will leak.</p>\n","group":"repository"},"git_repository_message":{"type":"function","file":"repository.h","line":517,"lineto":517,"args":[{"name":"out","type":"char *","comment":"Buffer to write data into or NULL to just read required size"},{"name":"len","type":"size_t","comment":"Length of buffer in bytes"},{"name":"repo","type":"git_repository *","comment":"Repository to read prepared message from"}],"argline":"char *out, size_t len, git_repository *repo","sig":"char *::size_t::git_repository *","return":{"type":"int","comment":"Bytes written to buffer, GIT_ENOTFOUND if no message, or -1 on error"},"description":"<p>Retrieve git&#39;s prepared message</p>\n","comments":"<p>Operations such as git revert/cherry-pick/merge with the -n option\nstop just short of creating a commit with the changes and save\ntheir prepared message in .git/MERGE_MSG so the next git-commit\nexecution can present it to the user for them to amend if they\nwish.</p>\n\n<p>Use this function to get the contents of this file. Don&#39;t forget to\nremove the file after you create the commit.</p>\n","group":"repository"},"git_repository_message_remove":{"type":"function","file":"repository.h","line":524,"lineto":524,"args":[{"name":"repo","type":"git_repository *"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"int"},"description":"<p>Remove git&#39;s prepared message.</p>\n","comments":"<p>Remove the message that <code>git_repository_message</code> retrieves.</p>\n","group":"repository"},"git_repository_merge_cleanup":{"type":"function","file":"repository.h","line":533,"lineto":539,"args":[{"name":"repo","type":"git_repository *","comment":"A repository object"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"int","comment":"0 on success, or error"},"description":"<p>Remove all the metadata associated with an ongoing git merge, including\nMERGE_HEAD, MERGE_MSG, etc.</p>\n","comments":"","group":"repository"},"git_repository_fetchhead_foreach":{"type":"function","file":"repository.h","line":549,"lineto":554,"args":[{"name":"repo","type":"git_repository *","comment":"A repository object"},{"name":"callback","type":"git_repository_fetchhead_foreach_cb","comment":"Callback function"},{"name":"payload","type":"void *","comment":"Pointer to callback data (optional)"}],"argline":"git_repository *repo,\n\tgit_repository_fetchhead_foreach_cb callback,\n\tvoid *payload","sig":"git_repository *::git_repository_fetchhead_foreach_cb::void *","return":{"type":"int","comment":"0 on success, GIT_ENOTFOUND, GIT_EUSER or error"},"description":"<p>Call callback &#39;callback&#39; for each entry in the given FETCH_HEAD file.</p>\n","comments":"","group":"repository"},"git_repository_mergehead_foreach":{"type":"function","file":"repository.h","line":565,"lineto":567,"args":[{"name":"repo","type":"git_repository *","comment":"A repository object"},{"name":"callback","type":"git_repository_mergehead_foreach_cb","comment":"Callback function"},{"name":"payload","type":"void *"}],"argline":"git_repository *repo,\n\tgit_repository_mergehead_foreach_cb callback,\n\tvoid *payload","sig":"git_repository *::git_repository_mergehead_foreach_cb::void *","return":{"type":"int","comment":"0 on success, GIT_ENOTFOUND, GIT_EUSER or error"},"description":"<p>If a merge is in progress, call callback &#39;cb&#39; for each commit ID in the\nMERGE_HEAD file.</p>\n","comments":"","group":"repository"},"git_repository_hashfile":{"type":"function","file":"repository.h","line":587,"lineto":592,"args":[{"name":"out","type":"git_oid *","comment":"Output value of calculated SHA"},{"name":"repo","type":"git_repository *","comment":"Repository pointer"},{"name":"path","type":"const char *","comment":"Path to file on disk whose contents should be hashed. If the repository is not NULL, this can be a relative path."},{"name":"type","type":"git_otype","comment":"The object type to hash as (e.g. GIT_OBJ_BLOB)"},{"name":"as_path","type":"const char *","comment":"The path to use to look up filtering rules. If this is NULL, then the `path` parameter will be used instead. If this is passed as the empty string, then no filters will be applied when calculating the hash."}],"argline":"git_oid *out,\n git_repository *repo,\n const char *path,\n git_otype type,\n const char *as_path","sig":"git_oid *::git_repository *::const char *::git_otype::const char *","return":{"type":"int"},"description":"<p>Calculate hash of file using repository filtering rules.</p>\n","comments":"<p>If you simply want to calculate the hash of a file on disk with no filters,\nyou can just use the <code>git_odb_hashfile()</code> API. However, if you want to\nhash a file in the repository and you want to apply filtering rules (e.g.\ncrlf filters) before generating the SHA, then use this function.</p>\n","group":"repository"},"git_repository_set_head":{"type":"function","file":"repository.h","line":612,"lineto":614,"args":[{"name":"repo","type":"git_repository*","comment":"Repository pointer"},{"name":"refname","type":"const char*","comment":"Canonical name of the reference the HEAD should point at"}],"argline":"git_repository* repo,\n\tconst char* refname","sig":"git_repository*::const char*","return":{"type":"int","comment":"0 on success, or an error code"},"description":"<p>Make the repository HEAD point to the specified reference.</p>\n","comments":"<p>If the provided reference points to a Tree or a Blob, the HEAD is\nunaltered and -1 is returned.</p>\n\n<p>If the provided reference points to a branch, the HEAD will point\nto that branch, staying attached, or become attached if it isn&#39;t yet.\nIf the branch doesn&#39;t exist yet, no error will be return. The HEAD\nwill then be attached to an unborn branch.</p>\n\n<p>Otherwise, the HEAD will be detached and will directly point to\nthe Commit.</p>\n","group":"repository"},"git_repository_set_head_detached":{"type":"function","file":"repository.h","line":632,"lineto":634,"args":[{"name":"repo","type":"git_repository*","comment":"Repository pointer"},{"name":"commitish","type":"const git_oid*","comment":"Object id of the Commit the HEAD should point to"}],"argline":"git_repository* repo,\n\tconst git_oid* commitish","sig":"git_repository*::const git_oid*","return":{"type":"int","comment":"0 on success, or an error code"},"description":"<p>Make the repository HEAD directly point to the Commit.</p>\n","comments":"<p>If the provided committish cannot be found in the repository, the HEAD\nis unaltered and GIT_ENOTFOUND is returned.</p>\n\n<p>If the provided commitish cannot be peeled into a commit, the HEAD\nis unaltered and -1 is returned.</p>\n\n<p>Otherwise, the HEAD will eventually be detached and will directly point to\nthe peeled Commit.</p>\n","group":"repository"},"git_repository_detach_head":{"type":"function","file":"repository.h","line":653,"lineto":667,"args":[{"name":"repo","type":"git_repository*","comment":"Repository pointer"}],"argline":"git_repository* repo","sig":"git_repository*","return":{"type":"int","comment":"0 on success, GIT_EORPHANEDHEAD when HEAD points to a non existing branch or an error code"},"description":"<p>Detach the HEAD.</p>\n","comments":"<p>If the HEAD is already detached and points to a Commit, 0 is returned.</p>\n\n<p>If the HEAD is already detached and points to a Tag, the HEAD is\nupdated into making it point to the peeled Commit, and 0 is returned.</p>\n\n<p>If the HEAD is already detached and points to a non commitish, the HEAD is \nunaltered, and -1 is returned.</p>\n\n<p>Otherwise, the HEAD will be detached and point to the peeled Commit.</p>\n","group":"repository"},"git_repository_state":{"type":"function","file":"repository.h","line":676,"lineto":676,"args":[{"name":"repo","type":"git_repository *","comment":"Repository pointer"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"int","comment":"The state of the repository"},"description":"<p>Determines the status of a git repository - ie, whether an operation\n(merge, cherry-pick, etc) is in progress.</p>\n","comments":"","group":"repository"},"git_reset":{"type":"function","file":"reset.h","line":53,"lineto":54,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where to perform the reset operation."},{"name":"target","type":"git_object *","comment":"Committish to which the Head should be moved to. This object must belong to the given `repo` and can either be a git_commit or a git_tag. When a git_tag is being passed, it should be dereferencable to a git_commit which oid will be used as the target of the branch."},{"name":"reset_type","type":"git_reset_t","comment":"Kind of reset operation to perform."}],"argline":"git_repository *repo, git_object *target, git_reset_t reset_type","sig":"git_repository *::git_object *::git_reset_t","return":{"type":"int","comment":"0 on success or an error code"},"description":"<p>Sets the current head to the specified commit oid and optionally\nresets the index and working tree to match.</p>\n","comments":"<p>SOFT reset means the Head will be moved to the commit.</p>\n\n<p>MIXED reset will trigger a SOFT reset, plus the index will be replaced\nwith the content of the commit tree.</p>\n\n<p>HARD reset will trigger a MIXED reset and the working directory will be\nreplaced with the content of the index. (Untracked and ignored files\nwill be left alone, however.)</p>\n\n<p>TODO: Implement remaining kinds of resets.</p>\n","group":"reset"},"git_reset_default":{"type":"function","file":"reset.h","line":74,"lineto":77,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where to perform the reset operation."},{"name":"target","type":"git_object *","comment":"The committish which content will be used to reset the content of the index."},{"name":"pathspecs","type":"git_strarray*","comment":"List of pathspecs to operate on."}],"argline":"git_repository *repo,\n git_object *target,\n git_strarray* pathspecs","sig":"git_repository *::git_object *::git_strarray*","return":{"type":"int","comment":"0 on success or an error code < 0"},"description":"<p>Updates some entries in the index from the target commit tree.</p>\n","comments":"<p>The scope of the updated entries is determined by the paths\nbeing passed in the <code>pathspec</code> parameters.</p>\n\n<p>Passing a NULL <code>target</code> will result in removing\nentries in the index matching the provided pathspecs.</p>\n","group":"reset"},"git_revparse_single":{"type":"function","file":"revparse.h","line":33,"lineto":33,"args":[{"name":"out","type":"git_object **","comment":"pointer to output object"},{"name":"repo","type":"git_repository *","comment":"the repository to search in"},{"name":"spec","type":"const char *","comment":"the textual specification for an object"}],"argline":"git_object **out, git_repository *repo, const char *spec","sig":"git_object **::git_repository *::const char *","return":{"type":"int","comment":"0 on success, GIT_ENOTFOUND, GIT_EAMBIGUOUS, GIT_EINVALIDSPEC or an error code"},"description":"<p>Find a single object, as specified by a revision string. See <code>man gitrevisions</code>,\nor http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for\ninformation on the syntax accepted.</p>\n","comments":"","group":"revparse"},"git_revparse":{"type":"function","file":"revparse.h","line":72,"lineto":75,"args":[{"name":"revspec","type":"git_revspec *","comment":"Pointer to an user-allocated git_revspec struct where the result of the rev-parse will be stored"},{"name":"repo","type":"git_repository *","comment":"the repository to search in"},{"name":"spec","type":"const char *","comment":"the rev-parse spec to parse"}],"argline":"git_revspec *revspec,\n\t\tgit_repository *repo,\n\t\tconst char *spec","sig":"git_revspec *::git_repository *::const char *","return":{"type":"int","comment":"0 on success, GIT_INVALIDSPEC, GIT_ENOTFOUND, GIT_EAMBIGUOUS or an error code"},"description":"<p>Parse a revision string for <code>from</code>, <code>to</code>, and intent. See <code>man gitrevisions</code> or\nhttp://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for information\non the syntax accepted.</p>\n","comments":"","group":"revparse"},"git_revwalk_new":{"type":"function","file":"revwalk.h","line":70,"lineto":70,"args":[{"name":"out","type":"git_revwalk **","comment":"pointer to the new revision walker"},{"name":"repo","type":"git_repository *","comment":"the repo to walk through"}],"argline":"git_revwalk **out, git_repository *repo","sig":"git_revwalk **::git_repository *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Allocate a new revision walker to iterate through a repo.</p>\n","comments":"<p>This revision walker uses a custom memory pool and an internal\ncommit cache, so it is relatively expensive to allocate.</p>\n\n<p>For maximum performance, this revision walker should be\nreused for different walks.</p>\n\n<p>This revision walker is <em>not</em> thread safe: it may only be\nused to walk a repository on a single thread; however,\nit is possible to have several revision walkers in\nseveral different threads walking the same repository.</p>\n","group":"revwalk","examples":{"general.c":["ex/v0.18.0/general.html#git_revwalk_new-61"]}},"git_revwalk_reset":{"type":"function","file":"revwalk.h","line":85,"lineto":85,"args":[{"name":"walker","type":"git_revwalk *","comment":"handle to reset."}],"argline":"git_revwalk *walker","sig":"git_revwalk *","return":{"type":"void"},"description":"<p>Reset the revision walker for reuse.</p>\n","comments":"<p>This will clear all the pushed and hidden commits, and\nleave the walker in a blank state (just like at\ncreation) ready to receive new commit pushes and\nstart a new walk.</p>\n\n<p>The revision walk is automatically reset when a walk\nis over.</p>\n","group":"revwalk"},"git_revwalk_push":{"type":"function","file":"revwalk.h","line":102,"lineto":102,"args":[{"name":"walk","type":"git_revwalk *","comment":"the walker being used for the traversal."},{"name":"id","type":"const git_oid *","comment":"the oid of the commit to start from."}],"argline":"git_revwalk *walk, const git_oid *id","sig":"git_revwalk *::const git_oid *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Mark a commit to start traversal from.</p>\n","comments":"<p>The given OID must belong to a commit on the walked\nrepository.</p>\n\n<p>The given commit will be used as one of the roots\nwhen starting the revision walk. At least one commit\nmust be pushed onto the walker before a walk can\nbe started.</p>\n","group":"revwalk","examples":{"general.c":["ex/v0.18.0/general.html#git_revwalk_push-62"]}},"git_revwalk_push_glob":{"type":"function","file":"revwalk.h","line":117,"lineto":117,"args":[{"name":"walk","type":"git_revwalk *","comment":"the walker being used for the traversal"},{"name":"glob","type":"const char *","comment":"the glob pattern references should match"}],"argline":"git_revwalk *walk, const char *glob","sig":"git_revwalk *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Push matching references</p>\n","comments":"<p>The OIDs pointed to by the references that match the given glob\npattern will be pushed to the revision walker.</p>\n\n<p>A leading &#39;refs/&#39; is implied if not present as well as a trailing\n&#39;/ <em>&#39; if the glob lacks &#39;?&#39;, &#39;</em>&#39; or &#39;[&#39;.</p>\n","group":"revwalk"},"git_revwalk_push_head":{"type":"function","file":"revwalk.h","line":125,"lineto":125,"args":[{"name":"walk","type":"git_revwalk *","comment":"the walker being used for the traversal"}],"argline":"git_revwalk *walk","sig":"git_revwalk *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Push the repository&#39;s HEAD</p>\n","comments":"","group":"revwalk"},"git_revwalk_hide":{"type":"function","file":"revwalk.h","line":140,"lineto":140,"args":[{"name":"walk","type":"git_revwalk *","comment":"the walker being used for the traversal."},{"name":"commit_id","type":"const git_oid *","comment":"the oid of commit that will be ignored during the traversal"}],"argline":"git_revwalk *walk, const git_oid *commit_id","sig":"git_revwalk *::const git_oid *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Mark a commit (and its ancestors) uninteresting for the output.</p>\n","comments":"<p>The given OID must belong to a commit on the walked\nrepository.</p>\n\n<p>The resolved commit and all its parents will be hidden from the\noutput on the revision walk.</p>\n","group":"revwalk"},"git_revwalk_hide_glob":{"type":"function","file":"revwalk.h","line":156,"lineto":156,"args":[{"name":"walk","type":"git_revwalk *","comment":"the walker being used for the traversal"},{"name":"glob","type":"const char *","comment":"the glob pattern references should match"}],"argline":"git_revwalk *walk, const char *glob","sig":"git_revwalk *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Hide matching references.</p>\n","comments":"<p>The OIDs pointed to by the references that match the given glob\npattern and their ancestors will be hidden from the output on the\nrevision walk.</p>\n\n<p>A leading &#39;refs/&#39; is implied if not present as well as a trailing\n&#39;/ <em>&#39; if the glob lacks &#39;?&#39;, &#39;</em>&#39; or &#39;[&#39;.</p>\n","group":"revwalk"},"git_revwalk_hide_head":{"type":"function","file":"revwalk.h","line":164,"lineto":164,"args":[{"name":"walk","type":"git_revwalk *","comment":"the walker being used for the traversal"}],"argline":"git_revwalk *walk","sig":"git_revwalk *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Hide the repository&#39;s HEAD</p>\n","comments":"","group":"revwalk"},"git_revwalk_push_ref":{"type":"function","file":"revwalk.h","line":175,"lineto":175,"args":[{"name":"walk","type":"git_revwalk *","comment":"the walker being used for the traversal"},{"name":"refname","type":"const char *","comment":"the reference to push"}],"argline":"git_revwalk *walk, const char *refname","sig":"git_revwalk *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Push the OID pointed to by a reference</p>\n","comments":"<p>The reference must point to a commit.</p>\n","group":"revwalk"},"git_revwalk_hide_ref":{"type":"function","file":"revwalk.h","line":186,"lineto":186,"args":[{"name":"walk","type":"git_revwalk *","comment":"the walker being used for the traversal"},{"name":"refname","type":"const char *","comment":"the reference to hide"}],"argline":"git_revwalk *walk, const char *refname","sig":"git_revwalk *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Hide the OID pointed to by a reference</p>\n","comments":"<p>The reference must point to a commit.</p>\n","group":"revwalk"},"git_revwalk_next":{"type":"function","file":"revwalk.h","line":206,"lineto":206,"args":[{"name":"out","type":"git_oid *","comment":"Pointer where to store the oid of the next commit"},{"name":"walk","type":"git_revwalk *","comment":"the walker to pop the commit from."}],"argline":"git_oid *out, git_revwalk *walk","sig":"git_oid *::git_revwalk *","return":{"type":"int","comment":"0 if the next commit was found; GIT_ITEROVER if there are no commits left to iterate"},"description":"<p>Get the next commit from the revision walk.</p>\n","comments":"<p>The initial call to this method is <em>not</em> blocking when\niterating through a repo with a time-sorting mode.</p>\n\n<p>Iterating with Topological or inverted modes makes the initial\ncall blocking to preprocess the commit list, but this block should be\nmostly unnoticeable on most repositories (topological preprocessing\ntimes at 0.3s on the git.git repo).</p>\n\n<p>The revision walker is reset when the walk is over.</p>\n","group":"revwalk","examples":{"general.c":["ex/v0.18.0/general.html#git_revwalk_next-63"]}},"git_revwalk_sorting":{"type":"function","file":"revwalk.h","line":217,"lineto":217,"args":[{"name":"walk","type":"git_revwalk *","comment":"the walker being used for the traversal."},{"name":"sort_mode","type":"unsigned int","comment":"combination of GIT_SORT_XXX flags"}],"argline":"git_revwalk *walk, unsigned int sort_mode","sig":"git_revwalk *::unsigned int","return":{"type":"void"},"description":"<p>Change the sorting mode when iterating through the\nrepository&#39;s contents.</p>\n","comments":"<p>Changing the sorting mode resets the walker.</p>\n","group":"revwalk","examples":{"general.c":["ex/v0.18.0/general.html#git_revwalk_sorting-64"]}},"git_revwalk_push_range":{"type":"function","file":"revwalk.h","line":232,"lineto":232,"args":[{"name":"walk","type":"git_revwalk *","comment":"the walker being used for the traversal"},{"name":"range","type":"const char *","comment":"the range"}],"argline":"git_revwalk *walk, const char *range","sig":"git_revwalk *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Push and hide the respective endpoints of the given range.</p>\n","comments":"<p>The range should be of the form\n <commit>..<commit>\nwhere each <commit> is in the form accepted by &#39;git_revparse_single&#39;.\nThe left-hand commit will be hidden and the right-hand commit pushed.</p>\n","group":"revwalk"},"git_revwalk_free":{"type":"function","file":"revwalk.h","line":239,"lineto":239,"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":"<p>Free a revision walker previously allocated.</p>\n","comments":"","group":"revwalk","examples":{"general.c":["ex/v0.18.0/general.html#git_revwalk_free-65"]}},"git_revwalk_repository":{"type":"function","file":"revwalk.h","line":248,"lineto":248,"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":"<p>Return the repository on which this walker\nis operating.</p>\n","comments":"","group":"revwalk"},"git_signature_new":{"type":"function","file":"signature.h","line":37,"lineto":37,"args":[{"name":"out","type":"git_signature **","comment":"new signature, in case of error NULL"},{"name":"name","type":"const char *","comment":"name of the person"},{"name":"email","type":"const char *","comment":"email of the person"},{"name":"time","type":"git_time_t","comment":"time when the action happened"},{"name":"offset","type":"int","comment":"timezone offset in minutes for the time"}],"argline":"git_signature **out, const char *name, const char *email, git_time_t time, int offset","sig":"git_signature **::const char *::const char *::git_time_t::int","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create a new action signature.</p>\n","comments":"<p>Call <code>git_signature_free()</code> to free the data.</p>\n\n<p>Note: angle brackets (&#39;&lt;&#39; and &#39;&gt;&#39;) characters are not allowed\nto be used in either the <code>name</code> or the <code>email</code> parameter.</p>\n","group":"signature","examples":{"general.c":["ex/v0.18.0/general.html#git_signature_new-66","ex/v0.18.0/general.html#git_signature_new-67"]}},"git_signature_now":{"type":"function","file":"signature.h","line":49,"lineto":49,"args":[{"name":"out","type":"git_signature **","comment":"new signature, in case of error NULL"},{"name":"name","type":"const char *","comment":"name of the person"},{"name":"email","type":"const char *","comment":"email of the person"}],"argline":"git_signature **out, const char *name, const char *email","sig":"git_signature **::const char *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create a new action signature with a timestamp of &#39;now&#39;.</p>\n","comments":"<p>Call <code>git_signature_free()</code> to free the data.</p>\n","group":"signature"},"git_signature_dup":{"type":"function","file":"signature.h","line":61,"lineto":61,"args":[{"name":"sig","type":"const git_signature *","comment":"signature to duplicated"}],"argline":"const git_signature *sig","sig":"const git_signature *","return":{"type":"git_signature *","comment":"a copy of sig, NULL on out of memory"},"description":"<p>Create a copy of an existing signature. All internal strings are also\nduplicated.</p>\n","comments":"<p>Call <code>git_signature_free()</code> to free the data.</p>\n","group":"signature"},"git_signature_free":{"type":"function","file":"signature.h","line":72,"lineto":72,"args":[{"name":"sig","type":"git_signature *","comment":"signature to free"}],"argline":"git_signature *sig","sig":"git_signature *","return":{"type":"void"},"description":"<p>Free an existing signature.</p>\n","comments":"<p>Because the signature is not an opaque structure, it is legal to free it\nmanually, but be sure to free the &quot;name&quot; and &quot;email&quot; strings in addition\nto the structure itself.</p>\n","group":"signature"},"git_stash_save":{"type":"function","file":"stash.h","line":57,"lineto":62,"args":[{"name":"out","type":"git_oid *","comment":"Object id of the commit containing the stashed state. This commit is also the target of the direct reference refs/stash."},{"name":"repo","type":"git_repository *","comment":"The owning repository."},{"name":"stasher","type":"git_signature *","comment":"The identity of the person performing the stashing."},{"name":"message","type":"const char *","comment":"Optional description along with the stashed state."},{"name":"flags","type":"unsigned int","comment":"Flags to control the stashing process. (see GIT_STASH_* above)"}],"argline":"git_oid *out,\n\tgit_repository *repo,\n\tgit_signature *stasher,\n\tconst char *message,\n\tunsigned int flags","sig":"git_oid *::git_repository *::git_signature *::const char *::unsigned int","return":{"type":"int","comment":"0 on success, GIT_ENOTFOUND where there's nothing to stash, or error code."},"description":"<p>Save the local modifications to a new stash.</p>\n","comments":"","group":"stash"},"git_stash_foreach":{"type":"function","file":"stash.h","line":99,"lineto":102,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where to find the stash."},{"name":"callback","type":"git_stash_cb"},{"name":"payload","type":"void *","comment":"Extra parameter to callback function."}],"argline":"git_repository *repo,\n\tgit_stash_cb callback,\n\tvoid *payload","sig":"git_repository *::git_stash_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Loop over all the stashed states and issue a callback for each one.</p>\n","comments":"<p>If the callback returns a non-zero value, this will stop looping.</p>\n","group":"stash"},"git_stash_drop":{"type":"function","file":"stash.h","line":114,"lineto":116,"args":[{"name":"repo","type":"git_repository *","comment":"The owning repository."},{"name":"index","type":"size_t","comment":"The position within the stash list. 0 points to the most recent stashed state."}],"argline":"git_repository *repo,\n\tsize_t index","sig":"git_repository *::size_t","return":{"type":"int","comment":"0 on success, or error code"},"description":"<p>Remove a single stashed state from the stash list.</p>\n","comments":"","group":"stash"},"git_status_foreach":{"type":"function","file":"status.h","line":76,"lineto":79,"args":[{"name":"repo","type":"git_repository *","comment":"A repository object"},{"name":"callback","type":"git_status_cb","comment":"The function to call on each file"},{"name":"payload","type":"void *","comment":"Pointer to pass through to callback function"}],"argline":"git_repository *repo,\n\tgit_status_cb callback,\n\tvoid *payload","sig":"git_repository *::git_status_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Gather file statuses and run a callback for each one.</p>\n","comments":"<p>The callback is passed the path of the file, the status (a combination of\nthe <code>git_status_t</code> values above) and the <code>payload</code> data pointer passed\ninto this function.</p>\n\n<p>If the callback returns a non-zero value, this function will stop looping\nand return GIT_EUSER.</p>\n","group":"status"},"git_status_foreach_ext":{"type":"function","file":"status.h","line":194,"lineto":198,"args":[{"name":"repo","type":"git_repository *","comment":"Repository object"},{"name":"opts","type":"const git_status_options *","comment":"Status options structure"},{"name":"callback","type":"git_status_cb","comment":"The function to call on each file"},{"name":"payload","type":"void *","comment":"Pointer to pass through to callback function"}],"argline":"git_repository *repo,\n\tconst git_status_options *opts,\n\tgit_status_cb callback,\n\tvoid *payload","sig":"git_repository *::const git_status_options *::git_status_cb::void *","return":{"type":"int","comment":"0 on success, GIT_EUSER on non-zero callback, or error code"},"description":"<p>Gather file status information and run callbacks as requested.</p>\n","comments":"<p>This is an extended version of the <code>git_status_foreach()</code> API that\nallows for more granular control over which paths will be processed and\nin what order. See the <code>git_status_options</code> structure for details\nabout the additional controls that this makes available.</p>\n","group":"status"},"git_status_file":{"type":"function","file":"status.h","line":213,"lineto":216,"args":[{"name":"status_flags","type":"unsigned int *","comment":"The status value for the file"},{"name":"repo","type":"git_repository *","comment":"A repository object"},{"name":"path","type":"const char *","comment":"The file to retrieve status for, rooted at the repo's workdir"}],"argline":"unsigned int *status_flags,\n\tgit_repository *repo,\n\tconst char *path","sig":"unsigned int *::git_repository *::const char *","return":{"type":"int","comment":"0 on success, GIT_ENOTFOUND if the file is not found in the HEAD, index, and work tree, GIT_EINVALIDPATH if `path` points at a folder, GIT_EAMBIGUOUS if \"path\" matches multiple files, -1 on other error."},"description":"<p>Get file status for a single file.</p>\n","comments":"<p>This is not quite the same as calling <code>git_status_foreach_ext()</code> with\nthe pathspec set to the specified path.</p>\n","group":"status"},"git_status_should_ignore":{"type":"function","file":"status.h","line":234,"lineto":237,"args":[{"name":"ignored","type":"int *","comment":"Boolean returning 0 if the file is not ignored, 1 if it is"},{"name":"repo","type":"git_repository *","comment":"A repository object"},{"name":"path","type":"const char *","comment":"The file to check ignores for, rooted at the repo's workdir."}],"argline":"int *ignored,\n\tgit_repository *repo,\n\tconst char *path","sig":"int *::git_repository *::const char *","return":{"type":"int","comment":"0 if ignore rules could be processed for the file (regardless of whether it exists or not), or an error < 0 if they could not."},"description":"<p>Test if the ignore rules apply to a given file.</p>\n","comments":"<p>This function checks the ignore rules to see if they would apply to the\ngiven file. This indicates if the file would be ignored regardless of\nwhether the file is already in the index or committed to the repository.</p>\n\n<p>One way to think of this is if you were to do &quot;git add .&quot; on the\ndirectory containing the file, would it be added or not?</p>\n","group":"status"},"git_strarray_free":{"type":"function","file":"strarray.h","line":41,"lineto":41,"args":[{"name":"array","type":"git_strarray *","comment":"git_strarray from which to free string data"}],"argline":"git_strarray *array","sig":"git_strarray *","return":{"type":"void"},"description":"<p>Close a string array object</p>\n","comments":"<p>This method should be called on <code>git_strarray</code> objects where the strings\narray is allocated and contains allocated strings, such as what you\nwould get from <code>git_strarray_copy()</code>. Not doing so, will result in a\nmemory leak.</p>\n\n<p>This does not free the <code>git_strarray</code> itself, since the library will\nnever allocate that object directly itself (it is more commonly embedded\ninside another struct or created on the stack).</p>\n","group":"strarray","examples":{"general.c":["ex/v0.18.0/general.html#git_strarray_free-68"]}},"git_strarray_copy":{"type":"function","file":"strarray.h","line":53,"lineto":53,"args":[{"name":"tgt","type":"git_strarray *","comment":"target"},{"name":"src","type":"const git_strarray *","comment":"source"}],"argline":"git_strarray *tgt, const git_strarray *src","sig":"git_strarray *::const git_strarray *","return":{"type":"int","comment":"0 on success, < 0 on allocation failure"},"description":"<p>Copy a string array object from source to target.</p>\n","comments":"<p>Note: target is overwritten and hence should be empty, otherwise its\ncontents are leaked. Call git_strarray_free() if necessary.</p>\n","group":"strarray"},"git_submodule_lookup":{"type":"function","file":"submodule.h","line":178,"lineto":181,"args":[{"name":"submodule","type":"git_submodule **","comment":"Pointer to submodule description object pointer.."},{"name":"repo","type":"git_repository *","comment":"The repository."},{"name":"name","type":"const char *","comment":"The name of the submodule. Trailing slashes will be ignored."}],"argline":"git_submodule **submodule,\n\tgit_repository *repo,\n\tconst char *name","sig":"git_submodule **::git_repository *::const char *","return":{"type":"int","comment":"0 on success, GIT_ENOTFOUND if submodule does not exist, GIT_EEXISTS if submodule exists in working directory only, -1 on other errors."},"description":"<p>Lookup submodule information by name or path.</p>\n","comments":"<p>Given either the submodule name or path (they are usually the same), this\nreturns a structure describing the submodule.</p>\n\n<p>There are two expected error scenarios:</p>\n\n<ul>\n<li>The submodule is not mentioned in the HEAD, the index, and the config,\nbut does &quot;exist&quot; in the working directory (i.e. there is a subdirectory\nthat is a valid self-contained git repo). In this case, this function\nreturns GIT_EEXISTS to indicate the the submodule exists but not in a\nstate where a git_submodule can be instantiated.</li>\n<li>The submodule is not mentioned in the HEAD, index, or config and the\nworking directory doesn&#39;t contain a value git repo at that path.\nThere may or may not be anything else at that path, but nothing that\nlooks like a submodule. In this case, this returns GIT_ENOTFOUND.</li>\n</ul>\n\n<p>The submodule object is owned by the containing repo and will be freed\nwhen the repo is freed. The caller need not free the submodule.</p>\n","group":"submodule"},"git_submodule_foreach":{"type":"function","file":"submodule.h","line":201,"lineto":204,"args":[{"name":"repo","type":"git_repository *","comment":"The repository"},{"name":"callback","type":"int (*)(git_submodule *sm, const char *name, void *payload)","comment":"Function to be called with the name of each submodule. Return a non-zero value to terminate the iteration."},{"name":"payload","type":"void *","comment":"Extra data to pass to callback"}],"argline":"git_repository *repo,\n\tint (*callback)(git_submodule *sm, const char *name, void *payload),\n\tvoid *payload","sig":"git_repository *::int (*)(git_submodule *sm, const char *name, void *payload)::void *","return":{"type":"int","comment":"0 on success, -1 on error, or non-zero return value of callback"},"description":"<p>Iterate over all tracked submodules of a repository.</p>\n","comments":"<p>See the note on <code>git_submodule</code> above. This iterates over the tracked\nsubmodules as decribed therein.</p>\n\n<p>If you are concerned about items in the working directory that look like\nsubmodules but are not tracked, the diff API will generate a diff record\nfor workdir items that look like submodules but are not tracked, showing\nthem as added in the workdir. Also, the status API will treat the entire\nsubdirectory of a contained git repo as a single GIT_STATUS_WT_NEW item.</p>\n","group":"submodule"},"git_submodule_add_setup":{"type":"function","file":"submodule.h","line":229,"lineto":234,"args":[{"name":"submodule","type":"git_submodule **","comment":"The newly created submodule ready to open for clone"},{"name":"repo","type":"git_repository *","comment":"Superproject repository to contain the new submodule"},{"name":"url","type":"const char *","comment":"URL for the submodules remote"},{"name":"path","type":"const char *","comment":"Path at which the submodule should be created"},{"name":"use_gitlink","type":"int","comment":"Should workdir contain a gitlink to the repo in .git/modules vs. repo directly in workdir."}],"argline":"git_submodule **submodule,\n\tgit_repository *repo,\n\tconst char *url,\n\tconst char *path,\n\tint use_gitlink","sig":"git_submodule **::git_repository *::const char *::const char *::int","return":{"type":"int","comment":"0 on success, GIT_EEXISTS if submodule already exists, -1 on other errors."},"description":"<p>Set up a new git submodule for checkout.</p>\n","comments":"<p>This does &quot;git submodule add&quot; up to the fetch and checkout of the\nsubmodule contents. It preps a new submodule, creates an entry in\n.gitmodules and creates an empty initialized repository either at the\ngiven path in the working directory or in .git/modules with a gitlink\nfrom the working directory to the new repo.</p>\n\n<p>To fully emulate &quot;git submodule add&quot; call this function, then open the\nsubmodule repo and perform the clone step as needed. Lastly, call\n<code>git_submodule_add_finalize()</code> to wrap up adding the new submodule and\n.gitmodules to the index to be ready to commit.</p>\n","group":"submodule"},"git_submodule_add_finalize":{"type":"function","file":"submodule.h","line":246,"lineto":246,"args":[{"name":"submodule","type":"git_submodule *","comment":"The submodule to finish adding."}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"int"},"description":"<p>Resolve the setup of a new git submodule.</p>\n","comments":"<p>This should be called on a submodule once you have called add setup\nand done the clone of the submodule. This adds the .gitmodules file\nand the newly cloned submodule to the index to be ready to be committed\n(but doesn&#39;t actually do the commit).</p>\n","group":"submodule"},"git_submodule_add_to_index":{"type":"function","file":"submodule.h","line":258,"lineto":260,"args":[{"name":"submodule","type":"git_submodule *","comment":"The submodule to add to the index"},{"name":"write_index","type":"int","comment":"Boolean if this should immediately write the index file. If you pass this as false, you will have to get the git_index and explicitly call `git_index_write()` on it to save the change."}],"argline":"git_submodule *submodule,\n\tint write_index","sig":"git_submodule *::int","return":{"type":"int","comment":"0 on success, <0 on failure"},"description":"<p>Add current submodule HEAD commit to index of superproject.</p>\n","comments":"","group":"submodule"},"git_submodule_save":{"type":"function","file":"submodule.h","line":274,"lineto":274,"args":[{"name":"submodule","type":"git_submodule *","comment":"The submodule to write."}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"int","comment":"0 on success, <0 on failure."},"description":"<p>Write submodule settings to .gitmodules file.</p>\n","comments":"<p>This commits any in-memory changes to the submodule to the gitmodules\nfile on disk. You may also be interested in <code>git_submodule_init()</code> which\nwrites submodule info to &quot;.git/config&quot; (which is better for local changes\nto submodule settings) and/or <code>git_submodule_sync()</code> which writes\nsettings about remotes to the actual submodule repository.</p>\n","group":"submodule"},"git_submodule_owner":{"type":"function","file":"submodule.h","line":287,"lineto":287,"args":[{"name":"submodule","type":"git_submodule *","comment":"Pointer to submodule object"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"git_repository *","comment":"Pointer to `git_repository`"},"description":"<p>Get the containing repository for a submodule.</p>\n","comments":"<p>This returns a pointer to the repository that contains the submodule.\nThis is a just a reference to the repository that was passed to the\noriginal <code>git_submodule_lookup()</code> call, so if that repository has been\nfreed, then this may be a dangling reference.</p>\n","group":"submodule"},"git_submodule_name":{"type":"function","file":"submodule.h","line":295,"lineto":295,"args":[{"name":"submodule","type":"git_submodule *","comment":"Pointer to submodule object"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"const char *","comment":"Pointer to the submodule name"},"description":"<p>Get the name of submodule.</p>\n","comments":"","group":"submodule"},"git_submodule_path":{"type":"function","file":"submodule.h","line":306,"lineto":306,"args":[{"name":"submodule","type":"git_submodule *","comment":"Pointer to submodule object"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"const char *","comment":"Pointer to the submodule path"},"description":"<p>Get the path to the submodule.</p>\n","comments":"<p>The path is almost always the same as the submodule name, but the\ntwo are actually not required to match.</p>\n","group":"submodule"},"git_submodule_url":{"type":"function","file":"submodule.h","line":314,"lineto":314,"args":[{"name":"submodule","type":"git_submodule *","comment":"Pointer to submodule object"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"const char *","comment":"Pointer to the submodule url"},"description":"<p>Get the URL for the submodule.</p>\n","comments":"","group":"submodule"},"git_submodule_set_url":{"type":"function","file":"submodule.h","line":330,"lineto":330,"args":[{"name":"submodule","type":"git_submodule *","comment":"Pointer to the submodule object"},{"name":"url","type":"const char *","comment":"URL that should be used for the submodule"}],"argline":"git_submodule *submodule, const char *url","sig":"git_submodule *::const char *","return":{"type":"int","comment":"0 on success, <0 on failure"},"description":"<p>Set the URL for the submodule.</p>\n","comments":"<p>This sets the URL in memory for the submodule. This will be used for\nany following submodule actions while this submodule data is in memory.</p>\n\n<p>After calling this, you may wish to call <code>git_submodule_save()</code> to write\nthe changes back to the &quot;.gitmodules&quot; file and <code>git_submodule_sync()</code> to\nwrite the changes to the checked out submodule repository.</p>\n","group":"submodule"},"git_submodule_index_id":{"type":"function","file":"submodule.h","line":338,"lineto":338,"args":[{"name":"submodule","type":"git_submodule *","comment":"Pointer to submodule object"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"const git_oid *","comment":"Pointer to git_oid or NULL if submodule is not in index."},"description":"<p>Get the OID for the submodule in the index.</p>\n","comments":"","group":"submodule"},"git_submodule_head_id":{"type":"function","file":"submodule.h","line":346,"lineto":346,"args":[{"name":"submodule","type":"git_submodule *","comment":"Pointer to submodule object"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"const git_oid *","comment":"Pointer to git_oid or NULL if submodule is not in the HEAD."},"description":"<p>Get the OID for the submodule in the current HEAD tree.</p>\n","comments":"","group":"submodule"},"git_submodule_wd_id":{"type":"function","file":"submodule.h","line":359,"lineto":359,"args":[{"name":"submodule","type":"git_submodule *","comment":"Pointer to submodule object"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"const git_oid *","comment":"Pointer to git_oid or NULL if submodule is not checked out."},"description":"<p>Get the OID for the submodule in the current working directory.</p>\n","comments":"<p>This returns the OID that corresponds to looking up &#39;HEAD&#39; in the checked\nout submodule. If there are pending changes in the index or anything\nelse, this won&#39;t notice that. You should call <code>git_submodule_status()</code>\nfor a more complete picture about the state of the working directory.</p>\n","group":"submodule"},"git_submodule_ignore":{"type":"function","file":"submodule.h","line":379,"lineto":380,"args":[{"name":"submodule","type":"git_submodule *"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"git_submodule_ignore_t"},"description":"<p>Get the ignore rule for the submodule.</p>\n","comments":"<p>There are four ignore values:</p>\n\n<ul>\n<li><strong>GIT_SUBMODULE_IGNORE_NONE</strong> will consider any change to the contents\nof the submodule from a clean checkout to be dirty, including the\naddition of untracked files. This is the default if unspecified.</li>\n<li><strong>GIT_SUBMODULE_IGNORE_UNTRACKED</strong> examines the contents of the\nworking tree (i.e. call <code>git_status_foreach()</code> on the submodule) but\nUNTRACKED files will not count as making the submodule dirty.</li>\n<li><strong>GIT_SUBMODULE_IGNORE_DIRTY</strong> means to only check if the HEAD of the\nsubmodule has moved for status. This is fast since it does not need to\nscan the working tree of the submodule at all.</li>\n<li><strong>GIT_SUBMODULE_IGNORE_ALL</strong> means not to open the submodule repo.\nThe working directory will be consider clean so long as there is a\nchecked out version present.</li>\n</ul>\n","group":"submodule"},"git_submodule_set_ignore":{"type":"function","file":"submodule.h","line":396,"lineto":398,"args":[{"name":"submodule","type":"git_submodule *"},{"name":"ignore","type":"git_submodule_ignore_t"}],"argline":"git_submodule *submodule,\n\tgit_submodule_ignore_t ignore","sig":"git_submodule *::git_submodule_ignore_t","return":{"type":"git_submodule_ignore_t","comment":"old value for ignore"},"description":"<p>Set the ignore rule for the submodule.</p>\n","comments":"<p>This sets the ignore rule in memory for the submodule. This will be used\nfor any following actions (such as <code>git_submodule_status()</code>) while the\nsubmodule is in memory. You should call <code>git_submodule_save()</code> if you\nwant to persist the new ignore role.</p>\n\n<p>Calling this again with GIT_SUBMODULE_IGNORE_DEFAULT or calling\n<code>git_submodule_reload()</code> will revert the rule to the value that was in the\noriginal config.</p>\n","group":"submodule"},"git_submodule_update":{"type":"function","file":"submodule.h","line":403,"lineto":404,"args":[{"name":"submodule","type":"git_submodule *"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"git_submodule_update_t"},"description":"<p>Get the update rule for the submodule.</p>\n","comments":"","group":"submodule"},"git_submodule_set_update":{"type":"function","file":"submodule.h","line":418,"lineto":420,"args":[{"name":"submodule","type":"git_submodule *"},{"name":"update","type":"git_submodule_update_t"}],"argline":"git_submodule *submodule,\n\tgit_submodule_update_t update","sig":"git_submodule *::git_submodule_update_t","return":{"type":"git_submodule_update_t","comment":"old value for update"},"description":"<p>Set the update rule for the submodule.</p>\n","comments":"<p>This sets the update rule in memory for the submodule. You should call\n<code>git_submodule_save()</code> if you want to persist the new update rule.</p>\n\n<p>Calling this again with GIT_SUBMODULE_UPDATE_DEFAULT or calling\n<code>git_submodule_reload()</code> will revert the rule to the value that was in the\noriginal config.</p>\n","group":"submodule"},"git_submodule_fetch_recurse_submodules":{"type":"function","file":"submodule.h","line":433,"lineto":434,"args":[{"name":"submodule","type":"git_submodule *"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"int","comment":"0 if fetchRecurseSubmodules is false, 1 if true"},"description":"<p>Read the fetchRecurseSubmodules rule for a submodule.</p>\n","comments":"<p>This accesses the submodule.<name>.fetchRecurseSubmodules value for\nthe submodule that controls fetching behavior for the submodule.</p>\n\n<p>Note that at this time, libgit2 does not honor this setting and the\nfetch functionality current ignores submodules.</p>\n","group":"submodule"},"git_submodule_set_fetch_recurse_submodules":{"type":"function","file":"submodule.h","line":447,"lineto":449,"args":[{"name":"submodule","type":"git_submodule *","comment":"The submodule to modify"},{"name":"fetch_recurse_submodules","type":"int","comment":"Boolean value"}],"argline":"git_submodule *submodule,\n\tint fetch_recurse_submodules","sig":"git_submodule *::int","return":{"type":"int","comment":"old value for fetchRecurseSubmodules"},"description":"<p>Set the fetchRecurseSubmodules rule for a submodule.</p>\n","comments":"<p>This sets the submodule.<name>.fetchRecurseSubmodules value for\nthe submodule. You should call <code>git_submodule_save()</code> if you want\nto persist the new value.</p>\n","group":"submodule"},"git_submodule_init":{"type":"function","file":"submodule.h","line":464,"lineto":464,"args":[{"name":"submodule","type":"git_submodule *","comment":"The submodule to write into the superproject config"},{"name":"overwrite","type":"int","comment":"By default, existing entries will not be overwritten, but setting this to true forces them to be updated."}],"argline":"git_submodule *submodule, int overwrite","sig":"git_submodule *::int","return":{"type":"int","comment":"0 on success, <0 on failure."},"description":"<p>Copy submodule info into &quot;.git/config&quot; file.</p>\n","comments":"<p>Just like &quot;git submodule init&quot;, this copies information about the\nsubmodule into &quot;.git/config&quot;. You can use the accessor functions\nabove to alter the in-memory git_submodule object and control what\nis written to the config, overriding what is in .gitmodules.</p>\n","group":"submodule"},"git_submodule_sync":{"type":"function","file":"submodule.h","line":474,"lineto":474,"args":[{"name":"submodule","type":"git_submodule *"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"int"},"description":"<p>Copy submodule remote info into submodule repo.</p>\n","comments":"<p>This copies the information about the submodules URL into the checked out\nsubmodule config, acting like &quot;git submodule sync&quot;. This is useful if\nyou have altered the URL for the submodule (or it has been altered by a\nfetch of upstream changes) and you need to update your local repo.</p>\n","group":"submodule"},"git_submodule_open":{"type":"function","file":"submodule.h","line":488,"lineto":490,"args":[{"name":"repo","type":"git_repository **"},{"name":"submodule","type":"git_submodule *","comment":"Submodule to be opened"}],"argline":"git_repository **repo,\n\tgit_submodule *submodule","sig":"git_repository **::git_submodule *","return":{"type":"int","comment":"0 on success, <0 if submodule repo could not be opened."},"description":"<p>Open the repository for a submodule.</p>\n","comments":"<p>This is a newly opened repository object. The caller is responsible for\ncalling <code>git_repository_free()</code> on it when done. Multiple calls to this\nfunction will return distinct <code>git_repository</code> objects. This will only\nwork if the submodule is checked out into the working directory.</p>\n","group":"submodule"},"git_submodule_reload":{"type":"function","file":"submodule.h","line":498,"lineto":498,"args":[{"name":"submodule","type":"git_submodule *"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"int"},"description":"<p>Reread submodule info from config, index, and HEAD.</p>\n","comments":"<p>Call this to reread cached submodule information for this submodule if\nyou have reason to believe that it has changed.</p>\n","group":"submodule"},"git_submodule_reload_all":{"type":"function","file":"submodule.h","line":505,"lineto":505,"args":[{"name":"repo","type":"git_repository *"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"int"},"description":"<p>Reread all submodule info.</p>\n","comments":"<p>Call this to reload all cached submodule information for the repo.</p>\n","group":"submodule"},"git_submodule_status":{"type":"function","file":"submodule.h","line":520,"lineto":522,"args":[{"name":"status","type":"unsigned int *","comment":"Combination of `GIT_SUBMODULE_STATUS` flags"},{"name":"submodule","type":"git_submodule *","comment":"Submodule for which to get status"}],"argline":"unsigned int *status,\n\tgit_submodule *submodule","sig":"unsigned int *::git_submodule *","return":{"type":"int","comment":"0 on success, <0 on error"},"description":"<p>Get the status for a submodule.</p>\n","comments":"<p>This looks at a submodule and tries to determine the status. It\nwill return a combination of the <code>GIT_SUBMODULE_STATUS</code> values above.\nHow deeply it examines the working directory to do this will depend\non the <code>git_submodule_ignore_t</code> value for the submodule - which can be\nset either temporarily or permanently with <code>git_submodule_set_ignore()</code>.</p>\n","group":"submodule"},"git_submodule_location":{"type":"function","file":"submodule.h","line":538,"lineto":540,"args":[{"name":"location_status","type":"unsigned int *"},{"name":"submodule","type":"git_submodule *","comment":"Submodule for which to get status"}],"argline":"unsigned int *location_status,\n\tgit_submodule *submodule","sig":"unsigned int *::git_submodule *","return":{"type":"int","comment":"0 on success, <0 on error"},"description":"<p>Get the locations of submodule information.</p>\n","comments":"<p>This is a bit like a very lightweight version of <code>git_submodule_status</code>.\nIt just returns a made of the first four submodule status values (i.e.\nthe ones like GIT_SUBMODULE_STATUS_IN_HEAD, etc) that tell you where the\nsubmodule data comes from (i.e. the HEAD commit, gitmodules file, etc.).\nThis can be useful if you want to know if the submodule is present in the\nworking directory at this point in time, etc.</p>\n","group":"submodule"},"git_tag_lookup":{"type":"function","file":"tag.h","line":33,"lineto":38,"args":[{"name":"out","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 **out, git_repository *repo, const git_oid *id","sig":"git_tag **::git_repository *::const git_oid *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Lookup a tag object from the repository.</p>\n","comments":"","group":"tag","examples":{"general.c":["ex/v0.18.0/general.html#git_tag_lookup-69"]}},"git_tag_lookup_prefix":{"type":"function","file":"tag.h","line":52,"lineto":57,"args":[{"name":"out","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."},{"name":"len","type":"size_t","comment":"the length of the short identifier"}],"argline":"git_tag **out, git_repository *repo, const git_oid *id, size_t len","sig":"git_tag **::git_repository *::const git_oid *::size_t","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Lookup a tag object from the repository,\ngiven a prefix of its identifier (short id).</p>\n","comments":"<p>@see git_object_lookup_prefix</p>\n","group":"tag"},"git_tag_free":{"type":"function","file":"tag.h","line":69,"lineto":72,"args":[{"name":"tag","type":"git_tag *","comment":"the tag to close"}],"argline":"git_tag *tag","sig":"git_tag *","return":{"type":"void"},"description":"<p>Close an open tag</p>\n","comments":"<p>You can no longer use the git_tag pointer after this call.</p>\n\n<p>IMPORTANT: You MUST call this method when you are through with a tag to\nrelease memory. Failure to do so will cause a memory leak.</p>\n","group":"tag"},"git_tag_id":{"type":"function","file":"tag.h","line":82,"lineto":82,"args":[{"name":"tag","type":"const git_tag *","comment":"a previously loaded tag."}],"argline":"const git_tag *tag","sig":"const git_tag *","return":{"type":"const git_oid *","comment":"object identity for the tag."},"description":"<p>Get the id of a tag.</p>\n","comments":"","group":"tag"},"git_tag_target":{"type":"function","file":"tag.h","line":94,"lineto":94,"args":[{"name":"target_out","type":"git_object **","comment":"pointer where to store the target"},{"name":"tag","type":"const git_tag *","comment":"a previously loaded tag."}],"argline":"git_object **target_out, const git_tag *tag","sig":"git_object **::const git_tag *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Get the tagged object of a tag</p>\n","comments":"<p>This method performs a repository lookup for the\ngiven object and returns it</p>\n","group":"tag","examples":{"general.c":["ex/v0.18.0/general.html#git_tag_target-70"]}},"git_tag_target_id":{"type":"function","file":"tag.h","line":102,"lineto":102,"args":[{"name":"tag","type":"const git_tag *","comment":"a previously loaded tag."}],"argline":"const git_tag *tag","sig":"const git_tag *","return":{"type":"const git_oid *","comment":"pointer to the OID"},"description":"<p>Get the OID of the tagged object of a tag</p>\n","comments":"","group":"tag"},"git_tag_target_type":{"type":"function","file":"tag.h","line":110,"lineto":110,"args":[{"name":"tag","type":"const git_tag *","comment":"a previously loaded tag."}],"argline":"const git_tag *tag","sig":"const git_tag *","return":{"type":"git_otype","comment":"type of the tagged object"},"description":"<p>Get the type of a tag&#39;s tagged object</p>\n","comments":"","group":"tag","examples":{"general.c":["ex/v0.18.0/general.html#git_tag_target_type-71"]}},"git_tag_name":{"type":"function","file":"tag.h","line":118,"lineto":118,"args":[{"name":"tag","type":"const git_tag *","comment":"a previously loaded tag."}],"argline":"const git_tag *tag","sig":"const git_tag *","return":{"type":"const char *","comment":"name of the tag"},"description":"<p>Get the name of a tag</p>\n","comments":"","group":"tag","examples":{"general.c":["ex/v0.18.0/general.html#git_tag_name-72"]}},"git_tag_tagger":{"type":"function","file":"tag.h","line":126,"lineto":126,"args":[{"name":"tag","type":"const git_tag *","comment":"a previously loaded tag."}],"argline":"const git_tag *tag","sig":"const git_tag *","return":{"type":"const git_signature *","comment":"reference to the tag's author or NULL when unspecified"},"description":"<p>Get the tagger (author) of a tag</p>\n","comments":"","group":"tag"},"git_tag_message":{"type":"function","file":"tag.h","line":134,"lineto":134,"args":[{"name":"tag","type":"const git_tag *","comment":"a previously loaded tag."}],"argline":"const git_tag *tag","sig":"const git_tag *","return":{"type":"const char *","comment":"message of the tag or NULL when unspecified"},"description":"<p>Get the message of a tag</p>\n","comments":"","group":"tag","examples":{"general.c":["ex/v0.18.0/general.html#git_tag_message-73"]}},"git_tag_create":{"type":"function","file":"tag.h","line":176,"lineto":183,"args":[{"name":"oid","type":"git_oid *","comment":"Pointer where to store the OID of the newly created tag. If the tag already exists, this parameter will be the oid of the existing tag, and the function will return a GIT_EEXISTS error code."},{"name":"repo","type":"git_repository *","comment":"Repository where to store the tag"},{"name":"tag_name","type":"const char *","comment":"Name for the tag; this name is validated for consistency. It should also not conflict with an already existing tag name"},{"name":"target","type":"const git_object *","comment":"Object to which this tag points. This object must belong to the given `repo`."},{"name":"tagger","type":"const git_signature *","comment":"Signature of the tagger for this tag, and of the tagging time"},{"name":"message","type":"const char *","comment":"Full message for this tag"},{"name":"force","type":"int","comment":"Overwrite existing references"}],"argline":"git_oid *oid,\n\tgit_repository *repo,\n\tconst char *tag_name,\n\tconst git_object *target,\n\tconst git_signature *tagger,\n\tconst char *message,\n\tint force","sig":"git_oid *::git_repository *::const char *::const git_object *::const git_signature *::const char *::int","return":{"type":"int","comment":"0 on success, GIT_EINVALIDSPEC or an error code A tag object is written to the ODB, and a proper reference is written in the /refs/tags folder, pointing to it"},"description":"<p>Create a new tag in the repository from an object</p>\n","comments":"<p>A new reference will also be created pointing to\nthis tag object. If <code>force</code> is true and a reference\nalready exists with the given name, it&#39;ll be replaced.</p>\n\n<p>The message will not be cleaned up. This can be achieved\nthrough <code>git_message_prettify()</code>.</p>\n\n<p>The tag name will be checked for validity. You must avoid\nthe characters &#39;~&#39;, &#39;^&#39;, &#39;:&#39;, &#39;\\&#39;, &#39;?&#39;, &#39;[&#39;, and &#39;*&#39;, and the\nsequences &quot;..&quot; and &quot;@{&quot; which have special meaning to revparse.</p>\n","group":"tag"},"git_tag_create_frombuffer":{"type":"function","file":"tag.h","line":194,"lineto":198,"args":[{"name":"oid","type":"git_oid *","comment":"Pointer where to store the OID of the newly created tag"},{"name":"repo","type":"git_repository *","comment":"Repository where to store the tag"},{"name":"buffer","type":"const char *","comment":"Raw tag data"},{"name":"force","type":"int","comment":"Overwrite existing tags"}],"argline":"git_oid *oid,\n\tgit_repository *repo,\n\tconst char *buffer,\n\tint force","sig":"git_oid *::git_repository *::const char *::int","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"<p>Create a new tag in the repository from a buffer</p>\n","comments":"","group":"tag"},"git_tag_create_lightweight":{"type":"function","file":"tag.h","line":230,"lineto":235,"args":[{"name":"oid","type":"git_oid *","comment":"Pointer where to store the OID of the provided target object. If the tag already exists, this parameter will be filled with the oid of the existing pointed object and the function will return a GIT_EEXISTS error code."},{"name":"repo","type":"git_repository *","comment":"Repository where to store the lightweight tag"},{"name":"tag_name","type":"const char *","comment":"Name for the tag; this name is validated for consistency. It should also not conflict with an already existing tag name"},{"name":"target","type":"const git_object *","comment":"Object to which this tag points. This object must belong to the given `repo`."},{"name":"force","type":"int","comment":"Overwrite existing references"}],"argline":"git_oid *oid,\n\tgit_repository *repo,\n\tconst char *tag_name,\n\tconst git_object *target,\n\tint force","sig":"git_oid *::git_repository *::const char *::const git_object *::int","return":{"type":"int","comment":"0 on success, GIT_EINVALIDSPEC or an error code A proper reference is written in the /refs/tags folder, pointing to the provided target object"},"description":"<p>Create a new lightweight tag pointing at a target object</p>\n","comments":"<p>A new direct reference will be created pointing to\nthis target object. If <code>force</code> is true and a reference\nalready exists with the given name, it&#39;ll be replaced.</p>\n\n<p>The tag name will be checked for validity.\nSee <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"tag"},"git_tag_delete":{"type":"function","file":"tag.h","line":250,"lineto":252,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where lives the tag"},{"name":"tag_name","type":"const char *","comment":"Name of the tag to be deleted; this name is validated for consistency."}],"argline":"git_repository *repo,\n\tconst char *tag_name","sig":"git_repository *::const char *","return":{"type":"int","comment":"0 on success, GIT_EINVALIDSPEC or an error code"},"description":"<p>Delete an existing tag reference.</p>\n","comments":"<p>The tag name will be checked for validity.\nSee <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"tag"},"git_tag_list":{"type":"function","file":"tag.h","line":267,"lineto":269,"args":[{"name":"tag_names","type":"git_strarray *","comment":"Pointer to a git_strarray structure where the tag names will be stored"},{"name":"repo","type":"git_repository *","comment":"Repository where to find the tags"}],"argline":"git_strarray *tag_names,\n\tgit_repository *repo","sig":"git_strarray *::git_repository *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Fill a list with all the tags in the Repository</p>\n","comments":"<p>The string array will be filled with the names of the\nmatching tags; these values are owned by the user and\nshould be free&#39;d manually when no longer needed, using\n<code>git_strarray_free</code>.</p>\n","group":"tag"},"git_tag_list_match":{"type":"function","file":"tag.h","line":289,"lineto":295,"args":[{"name":"tag_names","type":"git_strarray *","comment":"Pointer to a git_strarray structure where the tag names will be stored"},{"name":"pattern","type":"const char *","comment":"Standard fnmatch pattern"},{"name":"repo","type":"git_repository *","comment":"Repository where to find the tags"}],"argline":"git_strarray *tag_names,\n\tconst char *pattern,\n\tgit_repository *repo","sig":"git_strarray *::const char *::git_repository *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Fill a list with all the tags in the Repository\nwhich name match a defined pattern</p>\n","comments":"<p>If an empty pattern is provided, all the tags\nwill be returned.</p>\n\n<p>The string array will be filled with the names of the\nmatching tags; these values are owned by the user and\nshould be free&#39;d manually when no longer needed, using\n<code>git_strarray_free</code>.</p>\n","group":"tag"},"git_tag_foreach":{"type":"function","file":"tag.h","line":304,"lineto":307,"args":[{"name":"repo","type":"git_repository *","comment":"Repository"},{"name":"callback","type":"git_tag_foreach_cb","comment":"Callback function"},{"name":"payload","type":"void *","comment":"Pointer to callback data (optional)"}],"argline":"git_repository *repo,\n\tgit_tag_foreach_cb callback,\n\tvoid *payload","sig":"git_repository *::git_tag_foreach_cb::void *","return":{"type":"int"},"description":"<p>Call callback `cb&#39; for each tag in the repository</p>\n","comments":"","group":"tag"},"git_tag_peel":{"type":"function","file":"tag.h","line":320,"lineto":322,"args":[{"name":"tag_target_out","type":"git_object **","comment":"Pointer to the peeled git_object"},{"name":"tag","type":"const git_tag *","comment":"_target_out Pointer to the peeled git_object"}],"argline":"git_object **tag_target_out,\n\tconst git_tag *tag","sig":"git_object **::const git_tag *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Recursively peel a tag until a non tag git_object is found</p>\n","comments":"<p>The retrieved <code>tag_target</code> object is owned by the repository\nand should be closed with the <code>git_object_free</code> method.</p>\n","group":"tag"},"git_threads_init":{"type":"function","file":"threads.h","line":33,"lineto":33,"args":[],"argline":"void","sig":"","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Init the threading system.</p>\n","comments":"<p>If libgit2 has been built with GIT_THREADS\non, this function must be called once before\nany other library functions.</p>\n\n<p>If libgit2 has been built without GIT_THREADS\nsupport, this function is a no-op.</p>\n","group":"threads"},"git_threads_shutdown":{"type":"function","file":"threads.h","line":45,"lineto":45,"args":[],"argline":"void","sig":"","return":{"type":"void"},"description":"<p>Shutdown the threading system.</p>\n","comments":"<p>If libgit2 has been built with GIT_THREADS\non, this function must be called before shutting\ndown the library.</p>\n\n<p>If libgit2 has been built without GIT_THREADS\nsupport, this function is a no-op.</p>\n","group":"threads"},"git_trace_set":{"type":"function","file":"trace.h","line":63,"lineto":63,"args":[{"name":"level","type":"git_trace_level_t","comment":"Level to set tracing to"},{"name":"cb","type":"git_trace_callback","comment":"Function to call with trace data"}],"argline":"git_trace_level_t level, git_trace_callback cb","sig":"git_trace_level_t::git_trace_callback","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Sets the system tracing configuration to the specified level with the\nspecified callback. When system events occur at a level equal to, or\nlower than, the given level they will be reported to the given callback.</p>\n","comments":"","group":"trace"},"git_cred_userpass_plaintext_new":{"type":"function","file":"transport.h","line":55,"lineto":58,"args":[{"name":"out","type":"git_cred **","comment":"The newly created credential object."},{"name":"username","type":"const char *","comment":"The username of the credential."},{"name":"password","type":"const char *","comment":"The password of the credential."}],"argline":"git_cred **out,\n\tconst char *username,\n\tconst char *password","sig":"git_cred **::const char *::const char *","return":{"type":"int","comment":"0 for success or an error code for failure"},"description":"<p>Creates a new plain-text username and password credential object.\nThe supplied credential parameter will be internally duplicated.</p>\n","comments":"","group":"cred","examples":{"network/clone.c":["ex/v0.18.0/network/clone.html#git_cred_userpass_plaintext_new-4"]}},"git_transport_new":{"type":"function","file":"transport.h","line":166,"lineto":172,"args":[{"name":"out","type":"git_transport **","comment":"The newly created transport (out)"},{"name":"owner","type":"git_remote *","comment":"The git_remote which will own this transport"},{"name":"url","type":"const char *","comment":"The URL to connect to"}],"argline":"git_transport **out, git_remote *owner, const char *url","sig":"git_transport **::git_remote *::const char *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Function to use to create a transport from a URL. The transport database\nis scanned to find a transport that implements the scheme of the URI (i.e.\ngit:// or http://) and a transport object is returned to the caller.</p>\n","comments":"","group":"transport"},"git_transport_dummy":{"type":"function","file":"transport.h","line":182,"lineto":185,"args":[{"name":"out","type":"git_transport **","comment":"The newly created transport (out)"},{"name":"owner","type":"git_remote *","comment":"The git_remote which will own this transport"},{"name":"payload","type":"void *","comment":"You must pass NULL for this parameter."}],"argline":"git_transport **out,\n\tgit_remote *owner,\n\t void *payload","sig":"git_transport **::git_remote *::void *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create an instance of the dummy transport.</p>\n","comments":"","group":"transport"},"git_transport_local":{"type":"function","file":"transport.h","line":195,"lineto":198,"args":[{"name":"out","type":"git_transport **","comment":"The newly created transport (out)"},{"name":"owner","type":"git_remote *","comment":"The git_remote which will own this transport"},{"name":"payload","type":"void *","comment":"You must pass NULL for this parameter."}],"argline":"git_transport **out,\n\tgit_remote *owner,\n\t void *payload","sig":"git_transport **::git_remote *::void *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create an instance of the local transport.</p>\n","comments":"","group":"transport"},"git_transport_smart":{"type":"function","file":"transport.h","line":208,"lineto":296,"args":[{"name":"out","type":"git_transport **","comment":"The newly created transport (out)"},{"name":"owner","type":"git_remote *","comment":"The git_remote which will own this transport"},{"name":"payload","type":"void *","comment":"A pointer to a git_smart_subtransport_definition"}],"argline":"git_transport **out,\n\tgit_remote *owner,\n\t void *payload","sig":"git_transport **::git_remote *::void *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create an instance of the smart transport.</p>\n","comments":"","group":"transport"},"git_smart_subtransport_http":{"type":"function","file":"transport.h","line":307,"lineto":309,"args":[{"name":"out","type":"git_smart_subtransport **","comment":"The newly created subtransport"},{"name":"owner","type":"git_transport*","comment":"The smart transport to own this subtransport"}],"argline":"git_smart_subtransport **out,\n\tgit_transport* owner","sig":"git_smart_subtransport **::git_transport*","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create an instance of the http subtransport. This subtransport\nalso supports https. On Win32, this subtransport may be implemented\nusing the WinHTTP library.</p>\n","comments":"","group":"smart"},"git_smart_subtransport_git":{"type":"function","file":"transport.h","line":318,"lineto":324,"args":[{"name":"out","type":"git_smart_subtransport **","comment":"The newly created subtransport"},{"name":"owner","type":"git_transport*","comment":"The smart transport to own this subtransport"}],"argline":"git_smart_subtransport **out,\n\tgit_transport* owner","sig":"git_smart_subtransport **::git_transport*","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Create an instance of the git subtransport.</p>\n","comments":"","group":"smart"},"git_tree_lookup":{"type":"function","file":"tree.h","line":32,"lineto":36,"args":[{"name":"out","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 **out, git_repository *repo, const git_oid *id","sig":"git_tree **::git_repository *::const git_oid *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Lookup a tree object from the repository.</p>\n","comments":"","group":"tree","examples":{"general.c":["ex/v0.18.0/general.html#git_tree_lookup-74","ex/v0.18.0/general.html#git_tree_lookup-75"]}},"git_tree_lookup_prefix":{"type":"function","file":"tree.h","line":50,"lineto":58,"args":[{"name":"out","type":"git_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."},{"name":"len","type":"size_t","comment":"the length of the short identifier"}],"argline":"git_tree **out,\n\tgit_repository *repo,\n\tconst git_oid *id,\n\tsize_t len","sig":"git_tree **::git_repository *::const git_oid *::size_t","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Lookup a tree object from the repository,\ngiven a prefix of its identifier (short id).</p>\n","comments":"<p>@see git_object_lookup_prefix</p>\n","group":"tree"},"git_tree_free":{"type":"function","file":"tree.h","line":70,"lineto":73,"args":[{"name":"tree","type":"git_tree *","comment":"The tree to close"}],"argline":"git_tree *tree","sig":"git_tree *","return":{"type":"void"},"description":"<p>Close an open tree</p>\n","comments":"<p>You can no longer use the git_tree pointer after this call.</p>\n\n<p>IMPORTANT: You MUST call this method when you stop using a tree to\nrelease memory. Failure to do so will cause a memory leak.</p>\n","group":"tree"},"git_tree_id":{"type":"function","file":"tree.h","line":81,"lineto":81,"args":[{"name":"tree","type":"const git_tree *","comment":"a previously loaded tree."}],"argline":"const git_tree *tree","sig":"const git_tree *","return":{"type":"const git_oid *","comment":"object identity for the tree."},"description":"<p>Get the id of a tree.</p>\n","comments":"","group":"tree"},"git_tree_owner":{"type":"function","file":"tree.h","line":89,"lineto":89,"args":[{"name":"tree","type":"const git_tree *","comment":"A previously loaded tree."}],"argline":"const git_tree *tree","sig":"const git_tree *","return":{"type":"git_repository *","comment":"Repository that contains this tree."},"description":"<p>Get the repository that contains the tree.</p>\n","comments":"","group":"tree"},"git_tree_entrycount":{"type":"function","file":"tree.h","line":97,"lineto":97,"args":[{"name":"tree","type":"const git_tree *","comment":"a previously loaded tree."}],"argline":"const git_tree *tree","sig":"const git_tree *","return":{"type":"size_t","comment":"the number of entries in the tree"},"description":"<p>Get the number of entries listed in a tree</p>\n","comments":"","group":"tree","examples":{"general.c":["ex/v0.18.0/general.html#git_tree_entrycount-76"]}},"git_tree_entry_byname":{"type":"function","file":"tree.h","line":109,"lineto":110,"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":"const git_tree_entry *","comment":"the tree entry; NULL if not found"},"description":"<p>Lookup a tree entry by its filename</p>\n","comments":"<p>This returns a git_tree_entry that is owned by the git_tree. You don&#39;t\nhave to free it, but you must not use it after the git_tree is released.</p>\n","group":"tree","examples":{"general.c":["ex/v0.18.0/general.html#git_tree_entry_byname-77"]}},"git_tree_entry_byindex":{"type":"function","file":"tree.h","line":122,"lineto":123,"args":[{"name":"tree","type":"git_tree *","comment":"a previously loaded tree."},{"name":"idx","type":"size_t","comment":"the position in the entry list"}],"argline":"git_tree *tree, size_t idx","sig":"git_tree *::size_t","return":{"type":"const git_tree_entry *","comment":"the tree entry; NULL if not found"},"description":"<p>Lookup a tree entry by its position in the tree</p>\n","comments":"<p>This returns a git_tree_entry that is owned by the git_tree. You don&#39;t\nhave to free it, but you must not use it after the git_tree is released.</p>\n","group":"tree","examples":{"general.c":["ex/v0.18.0/general.html#git_tree_entry_byindex-78"]}},"git_tree_entry_byoid":{"type":"function","file":"tree.h","line":137,"lineto":138,"args":[{"name":"tree","type":"const git_tree *","comment":"a previously loaded tree."},{"name":"oid","type":"const git_oid *","comment":"the sha being looked for"}],"argline":"const git_tree *tree, const git_oid *oid","sig":"const git_tree *::const git_oid *","return":{"type":"const git_tree_entry *","comment":"the tree entry; NULL if not found"},"description":"<p>Lookup a tree entry by SHA value.</p>\n","comments":"<p>This returns a git_tree_entry that is owned by the git_tree. You don&#39;t\nhave to free it, but you must not use it after the git_tree is released.</p>\n\n<p>Warning: this must examine every entry in the tree, so it is not fast.</p>\n","group":"tree"},"git_tree_entry_bypath":{"type":"function","file":"tree.h","line":152,"lineto":155,"args":[{"name":"out","type":"git_tree_entry **","comment":"Pointer where to store the tree entry"},{"name":"root","type":"git_tree *","comment":"Previously loaded tree which is the root of the relative path"},{"name":"path","type":"const char *"}],"argline":"git_tree_entry **out,\n\tgit_tree *root,\n\tconst char *path","sig":"git_tree_entry **::git_tree *::const char *","return":{"type":"int","comment":"0 on success; GIT_ENOTFOUND if the path does not exist"},"description":"<p>Retrieve a tree entry contained in a tree or in any of its subtrees,\ngiven its relative path.</p>\n","comments":"<p>Unlike the other lookup functions, the returned tree entry is owned by\nthe user and must be freed explicitly with <code>git_tree_entry_free()</code>.</p>\n","group":"tree"},"git_tree_entry_dup":{"type":"function","file":"tree.h","line":166,"lineto":166,"args":[{"name":"entry","type":"const git_tree_entry *","comment":"A tree entry to duplicate"}],"argline":"const git_tree_entry *entry","sig":"const git_tree_entry *","return":{"type":"git_tree_entry *","comment":"a copy of the original entry or NULL on error (alloc failure)"},"description":"<p>Duplicate a tree entry</p>\n","comments":"<p>Create a copy of a tree entry. The returned copy is owned by the user,\nand must be freed explicitly with <code>git_tree_entry_free()</code>.</p>\n","group":"tree"},"git_tree_entry_free":{"type":"function","file":"tree.h","line":177,"lineto":177,"args":[{"name":"entry","type":"git_tree_entry *","comment":"The entry to free"}],"argline":"git_tree_entry *entry","sig":"git_tree_entry *","return":{"type":"void"},"description":"<p>Free a user-owned tree entry</p>\n","comments":"<p>IMPORTANT: This function is only needed for tree entries owned by the\nuser, such as the ones returned by <code>git_tree_entry_dup()</code> or\n<code>git_tree_entry_bypath()</code>.</p>\n","group":"tree"},"git_tree_entry_name":{"type":"function","file":"tree.h","line":185,"lineto":185,"args":[{"name":"entry","type":"const git_tree_entry *","comment":"a tree entry"}],"argline":"const git_tree_entry *entry","sig":"const git_tree_entry *","return":{"type":"const char *","comment":"the name of the file"},"description":"<p>Get the filename of a tree entry</p>\n","comments":"","group":"tree","examples":{"general.c":["ex/v0.18.0/general.html#git_tree_entry_name-79","ex/v0.18.0/general.html#git_tree_entry_name-80"]}},"git_tree_entry_id":{"type":"function","file":"tree.h","line":193,"lineto":193,"args":[{"name":"entry","type":"const git_tree_entry *","comment":"a tree entry"}],"argline":"const git_tree_entry *entry","sig":"const git_tree_entry *","return":{"type":"const git_oid *","comment":"the oid of the object"},"description":"<p>Get the id of the object pointed by the entry</p>\n","comments":"","group":"tree"},"git_tree_entry_type":{"type":"function","file":"tree.h","line":201,"lineto":201,"args":[{"name":"entry","type":"const git_tree_entry *","comment":"a tree entry"}],"argline":"const git_tree_entry *entry","sig":"const git_tree_entry *","return":{"type":"git_otype","comment":"the type of the pointed object"},"description":"<p>Get the type of the object pointed by the entry</p>\n","comments":"","group":"tree"},"git_tree_entry_filemode":{"type":"function","file":"tree.h","line":209,"lineto":209,"args":[{"name":"entry","type":"const git_tree_entry *","comment":"a tree entry"}],"argline":"const git_tree_entry *entry","sig":"const git_tree_entry *","return":{"type":"git_filemode_t","comment":"filemode as an integer"},"description":"<p>Get the UNIX file attributes of a tree entry</p>\n","comments":"","group":"tree"},"git_tree_entry_cmp":{"type":"function","file":"tree.h","line":218,"lineto":218,"args":[{"name":"e1","type":"const git_tree_entry *","comment":"first tree entry"},{"name":"e2","type":"const git_tree_entry *","comment":"second tree entry"}],"argline":"const git_tree_entry *e1, const git_tree_entry *e2","sig":"const git_tree_entry *::const git_tree_entry *","return":{"type":"int","comment":"<0 if e1 is before e2, 0 if e1 == e2, >0 if e1 is after e2"},"description":"<p>Compare two tree entries</p>\n","comments":"","group":"tree"},"git_tree_entry_to_object":{"type":"function","file":"tree.h","line":230,"lineto":233,"args":[{"name":"object_out","type":"git_object **"},{"name":"repo","type":"git_repository *","comment":"repository where to lookup the pointed object"},{"name":"entry","type":"const git_tree_entry *","comment":"a tree entry"}],"argline":"git_object **object_out,\n\tgit_repository *repo,\n\tconst git_tree_entry *entry","sig":"git_object **::git_repository *::const git_tree_entry *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Convert a tree entry to the git_object it points too.</p>\n","comments":"<p>You must call <code>git_object_free()</code> on the object when you are done with it.</p>\n","group":"tree","examples":{"general.c":["ex/v0.18.0/general.html#git_tree_entry_to_object-81"]}},"git_treebuilder_create":{"type":"function","file":"tree.h","line":251,"lineto":252,"args":[{"name":"out","type":"git_treebuilder **","comment":"Pointer where to store the tree builder"},{"name":"source","type":"const git_tree *","comment":"Source tree to initialize the builder (optional)"}],"argline":"git_treebuilder **out, const git_tree *source","sig":"git_treebuilder **::const git_tree *","return":{"type":"int","comment":"0 on success; error code otherwise"},"description":"<p>Create a new tree builder.</p>\n","comments":"<p>The tree builder can be used to create or modify trees in memory and\nwrite them as tree objects to the database.</p>\n\n<p>If the <code>source</code> parameter is not NULL, the tree builder will be\ninitialized with the entries of the given tree.</p>\n\n<p>If the <code>source</code> parameter is NULL, the tree builder will start with no\nentries and will have to be filled manually.</p>\n","group":"treebuilder"},"git_treebuilder_clear":{"type":"function","file":"tree.h","line":259,"lineto":259,"args":[{"name":"bld","type":"git_treebuilder *","comment":"Builder to clear"}],"argline":"git_treebuilder *bld","sig":"git_treebuilder *","return":{"type":"void"},"description":"<p>Clear all the entires in the builder</p>\n","comments":"","group":"treebuilder"},"git_treebuilder_entrycount":{"type":"function","file":"tree.h","line":267,"lineto":267,"args":[{"name":"bld","type":"git_treebuilder *"}],"argline":"git_treebuilder *bld","sig":"git_treebuilder *","return":{"type":"unsigned int","comment":"the number of entries in the treebuilder"},"description":"<p>Get the number of entries listed in a treebuilder</p>\n","comments":"","group":"treebuilder"},"git_treebuilder_free":{"type":"function","file":"tree.h","line":278,"lineto":278,"args":[{"name":"bld","type":"git_treebuilder *","comment":"Builder to free"}],"argline":"git_treebuilder *bld","sig":"git_treebuilder *","return":{"type":"void"},"description":"<p>Free a tree builder</p>\n","comments":"<p>This will clear all the entries and free to builder.\nFailing to free the builder after you&#39;re done using it\nwill result in a memory leak</p>\n","group":"treebuilder"},"git_treebuilder_get":{"type":"function","file":"tree.h","line":290,"lineto":291,"args":[{"name":"bld","type":"git_treebuilder *","comment":"Tree builder"},{"name":"filename","type":"const char *","comment":"Name of the entry"}],"argline":"git_treebuilder *bld, const char *filename","sig":"git_treebuilder *::const char *","return":{"type":"const git_tree_entry *","comment":"pointer to the entry; NULL if not found"},"description":"<p>Get an entry from the builder from its filename</p>\n","comments":"<p>The returned entry is owned by the builder and should\nnot be freed manually.</p>\n","group":"treebuilder"},"git_treebuilder_insert":{"type":"function","file":"tree.h","line":318,"lineto":323,"args":[{"name":"out","type":"const git_tree_entry **","comment":"Pointer to store the entry (optional)"},{"name":"bld","type":"git_treebuilder *","comment":"Tree builder"},{"name":"filename","type":"const char *","comment":"Filename of the entry"},{"name":"id","type":"const git_oid *","comment":"SHA1 oid of the entry"},{"name":"filemode","type":"git_filemode_t","comment":"Folder attributes of the entry. This parameter must be valued with one of the following entries: 0040000, 0100644, 0100755, 0120000 or 0160000."}],"argline":"const git_tree_entry **out,\n\tgit_treebuilder *bld,\n\tconst char *filename,\n\tconst git_oid *id,\n\tgit_filemode_t filemode","sig":"const git_tree_entry **::git_treebuilder *::const char *::const git_oid *::git_filemode_t","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Add or update an entry to the builder</p>\n","comments":"<p>Insert a new entry for <code>filename</code> in the builder with the\ngiven attributes.</p>\n\n<p>If an entry named <code>filename</code> already exists, its attributes\nwill be updated with the given ones.</p>\n\n<p>The optional pointer <code>out</code> can be used to retrieve a pointer to\nthe newly created/updated entry. Pass NULL if you do not need it.</p>\n\n<p>No attempt is being made to ensure that the provided oid points\nto an existing git object in the object database, nor that the\nattributes make sense regarding the type of the pointed at object.</p>\n","group":"treebuilder"},"git_treebuilder_remove":{"type":"function","file":"tree.h","line":331,"lineto":335,"args":[{"name":"bld","type":"git_treebuilder *","comment":"Tree builder"},{"name":"filename","type":"const char *","comment":"Filename of the entry to remove"}],"argline":"git_treebuilder *bld, const char *filename","sig":"git_treebuilder *::const char *","return":{"type":"int"},"description":"<p>Remove an entry from the builder by its filename</p>\n","comments":"","group":"treebuilder"},"git_treebuilder_filter":{"type":"function","file":"tree.h","line":348,"lineto":351,"args":[{"name":"bld","type":"git_treebuilder *","comment":"Tree builder"},{"name":"filter","type":"git_treebuilder_filter_cb","comment":"Callback to filter entries"},{"name":"payload","type":"void *","comment":"Extra data to pass to filter"}],"argline":"git_treebuilder *bld,\n\tgit_treebuilder_filter_cb filter,\n\tvoid *payload","sig":"git_treebuilder *::git_treebuilder_filter_cb::void *","return":{"type":"void"},"description":"<p>Filter the entries in the tree</p>\n","comments":"<p>The <code>filter</code> callback will be called for each entry in the tree with a\npointer to the entry and the provided <code>payload</code>; if the callback returns\nnon-zero, the entry will be filtered (removed from the builder).</p>\n","group":"treebuilder"},"git_treebuilder_write":{"type":"function","file":"tree.h","line":364,"lineto":365,"args":[{"name":"id","type":"git_oid *","comment":"Pointer to store the OID of the newly written tree"},{"name":"repo","type":"git_repository *","comment":"Repository in which to store the object"},{"name":"bld","type":"git_treebuilder *","comment":"Tree builder to write"}],"argline":"git_oid *id, git_repository *repo, git_treebuilder *bld","sig":"git_oid *::git_repository *::git_treebuilder *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Write the contents of the tree builder as a tree object</p>\n","comments":"<p>The tree builder will be written to the given <code>repo</code>, and its\nidentifying SHA1 hash will be stored in the <code>id</code> pointer.</p>\n","group":"treebuilder"},"git_tree_walk":{"type":"function","file":"tree.h","line":395,"lineto":399,"args":[{"name":"tree","type":"const git_tree *","comment":"The tree to walk"},{"name":"mode","type":"git_treewalk_mode","comment":"Traversal mode (pre or post-order)"},{"name":"callback","type":"git_treewalk_cb","comment":"Function to call on each tree entry"},{"name":"payload","type":"void *","comment":"Opaque pointer to be passed on each callback"}],"argline":"const git_tree *tree,\n\tgit_treewalk_mode mode,\n\tgit_treewalk_cb callback,\n\tvoid *payload","sig":"const git_tree *::git_treewalk_mode::git_treewalk_cb::void *","return":{"type":"int","comment":"0 or an error code"},"description":"<p>Traverse the entries in a tree and its subtrees in post or pre order.</p>\n","comments":"<p>The entries will be traversed in the specified order, children subtrees\nwill be automatically loaded as required, and the <code>callback</code> will be\ncalled once per entry with the current (relative) root for the entry and\nthe entry data itself.</p>\n\n<p>If the callback returns a positive value, the passed entry will be\nskipped on the traversal (in pre mode). A negative value stops the walk.</p>\n","group":"tree"}},"globals":{"GIT_ATTR_TRUE(attr)":{"value":"(git_attr_value(attr) == GIT_ATTR_TRUE_T)","file":"attr.h","line":33,"comments":"<p>GIT_ATTR_TRUE checks if an attribute is set on. In core git\nparlance, this the value for &quot;Set&quot; attributes.</p>\n\n<p>For example, if the attribute file contains:</p>\n\n<p>*.c foo</p>\n\n<p>Then for file <code>xyz.c</code> looking up attribute &quot;foo&quot; gives a value for\nwhich <code>GIT_ATTR_TRUE(value)</code> is true.</p>\n"},"GIT_ATTR_FALSE(attr)":{"value":"(git_attr_value(attr) == GIT_ATTR_FALSE_T)","file":"attr.h","line":47,"comments":"<p>GIT_ATTR_FALSE checks if an attribute is set off. In core git\nparlance, this is the value for attributes that are &quot;Unset&quot; (not to\nbe confused with values that a &quot;Unspecified&quot;).</p>\n\n<p>For example, if the attribute file contains:</p>\n\n<p>*.h -foo</p>\n\n<p>Then for file <code>zyx.h</code> looking up attribute &quot;foo&quot; gives a value for\nwhich <code>GIT_ATTR_FALSE(value)</code> is true.</p>\n"},"GIT_ATTR_UNSPECIFIED(attr)":{"value":"(git_attr_value(attr) == GIT_ATTR_UNSPECIFIED_T)","file":"attr.h","line":65,"comments":"<p>GIT_ATTR_UNSPECIFIED checks if an attribute is unspecified. This\nmay be due to the attribute not being mentioned at all or because\nthe attribute was explicitly set unspecified via the <code>!</code> operator.</p>\n\n<p>For example, if the attribute file contains:</p>\n\n<p>*.c foo\n *.h -foo\n onefile.c !foo</p>\n\n<p>Then for <code>onefile.c</code> looking up attribute &quot;foo&quot; yields a value with\n<code>GIT_ATTR_UNSPECIFIED(value)</code> of true. Also, looking up &quot;foo&quot; on\nfile <code>onefile.rb</code> or looking up &quot;bar&quot; on any file will all give\n<code>GIT_ATTR_UNSPECIFIED(value)</code> of true.</p>\n"},"GIT_ATTR_HAS_VALUE(attr)":{"value":"(git_attr_value(attr) == GIT_ATTR_VALUE_T)","file":"attr.h","line":77,"comments":"<p>GIT_ATTR_HAS_VALUE checks if an attribute is set to a value (as\nopposed to TRUE, FALSE or UNSPECIFIED). This would be the case if\nfor a file with something like:</p>\n\n<p>*.txt eol=lf</p>\n\n<p>Given this, looking up &quot;eol&quot; for <code>onefile.txt</code> will give back the\nstring &quot;lf&quot; and <code>GIT_ATTR_SET_TO_VALUE(attr)</code> will return true.</p>\n"},"GIT_ATTR_CHECK_NO_SYSTEM":{"value":"(1 << 2)","file":"attr.h","line":125,"comments":"<p>Check attribute flags: Using the system attributes file.</p>\n\n<p>Normally, attribute checks include looking in the /etc (or system\nequivalent) directory for a <code>gitattributes</code> file. Passing this\nflag will cause attribute checks to ignore that file.</p>\n"},"GIT_BEGIN_DECL":{"value":"","file":"common.h","line":24,"comments":"<p>Start declarations in C mode</p>\n"},"GIT_END_DECL":{"value":"","file":"common.h","line":26,"comments":"<p>End declarations in C mode</p>\n"},"GIT_EXTERN(type)":{"value":"extern __attribute__((visibility(\"default\"))) type","file":"common.h","line":30,"comments":"<p>Declare a public function exported for application use.</p>\n"},"GIT_INLINE(type)":{"value":"static __inline type","file":"common.h","line":41,"comments":"<p>Declare a function as always inlined.</p>\n"},"GIT_FORMAT_PRINTF(a,b)":{"value":"__attribute__((format (printf, a, b)))","file":"common.h","line":48,"comments":"<p>Declare a function&#39;s takes printf style arguments.</p>\n"},"GIT_PATH_LIST_SEPARATOR":{"value":"';'","file":"common.h","line":77,"comments":"<p>The separator used in path list strings (ie like in the PATH\nenvironment variable). A semi-colon &quot;;&quot; is used on Windows, and\na colon &quot;:&quot; for all other systems.</p>\n"},"GIT_PATH_MAX":{"value":"4096","file":"common.h","line":86,"comments":"<p>The maximum length of a valid git path.</p>\n"},"GIT_OID_HEX_ZERO":{"value":"\"0000000000000000000000000000000000000000\"","file":"common.h","line":91,"comments":"<p>The string representation of the null object ID.</p>\n"},"GIT_CAP_THREADS":{"file":"common.h","line":107,"value":"( 1 << 0 )","comments":"<p>Combinations of these values describe the capabilities of libgit2.</p>\n"},"GIT_CAP_HTTPS":{"file":"common.h","line":108,"value":"( 1 << 1 )\n","comments":"<p>Combinations of these values describe the capabilities of libgit2.</p>\n"},"GIT_CONFIG_LEVEL_SYSTEM":{"file":"config.h","line":31,"value":"1","comments":"<p>Priority level of a config file.\nThese priority levels correspond to the natural escalation logic\n(from higher to lower) when searching for config entries in git.git.</p>\n\n<p>git_config_open_default() and git_repository_config() honor those\npriority levels as well.</p>\n"},"GIT_CONFIG_LEVEL_XDG":{"file":"config.h","line":32,"value":"2","comments":"<p>Priority level of a config file.\nThese priority levels correspond to the natural escalation logic\n(from higher to lower) when searching for config entries in git.git.</p>\n\n<p>git_config_open_default() and git_repository_config() honor those\npriority levels as well.</p>\n"},"GIT_CONFIG_LEVEL_GLOBAL":{"file":"config.h","line":33,"value":"3","comments":"<p>Priority level of a config file.\nThese priority levels correspond to the natural escalation logic\n(from higher to lower) when searching for config entries in git.git.</p>\n\n<p>git_config_open_default() and git_repository_config() honor those\npriority levels as well.</p>\n"},"GIT_CONFIG_LEVEL_LOCAL":{"file":"config.h","line":34,"value":"4","comments":"<p>Priority level of a config file.\nThese priority levels correspond to the natural escalation logic\n(from higher to lower) when searching for config entries in git.git.</p>\n\n<p>git_config_open_default() and git_repository_config() honor those\npriority levels as well.</p>\n"},"GIT_CONFIG_HIGHEST_LEVEL":{"file":"config.h","line":35,"value":"-1","comments":"<p>Priority level of a config file.\nThese priority levels correspond to the natural escalation logic\n(from higher to lower) when searching for config entries in git.git.</p>\n\n<p>git_config_open_default() and git_repository_config() honor those\npriority levels as well.</p>\n"},"GIT_OK":{"file":"errors.h","line":22,"value":"0","comments":"<p>Generic return codes</p>\n"},"GIT_ERROR":{"file":"errors.h","line":23,"value":"-1","comments":"<p>Generic return codes</p>\n"},"GIT_ENOTFOUND":{"file":"errors.h","line":24,"value":"-3","comments":"<p>Generic return codes</p>\n"},"GIT_EEXISTS":{"file":"errors.h","line":25,"value":"-4","comments":"<p>Generic return codes</p>\n"},"GIT_EAMBIGUOUS":{"file":"errors.h","line":26,"value":"-5","comments":"<p>Generic return codes</p>\n"},"GIT_EBUFS":{"file":"errors.h","line":27,"value":"-6","comments":"<p>Generic return codes</p>\n"},"GIT_EUSER":{"file":"errors.h","line":28,"value":"-7","comments":"<p>Generic return codes</p>\n"},"GIT_EBAREREPO":{"file":"errors.h","line":29,"value":"-8","comments":"<p>Generic return codes</p>\n"},"GIT_EORPHANEDHEAD":{"file":"errors.h","line":30,"value":"-9","comments":"<p>Generic return codes</p>\n"},"GIT_EUNMERGED":{"file":"errors.h","line":31,"value":"-10","comments":"<p>Generic return codes</p>\n"},"GIT_ENONFASTFORWARD":{"file":"errors.h","line":32,"value":"-11","comments":"<p>Generic return codes</p>\n"},"GIT_EINVALIDSPEC":{"file":"errors.h","line":33,"value":"-12","comments":"<p>Generic return codes</p>\n"},"GIT_EMERGECONFLICT":{"file":"errors.h","line":34,"value":"-13","comments":"<p>Generic return codes</p>\n"},"GIT_PASSTHROUGH":{"file":"errors.h","line":36,"value":"-30","comments":"<p>Generic return codes</p>\n"},"GIT_ITEROVER":{"file":"errors.h","line":37,"value":"-31","comments":"<p>Generic return codes</p>\n"},"GIT_INDEXCAP_IGNORE_CASE":{"file":"index.h","line":96,"value":"1","comments":"<p>Capabilities of system that affect index actions.</p>\n"},"GIT_INDEXCAP_NO_FILEMODE":{"file":"index.h","line":97,"value":"2","comments":"<p>Capabilities of system that affect index actions.</p>\n"},"GIT_INDEXCAP_NO_SYMLINKS":{"file":"index.h","line":98,"value":"4","comments":"<p>Capabilities of system that affect index actions.</p>\n"},"GIT_INDEXCAP_FROM_OWNER":{"file":"index.h","line":99,"value":"~0u\n","comments":"<p>Capabilities of system that affect index actions.</p>\n"},"GIT_STREAM_RDONLY":{"file":"odb_backend.h","line":113,"value":"(1 << 1)","comments":"<p>Streaming mode</p>\n"},"GIT_STREAM_WRONLY":{"file":"odb_backend.h","line":114,"value":"(1 << 2)","comments":"<p>Streaming mode</p>\n"},"GIT_STREAM_RW":{"file":"odb_backend.h","line":115,"value":"(GIT_STREAM_RDONLY | GIT_STREAM_WRONLY)","comments":"<p>Streaming mode</p>\n"},"GIT_OID_RAWSZ":{"value":"20","file":"oid.h","line":23,"comments":"<p>Size (in bytes) of a raw/binary oid</p>\n"},"GIT_OID_HEXSZ":{"value":"(GIT_OID_RAWSZ * 2)","file":"oid.h","line":26,"comments":"<p>Size (in bytes) of a hex formatted oid</p>\n"},"GIT_OID_MINPREFIXLEN":{"value":"4","file":"oid.h","line":30,"comments":"<p>Minimum length (in number of hex characters,\ni.e. packets of 4 bits) of an oid prefix</p>\n"},"GIT_SORT_NONE":{"value":"(0)","file":"revwalk.h","line":29,"comments":"<p>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.</p>\n"},"GIT_SORT_TOPOLOGICAL":{"value":"(1 << 0)","file":"revwalk.h","line":36,"comments":"<p>Sort the repository contents in topological order\n(parents before children); this sorting mode\ncan be combined with time sorting.</p>\n"},"GIT_SORT_TIME":{"value":"(1 << 1)","file":"revwalk.h","line":43,"comments":"<p>Sort the repository contents by commit time;\nthis sorting mode can be combined with\ntopological sorting.</p>\n"},"GIT_SORT_REVERSE":{"value":"(1 << 2)","file":"revwalk.h","line":50,"comments":"<p>Iterate through the repository contents in reverse\norder; this sorting mode can be combined with\nany of the above.</p>\n"}},"types":[["GIT_ATTR_CHECK",{"sections":[["<p>Check attribute flags: Reading values from index and working directory.</p>\n\n<p>When checking attributes, it is possible to check attribute files\nin both the working directory (if there is one) and the index (if\nthere is one). You can explicitly choose where to check and in\nwhich order using the following flags.</p>\n\n<p>Core git usually checks the working directory then the index,\nexcept during a checkout when it checks the index first. It will\nuse index only for creating archives or for a bare repo (if an\nindex has been specified for the bare repo).</p>\n",["GIT_ATTR_CHECK_FILE_THEN_INDEX","GIT_ATTR_CHECK_INDEX_THEN_FILE","GIT_ATTR_CHECK_INDEX_ONLY"]]],"decl":["GIT_ATTR_CHECK_FILE_THEN_INDEX","GIT_ATTR_CHECK_INDEX_THEN_FILE","GIT_ATTR_CHECK_INDEX_ONLY"],"type":"enum","file":"attr.h","line":114,"lineto":116,"block":"GIT_ATTR_CHECK_FILE_THEN_INDEX\nGIT_ATTR_CHECK_INDEX_THEN_FILE\nGIT_ATTR_CHECK_INDEX_ONLY","tdef":null,"comments":"<p>Check attribute flags: Reading values from index and working directory.</p>\n\n<p>When checking attributes, it is possible to check attribute files\nin both the working directory (if there is one) and the index (if\nthere is one). You can explicitly choose where to check and in\nwhich order using the following flags.</p>\n\n<p>Core git usually checks the working directory then the index,\nexcept during a checkout when it checks the index first. It will\nuse index only for creating archives or for a bare repo (if an\nindex has been specified for the bare repo).</p>\n","used":{"returns":[],"needs":[]}}],["git_blob",{"decl":"","type":"struct","value":"git_blob","file":"types.h","line":117,"lineto":117,"block":"","tdef":"typedef","comments":"<p>In-memory representation of a blob object.</p>\n","used":{"returns":[],"needs":["git_blob_free","git_blob_id","git_blob_is_binary","git_blob_lookup","git_blob_lookup_prefix","git_blob_rawcontent","git_blob_rawsize","git_diff_blob_to_buffer","git_diff_blobs"]}}],["git_branch_t",{"sections":[["<p>Basic type of any Git branch.</p>\n",["GIT_BRANCH_LOCAL","GIT_BRANCH_REMOTE"]]],"decl":["GIT_BRANCH_LOCAL","GIT_BRANCH_REMOTE"],"type":"enum","file":"types.h","line":177,"lineto":180,"block":"GIT_BRANCH_LOCAL\nGIT_BRANCH_REMOTE","tdef":"typedef","comments":"<p>Basic type of any Git branch.</p>\n","used":{"returns":[],"needs":["git_branch_lookup"]}}],["git_checkout_notify_cb",{"decl":"int (*git_checkout_notify_cb)(\n\tgit_checkout_notify_t why,\n\tconst char *path,\n\tconst git_diff_file *baseline,\n\tconst git_diff_file *target,\n\tconst git_diff_file *workdir,\n\tvoid *payload)","type":"function pointer","value":"git_checkout_notify_cb","file":"checkout.h","line":186,"lineto":192,"comments":"<p>Checkout notification callback function</p>\n","used":{"returns":[],"needs":[]}}],["git_checkout_notify_t",{"sections":[["<p>Checkout notification flags</p>\n\n<p>Checkout will invoke an options notification callback (<code>notify_cb</code>) for\ncertain cases - you pick which ones via <code>notify_flags</code>:</p>\n\n<ul>\n<li><p>GIT_CHECKOUT_NOTIFY_CONFLICT invokes checkout on conflicting paths.</p></li>\n<li><p>GIT_CHECKOUT_NOTIFY_DIRTY notifies about &quot;dirty&quot; files, i.e. those that\ndo not need an update but no longer match the baseline. Core git\ndisplays these files when checkout runs, but won&#39;t stop the checkout.</p></li>\n<li><p>GIT_CHECKOUT_NOTIFY_UPDATED sends notification for any file changed.</p></li>\n<li><p>GIT_CHECKOUT_NOTIFY_UNTRACKED notifies about untracked files.</p></li>\n<li><p>GIT_CHECKOUT_NOTIFY_IGNORED notifies about ignored files.</p></li>\n</ul>\n\n<p>Returning a non-zero value from this callback will cancel the checkout.\nNotification callbacks are made prior to modifying any files on disk.</p>\n",["GIT_CHECKOUT_NOTIFY_NONE","GIT_CHECKOUT_NOTIFY_CONFLICT","GIT_CHECKOUT_NOTIFY_DIRTY","GIT_CHECKOUT_NOTIFY_UPDATED","GIT_CHECKOUT_NOTIFY_UNTRACKED","GIT_CHECKOUT_NOTIFY_IGNORED"]]],"decl":["GIT_CHECKOUT_NOTIFY_NONE","GIT_CHECKOUT_NOTIFY_CONFLICT","GIT_CHECKOUT_NOTIFY_DIRTY","GIT_CHECKOUT_NOTIFY_UPDATED","GIT_CHECKOUT_NOTIFY_UNTRACKED","GIT_CHECKOUT_NOTIFY_IGNORED"],"type":"enum","file":"checkout.h","line":176,"lineto":183,"block":"GIT_CHECKOUT_NOTIFY_NONE\nGIT_CHECKOUT_NOTIFY_CONFLICT\nGIT_CHECKOUT_NOTIFY_DIRTY\nGIT_CHECKOUT_NOTIFY_UPDATED\nGIT_CHECKOUT_NOTIFY_UNTRACKED\nGIT_CHECKOUT_NOTIFY_IGNORED","tdef":"typedef","comments":"<p>Checkout notification flags</p>\n\n<p>Checkout will invoke an options notification callback (<code>notify_cb</code>) for\ncertain cases - you pick which ones via <code>notify_flags</code>:</p>\n\n<ul>\n<li><p>GIT_CHECKOUT_NOTIFY_CONFLICT invokes checkout on conflicting paths.</p></li>\n<li><p>GIT_CHECKOUT_NOTIFY_DIRTY notifies about &quot;dirty&quot; files, i.e. those that\ndo not need an update but no longer match the baseline. Core git\ndisplays these files when checkout runs, but won&#39;t stop the checkout.</p></li>\n<li><p>GIT_CHECKOUT_NOTIFY_UPDATED sends notification for any file changed.</p></li>\n<li><p>GIT_CHECKOUT_NOTIFY_UNTRACKED notifies about untracked files.</p></li>\n<li><p>GIT_CHECKOUT_NOTIFY_IGNORED notifies about ignored files.</p></li>\n</ul>\n\n<p>Returning a non-zero value from this callback will cancel the checkout.\nNotification callbacks are made prior to modifying any files on disk.</p>\n","used":{"returns":[],"needs":[]}}],["git_checkout_opts",{"decl":["unsigned int version","unsigned int checkout_strategy","int disable_filters","unsigned int dir_mode","unsigned int file_mode","int file_open_flags","unsigned int notify_flags","git_checkout_notify_cb notify_cb","void *notify_payload","git_checkout_progress_cb progress_cb","void *progress_payload","git_strarray paths","git_tree *baseline"],"type":"struct","value":"git_checkout_opts","file":"checkout.h","line":209,"lineto":234,"block":"unsigned int version\nunsigned int checkout_strategy\nint disable_filters\nunsigned int dir_mode\nunsigned int file_mode\nint file_open_flags\nunsigned int notify_flags\ngit_checkout_notify_cb notify_cb\nvoid *notify_payload\ngit_checkout_progress_cb progress_cb\nvoid *progress_payload\ngit_strarray paths\ngit_tree *baseline","tdef":"typedef","comments":"<p>Checkout options structure</p>\n\n<p>Zero out for defaults. Initialize with <code>GIT_CHECKOUT_OPTS_INIT</code> macro to\ncorrectly set the <code>version</code> field. E.g.</p>\n\n<pre><code>git_checkout_opts opts = GIT_CHECKOUT_OPTS_INIT;\n</code></pre>\n","used":{"returns":[],"needs":["git_checkout_head","git_checkout_index","git_checkout_tree"]}}],["git_checkout_progress_cb",{"decl":"void (*git_checkout_progress_cb)(\n\tconst char *path,\n\tsize_t completed_steps,\n\tsize_t total_steps,\n\tvoid *payload)","type":"function pointer","value":"git_checkout_progress_cb","file":"checkout.h","line":195,"lineto":199,"comments":"<p>Checkout progress notification function</p>\n","used":{"returns":[],"needs":[]}}],["git_clone_options",{"decl":["unsigned int version","git_checkout_opts checkout_opts","int bare","git_transfer_progress_callback fetch_progress_cb","void *fetch_progress_payload","const char *remote_name","const char *pushurl","const char *fetch_spec","const char *push_spec","git_cred_acquire_cb cred_acquire_cb","void *cred_acquire_payload","git_transport *transport","git_remote_callbacks *remote_callbacks","git_remote_autotag_option_t remote_autotag","const char* checkout_branch"],"type":"struct","value":"git_clone_options","file":"clone.h","line":63,"lineto":84,"block":"unsigned int version\ngit_checkout_opts checkout_opts\nint bare\ngit_transfer_progress_callback fetch_progress_cb\nvoid *fetch_progress_payload\nconst char *remote_name\nconst char *pushurl\nconst char *fetch_spec\nconst char *push_spec\ngit_cred_acquire_cb cred_acquire_cb\nvoid *cred_acquire_payload\ngit_transport *transport\ngit_remote_callbacks *remote_callbacks\ngit_remote_autotag_option_t remote_autotag\nconst char* checkout_branch","tdef":"typedef","comments":"<p>Clone options structure</p>\n\n<p>Use zeros to indicate default settings. It&#39;s easiest to use the\n<code>GIT_CLONE_OPTIONS_INIT</code> macro:</p>\n\n<pre><code>git_clone_options opts = GIT_CLONE_OPTIONS_INIT;\n</code></pre>\n\n<ul>\n<li><code>checkout_opts</code> is options for the checkout step. To disable checkout,\nset the <code>checkout_strategy</code> to GIT_CHECKOUT_DEFAULT.</li>\n<li><code>bare</code> should be set to zero to create a standard repo, non-zero for\na bare repo</li>\n<li><code>fetch_progress_cb</code> is optional callback for fetch progress. Be aware that\nthis is called inline with network and indexing operations, so performance\nmay be affected.</li>\n<li><p><code>fetch_progress_payload</code> is payload for fetch_progress_cb</p>\n\n<p>** &quot;origin&quot; remote options: **</p></li>\n<li><p><code>remote_name</code> is the name given to the &quot;origin&quot; remote. The default is\n&quot;origin&quot;.</p></li>\n<li><p><code>pushurl</code> is a URL to be used for pushing. NULL means use the fetch url.</p></li>\n<li><p><code>fetch_spec</code> is the fetch specification to be used for fetching. NULL\nresults in the same behavior as GIT_REMOTE_DEFAULT_FETCH.</p></li>\n<li><p><code>push_spec</code> is the fetch specification to be used for pushing. NULL means\nuse the same spec as for fetching.</p></li>\n<li><p><code>cred_acquire_cb</code> is a callback to be used if credentials are required\nduring the initial fetch.</p></li>\n<li><p><code>cred_acquire_payload</code> is the payload for the above callback.</p></li>\n<li><p><code>transport</code> is a custom transport to be used for the initial fetch. NULL\nmeans use the transport autodetected from the URL.</p></li>\n<li><p><code>remote_callbacks</code> may be used to specify custom progress callbacks for\nthe origin remote before the fetch is initiated.</p></li>\n<li><p><code>remote_autotag</code> may be used to specify the autotag setting before the\ninitial fetch. The default is GIT_REMOTE_DOWNLOAD_TAGS_ALL.</p></li>\n<li><p><code>checkout_branch</code> gives the name of the branch to checkout. NULL means\nuse the remote&#39;s HEAD.</p></li>\n</ul>\n","used":{"returns":[],"needs":["git_clone"]}}],["git_commit",{"decl":"","type":"struct","value":"git_commit","file":"types.h","line":120,"lineto":120,"block":"","tdef":"typedef","comments":"<p>Parsed representation of a commit object.</p>\n","used":{"returns":[],"needs":["git_branch_create","git_commit_author","git_commit_committer","git_commit_create","git_commit_free","git_commit_id","git_commit_lookup","git_commit_lookup_prefix","git_commit_message","git_commit_message_encoding","git_commit_nth_gen_ancestor","git_commit_parent","git_commit_parent_id","git_commit_parentcount","git_commit_time","git_commit_time_offset","git_commit_tree","git_commit_tree_id"]}}],["git_config",{"decl":"","type":"struct","value":"git_config","file":"types.h","line":135,"lineto":135,"block":"","tdef":"typedef","comments":"<p>Memory representation of a set of config files</p>\n","used":{"returns":[],"needs":["git_config_add_backend","git_config_add_file_ondisk","git_config_delete_entry","git_config_foreach","git_config_foreach_match","git_config_free","git_config_get_bool","git_config_get_entry","git_config_get_int32","git_config_get_int64","git_config_get_mapped","git_config_get_multivar","git_config_get_string","git_config_new","git_config_open_default","git_config_open_level","git_config_open_ondisk","git_config_refresh","git_config_set_bool","git_config_set_int32","git_config_set_int64","git_config_set_multivar","git_config_set_string","git_repository_config","git_repository_set_config"]}}],["git_config_backend",{"decl":"","type":"struct","value":"git_config_backend","file":"types.h","line":138,"lineto":138,"block":"","tdef":"typedef","comments":"<p>Interface to access a configuration file</p>\n","used":{"returns":[],"needs":["git_config_add_backend"]}}],["git_cred_acquire_cb",{"decl":"int (*git_cred_acquire_cb)(\n\tgit_cred **cred,\n\tconst char *url,\n\tconst char *username_from_url,\n\tunsigned int allowed_types,\n\tvoid *payload)","type":"function pointer","value":"git_cred_acquire_cb","file":"transport.h","line":71,"lineto":154,"comments":"<p>Signature of a function which acquires a credential object.</p>\n\n<p>@param cred The newly created credential object.\n@param url The resource for which we are demanding a credential.\n@param username_from_url The username that was embedded in a &quot;user@host&quot;\n remote url, or NULL if not included.\n@param allowed_types A bitmask stating which cred types are OK to return.\n@param payload The payload provided when specifying this callback.\n@return 0 for success or an error code for failure</p>\n","used":{"returns":[],"needs":["git_remote_set_cred_acquire_cb"]}}],["git_cred_userpass_payload",{"decl":["char *username","char *password"],"type":"struct","value":"git_cred_userpass_payload","file":"cred_helpers.h","line":24,"lineto":27,"block":"char *username\nchar *password","tdef":"typedef","comments":"<p>Payload for git_cred_stock_userpass_plaintext.</p>\n","used":{"returns":[],"needs":[]}}],["git_delta_t",{"sections":[["<p>What type of change is described by a git_diff_delta?</p>\n\n<p><code>GIT_DELTA_RENAMED</code> and <code>GIT_DELTA_COPIED</code> will only show up if you run\n<code>git_diff_find_similar()</code> on the diff list object.</p>\n\n<p><code>GIT_DELTA_TYPECHANGE</code> only shows up given <code>GIT_DIFF_INCLUDE_TYPECHANGE</code>\nin the option flags (otherwise type changes will be split into ADDED /\nDELETED pairs).</p>\n",["GIT_DELTA_UNMODIFIED","GIT_DELTA_ADDED","GIT_DELTA_DELETED","GIT_DELTA_MODIFIED","GIT_DELTA_RENAMED","GIT_DELTA_COPIED","GIT_DELTA_IGNORED","GIT_DELTA_UNTRACKED","GIT_DELTA_TYPECHANGE"]]],"decl":["GIT_DELTA_UNMODIFIED","GIT_DELTA_ADDED","GIT_DELTA_DELETED","GIT_DELTA_MODIFIED","GIT_DELTA_RENAMED","GIT_DELTA_COPIED","GIT_DELTA_IGNORED","GIT_DELTA_UNTRACKED","GIT_DELTA_TYPECHANGE"],"type":"enum","file":"diff.h","line":163,"lineto":173,"block":"GIT_DELTA_UNMODIFIED\nGIT_DELTA_ADDED\nGIT_DELTA_DELETED\nGIT_DELTA_MODIFIED\nGIT_DELTA_RENAMED\nGIT_DELTA_COPIED\nGIT_DELTA_IGNORED\nGIT_DELTA_UNTRACKED\nGIT_DELTA_TYPECHANGE","tdef":"typedef","comments":"<p>What type of change is described by a git_diff_delta?</p>\n\n<p><code>GIT_DELTA_RENAMED</code> and <code>GIT_DELTA_COPIED</code> will only show up if you run\n<code>git_diff_find_similar()</code> on the diff list object.</p>\n\n<p><code>GIT_DELTA_TYPECHANGE</code> only shows up given <code>GIT_DIFF_INCLUDE_TYPECHANGE</code>\nin the option flags (otherwise type changes will be split into ADDED /\nDELETED pairs).</p>\n","used":{"returns":[],"needs":["git_diff_num_deltas_of_type","git_diff_status_char"]}}],["git_diff_delta",{"decl":["git_diff_file old_file","git_diff_file new_file","git_delta_t status","uint32_t similarity","uint32_t flags"],"type":"struct","value":"git_diff_delta","file":"diff.h","line":228,"lineto":234,"block":"git_diff_file old_file\ngit_diff_file new_file\ngit_delta_t status\nuint32_t similarity\nuint32_t flags","tdef":"typedef","comments":"<p>Description of changes to one entry.</p>\n\n<p>When iterating over a diff list object, this will be passed to most\ncallback functions and you can use the contents to understand exactly\nwhat has changed.</p>\n\n<p>The <code>old_file</code> represents the &quot;from&quot; side of the diff and the <code>new_file</code>\nrepresents to &quot;to&quot; side of the diff. What those means depend on the\nfunction that was used to generate the diff and will be documented below.\nYou can also use the <code>GIT_DIFF_REVERSE</code> flag to flip it around.</p>\n\n<p>Although the two sides of the delta are named &quot;old_file&quot; and &quot;new_file&quot;,\nthey actually may correspond to entries that represent a file, a symbolic\nlink, a submodule commit id, or even a tree (if you are tracking type\nchanges or ignored/untracked directories).</p>\n\n<p>Under some circumstances, in the name of efficiency, not all fields will\nbe filled in, but we generally try to fill in as much as possible. One\nexample is that the &quot;flags&quot; field may not have either the <code>BINARY</code> or the\n<code>NOT_BINARY</code> flag set to avoid examining file contents if you do not pass\nin hunk and/or line callbacks to the diff foreach iteration function. It\nwill just use the git attributes for those files.</p>\n","used":{"returns":["git_diff_patch_delta"],"needs":["git_diff_get_patch"]}}],["git_diff_file",{"decl":["git_oid oid","const char *path","git_off_t size","uint32_t flags","uint16_t mode"],"type":"struct","value":"git_diff_file","file":"diff.h","line":196,"lineto":202,"block":"git_oid oid\nconst char *path\ngit_off_t size\nuint32_t flags\nuint16_t mode","tdef":"typedef","comments":"<p>Description of one side of a diff entry.</p>\n\n<p>Although this is called a &quot;file&quot;, it may actually represent a file, a\nsymbolic link, a submodule commit id, or even a tree (although that only\nif you are tracking type changes or ignored/untracked directories).</p>\n\n<p>The <code>oid</code> is the <code>git_oid</code> of the item. If the entry represents an\nabsent side of a diff (e.g. the <code>old_file</code> of a <code>GIT_DELTA_ADDED</code> delta),\nthen the oid will be zeroes.</p>\n\n<p><code>path</code> is the NUL-terminated path to the entry relative to the working\ndirectory of the repository.</p>\n\n<p><code>size</code> is the size of the entry in bytes.</p>\n\n<p><code>flags</code> is a combination of the <code>git_diff_flag_t</code> types</p>\n\n<p><code>mode</code> is, roughly, the stat() <code>st_mode</code> value for the item. This will\nbe restricted to one of the <code>git_filemode_t</code> values.</p>\n","used":{"returns":[],"needs":[]}}],["git_diff_file_cb",{"decl":"int (*git_diff_file_cb)(\n\tconst git_diff_delta *delta,\n\tfloat progress,\n\tvoid *payload)","type":"function pointer","value":"git_diff_file_cb","file":"diff.h","line":301,"lineto":304,"comments":"<p>When iterating over a diff, callback that will be made per file.</p>\n\n<p>@param delta A pointer to the delta data for the file\n@param progress Goes from 0 to 1 over the diff list\n@param payload User-specified pointer from foreach function</p>\n","used":{"returns":[],"needs":["git_diff_blob_to_buffer","git_diff_blobs","git_diff_foreach"]}}],["git_diff_find_options",{"decl":["unsigned int version","unsigned int flags","unsigned int rename_threshold","unsigned int rename_from_rewrite_threshold","unsigned int copy_threshold","unsigned int break_rewrite_threshold","unsigned int target_limit","git_diff_similarity_metric *metric"],"type":"struct","value":"git_diff_find_options","file":"diff.h","line":436,"lineto":459,"block":"unsigned int version\nunsigned int flags\nunsigned int rename_threshold\nunsigned int rename_from_rewrite_threshold\nunsigned int copy_threshold\nunsigned int break_rewrite_threshold\nunsigned int target_limit\ngit_diff_similarity_metric *metric","tdef":"typedef","comments":"<p>Control behavior of rename and copy detection</p>\n\n<p>These options mostly mimic parameters that can be passed to git-diff.</p>\n\n<ul>\n<li><code>rename_threshold</code> is the same as the -M option with a value</li>\n<li><code>copy_threshold</code> is the same as the -C option with a value</li>\n<li><code>rename_from_rewrite_threshold</code> matches the top of the -B option</li>\n<li><code>break_rewrite_threshold</code> matches the bottom of the -B option</li>\n<li><code>target_limit</code> matches the -l option</li>\n</ul>\n\n<p>The <code>metric</code> option allows you to plug in a custom similarity metric.\nSet it to NULL for the default internal metric which is based on sampling\nhashes of ranges of data in the file. The default metric is a pretty\ngood similarity approximation that should work fairly well for both text\nand binary data, and is pretty fast with fixed memory overhead.</p>\n","used":{"returns":[],"needs":["git_diff_find_similar"]}}],["git_diff_flag_t",{"sections":[["<p>Flags for the delta object and the file objects on each side.</p>\n\n<p>These flags are used for both the <code>flags</code> value of the <code>git_diff_delta</code>\nand the flags for the <code>git_diff_file</code> objects representing the old and\nnew sides of the delta. Values outside of this public range should be\nconsidered reserved for internal or future use.</p>\n",["GIT_DIFF_FLAG_BINARY","GIT_DIFF_FLAG_NOT_BINARY","GIT_DIFF_FLAG_VALID_OID"]]],"decl":["GIT_DIFF_FLAG_BINARY","GIT_DIFF_FLAG_NOT_BINARY","GIT_DIFF_FLAG_VALID_OID"],"type":"enum","file":"diff.h","line":147,"lineto":151,"block":"GIT_DIFF_FLAG_BINARY\nGIT_DIFF_FLAG_NOT_BINARY\nGIT_DIFF_FLAG_VALID_OID","tdef":"typedef","comments":"<p>Flags for the delta object and the file objects on each side.</p>\n\n<p>These flags are used for both the <code>flags</code> value of the <code>git_diff_delta</code>\nand the flags for the <code>git_diff_file</code> objects representing the old and\nnew sides of the delta. Values outside of this public range should be\nconsidered reserved for internal or future use.</p>\n","used":{"returns":[],"needs":[]}}],["git_diff_hunk_cb",{"decl":"int (*git_diff_hunk_cb)(\n\tconst git_diff_delta *delta,\n\tconst git_diff_range *range,\n\tconst char *header,\n\tsize_t header_len,\n\tvoid *payload)","type":"function pointer","value":"git_diff_hunk_cb","file":"diff.h","line":319,"lineto":324,"comments":"<p>When iterating over a diff, callback that will be made per hunk.</p>\n","used":{"returns":[],"needs":["git_diff_blob_to_buffer","git_diff_blobs","git_diff_foreach"]}}],["git_diff_line_t",{"sections":[["<p>Line origin constants.</p>\n\n<p>These values describe where a line came from and will be passed to\nthe git_diff_data_cb when iterating over a diff. There are some\nspecial origin constants at the end that are used for the text\noutput callbacks to demarcate lines that are actually part of\nthe file or hunk headers.</p>\n",["GIT_DIFF_LINE_CONTEXT","GIT_DIFF_LINE_ADDITION","GIT_DIFF_LINE_DELETION","GIT_DIFF_LINE_ADD_EOFNL","GIT_DIFF_LINE_DEL_EOFNL","GIT_DIFF_LINE_FILE_HDR","GIT_DIFF_LINE_HUNK_HDR","GIT_DIFF_LINE_BINARY"]]],"decl":["GIT_DIFF_LINE_CONTEXT","GIT_DIFF_LINE_ADDITION","GIT_DIFF_LINE_DELETION","GIT_DIFF_LINE_ADD_EOFNL","GIT_DIFF_LINE_DEL_EOFNL","GIT_DIFF_LINE_FILE_HDR","GIT_DIFF_LINE_HUNK_HDR","GIT_DIFF_LINE_BINARY"],"type":"enum","file":"diff.h","line":335,"lineto":350,"block":"GIT_DIFF_LINE_CONTEXT\nGIT_DIFF_LINE_ADDITION\nGIT_DIFF_LINE_DELETION\nGIT_DIFF_LINE_ADD_EOFNL\nGIT_DIFF_LINE_DEL_EOFNL\nGIT_DIFF_LINE_FILE_HDR\nGIT_DIFF_LINE_HUNK_HDR\nGIT_DIFF_LINE_BINARY","tdef":"typedef","comments":"<p>Line origin constants.</p>\n\n<p>These values describe where a line came from and will be passed to\nthe git_diff_data_cb when iterating over a diff. There are some\nspecial origin constants at the end that are used for the text\noutput callbacks to demarcate lines that are actually part of\nthe file or hunk headers.</p>\n","used":{"returns":[],"needs":[]}}],["git_diff_list",{"decl":"","type":"struct","value":"git_diff_list","file":"diff.h","line":137,"lineto":137,"block":"","tdef":"typedef","comments":"<p>The diff list object that contains all individual file deltas.</p>\n\n<p>This is an opaque structure which will be allocated by one of the diff\ngenerator functions below (such as <code>git_diff_tree_to_tree</code>). You are\nresponsible for releasing the object memory when done, using the\n<code>git_diff_list_free()</code> function.</p>\n","used":{"returns":[],"needs":["git_diff_find_similar","git_diff_foreach","git_diff_get_patch","git_diff_index_to_workdir","git_diff_list_free","git_diff_merge","git_diff_num_deltas","git_diff_num_deltas_of_type","git_diff_print_compact","git_diff_print_patch","git_diff_tree_to_index","git_diff_tree_to_tree","git_diff_tree_to_workdir"]}}],["git_diff_notify_cb",{"decl":"int (*git_diff_notify_cb)(\n\tconst git_diff_list *diff_so_far,\n\tconst git_diff_delta *delta_to_add,\n\tconst char *matched_pathspec,\n\tvoid *payload)","type":"function pointer","value":"git_diff_notify_cb","file":"diff.h","line":249,"lineto":253,"comments":"<p>Diff notification callback function.</p>\n\n<p>The callback will be called for each file, just before the <code>git_delta_t</code>\ngets inserted into the diff list.</p>\n\n<p>When the callback:\n- returns &lt; 0, the diff process will be aborted.\n- returns &gt; 0, the delta will not be inserted into the diff list, but the\n diff process continues.\n- returns 0, the delta is inserted into the diff list, and the diff process\n continues.</p>\n","used":{"returns":[],"needs":[]}}],["git_diff_options",{"decl":["unsigned int version","uint32_t flags","uint16_t context_lines","uint16_t interhunk_lines","const char *old_prefix","const char *new_prefix","git_strarray pathspec","git_off_t max_size","git_diff_notify_cb notify_cb","void *notify_payload"],"type":"struct","value":"git_diff_options","file":"diff.h","line":278,"lineto":292,"block":"unsigned int version\nuint32_t flags\nuint16_t context_lines\nuint16_t interhunk_lines\nconst char *old_prefix\nconst char *new_prefix\ngit_strarray pathspec\ngit_off_t max_size\ngit_diff_notify_cb notify_cb\nvoid *notify_payload","tdef":"typedef","comments":"<p>Structure describing options about how the diff should be executed.</p>\n\n<p>Setting all values of the structure to zero will yield the default\nvalues. Similarly, passing NULL for the options structure will\ngive the defaults. The default values are marked below.</p>\n\n<ul>\n<li><code>flags</code> is a combination of the <code>git_diff_option_t</code> values above</li>\n<li><code>context_lines</code> is the number of unchanged lines that define the\nboundary of a hunk (and to display before and after)</li>\n<li><code>interhunk_lines</code> is the maximum number of unchanged lines between\nhunk boundaries before the hunks will be merged into a one.</li>\n<li><code>old_prefix</code> is the virtual &quot;directory&quot; to prefix to old file names\nin hunk headers (default &quot;a&quot;)</li>\n<li><code>new_prefix</code> is the virtual &quot;directory&quot; to prefix to new file names\nin hunk headers (default &quot;b&quot;)</li>\n<li><code>pathspec</code> is an array of paths / fnmatch patterns to constrain diff</li>\n<li><code>max_size</code> is a file size (in bytes) above which a blob will be marked\nas binary automatically; pass a negative value to disable.</li>\n<li><code>notify_cb</code> is an optional callback function, notifying the consumer of\nwhich files are being examined as the diff is generated</li>\n<li><code>notify_payload</code> is the payload data to pass to the <code>notify_cb</code> function</li>\n</ul>\n","used":{"returns":[],"needs":["git_diff_blob_to_buffer","git_diff_blobs","git_diff_index_to_workdir","git_diff_tree_to_index","git_diff_tree_to_tree","git_diff_tree_to_workdir"]}}],["git_diff_patch",{"decl":"","type":"struct","value":"git_diff_patch","file":"diff.h","line":374,"lineto":374,"block":"","tdef":"typedef","comments":"<p>The diff patch is used to store all the text diffs for a delta.</p>\n\n<p>You can easily loop over the content of patches and get information about\nthem.</p>\n","used":{"returns":[],"needs":["git_diff_get_patch","git_diff_patch_delta","git_diff_patch_free","git_diff_patch_get_hunk","git_diff_patch_get_line_in_hunk","git_diff_patch_line_stats","git_diff_patch_num_hunks","git_diff_patch_num_lines_in_hunk","git_diff_patch_print","git_diff_patch_to_str"]}}],["git_diff_range",{"decl":["int old_start","int old_lines","int new_start","int new_lines"],"type":"struct","value":"git_diff_range","file":"diff.h","line":309,"lineto":314,"block":"int old_start\nint old_lines\nint new_start\nint new_lines","tdef":"typedef","comments":"<p>Structure describing a hunk of a diff.</p>\n","used":{"returns":[],"needs":["git_diff_patch_get_hunk"]}}],["git_diff_similarity_metric",{"decl":["int (*file_signature)(void **out, const git_diff_file *file, const char *fullpath, void *payload)","int (*buffer_signature)(void **out, const git_diff_file *file, const char *buf, size_t buflen, void *payload)","void (*free_signature)(void *sig, void *payload)","int (*similarity)(int *score, void *siga, void *sigb, void *payload)","void *payload"],"type":"struct","value":"git_diff_similarity_metric","file":"diff.h","line":407,"lineto":417,"block":"int (*file_signature)(void **out, const git_diff_file *file, const char *fullpath, void *payload)\nint (*buffer_signature)(void **out, const git_diff_file *file, const char *buf, size_t buflen, void *payload)\nvoid (*free_signature)(void *sig, void *payload)\nint (*similarity)(int *score, void *siga, void *sigb, void *payload)\nvoid *payload","tdef":"typedef","comments":"<p>Pluggable similarity metric</p>\n","used":{"returns":[],"needs":[]}}],["git_error_t",{"sections":[["<p>Error classes</p>\n",["GITERR_NOMEMORY","GITERR_OS","GITERR_INVALID","GITERR_REFERENCE","GITERR_ZLIB","GITERR_REPOSITORY","GITERR_CONFIG","GITERR_REGEX","GITERR_ODB","GITERR_INDEX","GITERR_OBJECT","GITERR_NET","GITERR_TAG","GITERR_TREE","GITERR_INDEXER","GITERR_SSL","GITERR_SUBMODULE","GITERR_THREAD","GITERR_STASH","GITERR_CHECKOUT","GITERR_FETCHHEAD","GITERR_MERGE"]]],"decl":["GITERR_NOMEMORY","GITERR_OS","GITERR_INVALID","GITERR_REFERENCE","GITERR_ZLIB","GITERR_REPOSITORY","GITERR_CONFIG","GITERR_REGEX","GITERR_ODB","GITERR_INDEX","GITERR_OBJECT","GITERR_NET","GITERR_TAG","GITERR_TREE","GITERR_INDEXER","GITERR_SSL","GITERR_SUBMODULE","GITERR_THREAD","GITERR_STASH","GITERR_CHECKOUT","GITERR_FETCHHEAD","GITERR_MERGE"],"type":"enum","file":"errors.h","line":46,"lineto":69,"block":"GITERR_NOMEMORY\nGITERR_OS\nGITERR_INVALID\nGITERR_REFERENCE\nGITERR_ZLIB\nGITERR_REPOSITORY\nGITERR_CONFIG\nGITERR_REGEX\nGITERR_ODB\nGITERR_INDEX\nGITERR_OBJECT\nGITERR_NET\nGITERR_TAG\nGITERR_TREE\nGITERR_INDEXER\nGITERR_SSL\nGITERR_SUBMODULE\nGITERR_THREAD\nGITERR_STASH\nGITERR_CHECKOUT\nGITERR_FETCHHEAD\nGITERR_MERGE","tdef":"typedef","comments":"<p>Error classes</p>\n","used":{"returns":[],"needs":[]}}],["git_filemode_t",{"sections":[["<p>Valid modes for index and tree entries.</p>\n",["GIT_FILEMODE_NEW","GIT_FILEMODE_TREE","GIT_FILEMODE_BLOB","GIT_FILEMODE_BLOB_EXECUTABLE","GIT_FILEMODE_LINK","GIT_FILEMODE_COMMIT"]]],"decl":["GIT_FILEMODE_NEW","GIT_FILEMODE_TREE","GIT_FILEMODE_BLOB","GIT_FILEMODE_BLOB_EXECUTABLE","GIT_FILEMODE_LINK","GIT_FILEMODE_COMMIT"],"type":"enum","file":"types.h","line":183,"lineto":197,"block":"GIT_FILEMODE_NEW\nGIT_FILEMODE_TREE\nGIT_FILEMODE_BLOB\nGIT_FILEMODE_BLOB_EXECUTABLE\nGIT_FILEMODE_LINK\nGIT_FILEMODE_COMMIT","tdef":"typedef","comments":"<p>Valid modes for index and tree entries.</p>\n","used":{"returns":[],"needs":["git_treebuilder_insert"]}}],["git_headlist_cb",{"decl":"int (*git_headlist_cb)(git_remote_head *rhead, void *payload)","type":"function pointer","value":"git_headlist_cb","file":"net.h","line":49,"lineto":49,"comments":"<p>Callback for listing the remote heads</p>\n","used":{"returns":[],"needs":["git_remote_ls"]}}],["git_index",{"decl":"","type":"struct","value":"git_index","file":"types.h","line":132,"lineto":132,"block":"","tdef":"typedef","comments":"<p>Memory representation of an index file.</p>\n","used":{"returns":[],"needs":["git_checkout_index","git_diff_index_to_workdir","git_diff_tree_to_index","git_index_add","git_index_add_bypath","git_index_caps","git_index_clear","git_index_conflict_add","git_index_conflict_cleanup","git_index_conflict_get","git_index_conflict_remove","git_index_entrycount","git_index_find","git_index_free","git_index_get_byindex","git_index_get_bypath","git_index_has_conflicts","git_index_new","git_index_open","git_index_owner","git_index_read","git_index_read_tree","git_index_remove","git_index_remove_bypath","git_index_remove_directory","git_index_reuc_add","git_index_reuc_clear","git_index_reuc_entrycount","git_index_reuc_find","git_index_reuc_get_byindex","git_index_reuc_get_bypath","git_index_reuc_remove","git_index_set_caps","git_index_write","git_index_write_tree","git_index_write_tree_to","git_repository_index","git_repository_set_index"]}}],["git_index_entry",{"decl":["git_index_time ctime","git_index_time mtime","unsigned int dev","unsigned int ino","unsigned int mode","unsigned int uid","unsigned int gid","git_off_t file_size","git_oid oid","unsigned short flags","unsigned short flags_extended","char *path"],"type":"struct","value":"git_index_entry","file":"index.h","line":68,"lineto":85,"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":"<p>Memory representation of a file entry in the index.</p>\n","used":{"returns":["git_index_get_byindex","git_index_get_bypath"],"needs":["git_index_add","git_index_conflict_add","git_index_conflict_get","git_index_entry_stage"]}}],["git_index_reuc_entry",{"decl":["unsigned int mode[3]","git_oid oid[3]","char *path"],"type":"struct","value":"git_index_reuc_entry","file":"index.h","line":88,"lineto":92,"block":"unsigned int mode[3]\ngit_oid oid[3]\nchar *path","tdef":"typedef","comments":"<p>Representation of a resolve undo entry in the index.</p>\n","used":{"returns":["git_index_reuc_get_byindex","git_index_reuc_get_bypath"],"needs":[]}}],["git_index_time",{"decl":["git_time_t seconds","unsigned int nanoseconds"],"type":"struct","value":"git_index_time","file":"index.h","line":61,"lineto":65,"block":"git_time_t seconds\nunsigned int nanoseconds","tdef":"typedef","comments":"<p>Time used in a git index entry</p>\n","used":{"returns":[],"needs":[]}}],["git_note",{"decl":"","type":"struct","value":"git_note","file":"types.h","line":147,"lineto":147,"block":"","tdef":"typedef","comments":"<p>Representation of a git note</p>\n","used":{"returns":[],"needs":["git_note_free","git_note_message","git_note_oid","git_note_read"]}}],["git_note_foreach_cb",{"decl":"int (*git_note_foreach_cb)(\n\tconst git_oid *blob_id, const git_oid *annotated_object_id, void *payload)","type":"function pointer","value":"git_note_foreach_cb","file":"notes.h","line":29,"lineto":30,"comments":"<p>Callback for git_note_foreach.</p>\n\n<p>Receives:\n- blob_id: Oid of the blob containing the message\n- annotated_object_id: Oid of the git object being annotated\n- payload: Payload data passed to <code>git_note_foreach</code></p>\n","used":{"returns":[],"needs":["git_note_foreach"]}}],["git_note_iterator",{"decl":"","type":"struct","value":"git_note_iterator","file":"notes.h","line":35,"lineto":35,"block":"","tdef":"typedef","comments":"<p>note iterator</p>\n","used":{"returns":[],"needs":["git_note_iterator_free","git_note_iterator_new","git_note_next"]}}],["git_object",{"decl":"","type":"struct","value":"git_object","file":"types.h","line":108,"lineto":108,"block":"","tdef":"typedef","comments":"<p>Representation of a generic object in a repository</p>\n","used":{"returns":[],"needs":["git_checkout_tree","git_object_dup","git_object_free","git_object_id","git_object_lookup","git_object_lookup_prefix","git_object_owner","git_object_peel","git_object_type","git_reference_peel","git_reset","git_reset_default","git_revparse_single","git_tag_create","git_tag_create_lightweight","git_tag_peel","git_tag_target","git_tree_entry_to_object"]}}],["git_odb",{"decl":"","type":"struct","value":"git_odb","file":"types.h","line":81,"lineto":81,"block":"","tdef":"typedef","comments":"<p>An open object database handle.</p>\n","used":{"returns":[],"needs":["git_odb_add_alternate","git_odb_add_backend","git_odb_add_disk_alternate","git_odb_exists","git_odb_foreach","git_odb_free","git_odb_new","git_odb_open","git_odb_open_rstream","git_odb_open_wstream","git_odb_read","git_odb_read_header","git_odb_read_prefix","git_odb_refresh","git_odb_write","git_odb_write_pack","git_repository_odb","git_repository_set_odb","git_repository_wrap_odb"]}}],["git_odb_backend",{"decl":"","type":"struct","value":"git_odb_backend","file":"types.h","line":84,"lineto":84,"block":"","tdef":"typedef","comments":"<p>A custom backend in an ODB</p>\n","used":{"returns":[],"needs":["git_odb_add_alternate","git_odb_add_backend","git_odb_backend_pack"]}}],["git_odb_foreach_cb",{"decl":"int (*git_odb_foreach_cb)(const git_oid *id, void *payload)","type":"function pointer","value":"git_odb_foreach_cb","file":"odb_backend.h","line":30,"lineto":30,"comments":"<p>Function type for callbacks from git_odb_foreach.</p>\n","used":{"returns":[],"needs":["git_odb_foreach"]}}],["git_odb_object",{"decl":"","type":"struct","value":"git_odb_object","file":"types.h","line":87,"lineto":87,"block":"","tdef":"typedef","comments":"<p>An object read from the ODB</p>\n","used":{"returns":[],"needs":["git_odb_object_data","git_odb_object_free","git_odb_object_id","git_odb_object_size","git_odb_object_type","git_odb_read","git_odb_read_prefix"]}}],["git_odb_stream",{"decl":"","type":"struct","value":"git_odb_stream","file":"types.h","line":90,"lineto":90,"block":"","tdef":"typedef","comments":"<p>A stream to read/write from the ODB</p>\n","used":{"returns":[],"needs":["git_odb_open_rstream","git_odb_open_wstream"]}}],["git_odb_writepack",{"decl":"","type":"struct","value":"git_odb_writepack","file":"types.h","line":93,"lineto":93,"block":"","tdef":"typedef","comments":"<p>A stream to write a packfile to the ODB</p>\n","used":{"returns":[],"needs":["git_odb_write_pack"]}}],["git_oid",{"decl":["unsigned char id[GIT_OID_RAWSZ]"],"type":"struct","value":"git_oid","file":"oid.h","line":33,"lineto":36,"block":"unsigned char id[GIT_OID_RAWSZ]","tdef":"typedef","comments":"<p>Unique identity of any object (commit, tree, blob, tag).</p>\n","used":{"returns":["git_blob_id","git_commit_id","git_commit_parent_id","git_commit_tree_id","git_indexer_stream_hash","git_note_oid","git_object_id","git_odb_object_id","git_reference_target","git_reflog_entry_id_new","git_reflog_entry_id_old","git_submodule_head_id","git_submodule_index_id","git_submodule_wd_id","git_tag_id","git_tag_target_id","git_tree_entry_id","git_tree_id"],"needs":["git_blob_create_frombuffer","git_blob_create_fromchunks","git_blob_create_fromdisk","git_blob_create_fromworkdir","git_blob_lookup","git_blob_lookup_prefix","git_commit_create","git_commit_create_v","git_commit_lookup","git_commit_lookup_prefix","git_graph_ahead_behind","git_index_reuc_add","git_index_write_tree","git_index_write_tree_to","git_merge_base","git_merge_base_many","git_note_create","git_note_next","git_note_read","git_note_remove","git_object_lookup","git_object_lookup_prefix","git_odb_exists","git_odb_hash","git_odb_hashfile","git_odb_open_rstream","git_odb_read","git_odb_read_header","git_odb_read_prefix","git_odb_write","git_oid_allocfmt","git_oid_cmp","git_oid_cpy","git_oid_equal","git_oid_fmt","git_oid_fromraw","git_oid_fromstr","git_oid_fromstrn","git_oid_fromstrp","git_oid_iszero","git_oid_ncmp","git_oid_pathfmt","git_oid_streq","git_oid_tostr","git_packbuilder_insert","git_packbuilder_insert_tree","git_reference__alloc","git_reference_create","git_reference_name_to_id","git_reference_set_target","git_reflog_append","git_repository_hashfile","git_repository_set_head_detached","git_revwalk_hide","git_revwalk_next","git_revwalk_push","git_stash_save","git_tag_create","git_tag_create_frombuffer","git_tag_create_lightweight","git_tag_lookup","git_tag_lookup_prefix","git_tree_entry_byoid","git_tree_lookup","git_tree_lookup_prefix","git_treebuilder_insert","git_treebuilder_write"]}}],["git_oid_shorten",{"decl":"","type":"struct","value":"git_oid_shorten","file":"oid.h","line":205,"lineto":205,"block":"","tdef":"typedef","comments":"<p>OID Shortener object</p>\n","used":{"returns":["git_oid_shorten_new"],"needs":["git_oid_shorten_add","git_oid_shorten_free"]}}],["git_otype",{"sections":[["<p>Basic type (loose or packed) of any Git object.</p>\n",["GIT_OBJ_ANY","GIT_OBJ_BAD","GIT_OBJ__EXT1","GIT_OBJ_COMMIT","GIT_OBJ_TREE","GIT_OBJ_BLOB","GIT_OBJ_TAG","GIT_OBJ__EXT2","GIT_OBJ_OFS_DELTA","GIT_OBJ_REF_DELTA"]]],"decl":["GIT_OBJ_ANY","GIT_OBJ_BAD","GIT_OBJ__EXT1","GIT_OBJ_COMMIT","GIT_OBJ_TREE","GIT_OBJ_BLOB","GIT_OBJ_TAG","GIT_OBJ__EXT2","GIT_OBJ_OFS_DELTA","GIT_OBJ_REF_DELTA"],"type":"enum","file":"types.h","line":67,"lineto":78,"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":"<p>Basic type (loose or packed) of any Git object.</p>\n","used":{"returns":[],"needs":["git_object__size","git_object_lookup","git_object_lookup_prefix","git_object_peel","git_object_type2string","git_object_typeisloose","git_odb_hash","git_odb_hashfile","git_odb_open_wstream","git_odb_read_header","git_odb_write","git_reference_peel","git_repository_hashfile"]}}],["git_packbuilder",{"decl":"","type":"struct","value":"git_packbuilder","file":"types.h","line":150,"lineto":150,"block":"","tdef":"typedef","comments":"<p>Representation of a git packbuilder</p>\n","used":{"returns":[],"needs":["git_packbuilder_foreach","git_packbuilder_free","git_packbuilder_insert","git_packbuilder_insert_tree","git_packbuilder_new","git_packbuilder_object_count","git_packbuilder_set_threads","git_packbuilder_write","git_packbuilder_written"]}}],["git_push_options",{"decl":["unsigned int version","unsigned int pb_parallelism"],"type":"struct","value":"git_push_options","file":"push.h","line":24,"lineto":32,"block":"unsigned int version\nunsigned int pb_parallelism","tdef":"typedef","comments":"<p>Controls the behavior of a git_push object.</p>\n","used":{"returns":[],"needs":["git_push_set_options"]}}],["git_ref_t",{"sections":[["<p>Basic type of any Git reference.</p>\n",["GIT_REF_INVALID","GIT_REF_OID","GIT_REF_SYMBOLIC","GIT_REF_LISTALL"]]],"decl":["GIT_REF_INVALID","GIT_REF_OID","GIT_REF_SYMBOLIC","GIT_REF_LISTALL"],"type":"enum","file":"types.h","line":169,"lineto":174,"block":"GIT_REF_INVALID\nGIT_REF_OID\nGIT_REF_SYMBOLIC\nGIT_REF_LISTALL","tdef":"typedef","comments":"<p>Basic type of any Git reference.</p>\n","used":{"returns":[],"needs":[]}}],["git_refdb",{"decl":"","type":"struct","value":"git_refdb","file":"types.h","line":96,"lineto":96,"block":"","tdef":"typedef","comments":"<p>An open refs database handle.</p>\n","used":{"returns":[],"needs":["git_refdb_backend_fs","git_refdb_compress","git_refdb_free","git_refdb_new","git_refdb_open","git_refdb_set_backend","git_reference__alloc","git_repository_refdb","git_repository_set_refdb"]}}],["git_refdb_backend",{"decl":"","type":"struct","value":"git_refdb_backend","file":"types.h","line":99,"lineto":99,"block":"","tdef":"typedef","comments":"<p>A custom backend for refs</p>\n","used":{"returns":[],"needs":["git_refdb_backend_fs","git_refdb_set_backend"]}}],["git_reference",{"decl":"","type":"struct","value":"git_reference","file":"types.h","line":166,"lineto":166,"block":"","tdef":"typedef","comments":"<p>In-memory representation of a reference.</p>\n","used":{"returns":["git_reference__alloc"],"needs":["git_branch_create","git_branch_delete","git_branch_is_head","git_branch_lookup","git_branch_move","git_branch_name","git_branch_set_upstream","git_branch_upstream","git_reference_cmp","git_reference_create","git_reference_delete","git_reference_free","git_reference_has_log","git_reference_is_branch","git_reference_is_remote","git_reference_lookup","git_reference_name","git_reference_owner","git_reference_peel","git_reference_rename","git_reference_resolve","git_reference_set_target","git_reference_symbolic_create","git_reference_symbolic_set_target","git_reference_symbolic_target","git_reference_target","git_reference_type","git_reflog_delete","git_reflog_read","git_reflog_rename","git_repository_head"]}}],["git_reflog",{"decl":"","type":"struct","value":"git_reflog","file":"types.h","line":144,"lineto":144,"block":"","tdef":"typedef","comments":"<p>Representation of a reference log</p>\n","used":{"returns":[],"needs":["git_reflog_append","git_reflog_drop","git_reflog_entry_byindex","git_reflog_entrycount","git_reflog_free","git_reflog_read","git_reflog_write"]}}],["git_reflog_entry",{"decl":"","type":"struct","value":"git_reflog_entry","file":"types.h","line":141,"lineto":141,"block":"","tdef":"typedef","comments":"<p>Representation of a reference log entry</p>\n","used":{"returns":["git_reflog_entry_byindex"],"needs":["git_reflog_entry_committer","git_reflog_entry_id_new","git_reflog_entry_id_old","git_reflog_entry_message"]}}],["git_remote_callbacks",{"decl":["unsigned int version","void (*progress)(const char *str, int len, void *data)","int (*completion)(git_remote_completion_type type, void *data)","int (*update_tips)(const char *refname, const git_oid *a, const git_oid *b, void *data)","void *payload"],"type":"struct","value":"git_remote_callbacks","file":"remote.h","line":359,"lineto":368,"block":"unsigned int version\nvoid (*progress)(const char *str, int len, void *data)\nint (*completion)(git_remote_completion_type type, void *data)\nint (*update_tips)(const char *refname, const git_oid *a, const git_oid *b, void *data)\nvoid *payload","tdef":null,"comments":"<p>The callback settings structure</p>\n\n<p>Set the calbacks to be called by the remote.</p>\n","used":{"returns":[],"needs":["git_remote_set_callbacks"]}}],["git_remote_head",{"decl":["int local","git_oid oid","git_oid loid","char *name"],"type":"struct","value":"git_remote_head","file":"net.h","line":39,"lineto":44,"block":"int local\ngit_oid oid\ngit_oid loid\nchar *name","tdef":null,"comments":"<p>Remote head description, given out on <code>ls</code> calls.</p>\n","used":{"returns":[],"needs":[]}}],["git_repository",{"decl":"","type":"struct","value":"git_repository","file":"types.h","line":105,"lineto":105,"block":"","tdef":"typedef","comments":"<p>Representation of an existing git repository,\nincluding all its object contents</p>\n","used":{"returns":["git_index_owner","git_object_owner","git_reference_owner","git_revwalk_repository","git_submodule_owner","git_tree_owner"],"needs":["git_attr_add_macro","git_attr_cache_flush","git_attr_foreach","git_attr_get","git_attr_get_many","git_blob_create_frombuffer","git_blob_create_fromchunks","git_blob_create_fromdisk","git_blob_create_fromworkdir","git_blob_lookup","git_blob_lookup_prefix","git_branch_create","git_branch_foreach","git_branch_lookup","git_branch_remote_name","git_branch_upstream_name","git_checkout_head","git_checkout_index","git_checkout_tree","git_clone","git_commit_create","git_commit_create_v","git_commit_lookup","git_commit_lookup_prefix","git_diff_index_to_workdir","git_diff_tree_to_index","git_diff_tree_to_tree","git_diff_tree_to_workdir","git_graph_ahead_behind","git_ignore_add_rule","git_ignore_clear_internal_rules","git_ignore_path_is_ignored","git_index_write_tree_to","git_merge_base","git_merge_base_many","git_note_create","git_note_default_ref","git_note_foreach","git_note_iterator_new","git_note_read","git_note_remove","git_object_lookup","git_object_lookup_prefix","git_packbuilder_new","git_refdb_backend_fs","git_refdb_new","git_refdb_open","git_reference_create","git_reference_foreach","git_reference_foreach_glob","git_reference_list","git_reference_lookup","git_reference_name_to_id","git_reference_symbolic_create","git_remote_create","git_remote_create_inmemory","git_remote_list","git_remote_load","git_repository_config","git_repository_detach_head","git_repository_fetchhead_foreach","git_repository_free","git_repository_hashfile","git_repository_head","git_repository_head_detached","git_repository_head_orphan","git_repository_index","git_repository_init","git_repository_init_ext","git_repository_is_bare","git_repository_is_empty","git_repository_merge_cleanup","git_repository_mergehead_foreach","git_repository_message","git_repository_message_remove","git_repository_odb","git_repository_open","git_repository_open_ext","git_repository_path","git_repository_refdb","git_repository_set_config","git_repository_set_head","git_repository_set_head_detached","git_repository_set_index","git_repository_set_odb","git_repository_set_refdb","git_repository_set_workdir","git_repository_state","git_repository_workdir","git_repository_wrap_odb","git_reset","git_reset_default","git_revparse","git_revparse_single","git_revwalk_new","git_stash_drop","git_stash_foreach","git_stash_save","git_status_file","git_status_foreach","git_status_foreach_ext","git_status_should_ignore","git_submodule_add_setup","git_submodule_foreach","git_submodule_lookup","git_submodule_open","git_submodule_reload_all","git_tag_create","git_tag_create_frombuffer","git_tag_create_lightweight","git_tag_delete","git_tag_foreach","git_tag_list","git_tag_list_match","git_tag_lookup","git_tag_lookup_prefix","git_tree_entry_to_object","git_tree_lookup","git_tree_lookup_prefix","git_treebuilder_write"]}}],["git_repository_init_flag_t",{"sections":[["<p>Option flags for <code>git_repository_init_ext</code>.</p>\n\n<p>These flags configure extra behaviors to <code>git_repository_init_ext</code>.\nIn every case, the default behavior is the zero value (i.e. flag is\nnot set). Just OR the flag values together for the <code>flags</code> parameter\nwhen initializing a new repo. Details of individual values are:</p>\n\n<ul>\n<li>BARE - Create a bare repository with no working directory.</li>\n<li>NO_REINIT - Return an EEXISTS error if the repo_path appears to\n already be an git repository.</li>\n<li>NO_DOTGIT_DIR - Normally a &quot;/.git/&quot; will be appended to the repo\n path for non-bare repos (if it is not already there), but\n passing this flag prevents that behavior.</li>\n<li>MKDIR - Make the repo_path (and workdir_path) as needed. Init is\n always willing to create the &quot;.git&quot; directory even without this\n flag. This flag tells init to create the trailing component of\n the repo and workdir paths as needed.</li>\n<li>MKPATH - Recursively make all components of the repo and workdir\n paths as necessary.</li>\n<li>EXTERNAL_TEMPLATE - libgit2 normally uses internal templates to\n initialize a new repo. This flags enables external templates,\n looking the &quot;template_path&quot; from the options if set, or the\n <code>init.templatedir</code> global config if not, or falling back on\n &quot;/usr/share/git-core/templates&quot; if it exists.</li>\n</ul>\n",["GIT_REPOSITORY_INIT_BARE","GIT_REPOSITORY_INIT_NO_REINIT","GIT_REPOSITORY_INIT_NO_DOTGIT_DIR","GIT_REPOSITORY_INIT_MKDIR","GIT_REPOSITORY_INIT_MKPATH","GIT_REPOSITORY_INIT_EXTERNAL_TEMPLATE"]]],"decl":["GIT_REPOSITORY_INIT_BARE","GIT_REPOSITORY_INIT_NO_REINIT","GIT_REPOSITORY_INIT_NO_DOTGIT_DIR","GIT_REPOSITORY_INIT_MKDIR","GIT_REPOSITORY_INIT_MKPATH","GIT_REPOSITORY_INIT_EXTERNAL_TEMPLATE"],"type":"enum","file":"repository.h","line":185,"lineto":192,"block":"GIT_REPOSITORY_INIT_BARE\nGIT_REPOSITORY_INIT_NO_REINIT\nGIT_REPOSITORY_INIT_NO_DOTGIT_DIR\nGIT_REPOSITORY_INIT_MKDIR\nGIT_REPOSITORY_INIT_MKPATH\nGIT_REPOSITORY_INIT_EXTERNAL_TEMPLATE","tdef":"typedef","comments":"<p>Option flags for <code>git_repository_init_ext</code>.</p>\n\n<p>These flags configure extra behaviors to <code>git_repository_init_ext</code>.\nIn every case, the default behavior is the zero value (i.e. flag is\nnot set). Just OR the flag values together for the <code>flags</code> parameter\nwhen initializing a new repo. Details of individual values are:</p>\n\n<ul>\n<li>BARE - Create a bare repository with no working directory.</li>\n<li>NO_REINIT - Return an EEXISTS error if the repo_path appears to\n already be an git repository.</li>\n<li>NO_DOTGIT_DIR - Normally a &quot;/.git/&quot; will be appended to the repo\n path for non-bare repos (if it is not already there), but\n passing this flag prevents that behavior.</li>\n<li>MKDIR - Make the repo_path (and workdir_path) as needed. Init is\n always willing to create the &quot;.git&quot; directory even without this\n flag. This flag tells init to create the trailing component of\n the repo and workdir paths as needed.</li>\n<li>MKPATH - Recursively make all components of the repo and workdir\n paths as necessary.</li>\n<li>EXTERNAL_TEMPLATE - libgit2 normally uses internal templates to\n initialize a new repo. This flags enables external templates,\n looking the &quot;template_path&quot; from the options if set, or the\n <code>init.templatedir</code> global config if not, or falling back on\n &quot;/usr/share/git-core/templates&quot; if it exists.</li>\n</ul>\n","used":{"returns":[],"needs":[]}}],["git_repository_init_mode_t",{"sections":[["<p>Mode options for <code>git_repository_init_ext</code>.</p>\n\n<p>Set the mode field of the <code>git_repository_init_options</code> structure\neither to the custom mode that you would like, or to one of the\nfollowing modes:</p>\n\n<ul>\n<li>SHARED_UMASK - Use permissions configured by umask - the default.</li>\n<li>SHARED_GROUP - Use &quot;--shared=group&quot; behavior, chmod&#39;ing the new repo\n to be group writable and &quot;g+sx&quot; for sticky group assignment.</li>\n<li>SHARED_ALL - Use &quot;--shared=all&quot; behavior, adding world readability.</li>\n<li>Anything else - Set to custom value.</li>\n</ul>\n",["GIT_REPOSITORY_INIT_SHARED_UMASK","GIT_REPOSITORY_INIT_SHARED_GROUP","GIT_REPOSITORY_INIT_SHARED_ALL"]]],"decl":["GIT_REPOSITORY_INIT_SHARED_UMASK","GIT_REPOSITORY_INIT_SHARED_GROUP","GIT_REPOSITORY_INIT_SHARED_ALL"],"type":"enum","file":"repository.h","line":207,"lineto":211,"block":"GIT_REPOSITORY_INIT_SHARED_UMASK\nGIT_REPOSITORY_INIT_SHARED_GROUP\nGIT_REPOSITORY_INIT_SHARED_ALL","tdef":"typedef","comments":"<p>Mode options for <code>git_repository_init_ext</code>.</p>\n\n<p>Set the mode field of the <code>git_repository_init_options</code> structure\neither to the custom mode that you would like, or to one of the\nfollowing modes:</p>\n\n<ul>\n<li>SHARED_UMASK - Use permissions configured by umask - the default.</li>\n<li>SHARED_GROUP - Use &quot;--shared=group&quot; behavior, chmod&#39;ing the new repo\n to be group writable and &quot;g+sx&quot; for sticky group assignment.</li>\n<li>SHARED_ALL - Use &quot;--shared=all&quot; behavior, adding world readability.</li>\n<li>Anything else - Set to custom value.</li>\n</ul>\n","used":{"returns":[],"needs":[]}}],["git_repository_init_options",{"decl":["unsigned int version","uint32_t flags","uint32_t mode","const char *workdir_path","const char *description","const char *template_path","const char *initial_head","const char *origin_url"],"type":"struct","value":"git_repository_init_options","file":"repository.h","line":241,"lineto":253,"block":"unsigned int version\nuint32_t flags\nuint32_t mode\nconst char *workdir_path\nconst char *description\nconst char *template_path\nconst char *initial_head\nconst char *origin_url","tdef":"typedef","comments":"<p>Extended options structure for <code>git_repository_init_ext</code>.</p>\n\n<p>This contains extra options for <code>git_repository_init_ext</code> that enable\nadditional initialization features. The fields are:</p>\n\n<ul>\n<li>flags - Combination of GIT_REPOSITORY_INIT flags above.</li>\n<li>mode - Set to one of the standard GIT_REPOSITORY_INIT_SHARED_...\n constants above, or to a custom value that you would like.</li>\n<li>workdir_path - The path to the working dir or NULL for default (i.e.\n repo_path parent on non-bare repos). IF THIS IS RELATIVE PATH,\n IT WILL BE EVALUATED RELATIVE TO THE REPO_PATH. If this is not\n the &quot;natural&quot; working directory, a .git gitlink file will be\n created here linking to the repo_path.</li>\n<li>description - If set, this will be used to initialize the &quot;description&quot;\n file in the repository, instead of using the template content.</li>\n<li>template_path - When GIT_REPOSITORY_INIT_EXTERNAL_TEMPLATE is set,\n this contains the path to use for the template directory. If\n this is NULL, the config or default directory options will be\n used instead.</li>\n<li>initial_head - The name of the head to point HEAD at. If NULL, then\n this will be treated as &quot;master&quot; and the HEAD ref will be set\n to &quot;refs/heads/master&quot;. If this begins with &quot;refs/&quot; it will be\n used verbatim; otherwise &quot;refs/heads/&quot; will be prefixed.</li>\n<li>origin_url - If this is non-NULL, then after the rest of the\n repository initialization is completed, an &quot;origin&quot; remote\n will be added pointing to this URL.</li>\n</ul>\n","used":{"returns":[],"needs":["git_repository_init_ext"]}}],["git_repository_open_flag_t",{"sections":[["<p>Option flags for <code>git_repository_open_ext</code>.</p>\n\n<ul>\n<li>GIT_REPOSITORY_OPEN_NO_SEARCH - Only open the repository if it can be\nimmediately found in the start_path. Do not walk up from the\nstart_path looking at parent directories.</li>\n<li>GIT_REPOSITORY_OPEN_CROSS_FS - Unless this flag is set, open will not\ncontinue searching across filesystem boundaries (i.e. when <code>st_dev</code>\nchanges from the <code>stat</code> system call). (E.g. Searching in a user&#39;s home\ndirectory &quot;/home/user/source/&quot; will not return &quot;/.git/&quot; as the found\nrepo if &quot;/&quot; is a different filesystem than &quot;/home&quot;.)</li>\n</ul>\n",["GIT_REPOSITORY_OPEN_NO_SEARCH","GIT_REPOSITORY_OPEN_CROSS_FS"]]],"decl":["GIT_REPOSITORY_OPEN_NO_SEARCH","GIT_REPOSITORY_OPEN_CROSS_FS"],"type":"enum","file":"repository.h","line":98,"lineto":101,"block":"GIT_REPOSITORY_OPEN_NO_SEARCH\nGIT_REPOSITORY_OPEN_CROSS_FS","tdef":"typedef","comments":"<p>Option flags for <code>git_repository_open_ext</code>.</p>\n\n<ul>\n<li>GIT_REPOSITORY_OPEN_NO_SEARCH - Only open the repository if it can be\nimmediately found in the start_path. Do not walk up from the\nstart_path looking at parent directories.</li>\n<li>GIT_REPOSITORY_OPEN_CROSS_FS - Unless this flag is set, open will not\ncontinue searching across filesystem boundaries (i.e. when <code>st_dev</code>\nchanges from the <code>stat</code> system call). (E.g. Searching in a user&#39;s home\ndirectory &quot;/home/user/source/&quot; will not return &quot;/.git/&quot; as the found\nrepo if &quot;/&quot; is a different filesystem than &quot;/home&quot;.)</li>\n</ul>\n","used":{"returns":[],"needs":[]}}],["git_reset_t",{"sections":[["<p>Kinds of reset operation</p>\n",["GIT_RESET_SOFT","GIT_RESET_MIXED","GIT_RESET_HARD"]]],"decl":["GIT_RESET_SOFT","GIT_RESET_MIXED","GIT_RESET_HARD"],"type":"enum","file":"reset.h","line":21,"lineto":25,"block":"GIT_RESET_SOFT\nGIT_RESET_MIXED\nGIT_RESET_HARD","tdef":"typedef","comments":"<p>Kinds of reset operation</p>\n","used":{"returns":[],"needs":["git_reset"]}}],["git_revspec",{"decl":["git_object *from","git_object *to","unsigned int flags"],"type":"struct","value":"git_revspec","file":"revparse.h","line":52,"lineto":59,"block":"git_object *from\ngit_object *to\nunsigned int flags","tdef":"typedef","comments":"<p>Git Revision Spec: output of a <code>git_revparse</code> operation</p>\n","used":{"returns":[],"needs":["git_revparse"]}}],["git_revwalk",{"decl":"","type":"struct","value":"git_revwalk","file":"types.h","line":111,"lineto":111,"block":"","tdef":"typedef","comments":"<p>Representation of an in-progress walk through the commits in a repo</p>\n","used":{"returns":[],"needs":["git_revwalk_free","git_revwalk_hide","git_revwalk_hide_glob","git_revwalk_hide_head","git_revwalk_hide_ref","git_revwalk_new","git_revwalk_next","git_revwalk_push","git_revwalk_push_glob","git_revwalk_push_head","git_revwalk_push_range","git_revwalk_push_ref","git_revwalk_repository","git_revwalk_reset","git_revwalk_sorting"]}}],["git_signature",{"decl":["char *name","char *email","git_time when"],"type":"struct","value":"git_signature","file":"types.h","line":159,"lineto":163,"block":"char *name\nchar *email\ngit_time when","tdef":"typedef","comments":"<p>An action signature (e.g. for committers, taggers, etc)</p>\n","used":{"returns":["git_commit_author","git_commit_committer","git_reflog_entry_committer","git_signature_dup","git_tag_tagger"],"needs":["git_commit_create","git_commit_create_v","git_note_create","git_note_remove","git_reflog_append","git_signature_dup","git_signature_free","git_signature_new","git_signature_now","git_stash_save","git_tag_create"]}}],["git_stash_cb",{"decl":"int (*git_stash_cb)(\n\tsize_t index,\n\tconst char* message,\n\tconst git_oid *stash_id,\n\tvoid *payload)","type":"function pointer","value":"git_stash_cb","file":"stash.h","line":79,"lineto":83,"comments":"<p>When iterating over all the stashed states, callback that will be\nissued per entry.</p>\n\n<p>@param index The position within the stash list. 0 points to the\nmost recent stashed state.</p>\n\n<p>@param message The stash message.</p>\n\n<p>@param stash_id The commit oid of the stashed state.</p>\n\n<p>@param payload Extra parameter to callback function.</p>\n\n<p>@return 0 on success, GIT_EUSER on non-zero callback, or error code</p>\n","used":{"returns":[],"needs":["git_stash_foreach"]}}],["git_status_cb",{"decl":"int (*git_status_cb)(\n\tconst char *path, unsigned int status_flags, void *payload)","type":"function pointer","value":"git_status_cb","file":"status.h","line":58,"lineto":59,"comments":"<p>Function pointer to receive status on individual files</p>\n\n<p><code>path</code> is the relative path to the file from the root of the repository.</p>\n\n<p><code>status_flags</code> is a combination of <code>git_status_t</code> values that apply.</p>\n\n<p><code>payload</code> is the value you passed to the foreach function as payload.</p>\n","used":{"returns":[],"needs":["git_status_foreach","git_status_foreach_ext"]}}],["git_status_opt_t",{"sections":[["<p>Flags to control status callbacks</p>\n\n<ul>\n<li>GIT_STATUS_OPT_INCLUDE_UNTRACKED says that callbacks should be made\non untracked files. These will only be made if the workdir files are\nincluded in the status &quot;show&quot; option.</li>\n<li>GIT_STATUS_OPT_INCLUDE_IGNORED says that ignored files should get\ncallbacks. Again, these callbacks will only be made if the workdir\nfiles are included in the status &quot;show&quot; option. Right now, there is\nno option to include all files in directories that are ignored\ncompletely.</li>\n<li>GIT_STATUS_OPT_INCLUDE_UNMODIFIED indicates that callback should be\nmade even on unmodified files.</li>\n<li>GIT_STATUS_OPT_EXCLUDE_SUBMODULES indicates that directories which\nappear to be submodules should just be skipped over.</li>\n<li>GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS indicates that the contents of\nuntracked directories should be included in the status. Normally if\nan entire directory is new, then just the top-level directory will be\nincluded (with a trailing slash on the entry name). Given this flag,\nthe directory itself will not be included, but all the files in it\nwill.</li>\n<li>GIT_STATUS_OPT_DISABLE_PATHSPEC_MATCH indicates that the given path\nwill be treated as a literal path, and not as a pathspec.</li>\n<li>GIT_STATUS_OPT_RECURSE_IGNORED_DIRS indicates that the contents of\nignored directories should be included in the status. This is like\ndoing <code>git ls-files -o -i --exclude-standard</code> with core git.</li>\n</ul>\n\n<p>Calling <code>git_status_foreach()</code> is like calling the extended version\nwith: GIT_STATUS_OPT_INCLUDE_IGNORED, GIT_STATUS_OPT_INCLUDE_UNTRACKED,\nand GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS. Those options are bundled\ntogether as <code>GIT_STATUS_OPT_DEFAULTS</code> if you want them as a baseline.</p>\n",["GIT_STATUS_OPT_INCLUDE_UNTRACKED","GIT_STATUS_OPT_INCLUDE_IGNORED","GIT_STATUS_OPT_INCLUDE_UNMODIFIED","GIT_STATUS_OPT_EXCLUDE_SUBMODULES","GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS","GIT_STATUS_OPT_DISABLE_PATHSPEC_MATCH","GIT_STATUS_OPT_RECURSE_IGNORED_DIRS"]]],"decl":["GIT_STATUS_OPT_INCLUDE_UNTRACKED","GIT_STATUS_OPT_INCLUDE_IGNORED","GIT_STATUS_OPT_INCLUDE_UNMODIFIED","GIT_STATUS_OPT_EXCLUDE_SUBMODULES","GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS","GIT_STATUS_OPT_DISABLE_PATHSPEC_MATCH","GIT_STATUS_OPT_RECURSE_IGNORED_DIRS"],"type":"enum","file":"status.h","line":139,"lineto":152,"block":"GIT_STATUS_OPT_INCLUDE_UNTRACKED\nGIT_STATUS_OPT_INCLUDE_IGNORED\nGIT_STATUS_OPT_INCLUDE_UNMODIFIED\nGIT_STATUS_OPT_EXCLUDE_SUBMODULES\nGIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS\nGIT_STATUS_OPT_DISABLE_PATHSPEC_MATCH\nGIT_STATUS_OPT_RECURSE_IGNORED_DIRS","tdef":"typedef","comments":"<p>Flags to control status callbacks</p>\n\n<ul>\n<li>GIT_STATUS_OPT_INCLUDE_UNTRACKED says that callbacks should be made\non untracked files. These will only be made if the workdir files are\nincluded in the status &quot;show&quot; option.</li>\n<li>GIT_STATUS_OPT_INCLUDE_IGNORED says that ignored files should get\ncallbacks. Again, these callbacks will only be made if the workdir\nfiles are included in the status &quot;show&quot; option. Right now, there is\nno option to include all files in directories that are ignored\ncompletely.</li>\n<li>GIT_STATUS_OPT_INCLUDE_UNMODIFIED indicates that callback should be\nmade even on unmodified files.</li>\n<li>GIT_STATUS_OPT_EXCLUDE_SUBMODULES indicates that directories which\nappear to be submodules should just be skipped over.</li>\n<li>GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS indicates that the contents of\nuntracked directories should be included in the status. Normally if\nan entire directory is new, then just the top-level directory will be\nincluded (with a trailing slash on the entry name). Given this flag,\nthe directory itself will not be included, but all the files in it\nwill.</li>\n<li>GIT_STATUS_OPT_DISABLE_PATHSPEC_MATCH indicates that the given path\nwill be treated as a literal path, and not as a pathspec.</li>\n<li>GIT_STATUS_OPT_RECURSE_IGNORED_DIRS indicates that the contents of\nignored directories should be included in the status. This is like\ndoing <code>git ls-files -o -i --exclude-standard</code> with core git.</li>\n</ul>\n\n<p>Calling <code>git_status_foreach()</code> is like calling the extended version\nwith: GIT_STATUS_OPT_INCLUDE_IGNORED, GIT_STATUS_OPT_INCLUDE_UNTRACKED,\nand GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS. Those options are bundled\ntogether as <code>GIT_STATUS_OPT_DEFAULTS</code> if you want them as a baseline.</p>\n","used":{"returns":[],"needs":[]}}],["git_status_options",{"decl":["unsigned int version","git_status_show_t show","unsigned int flags","git_strarray pathspec"],"type":"struct","value":"git_status_options","file":"status.h","line":170,"lineto":178,"block":"unsigned int version\ngit_status_show_t show\nunsigned int flags\ngit_strarray pathspec","tdef":"typedef","comments":"<p>Options to control how <code>git_status_foreach_ext()</code> will issue callbacks.</p>\n\n<p>This structure is set so that zeroing it out will give you relatively\nsane defaults.</p>\n\n<p>The <code>show</code> value is one of the <code>git_status_show_t</code> constants that\ncontrol which files to scan and in what order.</p>\n\n<p>The <code>flags</code> value is an OR&#39;ed combination of the <code>git_status_opt_t</code>\nvalues above.</p>\n\n<p>The <code>pathspec</code> is an array of path patterns to match (using\nfnmatch-style matching), or just an array of paths to match exactly if\n<code>GIT_STATUS_OPT_DISABLE_PATHSPEC_MATCH</code> is specified in the flags.</p>\n","used":{"returns":[],"needs":["git_status_foreach_ext"]}}],["git_status_show_t",{"sections":[["<p>For extended status, select the files on which to report status.</p>\n\n<ul>\n<li>GIT_STATUS_SHOW_INDEX_AND_WORKDIR is the default. This is the\nrough equivalent of <code>git status --porcelain</code> where each file\nwill receive a callback indicating its status in the index and\nin the workdir.</li>\n<li>GIT_STATUS_SHOW_INDEX_ONLY will only make callbacks for index\nside of status. The status of the index contents relative to\nthe HEAD will be given.</li>\n<li>GIT_STATUS_SHOW_WORKDIR_ONLY will only make callbacks for the\nworkdir side of status, reporting the status of workdir content\nrelative to the index.</li>\n<li>GIT_STATUS_SHOW_INDEX_THEN_WORKDIR behaves like index-only\nfollowed by workdir-only, causing two callbacks to be issued\nper file (first index then workdir). This is slightly more\nefficient than making separate calls. This makes it easier to\nemulate the output of a plain <code>git status</code>.</li>\n</ul>\n",["GIT_STATUS_SHOW_INDEX_AND_WORKDIR","GIT_STATUS_SHOW_INDEX_ONLY","GIT_STATUS_SHOW_WORKDIR_ONLY","GIT_STATUS_SHOW_INDEX_THEN_WORKDIR"]]],"decl":["GIT_STATUS_SHOW_INDEX_AND_WORKDIR","GIT_STATUS_SHOW_INDEX_ONLY","GIT_STATUS_SHOW_WORKDIR_ONLY","GIT_STATUS_SHOW_INDEX_THEN_WORKDIR"],"type":"enum","file":"status.h","line":100,"lineto":105,"block":"GIT_STATUS_SHOW_INDEX_AND_WORKDIR\nGIT_STATUS_SHOW_INDEX_ONLY\nGIT_STATUS_SHOW_WORKDIR_ONLY\nGIT_STATUS_SHOW_INDEX_THEN_WORKDIR","tdef":"typedef","comments":"<p>For extended status, select the files on which to report status.</p>\n\n<ul>\n<li>GIT_STATUS_SHOW_INDEX_AND_WORKDIR is the default. This is the\nrough equivalent of <code>git status --porcelain</code> where each file\nwill receive a callback indicating its status in the index and\nin the workdir.</li>\n<li>GIT_STATUS_SHOW_INDEX_ONLY will only make callbacks for index\nside of status. The status of the index contents relative to\nthe HEAD will be given.</li>\n<li>GIT_STATUS_SHOW_WORKDIR_ONLY will only make callbacks for the\nworkdir side of status, reporting the status of workdir content\nrelative to the index.</li>\n<li>GIT_STATUS_SHOW_INDEX_THEN_WORKDIR behaves like index-only\nfollowed by workdir-only, causing two callbacks to be issued\nper file (first index then workdir). This is slightly more\nefficient than making separate calls. This makes it easier to\nemulate the output of a plain <code>git status</code>.</li>\n</ul>\n","used":{"returns":[],"needs":[]}}],["git_status_t",{"sections":[["<p>Status flags for a single file.</p>\n\n<p>A combination of these values will be returned to indicate the status of\na file. Status compares the working directory, the index, and the\ncurrent HEAD of the repository. The <code>GIT_STATUS_INDEX</code> set of flags\nrepresents the status of file in the index relative to the HEAD, and the\n<code>GIT_STATUS_WT</code> set of flags represent the status of the file in the\nworking directory relative to the index.</p>\n",["GIT_STATUS_CURRENT","GIT_STATUS_INDEX_NEW","GIT_STATUS_INDEX_MODIFIED","GIT_STATUS_INDEX_DELETED","GIT_STATUS_INDEX_RENAMED","GIT_STATUS_INDEX_TYPECHANGE","GIT_STATUS_WT_NEW","GIT_STATUS_WT_MODIFIED","GIT_STATUS_WT_DELETED","GIT_STATUS_WT_TYPECHANGE","GIT_STATUS_IGNORED"]]],"decl":["GIT_STATUS_CURRENT","GIT_STATUS_INDEX_NEW","GIT_STATUS_INDEX_MODIFIED","GIT_STATUS_INDEX_DELETED","GIT_STATUS_INDEX_RENAMED","GIT_STATUS_INDEX_TYPECHANGE","GIT_STATUS_WT_NEW","GIT_STATUS_WT_MODIFIED","GIT_STATUS_WT_DELETED","GIT_STATUS_WT_TYPECHANGE","GIT_STATUS_IGNORED"],"type":"enum","file":"status.h","line":32,"lineto":47,"block":"GIT_STATUS_CURRENT\nGIT_STATUS_INDEX_NEW\nGIT_STATUS_INDEX_MODIFIED\nGIT_STATUS_INDEX_DELETED\nGIT_STATUS_INDEX_RENAMED\nGIT_STATUS_INDEX_TYPECHANGE\nGIT_STATUS_WT_NEW\nGIT_STATUS_WT_MODIFIED\nGIT_STATUS_WT_DELETED\nGIT_STATUS_WT_TYPECHANGE\nGIT_STATUS_IGNORED","tdef":"typedef","comments":"<p>Status flags for a single file.</p>\n\n<p>A combination of these values will be returned to indicate the status of\na file. Status compares the working directory, the index, and the\ncurrent HEAD of the repository. The <code>GIT_STATUS_INDEX</code> set of flags\nrepresents the status of file in the index relative to the HEAD, and the\n<code>GIT_STATUS_WT</code> set of flags represent the status of the file in the\nworking directory relative to the index.</p>\n","used":{"returns":[],"needs":[]}}],["git_strarray",{"decl":["char **strings","size_t count"],"type":"struct","value":"git_strarray","file":"strarray.h","line":22,"lineto":25,"block":"char **strings\nsize_t count","tdef":"typedef","comments":"<p>Array of strings</p>\n","used":{"returns":[],"needs":["git_reference_list","git_remote_list","git_reset_default","git_strarray_copy","git_strarray_free","git_tag_list","git_tag_list_match"]}}],["git_submodule",{"decl":"","type":"struct","value":"git_submodule","file":"submodule.h","line":32,"lineto":32,"block":"","tdef":"typedef","comments":"<p>Opaque structure representing a submodule.</p>\n\n<p>Submodule support in libgit2 builds a list of known submodules and keeps\nit in the repository. The list is built from the .gitmodules file, the\n.git/config file, the index, and the HEAD tree. Items in the working\ndirectory that look like submodules (i.e. a git repo) but are not\nmentioned in those places won&#39;t be tracked.</p>\n","used":{"returns":[],"needs":["git_submodule_add_finalize","git_submodule_add_setup","git_submodule_add_to_index","git_submodule_fetch_recurse_submodules","git_submodule_foreach","git_submodule_head_id","git_submodule_ignore","git_submodule_index_id","git_submodule_init","git_submodule_location","git_submodule_lookup","git_submodule_name","git_submodule_open","git_submodule_owner","git_submodule_path","git_submodule_reload","git_submodule_save","git_submodule_set_fetch_recurse_submodules","git_submodule_set_ignore","git_submodule_set_update","git_submodule_set_url","git_submodule_status","git_submodule_sync","git_submodule_update","git_submodule_url","git_submodule_wd_id"]}}],["git_submodule_ignore_t",{"sections":[["<p>Values that could be specified for how closely to examine the\nworking directory when getting submodule status.</p>\n\n<p>Use the DEFUALT value if you have altered the ignore value via\n<code>git_submodule_set_ignore()</code> and wish to reset to the original value.</p>\n",["GIT_SUBMODULE_IGNORE_DEFAULT","GIT_SUBMODULE_IGNORE_NONE","GIT_SUBMODULE_IGNORE_UNTRACKED","GIT_SUBMODULE_IGNORE_DIRTY","GIT_SUBMODULE_IGNORE_ALL"]]],"decl":["GIT_SUBMODULE_IGNORE_DEFAULT","GIT_SUBMODULE_IGNORE_NONE","GIT_SUBMODULE_IGNORE_UNTRACKED","GIT_SUBMODULE_IGNORE_DIRTY","GIT_SUBMODULE_IGNORE_ALL"],"type":"enum","file":"submodule.h","line":55,"lineto":61,"block":"GIT_SUBMODULE_IGNORE_DEFAULT\nGIT_SUBMODULE_IGNORE_NONE\nGIT_SUBMODULE_IGNORE_UNTRACKED\nGIT_SUBMODULE_IGNORE_DIRTY\nGIT_SUBMODULE_IGNORE_ALL","tdef":"typedef","comments":"<p>Values that could be specified for how closely to examine the\nworking directory when getting submodule status.</p>\n\n<p>Use the DEFUALT value if you have altered the ignore value via\n<code>git_submodule_set_ignore()</code> and wish to reset to the original value.</p>\n","used":{"returns":[],"needs":["git_submodule_set_ignore"]}}],["git_submodule_status_t",{"sections":[["<p>Return codes for submodule status.</p>\n\n<p>A combination of these flags will be returned to describe the status of a\nsubmodule. Depending on the &quot;ignore&quot; property of the submodule, some of\nthe flags may never be returned because they indicate changes that are\nsupposed to be ignored.</p>\n\n<p>Submodule info is contained in 4 places: the HEAD tree, the index, config\nfiles (both .git/config and .gitmodules), and the working directory. Any\nor all of those places might be missing information about the submodule\ndepending on what state the repo is in. We consider all four places to\nbuild the combination of status flags.</p>\n\n<p>There are four values that are not really status, but give basic info\nabout what sources of submodule data are available. These will be\nreturned even if ignore is set to &quot;ALL&quot;.</p>\n\n<ul>\n<li>IN_HEAD - superproject head contains submodule</li>\n<li>IN_INDEX - superproject index contains submodule</li>\n<li>IN_CONFIG - superproject gitmodules has submodule</li>\n<li>IN_WD - superproject workdir has submodule</li>\n</ul>\n\n<p>The following values will be returned so long as ignore is not &quot;ALL&quot;.</p>\n\n<ul>\n<li>INDEX_ADDED - in index, not in head</li>\n<li>INDEX_DELETED - in head, not in index</li>\n<li>INDEX_MODIFIED - index and head don&#39;t match</li>\n<li>WD_UNINITIALIZED - workdir contains empty directory</li>\n<li>WD_ADDED - in workdir, not index</li>\n<li>WD_DELETED - in index, not workdir</li>\n<li>WD_MODIFIED - index and workdir head don&#39;t match</li>\n</ul>\n\n<p>The following can only be returned if ignore is &quot;NONE&quot; or &quot;UNTRACKED&quot;.</p>\n\n<ul>\n<li>WD_INDEX_MODIFIED - submodule workdir index is dirty</li>\n<li>WD_WD_MODIFIED - submodule workdir has modified files</li>\n</ul>\n\n<p>Lastly, the following will only be returned for ignore &quot;NONE&quot;.</p>\n\n<ul>\n<li>WD_UNTRACKED - wd contains untracked files</li>\n</ul>\n",["GIT_SUBMODULE_STATUS_IN_HEAD","GIT_SUBMODULE_STATUS_IN_INDEX","GIT_SUBMODULE_STATUS_IN_CONFIG","GIT_SUBMODULE_STATUS_IN_WD","GIT_SUBMODULE_STATUS_INDEX_ADDED","GIT_SUBMODULE_STATUS_INDEX_DELETED","GIT_SUBMODULE_STATUS_INDEX_MODIFIED","GIT_SUBMODULE_STATUS_WD_UNINITIALIZED","GIT_SUBMODULE_STATUS_WD_ADDED","GIT_SUBMODULE_STATUS_WD_DELETED","GIT_SUBMODULE_STATUS_WD_MODIFIED","GIT_SUBMODULE_STATUS_WD_INDEX_MODIFIED","GIT_SUBMODULE_STATUS_WD_WD_MODIFIED","GIT_SUBMODULE_STATUS_WD_UNTRACKED"]]],"decl":["GIT_SUBMODULE_STATUS_IN_HEAD","GIT_SUBMODULE_STATUS_IN_INDEX","GIT_SUBMODULE_STATUS_IN_CONFIG","GIT_SUBMODULE_STATUS_IN_WD","GIT_SUBMODULE_STATUS_INDEX_ADDED","GIT_SUBMODULE_STATUS_INDEX_DELETED","GIT_SUBMODULE_STATUS_INDEX_MODIFIED","GIT_SUBMODULE_STATUS_WD_UNINITIALIZED","GIT_SUBMODULE_STATUS_WD_ADDED","GIT_SUBMODULE_STATUS_WD_DELETED","GIT_SUBMODULE_STATUS_WD_MODIFIED","GIT_SUBMODULE_STATUS_WD_INDEX_MODIFIED","GIT_SUBMODULE_STATUS_WD_WD_MODIFIED","GIT_SUBMODULE_STATUS_WD_UNTRACKED"],"type":"enum","file":"submodule.h","line":105,"lineto":148,"block":"GIT_SUBMODULE_STATUS_IN_HEAD\nGIT_SUBMODULE_STATUS_IN_INDEX\nGIT_SUBMODULE_STATUS_IN_CONFIG\nGIT_SUBMODULE_STATUS_IN_WD\nGIT_SUBMODULE_STATUS_INDEX_ADDED\nGIT_SUBMODULE_STATUS_INDEX_DELETED\nGIT_SUBMODULE_STATUS_INDEX_MODIFIED\nGIT_SUBMODULE_STATUS_WD_UNINITIALIZED\nGIT_SUBMODULE_STATUS_WD_ADDED\nGIT_SUBMODULE_STATUS_WD_DELETED\nGIT_SUBMODULE_STATUS_WD_MODIFIED\nGIT_SUBMODULE_STATUS_WD_INDEX_MODIFIED\nGIT_SUBMODULE_STATUS_WD_WD_MODIFIED\nGIT_SUBMODULE_STATUS_WD_UNTRACKED","tdef":"typedef","comments":"<p>Return codes for submodule status.</p>\n\n<p>A combination of these flags will be returned to describe the status of a\nsubmodule. Depending on the &quot;ignore&quot; property of the submodule, some of\nthe flags may never be returned because they indicate changes that are\nsupposed to be ignored.</p>\n\n<p>Submodule info is contained in 4 places: the HEAD tree, the index, config\nfiles (both .git/config and .gitmodules), and the working directory. Any\nor all of those places might be missing information about the submodule\ndepending on what state the repo is in. We consider all four places to\nbuild the combination of status flags.</p>\n\n<p>There are four values that are not really status, but give basic info\nabout what sources of submodule data are available. These will be\nreturned even if ignore is set to &quot;ALL&quot;.</p>\n\n<ul>\n<li>IN_HEAD - superproject head contains submodule</li>\n<li>IN_INDEX - superproject index contains submodule</li>\n<li>IN_CONFIG - superproject gitmodules has submodule</li>\n<li>IN_WD - superproject workdir has submodule</li>\n</ul>\n\n<p>The following values will be returned so long as ignore is not &quot;ALL&quot;.</p>\n\n<ul>\n<li>INDEX_ADDED - in index, not in head</li>\n<li>INDEX_DELETED - in head, not in index</li>\n<li>INDEX_MODIFIED - index and head don&#39;t match</li>\n<li>WD_UNINITIALIZED - workdir contains empty directory</li>\n<li>WD_ADDED - in workdir, not index</li>\n<li>WD_DELETED - in index, not workdir</li>\n<li>WD_MODIFIED - index and workdir head don&#39;t match</li>\n</ul>\n\n<p>The following can only be returned if ignore is &quot;NONE&quot; or &quot;UNTRACKED&quot;.</p>\n\n<ul>\n<li>WD_INDEX_MODIFIED - submodule workdir index is dirty</li>\n<li>WD_WD_MODIFIED - submodule workdir has modified files</li>\n</ul>\n\n<p>Lastly, the following will only be returned for ignore &quot;NONE&quot;.</p>\n\n<ul>\n<li>WD_UNTRACKED - wd contains untracked files</li>\n</ul>\n","used":{"returns":[],"needs":[]}}],["git_submodule_update_t",{"sections":[["<p>Values that could be specified for the update rule of a submodule.</p>\n\n<p>Use the DEFAULT value if you have altered the update value via\n<code>git_submodule_set_update()</code> and wish to reset to the original default.</p>\n",["GIT_SUBMODULE_UPDATE_DEFAULT","GIT_SUBMODULE_UPDATE_CHECKOUT","GIT_SUBMODULE_UPDATE_REBASE","GIT_SUBMODULE_UPDATE_MERGE","GIT_SUBMODULE_UPDATE_NONE"]]],"decl":["GIT_SUBMODULE_UPDATE_DEFAULT","GIT_SUBMODULE_UPDATE_CHECKOUT","GIT_SUBMODULE_UPDATE_REBASE","GIT_SUBMODULE_UPDATE_MERGE","GIT_SUBMODULE_UPDATE_NONE"],"type":"enum","file":"submodule.h","line":40,"lineto":46,"block":"GIT_SUBMODULE_UPDATE_DEFAULT\nGIT_SUBMODULE_UPDATE_CHECKOUT\nGIT_SUBMODULE_UPDATE_REBASE\nGIT_SUBMODULE_UPDATE_MERGE\nGIT_SUBMODULE_UPDATE_NONE","tdef":"typedef","comments":"<p>Values that could be specified for the update rule of a submodule.</p>\n\n<p>Use the DEFAULT value if you have altered the update value via\n<code>git_submodule_set_update()</code> and wish to reset to the original default.</p>\n","used":{"returns":[],"needs":["git_submodule_set_update"]}}],["git_tag",{"decl":"","type":"struct","value":"git_tag","file":"types.h","line":114,"lineto":114,"block":"","tdef":"typedef","comments":"<p>Parsed representation of a tag object.</p>\n","used":{"returns":[],"needs":["git_tag_free","git_tag_id","git_tag_lookup","git_tag_lookup_prefix","git_tag_message","git_tag_name","git_tag_peel","git_tag_tagger","git_tag_target","git_tag_target_id","git_tag_target_type"]}}],["git_time",{"decl":["git_time_t time","int offset"],"type":"struct","value":"git_time","file":"types.h","line":153,"lineto":156,"block":"git_time_t time\nint offset","tdef":"typedef","comments":"<p>Time in a signature</p>\n","used":{"returns":[],"needs":[]}}],["git_trace_callback",{"decl":"void (*git_trace_callback)(git_trace_level_t level, const char *msg)","type":"function pointer","value":"git_trace_callback","file":"trace.h","line":52,"lineto":52,"comments":"<p>An instance for a tracing function</p>\n","used":{"returns":[],"needs":["git_trace_set"]}}],["git_transfer_progress",{"decl":["unsigned int total_objects","unsigned int indexed_objects","unsigned int received_objects","size_t received_bytes"],"type":"struct","value":"git_transfer_progress","file":"indexer.h","line":19,"lineto":24,"block":"unsigned int total_objects\nunsigned int indexed_objects\nunsigned int received_objects\nsize_t received_bytes","tdef":"typedef","comments":"<p>This is passed as the first argument to the callback to allow the\nuser to see the progress.</p>\n","used":{"returns":["git_remote_stats"],"needs":["git_indexer_stream_add","git_indexer_stream_finalize"]}}],["git_transfer_progress_callback",{"decl":"int (*git_transfer_progress_callback)(const git_transfer_progress *stats, void *payload)","type":"function pointer","value":"git_transfer_progress_callback","file":"indexer.h","line":34,"lineto":36,"comments":"<p>Type for progress callbacks during indexing. Return a value less than zero\nto cancel the transfer.</p>\n\n<p>@param stats Structure containing information about the state of the transfer\n@param payload Payload provided by caller</p>\n","used":{"returns":[],"needs":["git_indexer_stream_new","git_odb_write_pack","git_remote_download"]}}],["git_tree",{"decl":"","type":"struct","value":"git_tree","file":"types.h","line":126,"lineto":126,"block":"","tdef":"typedef","comments":"<p>Representation of a tree object.</p>\n","used":{"returns":[],"needs":["git_commit_create","git_commit_create_v","git_commit_tree","git_diff_tree_to_index","git_diff_tree_to_tree","git_diff_tree_to_workdir","git_index_read_tree","git_tree_entry_byindex","git_tree_entry_byname","git_tree_entry_byoid","git_tree_entry_bypath","git_tree_entrycount","git_tree_free","git_tree_id","git_tree_lookup","git_tree_lookup_prefix","git_tree_owner","git_tree_walk","git_treebuilder_create"]}}],["git_tree_entry",{"decl":"","type":"struct","value":"git_tree_entry","file":"types.h","line":123,"lineto":123,"block":"","tdef":"typedef","comments":"<p>Representation of each one of the entries in a tree object.</p>\n","used":{"returns":["git_tree_entry_byindex","git_tree_entry_byname","git_tree_entry_byoid","git_tree_entry_dup","git_treebuilder_get"],"needs":["git_tree_entry_bypath","git_tree_entry_cmp","git_tree_entry_dup","git_tree_entry_filemode","git_tree_entry_free","git_tree_entry_id","git_tree_entry_name","git_tree_entry_to_object","git_tree_entry_type","git_treebuilder_insert"]}}],["git_treebuilder",{"decl":"","type":"struct","value":"git_treebuilder","file":"types.h","line":129,"lineto":129,"block":"","tdef":"typedef","comments":"<p>Constructor for in-memory trees</p>\n","used":{"returns":[],"needs":["git_treebuilder_clear","git_treebuilder_create","git_treebuilder_entrycount","git_treebuilder_filter","git_treebuilder_free","git_treebuilder_get","git_treebuilder_insert","git_treebuilder_remove","git_treebuilder_write"]}}],["git_treewalk_cb",{"decl":"int (*git_treewalk_cb)(\n\tconst char *root, const git_tree_entry *entry, void *payload)","type":"function pointer","value":"git_treewalk_cb","file":"tree.h","line":369,"lineto":370,"comments":"<p>Callback for the tree traversal method</p>\n","used":{"returns":[],"needs":["git_tree_walk"]}}],["git_treewalk_mode",{"sections":[["<p>Tree traversal modes</p>\n",["GIT_TREEWALK_PRE","GIT_TREEWALK_POST"]]],"decl":["GIT_TREEWALK_PRE","GIT_TREEWALK_POST"],"type":"enum","file":"tree.h","line":373,"lineto":376,"block":"GIT_TREEWALK_PRE\nGIT_TREEWALK_POST","tdef":"typedef","comments":"<p>Tree traversal modes</p>\n","used":{"returns":[],"needs":["git_tree_walk"]}}]],"prefix":"include/git2","groups":[["attr",["git_attr_add_macro","git_attr_cache_flush","git_attr_foreach","git_attr_get","git_attr_get_many"]],["blob",["git_blob_create_frombuffer","git_blob_create_fromchunks","git_blob_create_fromdisk","git_blob_create_fromworkdir","git_blob_free","git_blob_id","git_blob_is_binary","git_blob_lookup","git_blob_lookup_prefix","git_blob_rawcontent","git_blob_rawsize"]],["branch",["git_branch_create","git_branch_delete","git_branch_foreach","git_branch_is_head","git_branch_lookup","git_branch_move","git_branch_name","git_branch_remote_name","git_branch_set_upstream","git_branch_upstream","git_branch_upstream_name"]],["checkout",["git_checkout_head","git_checkout_index","git_checkout_tree"]],["clone",["git_clone"]],["commit",["git_commit_author","git_commit_committer","git_commit_create","git_commit_create_v","git_commit_free","git_commit_id","git_commit_lookup","git_commit_lookup_prefix","git_commit_message","git_commit_message_encoding","git_commit_nth_gen_ancestor","git_commit_parent","git_commit_parent_id","git_commit_parentcount","git_commit_time","git_commit_time_offset","git_commit_tree","git_commit_tree_id"]],["config",["git_config_add_backend","git_config_add_file_ondisk","git_config_delete_entry","git_config_find_global","git_config_find_system","git_config_find_xdg","git_config_foreach","git_config_foreach_match","git_config_free","git_config_get_bool","git_config_get_entry","git_config_get_int32","git_config_get_int64","git_config_get_mapped","git_config_get_multivar","git_config_get_string","git_config_lookup_map_value","git_config_new","git_config_open_default","git_config_open_level","git_config_open_ondisk","git_config_parse_bool","git_config_parse_int32","git_config_parse_int64","git_config_refresh","git_config_set_bool","git_config_set_int32","git_config_set_int64","git_config_set_multivar","git_config_set_string"]],["cred",["git_cred_userpass","git_cred_userpass_plaintext_new"]],["diff",["git_diff_blob_to_buffer","git_diff_blobs","git_diff_find_similar","git_diff_foreach","git_diff_get_patch","git_diff_index_to_workdir","git_diff_list_free","git_diff_merge","git_diff_num_deltas","git_diff_num_deltas_of_type","git_diff_patch_delta","git_diff_patch_free","git_diff_patch_get_hunk","git_diff_patch_get_line_in_hunk","git_diff_patch_line_stats","git_diff_patch_num_hunks","git_diff_patch_num_lines_in_hunk","git_diff_patch_print","git_diff_patch_to_str","git_diff_print_compact","git_diff_print_patch","git_diff_status_char","git_diff_tree_to_index","git_diff_tree_to_tree","git_diff_tree_to_workdir"]],["giterr",["giterr_clear","giterr_last","giterr_set_oom","giterr_set_str"]],["graph",["git_graph_ahead_behind"]],["ignore",["git_ignore_add_rule","git_ignore_clear_internal_rules","git_ignore_path_is_ignored"]],["index",["git_index_add","git_index_add_bypath","git_index_caps","git_index_clear","git_index_conflict_add","git_index_conflict_cleanup","git_index_conflict_get","git_index_conflict_remove","git_index_entry_stage","git_index_entrycount","git_index_find","git_index_free","git_index_get_byindex","git_index_get_bypath","git_index_has_conflicts","git_index_new","git_index_open","git_index_owner","git_index_read","git_index_read_tree","git_index_remove","git_index_remove_bypath","git_index_remove_directory","git_index_reuc_add","git_index_reuc_clear","git_index_reuc_entrycount","git_index_reuc_find","git_index_reuc_get_byindex","git_index_reuc_get_bypath","git_index_reuc_remove","git_index_set_caps","git_index_write","git_index_write_tree","git_index_write_tree_to"]],["indexer",["git_indexer_stream_add","git_indexer_stream_finalize","git_indexer_stream_free","git_indexer_stream_hash","git_indexer_stream_new"]],["libgit2",["git_libgit2_capabilities","git_libgit2_opts","git_libgit2_version"]],["merge",["git_merge_base","git_merge_base_many"]],["message",["git_message_prettify"]],["note",["git_note_create","git_note_default_ref","git_note_foreach","git_note_free","git_note_iterator_free","git_note_iterator_new","git_note_message","git_note_next","git_note_oid","git_note_read","git_note_remove"]],["object",["git_object__size","git_object_dup","git_object_free","git_object_id","git_object_lookup","git_object_lookup_prefix","git_object_owner","git_object_peel","git_object_string2type","git_object_type","git_object_type2string","git_object_typeisloose"]],["odb",["git_odb_add_alternate","git_odb_add_backend","git_odb_add_disk_alternate","git_odb_backend_pack","git_odb_exists","git_odb_foreach","git_odb_free","git_odb_hash","git_odb_hashfile","git_odb_new","git_odb_object_data","git_odb_object_free","git_odb_object_id","git_odb_object_size","git_odb_object_type","git_odb_open","git_odb_open_rstream","git_odb_open_wstream","git_odb_read","git_odb_read_header","git_odb_read_prefix","git_odb_refresh","git_odb_write","git_odb_write_pack"]],["oid",["git_oid_allocfmt","git_oid_cmp","git_oid_cpy","git_oid_equal","git_oid_fmt","git_oid_fromraw","git_oid_fromstr","git_oid_fromstrn","git_oid_fromstrp","git_oid_iszero","git_oid_ncmp","git_oid_pathfmt","git_oid_shorten_add","git_oid_shorten_free","git_oid_shorten_new","git_oid_streq","git_oid_tostr"]],["packbuilder",["git_packbuilder_foreach","git_packbuilder_free","git_packbuilder_insert","git_packbuilder_insert_tree","git_packbuilder_new","git_packbuilder_object_count","git_packbuilder_set_threads","git_packbuilder_write","git_packbuilder_written"]],["push",["git_push_add_refspec","git_push_finish","git_push_free","git_push_new","git_push_set_options","git_push_status_foreach","git_push_unpack_ok","git_push_update_tips"]],["refdb",["git_refdb_backend_fs","git_refdb_compress","git_refdb_free","git_refdb_new","git_refdb_open","git_refdb_set_backend"]],["reference",["git_reference__alloc","git_reference_cmp","git_reference_create","git_reference_delete","git_reference_foreach","git_reference_foreach_glob","git_reference_free","git_reference_has_log","git_reference_is_branch","git_reference_is_remote","git_reference_is_valid_name","git_reference_list","git_reference_lookup","git_reference_name","git_reference_name_to_id","git_reference_normalize_name","git_reference_owner","git_reference_peel","git_reference_rename","git_reference_resolve","git_reference_set_target","git_reference_symbolic_create","git_reference_symbolic_set_target","git_reference_symbolic_target","git_reference_target","git_reference_type"]],["reflog",["git_reflog_append","git_reflog_delete","git_reflog_drop","git_reflog_entry_byindex","git_reflog_entry_committer","git_reflog_entry_id_new","git_reflog_entry_id_old","git_reflog_entry_message","git_reflog_entrycount","git_reflog_free","git_reflog_read","git_reflog_rename","git_reflog_write"]],["refspec",["git_refspec_dst","git_refspec_dst_matches","git_refspec_force","git_refspec_rtransform","git_refspec_src","git_refspec_src_matches","git_refspec_transform"]],["remote",["git_remote_autotag","git_remote_check_cert","git_remote_connect","git_remote_connected","git_remote_create","git_remote_create_inmemory","git_remote_disconnect","git_remote_download","git_remote_fetchspec","git_remote_free","git_remote_is_valid_name","git_remote_list","git_remote_load","git_remote_ls","git_remote_name","git_remote_pushspec","git_remote_pushurl","git_remote_rename","git_remote_save","git_remote_set_autotag","git_remote_set_callbacks","git_remote_set_cred_acquire_cb","git_remote_set_fetchspec","git_remote_set_pushspec","git_remote_set_pushurl","git_remote_set_transport","git_remote_set_update_fetchhead","git_remote_set_url","git_remote_stats","git_remote_stop","git_remote_supported_url","git_remote_update_fetchhead","git_remote_update_tips","git_remote_url","git_remote_valid_url"]],["repository",["git_repository_config","git_repository_detach_head","git_repository_discover","git_repository_fetchhead_foreach","git_repository_free","git_repository_hashfile","git_repository_head","git_repository_head_detached","git_repository_head_orphan","git_repository_index","git_repository_init","git_repository_init_ext","git_repository_is_bare","git_repository_is_empty","git_repository_merge_cleanup","git_repository_mergehead_foreach","git_repository_message","git_repository_message_remove","git_repository_odb","git_repository_open","git_repository_open_ext","git_repository_path","git_repository_refdb","git_repository_set_config","git_repository_set_head","git_repository_set_head_detached","git_repository_set_index","git_repository_set_odb","git_repository_set_refdb","git_repository_set_workdir","git_repository_state","git_repository_workdir","git_repository_wrap_odb"]],["reset",["git_reset","git_reset_default"]],["revparse",["git_revparse","git_revparse_single"]],["revwalk",["git_revwalk_free","git_revwalk_hide","git_revwalk_hide_glob","git_revwalk_hide_head","git_revwalk_hide_ref","git_revwalk_new","git_revwalk_next","git_revwalk_push","git_revwalk_push_glob","git_revwalk_push_head","git_revwalk_push_range","git_revwalk_push_ref","git_revwalk_repository","git_revwalk_reset","git_revwalk_sorting"]],["signature",["git_signature_dup","git_signature_free","git_signature_new","git_signature_now"]],["smart",["git_smart_subtransport_git","git_smart_subtransport_http"]],["stash",["git_stash_drop","git_stash_foreach","git_stash_save"]],["status",["git_status_file","git_status_foreach","git_status_foreach_ext","git_status_should_ignore"]],["strarray",["git_strarray_copy","git_strarray_free"]],["submodule",["git_submodule_add_finalize","git_submodule_add_setup","git_submodule_add_to_index","git_submodule_fetch_recurse_submodules","git_submodule_foreach","git_submodule_head_id","git_submodule_ignore","git_submodule_index_id","git_submodule_init","git_submodule_location","git_submodule_lookup","git_submodule_name","git_submodule_open","git_submodule_owner","git_submodule_path","git_submodule_reload","git_submodule_reload_all","git_submodule_save","git_submodule_set_fetch_recurse_submodules","git_submodule_set_ignore","git_submodule_set_update","git_submodule_set_url","git_submodule_status","git_submodule_sync","git_submodule_update","git_submodule_url","git_submodule_wd_id"]],["tag",["git_tag_create","git_tag_create_frombuffer","git_tag_create_lightweight","git_tag_delete","git_tag_foreach","git_tag_free","git_tag_id","git_tag_list","git_tag_list_match","git_tag_lookup","git_tag_lookup_prefix","git_tag_message","git_tag_name","git_tag_peel","git_tag_tagger","git_tag_target","git_tag_target_id","git_tag_target_type"]],["threads",["git_threads_init","git_threads_shutdown"]],["trace",["git_trace_set"]],["transport",["git_transport_dummy","git_transport_local","git_transport_new","git_transport_smart"]],["tree",["git_tree_entry_byindex","git_tree_entry_byname","git_tree_entry_byoid","git_tree_entry_bypath","git_tree_entry_cmp","git_tree_entry_dup","git_tree_entry_filemode","git_tree_entry_free","git_tree_entry_id","git_tree_entry_name","git_tree_entry_to_object","git_tree_entry_type","git_tree_entrycount","git_tree_free","git_tree_id","git_tree_lookup","git_tree_lookup_prefix","git_tree_owner","git_tree_walk"]],["treebuilder",["git_treebuilder_clear","git_treebuilder_create","git_treebuilder_entrycount","git_treebuilder_filter","git_treebuilder_free","git_treebuilder_get","git_treebuilder_insert","git_treebuilder_remove","git_treebuilder_write"]]],"examples":[["diff.c","ex/v0.18.0/diff.html"],["general.c","ex/v0.18.0/general.html"],["network/clone.c","ex/v0.18.0/network/clone.html"],["network/fetch.c","ex/v0.18.0/network/fetch.html"],["network/git2.c","ex/v0.18.0/network/git2.html"],["network/index-pack.c","ex/v0.18.0/network/index-pack.html"],["network/ls-remote.c","ex/v0.18.0/network/ls-remote.html"],["rev-list.c","ex/v0.18.0/rev-list.html"],["showindex.c","ex/v0.18.0/showindex.html"]]}