1
|
{"files":[{"file":"git2/annotated_commit.h","functions":["git_annotated_commit_from_ref","git_annotated_commit_from_fetchhead","git_annotated_commit_lookup","git_annotated_commit_from_revspec","git_annotated_commit_id","git_annotated_commit_free"],"meta":{},"lines":112},{"file":"git2/attr.h","functions":["git_attr_value","git_attr_get","git_attr_get_many","git_attr_foreach","git_attr_cache_flush","git_attr_add_macro"],"meta":{},"lines":240},{"file":"git2/blame.h","functions":["git_blame_init_options","git_blame_get_hunk_count","git_blame_get_hunk_byindex","git_blame_get_hunk_byline","git_blame_file","git_blame_buffer","git_blame_free"],"meta":{},"lines":207},{"file":"git2/blob.h","functions":["git_blob_lookup","git_blob_lookup_prefix","git_blob_free","git_blob_id","git_blob_owner","git_blob_rawcontent","git_blob_rawsize","git_blob_filtered_content","git_blob_create_fromworkdir","git_blob_create_fromdisk","git_blob_create_fromstream","git_blob_create_fromstream_commit","git_blob_create_frombuffer","git_blob_is_binary","git_blob_dup"],"meta":{},"lines":228},{"file":"git2/branch.h","functions":["git_branch_create","git_branch_create_from_annotated","git_branch_delete","git_branch_iterator_new","git_branch_next","git_branch_iterator_free","git_branch_move","git_branch_lookup","git_branch_name","git_branch_upstream","git_branch_set_upstream","git_branch_is_head","git_branch_is_checked_out"],"meta":{},"lines":258},{"file":"git2/buffer.h","functions":["git_buf_free","git_buf_grow","git_buf_set","git_buf_is_binary","git_buf_contains_nul"],"meta":{},"lines":122},{"file":"git2/checkout.h","functions":["git_checkout_notify_cb","git_checkout_progress_cb","git_checkout_perfdata_cb","git_checkout_init_options","git_checkout_head","git_checkout_index","git_checkout_tree"],"meta":{},"lines":361},{"file":"git2/cherrypick.h","functions":["git_cherrypick_init_options","git_cherrypick_commit","git_cherrypick"],"meta":{},"lines":84},{"file":"git2/clone.h","functions":["git_remote_create_cb","git_repository_create_cb","git_clone_init_options","git_clone"],"meta":{},"lines":203},{"file":"git2/commit.h","functions":["git_commit_lookup","git_commit_lookup_prefix","git_commit_free","git_commit_id","git_commit_owner","git_commit_message_encoding","git_commit_message","git_commit_message_raw","git_commit_summary","git_commit_body","git_commit_time","git_commit_time_offset","git_commit_committer","git_commit_author","git_commit_raw_header","git_commit_tree","git_commit_tree_id","git_commit_parentcount","git_commit_parent","git_commit_parent_id","git_commit_nth_gen_ancestor","git_commit_header_field","git_commit_extract_signature","git_commit_create","git_commit_create_v","git_commit_amend","git_commit_create_buffer","git_commit_create_with_signature","git_commit_dup"],"meta":{},"lines":474},{"file":"git2/common.h","functions":["git_libgit2_version","git_libgit2_features","git_libgit2_opts"],"meta":{},"lines":352},{"file":"git2/config.h","functions":["git_config_entry_free","git_config_find_global","git_config_find_xdg","git_config_find_system","git_config_find_programdata","git_config_open_default","git_config_new","git_config_add_file_ondisk","git_config_open_ondisk","git_config_open_level","git_config_open_global","git_config_snapshot","git_config_free","git_config_get_entry","git_config_get_int32","git_config_get_int64","git_config_get_bool","git_config_get_path","git_config_get_string","git_config_get_string_buf","git_config_get_multivar_foreach","git_config_multivar_iterator_new","git_config_next","git_config_iterator_free","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_delete_multivar","git_config_foreach","git_config_iterator_new","git_config_iterator_glob_new","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","git_config_parse_path","git_config_backend_foreach_match","git_config_lock"],"meta":{},"lines":751},{"file":"git2/cred_helpers.h","functions":["git_cred_userpass"],"meta":{},"lines":48},{"file":"git2/describe.h","functions":["git_describe_commit","git_describe_workdir","git_describe_format","git_describe_result_free"],"meta":{},"lines":161},{"file":"git2/diff.h","functions":["git_diff_notify_cb","git_diff_progress_cb","git_diff_init_options","git_diff_file_cb","git_diff_binary_cb","git_diff_hunk_cb","git_diff_line_cb","git_diff_find_init_options","git_diff_free","git_diff_tree_to_tree","git_diff_tree_to_index","git_diff_index_to_workdir","git_diff_tree_to_workdir","git_diff_tree_to_workdir_with_index","git_diff_index_to_index","git_diff_merge","git_diff_find_similar","git_diff_num_deltas","git_diff_num_deltas_of_type","git_diff_get_delta","git_diff_is_sorted_icase","git_diff_foreach","git_diff_status_char","git_diff_print","git_diff_to_buf","git_diff_blobs","git_diff_blob_to_buffer","git_diff_buffers","git_diff_from_buffer","git_diff_get_stats","git_diff_stats_files_changed","git_diff_stats_insertions","git_diff_stats_deletions","git_diff_stats_to_buf","git_diff_stats_free","git_diff_format_email","git_diff_commit_as_email","git_diff_format_email_init_options","git_diff_patchid_init_options","git_diff_patchid"],"meta":{},"lines":1452},{"file":"git2/errors.h","functions":["giterr_last","giterr_clear","giterr_set_str","giterr_set_oom"],"meta":{},"lines":149},{"file":"git2/filter.h","functions":["git_filter_list_load","git_filter_list_contains","git_filter_list_apply_to_data","git_filter_list_apply_to_file","git_filter_list_apply_to_blob","git_filter_list_stream_data","git_filter_list_stream_file","git_filter_list_stream_blob","git_filter_list_free"],"meta":{},"lines":210},{"file":"git2/global.h","functions":["git_libgit2_init","git_libgit2_shutdown"],"meta":{},"lines":39},{"file":"git2/graph.h","functions":["git_graph_ahead_behind","git_graph_descendant_of"],"meta":{},"lines":54},{"file":"git2/ignore.h","functions":["git_ignore_add_rule","git_ignore_clear_internal_rules","git_ignore_path_is_ignored"],"meta":{},"lines":74},{"file":"git2/index.h","functions":["git_index_matched_path_cb","git_index_open","git_index_new","git_index_free","git_index_owner","git_index_caps","git_index_set_caps","git_index_version","git_index_set_version","git_index_read","git_index_write","git_index_path","git_index_checksum","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_entry_is_conflict","git_index_add_bypath","git_index_add_frombuffer","git_index_remove_bypath","git_index_add_all","git_index_remove_all","git_index_update_all","git_index_find","git_index_find_prefix","git_index_conflict_add","git_index_conflict_get","git_index_conflict_remove","git_index_conflict_cleanup","git_index_has_conflicts","git_index_conflict_iterator_new","git_index_conflict_next","git_index_conflict_iterator_free"],"meta":{},"lines":806},{"file":"git2/indexer.h","functions":["git_indexer_new","git_indexer_append","git_indexer_commit","git_indexer_hash","git_indexer_free"],"meta":{},"lines":72},{"file":"git2/merge.h","functions":["git_merge_file_init_input","git_merge_file_init_options","git_merge_init_options","git_merge_analysis","git_merge_base","git_merge_bases","git_merge_base_many","git_merge_bases_many","git_merge_base_octopus","git_merge_file","git_merge_file_from_index","git_merge_file_result_free","git_merge_trees","git_merge_commits","git_merge"],"meta":{},"lines":585},{"file":"git2/message.h","functions":["git_message_prettify","git_message_trailers","git_message_trailer_array_free"],"meta":{},"lines":79},{"file":"git2/net.h","functions":["git_headlist_cb"],"meta":{},"lines":55},{"file":"git2/notes.h","functions":["git_note_foreach_cb","git_note_iterator_new","git_note_commit_iterator_new","git_note_iterator_free","git_note_next","git_note_read","git_note_commit_read","git_note_author","git_note_committer","git_note_message","git_note_id","git_note_create","git_note_commit_create","git_note_remove","git_note_commit_remove","git_note_free","git_note_foreach"],"meta":{},"lines":302},{"file":"git2/object.h","functions":["git_object_lookup","git_object_lookup_prefix","git_object_lookup_bypath","git_object_id","git_object_short_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":{},"lines":237},{"file":"git2/odb.h","functions":["git_odb_foreach_cb","git_odb_new","git_odb_open","git_odb_add_disk_alternate","git_odb_free","git_odb_read","git_odb_read_prefix","git_odb_read_header","git_odb_exists","git_odb_exists_prefix","git_odb_expand_ids","git_odb_refresh","git_odb_foreach","git_odb_write","git_odb_open_wstream","git_odb_stream_write","git_odb_stream_finalize_write","git_odb_stream_read","git_odb_stream_free","git_odb_open_rstream","git_odb_write_pack","git_odb_hash","git_odb_hashfile","git_odb_object_dup","git_odb_object_free","git_odb_object_id","git_odb_object_data","git_odb_object_size","git_odb_object_type","git_odb_add_backend","git_odb_add_alternate","git_odb_num_backends","git_odb_get_backend"],"meta":{},"lines":544},{"file":"git2/odb_backend.h","functions":["git_odb_backend_pack","git_odb_backend_loose","git_odb_backend_one_pack"],"meta":{},"lines":130},{"file":"git2/oid.h","functions":["git_oid_fromstr","git_oid_fromstrp","git_oid_fromstrn","git_oid_fromraw","git_oid_fmt","git_oid_nfmt","git_oid_pathfmt","git_oid_tostr_s","git_oid_tostr","git_oid_cpy","git_oid_cmp","git_oid_equal","git_oid_ncmp","git_oid_streq","git_oid_strcmp","git_oid_iszero","git_oid_shorten_new","git_oid_shorten_add","git_oid_shorten_free"],"meta":{},"lines":264},{"file":"git2/oidarray.h","functions":["git_oidarray_free"],"meta":{},"lines":34},{"file":"git2/pack.h","functions":["git_packbuilder_new","git_packbuilder_set_threads","git_packbuilder_insert","git_packbuilder_insert_tree","git_packbuilder_insert_commit","git_packbuilder_insert_walk","git_packbuilder_insert_recur","git_packbuilder_write","git_packbuilder_hash","git_packbuilder_foreach","git_packbuilder_object_count","git_packbuilder_written","git_packbuilder_progress","git_packbuilder_set_callbacks","git_packbuilder_free"],"meta":{},"lines":236},{"file":"git2/patch.h","functions":["git_patch_from_diff","git_patch_from_blobs","git_patch_from_blob_and_buffer","git_patch_from_buffers","git_patch_free","git_patch_get_delta","git_patch_num_hunks","git_patch_line_stats","git_patch_get_hunk","git_patch_num_lines_in_hunk","git_patch_get_line_in_hunk","git_patch_size","git_patch_print","git_patch_to_buf"],"meta":{},"lines":268},{"file":"git2/proxy.h","functions":["git_proxy_init_options"],"meta":{},"lines":88},{"file":"git2/rebase.h","functions":["git_rebase_init_options","git_rebase_init","git_rebase_open","git_rebase_operation_entrycount","git_rebase_operation_current","git_rebase_operation_byindex","git_rebase_next","git_rebase_inmemory_index","git_rebase_commit","git_rebase_abort","git_rebase_finish","git_rebase_free"],"meta":{},"lines":316},{"file":"git2/refdb.h","functions":["git_refdb_new","git_refdb_open","git_refdb_compress","git_refdb_free"],"meta":{},"lines":63},{"file":"git2/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":{},"lines":166},{"file":"git2/refs.h","functions":["git_reference_lookup","git_reference_name_to_id","git_reference_dwim","git_reference_symbolic_create_matching","git_reference_symbolic_create","git_reference_create","git_reference_create_matching","git_reference_target","git_reference_target_peel","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_remove","git_reference_list","git_reference_foreach","git_reference_foreach_name","git_reference_dup","git_reference_free","git_reference_cmp","git_reference_iterator_new","git_reference_iterator_glob_new","git_reference_next","git_reference_next_name","git_reference_iterator_free","git_reference_foreach_glob","git_reference_has_log","git_reference_ensure_log","git_reference_is_branch","git_reference_is_remote","git_reference_is_tag","git_reference_is_note","git_reference_normalize_name","git_reference_peel","git_reference_is_valid_name","git_reference_shorthand"],"meta":{},"lines":744},{"file":"git2/refspec.h","functions":["git_refspec_src","git_refspec_dst","git_refspec_string","git_refspec_force","git_refspec_direction","git_refspec_src_matches","git_refspec_dst_matches","git_refspec_transform","git_refspec_rtransform"],"meta":{},"lines":100},{"file":"git2/remote.h","functions":["git_remote_create","git_remote_create_with_fetchspec","git_remote_create_anonymous","git_remote_create_detached","git_remote_lookup","git_remote_dup","git_remote_owner","git_remote_name","git_remote_url","git_remote_pushurl","git_remote_set_url","git_remote_set_pushurl","git_remote_add_fetch","git_remote_get_fetch_refspecs","git_remote_add_push","git_remote_get_push_refspecs","git_remote_refspec_count","git_remote_get_refspec","git_remote_connect","git_remote_ls","git_remote_connected","git_remote_stop","git_remote_disconnect","git_remote_free","git_remote_list","git_push_transfer_progress","git_push_negotiation","git_push_update_reference_cb","git_remote_init_callbacks","git_fetch_init_options","git_push_init_options","git_remote_download","git_remote_upload","git_remote_update_tips","git_remote_fetch","git_remote_prune","git_remote_push","git_remote_stats","git_remote_autotag","git_remote_set_autotag","git_remote_prune_refs","git_remote_rename","git_remote_is_valid_name","git_remote_delete","git_remote_default_branch"],"meta":{},"lines":850},{"file":"git2/repository.h","functions":["git_repository_open","git_repository_open_from_worktree","git_repository_wrap_odb","git_repository_discover","git_repository_open_ext","git_repository_open_bare","git_repository_free","git_repository_init","git_repository_init_init_options","git_repository_init_ext","git_repository_head","git_repository_head_for_worktree","git_repository_head_detached","git_repository_head_unborn","git_repository_is_empty","git_repository_item_path","git_repository_path","git_repository_workdir","git_repository_commondir","git_repository_set_workdir","git_repository_is_bare","git_repository_is_worktree","git_repository_config","git_repository_config_snapshot","git_repository_odb","git_repository_refdb","git_repository_index","git_repository_message","git_repository_message_remove","git_repository_state_cleanup","git_repository_fetchhead_foreach","git_repository_mergehead_foreach","git_repository_hashfile","git_repository_set_head","git_repository_set_head_detached","git_repository_set_head_detached_from_annotated","git_repository_detach_head","git_repository_state","git_repository_set_namespace","git_repository_get_namespace","git_repository_is_shallow","git_repository_ident","git_repository_set_ident"],"meta":{},"lines":862},{"file":"git2/reset.h","functions":["git_reset","git_reset_from_annotated","git_reset_default"],"meta":{},"lines":107},{"file":"git2/revert.h","functions":["git_revert_init_options","git_revert_commit","git_revert"],"meta":{},"lines":84},{"file":"git2/revparse.h","functions":["git_revparse_single","git_revparse_ext","git_revparse"],"meta":{},"lines":108},{"file":"git2/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_simplify_first_parent","git_revwalk_free","git_revwalk_repository","git_revwalk_hide_cb","git_revwalk_add_hide_cb"],"meta":{},"lines":291},{"file":"git2/signature.h","functions":["git_signature_new","git_signature_now","git_signature_default","git_signature_from_buffer","git_signature_dup","git_signature_free"],"meta":{},"lines":99},{"file":"git2/stash.h","functions":["git_stash_apply_progress_cb","git_stash_apply_init_options","git_stash_apply","git_stash_cb","git_stash_foreach","git_stash_drop","git_stash_pop"],"meta":{},"lines":253},{"file":"git2/status.h","functions":["git_status_cb","git_status_init_options","git_status_foreach","git_status_foreach_ext","git_status_file","git_status_list_new","git_status_list_entrycount","git_status_byindex","git_status_list_free","git_status_should_ignore"],"meta":{},"lines":370},{"file":"git2/strarray.h","functions":["git_strarray_free","git_strarray_copy"],"meta":{},"lines":53},{"file":"git2/submodule.h","functions":["git_submodule_cb","git_submodule_update_init_options","git_submodule_update","git_submodule_lookup","git_submodule_free","git_submodule_foreach","git_submodule_add_setup","git_submodule_add_finalize","git_submodule_add_to_index","git_submodule_owner","git_submodule_name","git_submodule_path","git_submodule_url","git_submodule_resolve_url","git_submodule_branch","git_submodule_set_branch","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_strategy","git_submodule_set_update","git_submodule_fetch_recurse_submodules","git_submodule_set_fetch_recurse_submodules","git_submodule_init","git_submodule_repo_init","git_submodule_sync","git_submodule_open","git_submodule_reload","git_submodule_status","git_submodule_location"],"meta":{},"lines":632},{"file":"git2/sys/config.h","functions":[],"meta":{},"lines":85},{"file":"git2/sys/filter.h","functions":["git_filter_init_fn","git_filter_shutdown_fn","git_filter_check_fn","git_filter_apply_fn","git_filter_cleanup_fn"],"meta":{},"lines":271},{"file":"git2/sys/hashsig.h","functions":[],"meta":{},"lines":45},{"file":"git2/sys/merge.h","functions":["git_merge_driver_init_fn","git_merge_driver_shutdown_fn","git_merge_driver_apply_fn"],"meta":{},"lines":135},{"file":"git2/sys/refdb_backend.h","functions":[],"meta":{},"lines":170},{"file":"git2/sys/transport.h","functions":[],"meta":{},"lines":349},{"file":"git2/tag.h","functions":["git_tag_lookup","git_tag_lookup_prefix","git_tag_free","git_tag_id","git_tag_owner","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_annotation_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","git_tag_dup"],"meta":{},"lines":357},{"file":"git2/trace.h","functions":["git_trace_callback","git_trace_set"],"meta":{},"lines":63},{"file":"git2/transport.h","functions":["git_transport_cb","git_cred_has_username","git_cred_userpass_plaintext_new","git_cred_ssh_key_new","git_cred_ssh_interactive_new","git_cred_ssh_key_from_agent","git_cred_ssh_custom_new","git_cred_default_new","git_cred_username_new","git_cred_ssh_key_memory_new","git_cred_free","git_cred_acquire_cb"],"meta":{},"lines":338},{"file":"git2/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_byid","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_filemode_raw","git_tree_entry_cmp","git_tree_entry_to_object","git_treebuilder_new","git_treebuilder_clear","git_treebuilder_entrycount","git_treebuilder_free","git_treebuilder_get","git_treebuilder_insert","git_treebuilder_remove","git_treebuilder_filter_cb","git_treebuilder_filter","git_treebuilder_write","git_treebuilder_write_with_buffer","git_treewalk_cb","git_tree_walk","git_tree_dup","git_tree_create_updated"],"meta":{},"lines":479},{"file":"git2/types.h","functions":["git_transfer_progress_cb","git_transport_message_cb","git_transport_certificate_check_cb"],"meta":{},"lines":429},{"file":"git2/worktree.h","functions":["git_worktree_list","git_worktree_lookup","git_worktree_open_from_repository","git_worktree_free","git_worktree_validate","git_worktree_add_init_options","git_worktree_add","git_worktree_lock","git_worktree_unlock","git_worktree_is_locked","git_worktree_prune_init_options","git_worktree_is_prunable","git_worktree_prune"],"meta":{},"lines":216}],"functions":{"git_annotated_commit_from_ref":{"type":"function","file":"git2/annotated_commit.h","line":33,"lineto":36,"args":[{"name":"out","type":"git_annotated_commit **","comment":"pointer to store the git_annotated_commit result in"},{"name":"repo","type":"git_repository *","comment":"repository that contains the given reference"},{"name":"ref","type":"const git_reference *","comment":"reference to use to lookup the git_annotated_commit"}],"argline":"git_annotated_commit **out, git_repository *repo, const git_reference *ref","sig":"git_annotated_commit **::git_repository *::const git_reference *","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Creates a <code>git_annotated_commit</code> from the given reference.\n The resulting git_annotated_commit must be freed with\n <code>git_annotated_commit_free</code>.</p>\n","comments":"","group":"annotated","examples":{"merge.c":["ex/v0.27.1/merge.html#git_annotated_commit_from_ref-1"]}},"git_annotated_commit_from_fetchhead":{"type":"function","file":"git2/annotated_commit.h","line":50,"lineto":55,"args":[{"name":"out","type":"git_annotated_commit **","comment":"pointer to store the git_annotated_commit result in"},{"name":"repo","type":"git_repository *","comment":"repository that contains the given commit"},{"name":"branch_name","type":"const char *","comment":"name of the (remote) branch"},{"name":"remote_url","type":"const char *","comment":"url of the remote"},{"name":"id","type":"const git_oid *","comment":"the commit object id of the remote branch"}],"argline":"git_annotated_commit **out, git_repository *repo, const char *branch_name, const char *remote_url, const git_oid *id","sig":"git_annotated_commit **::git_repository *::const char *::const char *::const git_oid *","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Creates a <code>git_annotated_commit</code> from the given fetch head data.\n The resulting git_annotated_commit must be freed with\n <code>git_annotated_commit_free</code>.</p>\n","comments":"","group":"annotated"},"git_annotated_commit_lookup":{"type":"function","file":"git2/annotated_commit.h","line":75,"lineto":78,"args":[{"name":"out","type":"git_annotated_commit **","comment":"pointer to store the git_annotated_commit result in"},{"name":"repo","type":"git_repository *","comment":"repository that contains the given commit"},{"name":"id","type":"const git_oid *","comment":"the commit object id to lookup"}],"argline":"git_annotated_commit **out, git_repository *repo, const git_oid *id","sig":"git_annotated_commit **::git_repository *::const git_oid *","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Creates a <code>git_annotated_commit</code> from the given commit id.\n The resulting git_annotated_commit must be freed with\n <code>git_annotated_commit_free</code>.</p>\n","comments":"<p>An annotated commit contains information about how it was looked up, which may be useful for functions like merge or rebase to provide context to the operation. For example, conflict files will include the name of the source or target branches being merged. It is therefore preferable to use the most specific function (eg <code>git_annotated_commit_from_ref</code>) instead of this one when that data is known.</p>\n","group":"annotated","examples":{"merge.c":["ex/v0.27.1/merge.html#git_annotated_commit_lookup-2"]}},"git_annotated_commit_from_revspec":{"type":"function","file":"git2/annotated_commit.h","line":92,"lineto":95,"args":[{"name":"out","type":"git_annotated_commit **","comment":"pointer to store the git_annotated_commit result in"},{"name":"repo","type":"git_repository *","comment":"repository that contains the given commit"},{"name":"revspec","type":"const char *","comment":"the extended sha syntax string to use to lookup the commit"}],"argline":"git_annotated_commit **out, git_repository *repo, const char *revspec","sig":"git_annotated_commit **::git_repository *::const char *","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Creates a <code>git_annotated_comit</code> from a revision string.</p>\n","comments":"<p>See <code>man gitrevisions</code>, or http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for information on the syntax accepted.</p>\n","group":"annotated"},"git_annotated_commit_id":{"type":"function","file":"git2/annotated_commit.h","line":103,"lineto":104,"args":[{"name":"commit","type":"const git_annotated_commit *","comment":"the given annotated commit"}],"argline":"const git_annotated_commit *commit","sig":"const git_annotated_commit *","return":{"type":"const git_oid *","comment":" commit id"},"description":"<p>Gets the commit ID that the given <code>git_annotated_commit</code> refers to.</p>\n","comments":"","group":"annotated","examples":{"merge.c":["ex/v0.27.1/merge.html#git_annotated_commit_id-3","ex/v0.27.1/merge.html#git_annotated_commit_id-4","ex/v0.27.1/merge.html#git_annotated_commit_id-5"]}},"git_annotated_commit_free":{"type":"function","file":"git2/annotated_commit.h","line":111,"lineto":112,"args":[{"name":"commit","type":"git_annotated_commit *","comment":"annotated commit to free"}],"argline":"git_annotated_commit *commit","sig":"git_annotated_commit *","return":{"type":"void","comment":null},"description":"<p>Frees a <code>git_annotated_commit</code>.</p>\n","comments":"","group":"annotated"},"git_attr_value":{"type":"function","file":"git2/attr.h","line":102,"lineto":102,"args":[{"name":"attr","type":"const char *","comment":"The attribute"}],"argline":"const char *attr","sig":"const char *","return":{"type":"git_attr_t","comment":" the value type for the attribute"},"description":"<p>Return the value type for a given attribute.</p>\n","comments":"<p>This can be either <code>TRUE</code>, <code>FALSE</code>, <code>UNSPECIFIED</code> (if the attribute was not set at all), or <code>VALUE</code>, if the attribute was set to an actual string.</p>\n\n<p>If the attribute has a <code>VALUE</code> string, it can be accessed normally as a NULL-terminated C string.</p>\n","group":"attr"},"git_attr_get":{"type":"function","file":"git2/attr.h","line":145,"lineto":150,"args":[{"name":"value_out","type":"const char **","comment":"Output of the value of the attribute. Use the GIT_ATTR_...\n macros to test for TRUE, FALSE, UNSPECIFIED, etc. or just\n use the string value for attributes set to a value. You\n 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\n interpreted relative to the repo root. The file does\n not have to exist, but if it does not, then it will be\n 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, git_repository *repo, uint32_t flags, const char *path, const char *name","sig":"const char **::git_repository *::uint32_t::const char *::const char *","return":{"type":"int","comment":null},"description":"<p>Look up the value of one git attribute for path.</p>\n","comments":"","group":"attr"},"git_attr_get_many":{"type":"function","file":"git2/attr.h","line":181,"lineto":187,"args":[{"name":"values_out","type":"const char **","comment":"An array of num_attr entries that will have string\n pointers written into it for the values of the attributes.\n You should not modify or free the values that are written\n into this array (although of course, you should free the\n array itself if you allocated it)."},{"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\n does not have to exist, but if it does not, then\n 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, git_repository *repo, uint32_t flags, const char *path, size_t num_attr, const char **names","sig":"const char **::git_repository *::uint32_t::const char *::size_t::const char **","return":{"type":"int","comment":null},"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 look up in a single call. This is somewhat more efficient than calling <code>git_attr_get()</code> multiple times.</p>\n\n<p>For example, you might write:</p>\n\n<pre><code> const char *attrs[] = { "crlf", "diff", "foo" }; const char **values[3]; git_attr_get_many(values, repo, 0, "my/fun/file.c", 3, attrs);\n</code></pre>\n\n<p>Then you could loop through the 3 values to get the settings for the three attributes you asked about.</p>\n","group":"attr"},"git_attr_foreach":{"type":"function","file":"git2/attr.h","line":209,"lineto":214,"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\n to exist, but if it does not, then it will be treated as a\n 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\n value may be NULL is the attribute is explicitly set to\n UNSPECIFIED using the '!' sign. Callback will be invoked\n only once per attribute name, even if there are multiple\n rules for a given file. The highest priority rule will be\n used. Return a non-zero value from this to stop looping.\n The value will be returned from `git_attr_foreach`."},{"name":"payload","type":"void *","comment":"Passed on as extra parameter to callback function."}],"argline":"git_repository *repo, uint32_t flags, const char *path, git_attr_foreach_cb callback, void *payload","sig":"git_repository *::uint32_t::const char *::git_attr_foreach_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, 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":"git2/attr.h","line":224,"lineto":225,"args":[{"name":"repo","type":"git_repository *","comment":null}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"void","comment":null},"description":"<p>Flush the gitattributes cache.</p>\n","comments":"<p>Call this if you have reason to believe that the attributes files on disk no longer match the cached contents of memory. This will cause the attributes files to be reloaded the next time that an attribute access function is called.</p>\n","group":"attr"},"git_attr_add_macro":{"type":"function","file":"git2/attr.h","line":237,"lineto":240,"args":[{"name":"repo","type":"git_repository *","comment":null},{"name":"name","type":"const char *","comment":null},{"name":"values","type":"const char *","comment":null}],"argline":"git_repository *repo, const char *name, const char *values","sig":"git_repository *::const char *::const char *","return":{"type":"int","comment":null},"description":"<p>Add a macro definition.</p>\n","comments":"<p>Macros will automatically be loaded from the top level <code>.gitattributes</code> file of the repository (plus the build-in "binary" macro). This function allows you to add others. For example, to add the default macro, you would call:</p>\n\n<pre><code> git_attr_add_macro(repo, "binary", "-diff -crlf");\n</code></pre>\n","group":"attr"},"git_blame_init_options":{"type":"function","file":"git2/blame.h","line":92,"lineto":94,"args":[{"name":"opts","type":"git_blame_options *","comment":"The `git_blame_options` struct to initialize"},{"name":"version","type":"unsigned int","comment":"Version of struct; pass `GIT_BLAME_OPTIONS_VERSION`"}],"argline":"git_blame_options *opts, unsigned int version","sig":"git_blame_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_blame_options</code> with default values. Equivalent to\n creating an instance with GIT_BLAME_OPTIONS_INIT.</p>\n","comments":"","group":"blame"},"git_blame_get_hunk_count":{"type":"function","file":"git2/blame.h","line":137,"lineto":137,"args":[{"name":"blame","type":"git_blame *","comment":null}],"argline":"git_blame *blame","sig":"git_blame *","return":{"type":"uint32_t","comment":null},"description":"<p>Gets the number of hunks that exist in the blame structure.</p>\n","comments":"","group":"blame"},"git_blame_get_hunk_byindex":{"type":"function","file":"git2/blame.h","line":146,"lineto":148,"args":[{"name":"blame","type":"git_blame *","comment":"the blame structure to query"},{"name":"index","type":"uint32_t","comment":"index of the hunk to retrieve"}],"argline":"git_blame *blame, uint32_t index","sig":"git_blame *::uint32_t","return":{"type":"const git_blame_hunk *","comment":" the hunk at the given index, or NULL on error"},"description":"<p>Gets the blame hunk at the given index.</p>\n","comments":"","group":"blame"},"git_blame_get_hunk_byline":{"type":"function","file":"git2/blame.h","line":157,"lineto":159,"args":[{"name":"blame","type":"git_blame *","comment":"the blame structure to query"},{"name":"lineno","type":"size_t","comment":"the (1-based) line number to find a hunk for"}],"argline":"git_blame *blame, size_t lineno","sig":"git_blame *::size_t","return":{"type":"const git_blame_hunk *","comment":" the hunk that contains the given line, or NULL on error"},"description":"<p>Gets the hunk that relates to the given line number in the newest commit.</p>\n","comments":"","group":"blame","examples":{"blame.c":["ex/v0.27.1/blame.html#git_blame_get_hunk_byline-1"]}},"git_blame_file":{"type":"function","file":"git2/blame.h","line":172,"lineto":176,"args":[{"name":"out","type":"git_blame **","comment":"pointer that will receive the blame object"},{"name":"repo","type":"git_repository *","comment":"repository whose history is to be walked"},{"name":"path","type":"const char *","comment":"path to file to consider"},{"name":"options","type":"git_blame_options *","comment":"options for the blame operation. If NULL, this is treated as\n though GIT_BLAME_OPTIONS_INIT were passed."}],"argline":"git_blame **out, git_repository *repo, const char *path, git_blame_options *options","sig":"git_blame **::git_repository *::const char *::git_blame_options *","return":{"type":"int","comment":" 0 on success, or an error code. (use giterr_last for information\n about the error.)"},"description":"<p>Get the blame for a single file.</p>\n","comments":"","group":"blame","examples":{"blame.c":["ex/v0.27.1/blame.html#git_blame_file-2"]}},"git_blame_buffer":{"type":"function","file":"git2/blame.h","line":196,"lineto":200,"args":[{"name":"out","type":"git_blame **","comment":"pointer that will receive the resulting blame data"},{"name":"reference","type":"git_blame *","comment":"cached blame from the history of the file (usually the output\n from git_blame_file)"},{"name":"buffer","type":"const char *","comment":"the (possibly) modified contents of the file"},{"name":"buffer_len","type":"size_t","comment":"number of valid bytes in the buffer"}],"argline":"git_blame **out, git_blame *reference, const char *buffer, size_t buffer_len","sig":"git_blame **::git_blame *::const char *::size_t","return":{"type":"int","comment":" 0 on success, or an error code. (use giterr_last for information\n about the error)"},"description":"<p>Get blame data for a file that has been modified in memory. The <code>reference</code>\n parameter is a pre-calculated blame for the in-odb history of the file. This\n means that once a file blame is completed (which can be expensive), updating\n the buffer blame is very fast.</p>\n","comments":"<p>Lines that differ between the buffer and the committed version are marked as having a zero OID for their final_commit_id.</p>\n","group":"blame"},"git_blame_free":{"type":"function","file":"git2/blame.h","line":207,"lineto":207,"args":[{"name":"blame","type":"git_blame *","comment":"the blame structure to free"}],"argline":"git_blame *blame","sig":"git_blame *","return":{"type":"void","comment":null},"description":"<p>Free memory allocated by git_blame_file or git_blame_buffer.</p>\n","comments":"","group":"blame","examples":{"blame.c":["ex/v0.27.1/blame.html#git_blame_free-3"]}},"git_blob_lookup":{"type":"function","file":"git2/blob.h","line":33,"lineto":33,"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":{"blame.c":["ex/v0.27.1/blame.html#git_blob_lookup-4"],"general.c":["ex/v0.27.1/general.html#git_blob_lookup-1"]}},"git_blob_lookup_prefix":{"type":"function","file":"git2/blob.h","line":47,"lineto":47,"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,\n given a prefix of its identifier (short id).</p>\n","comments":"","group":"blob"},"git_blob_free":{"type":"function","file":"git2/blob.h","line":60,"lineto":60,"args":[{"name":"blob","type":"git_blob *","comment":"the blob to close"}],"argline":"git_blob *blob","sig":"git_blob *","return":{"type":"void","comment":null},"description":"<p>Close an open blob</p>\n","comments":"<p>This is a wrapper around git_object_free()</p>\n\n<p>IMPORTANT: It <em>is</em> necessary to call this method when you stop using a blob. Failure to do so will cause a memory leak.</p>\n","group":"blob","examples":{"blame.c":["ex/v0.27.1/blame.html#git_blob_free-5"],"general.c":["ex/v0.27.1/general.html#git_blob_free-2"]}},"git_blob_id":{"type":"function","file":"git2/blob.h","line":68,"lineto":68,"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_owner":{"type":"function","file":"git2/blob.h","line":76,"lineto":76,"args":[{"name":"blob","type":"const git_blob *","comment":"A previously loaded blob."}],"argline":"const git_blob *blob","sig":"const git_blob *","return":{"type":"git_repository *","comment":" Repository that contains this blob."},"description":"<p>Get the repository that contains the blob.</p>\n","comments":"","group":"blob"},"git_blob_rawcontent":{"type":"function","file":"git2/blob.h","line":89,"lineto":89,"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"},"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; this pointer is owned internally by the object and shall not be free'd. The pointer may be invalidated at a later time.</p>\n","group":"blob","examples":{"blame.c":["ex/v0.27.1/blame.html#git_blob_rawcontent-6"],"cat-file.c":["ex/v0.27.1/cat-file.html#git_blob_rawcontent-1"],"general.c":["ex/v0.27.1/general.html#git_blob_rawcontent-3"]}},"git_blob_rawsize":{"type":"function","file":"git2/blob.h","line":97,"lineto":97,"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":{"blame.c":["ex/v0.27.1/blame.html#git_blob_rawsize-7"],"cat-file.c":["ex/v0.27.1/cat-file.html#git_blob_rawsize-2"],"general.c":["ex/v0.27.1/general.html#git_blob_rawsize-4","ex/v0.27.1/general.html#git_blob_rawsize-5"]}},"git_blob_filtered_content":{"type":"function","file":"git2/blob.h","line":122,"lineto":126,"args":[{"name":"out","type":"git_buf *","comment":"The git_buf to be filled in"},{"name":"blob","type":"git_blob *","comment":"Pointer to the blob"},{"name":"as_path","type":"const char *","comment":"Path used for file attribute lookups, etc."},{"name":"check_for_binary_data","type":"int","comment":"Should this test if blob content contains\n NUL bytes / looks like binary data before applying filters?"}],"argline":"git_buf *out, git_blob *blob, const char *as_path, int check_for_binary_data","sig":"git_buf *::git_blob *::const char *::int","return":{"type":"int","comment":" 0 on success or an error code"},"description":"<p>Get a buffer with the filtered content of a blob.</p>\n","comments":"<p>This applies filters as if the blob was being checked out to the working directory under the specified filename. This may apply CRLF filtering or other types of changes depending on the file attributes set for the blob and the content detected in it.</p>\n\n<p>The output is written into a <code>git_buf</code> which the caller must free when done (via <code>git_buf_free</code>).</p>\n\n<p>If no filters need to be applied, then the <code>out</code> buffer will just be populated with a pointer to the raw content of the blob. In that case, be careful to <em>not</em> free the blob until done with the buffer or copy it into memory you own.</p>\n","group":"blob"},"git_blob_create_fromworkdir":{"type":"function","file":"git2/blob.h","line":139,"lineto":139,"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.\n\tthis repository cannot be bare"},{"name":"relative_path","type":"const char *","comment":"file from which the blob will be created,\n\trelative 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\n and write it to the Object Database as a loose blob</p>\n","comments":"","group":"blob"},"git_blob_create_fromdisk":{"type":"function","file":"git2/blob.h","line":151,"lineto":151,"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.\n\tthis 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\n to the Object Database as a loose blob</p>\n","comments":"","group":"blob"},"git_blob_create_fromstream":{"type":"function","file":"git2/blob.h","line":178,"lineto":181,"args":[{"name":"out","type":"git_writestream **","comment":"the stream into which to write"},{"name":"repo","type":"git_repository *","comment":"Repository where the blob will be written.\n This repository can be bare or not."},{"name":"hintpath","type":"const char *","comment":"If not NULL, will be used to select data filters\n to apply onto the content of the blob to be created."}],"argline":"git_writestream **out, git_repository *repo, const char *hintpath","sig":"git_writestream **::git_repository *::const char *","return":{"type":"int","comment":" 0 or error code"},"description":"<p>Create a stream to write a new blob into the object db</p>\n","comments":"<p>This function may need to buffer the data on disk and will in general not be the right choice if you know the size of the data to write. If you have data in memory, use <code>git_blob_create_frombuffer()</code>. If you do not, but know the size of the contents (and don't want/need to perform filtering), use <code>git_odb_open_wstream()</code>.</p>\n\n<p>Don't close this stream yourself but pass it to <code>git_blob_create_fromstream_commit()</code> to commit the write to the object db and get the object id.</p>\n\n<p>If the <code>hintpath</code> parameter is filled, it will be used to determine what git filters should be applied to the object before it is written to the object database.</p>\n","group":"blob"},"git_blob_create_fromstream_commit":{"type":"function","file":"git2/blob.h","line":192,"lineto":194,"args":[{"name":"out","type":"git_oid *","comment":"the id of the new blob"},{"name":"stream","type":"git_writestream *","comment":"the stream to close"}],"argline":"git_oid *out, git_writestream *stream","sig":"git_oid *::git_writestream *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Close the stream and write the blob to the object db</p>\n","comments":"<p>The stream will be closed and freed.</p>\n","group":"blob"},"git_blob_create_frombuffer":{"type":"function","file":"git2/blob.h","line":205,"lineto":206,"args":[{"name":"id","type":"git_oid *","comment":"return the id 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 *id, 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":"git2/blob.h","line":219,"lineto":219,"args":[{"name":"blob","type":"const git_blob *","comment":"The blob which content should be analyzed"}],"argline":"const git_blob *blob","sig":"const git_blob *","return":{"type":"int","comment":" 1 if the content of the blob is detected\n 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: Searching for NUL bytes and looking for a reasonable ratio of printable to non-printable characters among the first 8000 bytes.</p>\n","group":"blob"},"git_blob_dup":{"type":"function","file":"git2/blob.h","line":228,"lineto":228,"args":[{"name":"out","type":"git_blob **","comment":"Pointer to store the copy of the object"},{"name":"source","type":"git_blob *","comment":"Original object to copy"}],"argline":"git_blob **out, git_blob *source","sig":"git_blob **::git_blob *","return":{"type":"int","comment":null},"description":"<p>Create an in-memory copy of a blob. The copy must be explicitly\n free'd or it will leak.</p>\n","comments":"","group":"blob"},"git_branch_create":{"type":"function","file":"git2/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 *","comment":null},{"name":"branch_name","type":"const char *","comment":"Name for the branch; this name is\n validated for consistency. It should also not conflict with\n an already existing branch name."},{"name":"target","type":"const git_commit *","comment":"Commit to which this branch should point. This object\n must belong to the given `repo`."},{"name":"force","type":"int","comment":"Overwrite existing branch."}],"argline":"git_reference **out, git_repository *repo, const char *branch_name, const git_commit *target, int force","sig":"git_reference **::git_repository *::const char *::const git_commit *::int","return":{"type":"int","comment":" 0, GIT_EINVALIDSPEC or an error code.\n A proper reference is written in the refs/heads namespace\n 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 this target commit. If <code>force</code> is true and a reference already exists with the given name, it'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. See <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"branch"},"git_branch_create_from_annotated":{"type":"function","file":"git2/branch.h","line":68,"lineto":73,"args":[{"name":"ref_out","type":"git_reference **","comment":null},{"name":"repository","type":"git_repository *","comment":null},{"name":"branch_name","type":"const char *","comment":null},{"name":"commit","type":"const git_annotated_commit *","comment":null},{"name":"force","type":"int","comment":null}],"argline":"git_reference **ref_out, git_repository *repository, const char *branch_name, const git_annotated_commit *commit, int force","sig":"git_reference **::git_repository *::const char *::const git_annotated_commit *::int","return":{"type":"int","comment":null},"description":"<p>Create a new branch pointing at a target commit</p>\n","comments":"<p>This behaves like <code>git_branch_create()</code> but takes an annotated commit, which lets you specify which extended sha syntax string was specified by a user, allowing for more exact reflog messages.</p>\n\n<p>See the documentation for <code>git_branch_create()</code>.</p>\n","group":"branch"},"git_branch_delete":{"type":"function","file":"git2/branch.h","line":85,"lineto":85,"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 object will be invalidated. The reference must be freed manually by the user.</p>\n","group":"branch"},"git_branch_iterator_new":{"type":"function","file":"git2/branch.h","line":101,"lineto":104,"args":[{"name":"out","type":"git_branch_iterator **","comment":"the iterator"},{"name":"repo","type":"git_repository *","comment":"Repository where to find the branches."},{"name":"list_flags","type":"git_branch_t","comment":"Filtering flags for the branch\n listing. Valid values are GIT_BRANCH_LOCAL, GIT_BRANCH_REMOTE\n or GIT_BRANCH_ALL."}],"argline":"git_branch_iterator **out, git_repository *repo, git_branch_t list_flags","sig":"git_branch_iterator **::git_repository *::git_branch_t","return":{"type":"int","comment":" 0 on success or an error code"},"description":"<p>Create an iterator which loops over the requested branches.</p>\n","comments":"","group":"branch"},"git_branch_next":{"type":"function","file":"git2/branch.h","line":114,"lineto":114,"args":[{"name":"out","type":"git_reference **","comment":"the reference"},{"name":"out_type","type":"git_branch_t *","comment":"the type of branch (local or remote-tracking)"},{"name":"iter","type":"git_branch_iterator *","comment":"the branch iterator"}],"argline":"git_reference **out, git_branch_t *out_type, git_branch_iterator *iter","sig":"git_reference **::git_branch_t *::git_branch_iterator *","return":{"type":"int","comment":" 0 on success, GIT_ITEROVER if there are no more branches or an error code."},"description":"<p>Retrieve the next branch from the iterator</p>\n","comments":"","group":"branch"},"git_branch_iterator_free":{"type":"function","file":"git2/branch.h","line":121,"lineto":121,"args":[{"name":"iter","type":"git_branch_iterator *","comment":"the iterator to free"}],"argline":"git_branch_iterator *iter","sig":"git_branch_iterator *","return":{"type":"void","comment":null},"description":"<p>Free a branch iterator</p>\n","comments":"","group":"branch"},"git_branch_move":{"type":"function","file":"git2/branch.h","line":138,"lineto":142,"args":[{"name":"out","type":"git_reference **","comment":null},{"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\n is performed; this name is validated for consistency."},{"name":"force","type":"int","comment":"Overwrite existing branch."}],"argline":"git_reference **out, git_reference *branch, const char *new_branch_name, int 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. See <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"branch"},"git_branch_lookup":{"type":"function","file":"git2/branch.h","line":165,"lineto":169,"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;\n this name is validated for consistency."},{"name":"branch_type","type":"git_branch_t","comment":"Type of the considered branch. This should\n be valued with either GIT_BRANCH_LOCAL or GIT_BRANCH_REMOTE."}],"argline":"git_reference **out, git_repository *repo, const char *branch_name, git_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\n 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. See <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"branch"},"git_branch_name":{"type":"function","file":"git2/branch.h","line":186,"lineto":188,"args":[{"name":"out","type":"const char **","comment":"where the pointer of branch name is stored;\n this is valid as long as the ref is not freed."},{"name":"ref","type":"const git_reference *","comment":"the reference ideally pointing to a branch"}],"argline":"const char **out, const git_reference *ref","sig":"const char **::const git_reference *","return":{"type":"int","comment":" 0 on success; otherwise an error code (e.g., if the\n 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 for git_branch_lookup. That is, if the returned name is given to git_branch_lookup() then the reference is returned that was given to this function.</p>\n","group":"branch","examples":{"merge.c":["ex/v0.27.1/merge.html#git_branch_name-6"]}},"git_branch_upstream":{"type":"function","file":"git2/branch.h","line":202,"lineto":204,"args":[{"name":"out","type":"git_reference **","comment":"Pointer where to store the retrieved\n reference."},{"name":"branch","type":"const git_reference *","comment":"Current underlying reference of the branch."}],"argline":"git_reference **out, const git_reference *branch","sig":"git_reference **::const git_reference *","return":{"type":"int","comment":" 0 on success; GIT_ENOTFOUND when no remote tracking\n reference exists, otherwise an error code."},"description":"<p>Return the reference supporting the remote tracking branch,\n given a local branch reference.</p>\n","comments":"","group":"branch"},"git_branch_set_upstream":{"type":"function","file":"git2/branch.h","line":216,"lineto":216,"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\n 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_is_head":{"type":"function","file":"git2/branch.h","line":245,"lineto":246,"args":[{"name":"branch","type":"const git_reference *","comment":"Current underlying reference of the branch."}],"argline":"const git_reference *branch","sig":"const git_reference *","return":{"type":"int","comment":" 1 if HEAD points at the branch, 0 if it isn't,\n error code otherwise."},"description":"<p>Determine if the current local branch is pointed at by HEAD.</p>\n","comments":"","group":"branch"},"git_branch_is_checked_out":{"type":"function","file":"git2/branch.h","line":257,"lineto":258,"args":[{"name":"branch","type":"const git_reference *","comment":"Reference to the branch."}],"argline":"const git_reference *branch","sig":"const git_reference *","return":{"type":"int","comment":" 1 if branch is checked out, 0 if it isn't,\n error code otherwise."},"description":"<p>Determine if the current branch is checked out in any linked\n repository.</p>\n","comments":"","group":"branch"},"git_buf_free":{"type":"function","file":"git2/buffer.h","line":72,"lineto":72,"args":[{"name":"buffer","type":"git_buf *","comment":"The buffer to deallocate"}],"argline":"git_buf *buffer","sig":"git_buf *","return":{"type":"void","comment":null},"description":"<p>Free the memory referred to by the git_buf.</p>\n","comments":"<p>Note that this does not free the <code>git_buf</code> itself, just the memory pointed to by <code>buffer->ptr</code>. This will not free the memory if it looks like it was not allocated internally, but it will clear the buffer back to the empty state.</p>\n","group":"buf","examples":{"diff.c":["ex/v0.27.1/diff.html#git_buf_free-1"],"remote.c":["ex/v0.27.1/remote.html#git_buf_free-1"],"tag.c":["ex/v0.27.1/tag.html#git_buf_free-1"]}},"git_buf_grow":{"type":"function","file":"git2/buffer.h","line":95,"lineto":95,"args":[{"name":"buffer","type":"git_buf *","comment":"The buffer to be resized; may or may not be allocated yet"},{"name":"target_size","type":"size_t","comment":"The desired available size"}],"argline":"git_buf *buffer, size_t target_size","sig":"git_buf *::size_t","return":{"type":"int","comment":" 0 on success, -1 on allocation failure"},"description":"<p>Resize the buffer allocation to make more space.</p>\n","comments":"<p>This will attempt to grow the buffer to accommodate the target size.</p>\n\n<p>If the buffer refers to memory that was not allocated by libgit2 (i.e. the <code>asize</code> field is zero), then <code>ptr</code> will be replaced with a newly allocated block of data. Be careful so that memory allocated by the caller is not lost. As a special variant, if you pass <code>target_size</code> as 0 and the memory is not allocated by libgit2, this will allocate a new buffer of size <code>size</code> and copy the external data into it.</p>\n\n<p>Currently, this will never shrink a buffer, only expand it.</p>\n\n<p>If the allocation fails, this will return an error and the buffer will be marked as invalid for future operations, invaliding the contents.</p>\n","group":"buf"},"git_buf_set":{"type":"function","file":"git2/buffer.h","line":105,"lineto":106,"args":[{"name":"buffer","type":"git_buf *","comment":"The buffer to set"},{"name":"data","type":"const void *","comment":"The data to copy into the buffer"},{"name":"datalen","type":"size_t","comment":"The length of the data to copy into the buffer"}],"argline":"git_buf *buffer, const void *data, size_t datalen","sig":"git_buf *::const void *::size_t","return":{"type":"int","comment":" 0 on success, -1 on allocation failure"},"description":"<p>Set buffer to a copy of some raw data.</p>\n","comments":"","group":"buf"},"git_buf_is_binary":{"type":"function","file":"git2/buffer.h","line":114,"lineto":114,"args":[{"name":"buf","type":"const git_buf *","comment":"Buffer to check"}],"argline":"const git_buf *buf","sig":"const git_buf *","return":{"type":"int","comment":" 1 if buffer looks like non-text data"},"description":"<p>Check quickly if buffer looks like it contains binary data</p>\n","comments":"","group":"buf"},"git_buf_contains_nul":{"type":"function","file":"git2/buffer.h","line":122,"lineto":122,"args":[{"name":"buf","type":"const git_buf *","comment":"Buffer to check"}],"argline":"const git_buf *buf","sig":"const git_buf *","return":{"type":"int","comment":" 1 if buffer contains a NUL byte"},"description":"<p>Check quickly if buffer contains a NUL byte</p>\n","comments":"","group":"buf"},"git_checkout_init_options":{"type":"function","file":"git2/checkout.h","line":308,"lineto":310,"args":[{"name":"opts","type":"git_checkout_options *","comment":"the `git_checkout_options` struct to initialize."},{"name":"version","type":"unsigned int","comment":"Version of struct; pass `GIT_CHECKOUT_OPTIONS_VERSION`"}],"argline":"git_checkout_options *opts, unsigned int version","sig":"git_checkout_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_checkout_options</code> with default values. Equivalent to\n creating an instance with GIT_CHECKOUT_OPTIONS_INIT.</p>\n","comments":"","group":"checkout"},"git_checkout_head":{"type":"function","file":"git2/checkout.h","line":329,"lineto":331,"args":[{"name":"repo","type":"git_repository *","comment":"repository to check out (must be non-bare)"},{"name":"opts","type":"const git_checkout_options *","comment":"specifies checkout options (may be NULL)"}],"argline":"git_repository *repo, const git_checkout_options *opts","sig":"git_repository *::const git_checkout_options *","return":{"type":"int","comment":" 0 on success, GIT_EUNBORNBRANCH if HEAD points to a non\n existing branch, non-zero value returned by `notify_cb`, or\n other error code \n<\n 0 (use giterr_last for error details)"},"description":"<p>Updates files in the index and the working tree to match the content of\n the commit pointed at by HEAD.</p>\n","comments":"<p>Note that this is <em>not</em> the correct mechanism used to switch branches; do not change your <code>HEAD</code> and then call this method, that would leave you with checkout conflicts since your working directory would then appear to be dirty. Instead, checkout the target of the branch and then update <code>HEAD</code> using <code>git_repository_set_head</code> to point to the branch you checked out.</p>\n","group":"checkout"},"git_checkout_index":{"type":"function","file":"git2/checkout.h","line":342,"lineto":345,"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":"const git_checkout_options *","comment":"specifies checkout options (may be NULL)"}],"argline":"git_repository *repo, git_index *index, const git_checkout_options *opts","sig":"git_repository *::git_index *::const git_checkout_options *","return":{"type":"int","comment":" 0 on success, non-zero return value from `notify_cb`, or error\n code \n<\n 0 (use giterr_last for error details)"},"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":"git2/checkout.h","line":358,"lineto":361,"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\n the working directory (or NULL to use HEAD)"},{"name":"opts","type":"const git_checkout_options *","comment":"specifies checkout options (may be NULL)"}],"argline":"git_repository *repo, const git_object *treeish, const git_checkout_options *opts","sig":"git_repository *::const git_object *::const git_checkout_options *","return":{"type":"int","comment":" 0 on success, non-zero return value from `notify_cb`, or error\n code \n<\n 0 (use giterr_last for error details)"},"description":"<p>Updates files in the index and working tree to match the content of the\n tree pointed at by the treeish.</p>\n","comments":"","group":"checkout","examples":{"merge.c":["ex/v0.27.1/merge.html#git_checkout_tree-7"]}},"git_cherrypick_init_options":{"type":"function","file":"git2/cherrypick.h","line":47,"lineto":49,"args":[{"name":"opts","type":"git_cherrypick_options *","comment":"the `git_cherrypick_options` struct to initialize"},{"name":"version","type":"unsigned int","comment":"Version of struct; pass `GIT_CHERRYPICK_OPTIONS_VERSION`"}],"argline":"git_cherrypick_options *opts, unsigned int version","sig":"git_cherrypick_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_cherrypick_options</code> with default values. Equivalent to\n creating an instance with GIT_CHERRYPICK_OPTIONS_INIT.</p>\n","comments":"","group":"cherrypick"},"git_cherrypick_commit":{"type":"function","file":"git2/cherrypick.h","line":65,"lineto":71,"args":[{"name":"out","type":"git_index **","comment":"pointer to store the index result in"},{"name":"repo","type":"git_repository *","comment":"the repository that contains the given commits"},{"name":"cherrypick_commit","type":"git_commit *","comment":"the commit to cherry-pick"},{"name":"our_commit","type":"git_commit *","comment":"the commit to revert against (eg, HEAD)"},{"name":"mainline","type":"unsigned int","comment":"the parent of the revert commit, if it is a merge"},{"name":"merge_options","type":"const git_merge_options *","comment":"the merge options (or null for defaults)"}],"argline":"git_index **out, git_repository *repo, git_commit *cherrypick_commit, git_commit *our_commit, unsigned int mainline, const git_merge_options *merge_options","sig":"git_index **::git_repository *::git_commit *::git_commit *::unsigned int::const git_merge_options *","return":{"type":"int","comment":" zero on success, -1 on failure."},"description":"<p>Cherry-picks the given commit against the given "our" commit, producing an\n index that reflects the result of the cherry-pick.</p>\n","comments":"<p>The returned index must be freed explicitly with <code>git_index_free</code>.</p>\n","group":"cherrypick"},"git_cherrypick":{"type":"function","file":"git2/cherrypick.h","line":81,"lineto":84,"args":[{"name":"repo","type":"git_repository *","comment":"the repository to cherry-pick"},{"name":"commit","type":"git_commit *","comment":"the commit to cherry-pick"},{"name":"cherrypick_options","type":"const git_cherrypick_options *","comment":"the cherry-pick options (or null for defaults)"}],"argline":"git_repository *repo, git_commit *commit, const git_cherrypick_options *cherrypick_options","sig":"git_repository *::git_commit *::const git_cherrypick_options *","return":{"type":"int","comment":" zero on success, -1 on failure."},"description":"<p>Cherry-pick the given commit, producing changes in the index and working directory.</p>\n","comments":"","group":"cherrypick"},"git_clone_init_options":{"type":"function","file":"git2/clone.h","line":179,"lineto":181,"args":[{"name":"opts","type":"git_clone_options *","comment":"The `git_clone_options` struct to initialize"},{"name":"version","type":"unsigned int","comment":"Version of struct; pass `GIT_CLONE_OPTIONS_VERSION`"}],"argline":"git_clone_options *opts, unsigned int version","sig":"git_clone_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_clone_options</code> with default values. Equivalent to\n creating an instance with GIT_CLONE_OPTIONS_INIT.</p>\n","comments":"","group":"clone"},"git_clone":{"type":"function","file":"git2/clone.h","line":199,"lineto":203,"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\n function works as though GIT_OPTIONS_INIT were passed."}],"argline":"git_repository **out, const char *url, const char *local_path, const git_clone_options *options","sig":"git_repository **::const char *::const char *::const git_clone_options *","return":{"type":"int","comment":" 0 on success, any non-zero return value from a callback\n function, or a negative value to indicate an error (use\n `giterr_last` for a detailed error message)"},"description":"<p>Clone a remote repository.</p>\n","comments":"<p>By default this creates its repository and initial remote to match git's defaults. You can use the options in the callback to customize how these are created.</p>\n","group":"clone","examples":{"network/clone.c":["ex/v0.27.1/network/clone.html#git_clone-1"]}},"git_commit_lookup":{"type":"function","file":"git2/commit.h","line":36,"lineto":37,"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\n\t\tan 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":"<p>The returned object should be released with <code>git_commit_free</code> when no longer needed.</p>\n","group":"commit","examples":{"general.c":["ex/v0.27.1/general.html#git_commit_lookup-6","ex/v0.27.1/general.html#git_commit_lookup-7","ex/v0.27.1/general.html#git_commit_lookup-8"],"log.c":["ex/v0.27.1/log.html#git_commit_lookup-1"],"merge.c":["ex/v0.27.1/merge.html#git_commit_lookup-8"]}},"git_commit_lookup_prefix":{"type":"function","file":"git2/commit.h","line":55,"lineto":56,"args":[{"name":"commit","type":"git_commit **","comment":"pointer to the looked up commit"},{"name":"repo","type":"git_repository *","comment":"the repo to use when locating the commit."},{"name":"id","type":"const git_oid *","comment":"identity of the commit to locate. If the object is\n\t\tan 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, given a prefix of its\n identifier (short id).</p>\n","comments":"<p>The returned object should be released with <code>git_commit_free</code> when no longer needed.</p>\n","group":"commit"},"git_commit_free":{"type":"function","file":"git2/commit.h","line":70,"lineto":70,"args":[{"name":"commit","type":"git_commit *","comment":"the commit to close"}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"void","comment":null},"description":"<p>Close an open commit</p>\n","comments":"<p>This is a wrapper around git_object_free()</p>\n\n<p>IMPORTANT: It <em>is</em> necessary to call this method when you stop using a commit. Failure to do so will cause a memory leak.</p>\n","group":"commit","examples":{"general.c":["ex/v0.27.1/general.html#git_commit_free-9","ex/v0.27.1/general.html#git_commit_free-10","ex/v0.27.1/general.html#git_commit_free-11","ex/v0.27.1/general.html#git_commit_free-12","ex/v0.27.1/general.html#git_commit_free-13"],"log.c":["ex/v0.27.1/log.html#git_commit_free-2","ex/v0.27.1/log.html#git_commit_free-3","ex/v0.27.1/log.html#git_commit_free-4","ex/v0.27.1/log.html#git_commit_free-5"]}},"git_commit_id":{"type":"function","file":"git2/commit.h","line":78,"lineto":78,"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.27.1/general.html#git_commit_id-14"],"log.c":["ex/v0.27.1/log.html#git_commit_id-6"]}},"git_commit_owner":{"type":"function","file":"git2/commit.h","line":86,"lineto":86,"args":[{"name":"commit","type":"const git_commit *","comment":"A previously loaded commit."}],"argline":"const git_commit *commit","sig":"const git_commit *","return":{"type":"git_repository *","comment":" Repository that contains this commit."},"description":"<p>Get the repository that contains the commit.</p>\n","comments":"","group":"commit","examples":{"log.c":["ex/v0.27.1/log.html#git_commit_owner-7","ex/v0.27.1/log.html#git_commit_owner-8"]}},"git_commit_message_encoding":{"type":"function","file":"git2/commit.h","line":98,"lineto":98,"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,\n as a string representing a standard encoding name.</p>\n","comments":"<p>The encoding may be NULL if the <code>encoding</code> header in the commit is missing; in that case UTF-8 is assumed.</p>\n","group":"commit"},"git_commit_message":{"type":"function","file":"git2/commit.h","line":109,"lineto":109,"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":"<p>The returned message will be slightly prettified by removing any potential leading newlines.</p>\n","group":"commit","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_commit_message-3","ex/v0.27.1/cat-file.html#git_commit_message-4"],"general.c":["ex/v0.27.1/general.html#git_commit_message-15","ex/v0.27.1/general.html#git_commit_message-16","ex/v0.27.1/general.html#git_commit_message-17"],"log.c":["ex/v0.27.1/log.html#git_commit_message-9","ex/v0.27.1/log.html#git_commit_message-10","ex/v0.27.1/log.html#git_commit_message-11"],"tag.c":["ex/v0.27.1/tag.html#git_commit_message-2"]}},"git_commit_message_raw":{"type":"function","file":"git2/commit.h","line":117,"lineto":117,"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 raw message of a commit"},"description":"<p>Get the full raw message of a commit.</p>\n","comments":"","group":"commit"},"git_commit_summary":{"type":"function","file":"git2/commit.h","line":128,"lineto":128,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const char *","comment":" the summary of a commit or NULL on error"},"description":"<p>Get the short "summary" of the git commit message.</p>\n","comments":"<p>The returned message is the summary of the commit, comprising the first paragraph of the message with whitespace trimmed and squashed.</p>\n","group":"commit"},"git_commit_body":{"type":"function","file":"git2/commit.h","line":141,"lineto":141,"args":[{"name":"commit","type":"git_commit *","comment":"a previously loaded commit."}],"argline":"git_commit *commit","sig":"git_commit *","return":{"type":"const char *","comment":" the body of a commit or NULL when no the message only\n consists of a summary"},"description":"<p>Get the long "body" of the git commit message.</p>\n","comments":"<p>The returned message is the body of the commit, comprising everything but the first paragraph of the message. Leading and trailing whitespaces are trimmed.</p>\n","group":"commit"},"git_commit_time":{"type":"function","file":"git2/commit.h","line":149,"lineto":149,"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.27.1/general.html#git_commit_time-18","ex/v0.27.1/general.html#git_commit_time-19"]}},"git_commit_time_offset":{"type":"function","file":"git2/commit.h","line":157,"lineto":157,"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's preferred timezone) of a commit.</p>\n","comments":"","group":"commit"},"git_commit_committer":{"type":"function","file":"git2/commit.h","line":165,"lineto":165,"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":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_commit_committer-5"],"general.c":["ex/v0.27.1/general.html#git_commit_committer-20"],"log.c":["ex/v0.27.1/log.html#git_commit_committer-12"]}},"git_commit_author":{"type":"function","file":"git2/commit.h","line":173,"lineto":173,"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":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_commit_author-6"],"general.c":["ex/v0.27.1/general.html#git_commit_author-21","ex/v0.27.1/general.html#git_commit_author-22"],"log.c":["ex/v0.27.1/log.html#git_commit_author-13","ex/v0.27.1/log.html#git_commit_author-14"]}},"git_commit_raw_header":{"type":"function","file":"git2/commit.h","line":181,"lineto":181,"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 header text of the commit"},"description":"<p>Get the full raw text of the commit header.</p>\n","comments":"","group":"commit"},"git_commit_tree":{"type":"function","file":"git2/commit.h","line":190,"lineto":190,"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","examples":{"log.c":["ex/v0.27.1/log.html#git_commit_tree-15","ex/v0.27.1/log.html#git_commit_tree-16","ex/v0.27.1/log.html#git_commit_tree-17","ex/v0.27.1/log.html#git_commit_tree-18","ex/v0.27.1/log.html#git_commit_tree-19"]}},"git_commit_tree_id":{"type":"function","file":"git2/commit.h","line":200,"lineto":200,"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\n from the ODB.</p>\n","comments":"","group":"commit","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_commit_tree_id-7"]}},"git_commit_parentcount":{"type":"function","file":"git2/commit.h","line":208,"lineto":208,"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":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_commit_parentcount-8"],"general.c":["ex/v0.27.1/general.html#git_commit_parentcount-23"],"log.c":["ex/v0.27.1/log.html#git_commit_parentcount-20","ex/v0.27.1/log.html#git_commit_parentcount-21"]}},"git_commit_parent":{"type":"function","file":"git2/commit.h","line":218,"lineto":221,"args":[{"name":"out","type":"git_commit **","comment":"Pointer where to store the parent commit"},{"name":"commit","type":"const 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, const git_commit *commit, unsigned int n","sig":"git_commit **::const 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.27.1/general.html#git_commit_parent-24"],"log.c":["ex/v0.27.1/log.html#git_commit_parent-22","ex/v0.27.1/log.html#git_commit_parent-23"]}},"git_commit_parent_id":{"type":"function","file":"git2/commit.h","line":232,"lineto":234,"args":[{"name":"commit","type":"const git_commit *","comment":"a previously loaded commit."},{"name":"n","type":"unsigned int","comment":"the position of the parent (from 0 to `parentcount`)"}],"argline":"const git_commit *commit, unsigned int n","sig":"const 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\n the ODB.</p>\n","comments":"","group":"commit","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_commit_parent_id-9"],"log.c":["ex/v0.27.1/log.html#git_commit_parent_id-24"]}},"git_commit_nth_gen_ancestor":{"type":"function","file":"git2/commit.h","line":250,"lineto":253,"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, const git_commit *commit, unsigned int n","sig":"git_commit **::const git_commit *::unsigned int","return":{"type":"int","comment":" 0 on success; GIT_ENOTFOUND if no matching ancestor exists\n or an error code"},"description":"<p>Get the commit object that is the \n<n</p>\n\n<blockquote>\n<p>th generation ancestor\n of the named commit object, following only the first parents.\n The returned commit has to be freed by the caller.</p>\n</blockquote>\n","comments":"<p>Passing <code>0</code> as the generation number returns another instance of the base commit itself.</p>\n","group":"commit"},"git_commit_header_field":{"type":"function","file":"git2/commit.h","line":265,"lineto":265,"args":[{"name":"out","type":"git_buf *","comment":"the buffer to fill; existing content will be\n overwritten"},{"name":"commit","type":"const git_commit *","comment":"the commit to look in"},{"name":"field","type":"const char *","comment":"the header field to return"}],"argline":"git_buf *out, const git_commit *commit, const char *field","sig":"git_buf *::const git_commit *::const char *","return":{"type":"int","comment":" 0 on succeess, GIT_ENOTFOUND if the field does not exist,\n or an error code"},"description":"<p>Get an arbitrary header field</p>\n","comments":"","group":"commit"},"git_commit_extract_signature":{"type":"function","file":"git2/commit.h","line":285,"lineto":285,"args":[{"name":"signature","type":"git_buf *","comment":"the signature block; existing content will be\n overwritten"},{"name":"signed_data","type":"git_buf *","comment":"signed data; this is the commit contents minus the signature block;\n existing content will be overwritten"},{"name":"repo","type":"git_repository *","comment":"the repository in which the commit exists"},{"name":"commit_id","type":"git_oid *","comment":"the commit from which to extract the data"},{"name":"field","type":"const char *","comment":"the name of the header field containing the signature\n block; pass `NULL` to extract the default 'gpgsig'"}],"argline":"git_buf *signature, git_buf *signed_data, git_repository *repo, git_oid *commit_id, const char *field","sig":"git_buf *::git_buf *::git_repository *::git_oid *::const char *","return":{"type":"int","comment":" 0 on success, GIT_ENOTFOUND if the id is not for a commit\n or the commit does not have a signature."},"description":"<p>Extract the signature from a commit</p>\n","comments":"<p>If the id is not for a commit, the error class will be <code>GITERR_INVALID</code>. If the commit does not have a signature, the error class will be <code>GITERR_OBJECT</code>.</p>\n","group":"commit"},"git_commit_create":{"type":"function","file":"git2/commit.h","line":331,"lineto":341,"args":[{"name":"id","type":"git_oid *","comment":"Pointer in which 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\n\twill be updated to point to this commit. If the reference\n\tis not direct, it will be resolved to a direct reference.\n\tUse \"HEAD\" to update the HEAD of the current branch and\n\tmake it point to this commit. If the reference doesn't\n\texist yet, it will be created. If it does exist, the first\n\tparent must be the tip of this branch."},{"name":"author","type":"const git_signature *","comment":"Signature with author and author time of commit"},{"name":"committer","type":"const git_signature *","comment":"Signature with committer and * commit time of commit"},{"name":"message_encoding","type":"const char *","comment":"The encoding for the message in the\n commit, represented with a standard encoding name.\n E.g. \"UTF-8\". If NULL, no encoding header is written and\n UTF-8 is assumed."},{"name":"message","type":"const char *","comment":"Full message for this commit"},{"name":"tree","type":"const git_tree *","comment":"An instance of a `git_tree` object that will\n be used as the tree for the commit. This tree object must\n also be owned by the given `repo`."},{"name":"parent_count","type":"size_t","comment":"Number of parents for this commit"},{"name":"parents","type":"const git_commit *[]","comment":"Array of `parent_count` pointers to `git_commit`\n objects that will be used as the parents for this commit. This\n array may be NULL if `parent_count` is 0 (root commit). All the\n given commits must be owned by the `repo`."}],"argline":"git_oid *id, git_repository *repo, const char *update_ref, const git_signature *author, const git_signature *committer, const char *message_encoding, const char *message, const git_tree *tree, size_t parent_count, const git_commit *[] parents","sig":"git_oid *::git_repository *::const char *::const git_signature *::const git_signature *::const char *::const char *::const git_tree *::size_t::const git_commit *[]","return":{"type":"int","comment":" 0 or an error code\n\tThe created commit will be written to the Object Database and\n\tthe given reference will be updated to point to it"},"description":"<p>Create new commit in the repository from a list of <code>git_object</code> pointers</p>\n","comments":"<p>The message will <strong>not</strong> be cleaned up automatically. You can do that with the <code>git_message_prettify()</code> function.</p>\n","group":"commit","examples":{"merge.c":["ex/v0.27.1/merge.html#git_commit_create-9"]}},"git_commit_create_v":{"type":"function","file":"git2/commit.h","line":357,"lineto":367,"args":[{"name":"id","type":"git_oid *","comment":null},{"name":"repo","type":"git_repository *","comment":null},{"name":"update_ref","type":"const char *","comment":null},{"name":"author","type":"const git_signature *","comment":null},{"name":"committer","type":"const git_signature *","comment":null},{"name":"message_encoding","type":"const char *","comment":null},{"name":"message","type":"const char *","comment":null},{"name":"tree","type":"const git_tree *","comment":null},{"name":"parent_count","type":"size_t","comment":null}],"argline":"git_oid *id, git_repository *repo, const char *update_ref, const git_signature *author, const git_signature *committer, const char *message_encoding, const char *message, const git_tree *tree, size_t parent_count","sig":"git_oid *::git_repository *::const char *::const git_signature *::const git_signature *::const char *::const char *::const git_tree *::size_t","return":{"type":"int","comment":null},"description":"<p>Create new commit in the repository using a variable argument list.</p>\n","comments":"<p>The message will <strong>not</strong> be cleaned up automatically. You can do that with the <code>git_message_prettify()</code> function.</p>\n\n<p>The parents for the commit are specified as a variable list of pointers to <code>const git_commit *</code>. Note that this is a convenience method which may not be safe to export for certain languages or compilers</p>\n\n<p>All other parameters remain the same as <code>git_commit_create()</code>.</p>\n","group":"commit","examples":{"general.c":["ex/v0.27.1/general.html#git_commit_create_v-25"],"init.c":["ex/v0.27.1/init.html#git_commit_create_v-1"]}},"git_commit_amend":{"type":"function","file":"git2/commit.h","line":390,"lineto":398,"args":[{"name":"id","type":"git_oid *","comment":null},{"name":"commit_to_amend","type":"const git_commit *","comment":null},{"name":"update_ref","type":"const char *","comment":null},{"name":"author","type":"const git_signature *","comment":null},{"name":"committer","type":"const git_signature *","comment":null},{"name":"message_encoding","type":"const char *","comment":null},{"name":"message","type":"const char *","comment":null},{"name":"tree","type":"const git_tree *","comment":null}],"argline":"git_oid *id, const git_commit *commit_to_amend, const char *update_ref, const git_signature *author, const git_signature *committer, const char *message_encoding, const char *message, const git_tree *tree","sig":"git_oid *::const git_commit *::const char *::const git_signature *::const git_signature *::const char *::const char *::const git_tree *","return":{"type":"int","comment":null},"description":"<p>Amend an existing commit by replacing only non-NULL values.</p>\n","comments":"<p>This creates a new commit that is exactly the same as the old commit, except that any non-NULL values will be updated. The new commit has the same parents as the old commit.</p>\n\n<p>The <code>update_ref</code> value works as in the regular <code>git_commit_create()</code>, updating the ref to point to the newly rewritten commit. If you want to amend a commit that is not currently the tip of the branch and then rewrite the following commits to reach a ref, pass this as NULL and update the rest of the commit chain and ref separately.</p>\n\n<p>Unlike <code>git_commit_create()</code>, the <code>author</code>, <code>committer</code>, <code>message</code>, <code>message_encoding</code>, and <code>tree</code> parameters can be NULL in which case this will use the values from the original <code>commit_to_amend</code>.</p>\n\n<p>All parameters have the same meanings as in <code>git_commit_create()</code>.</p>\n","group":"commit"},"git_commit_create_buffer":{"type":"function","file":"git2/commit.h","line":435,"lineto":444,"args":[{"name":"out","type":"git_buf *","comment":"the buffer into which to write the commit object content"},{"name":"repo","type":"git_repository *","comment":"Repository where the referenced tree and parents live"},{"name":"author","type":"const git_signature *","comment":"Signature with author and author time of commit"},{"name":"committer","type":"const git_signature *","comment":"Signature with committer and * commit time of commit"},{"name":"message_encoding","type":"const char *","comment":"The encoding for the message in the\n commit, represented with a standard encoding name.\n E.g. \"UTF-8\". If NULL, no encoding header is written and\n UTF-8 is assumed."},{"name":"message","type":"const char *","comment":"Full message for this commit"},{"name":"tree","type":"const git_tree *","comment":"An instance of a `git_tree` object that will\n be used as the tree for the commit. This tree object must\n also be owned by the given `repo`."},{"name":"parent_count","type":"size_t","comment":"Number of parents for this commit"},{"name":"parents","type":"const git_commit *[]","comment":"Array of `parent_count` pointers to `git_commit`\n objects that will be used as the parents for this commit. This\n array may be NULL if `parent_count` is 0 (root commit). All the\n given commits must be owned by the `repo`."}],"argline":"git_buf *out, git_repository *repo, const git_signature *author, const git_signature *committer, const char *message_encoding, const char *message, const git_tree *tree, size_t parent_count, const git_commit *[] parents","sig":"git_buf *::git_repository *::const git_signature *::const git_signature *::const char *::const char *::const git_tree *::size_t::const git_commit *[]","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create a commit and write it into a buffer</p>\n","comments":"<p>Create a commit as with <code>git_commit_create()</code> but instead of writing it to the objectdb, write the contents of the object into a buffer.</p>\n","group":"commit"},"git_commit_create_with_signature":{"type":"function","file":"git2/commit.h","line":460,"lineto":465,"args":[{"name":"out","type":"git_oid *","comment":"the resulting commit id"},{"name":"repo","type":"git_repository *","comment":null},{"name":"commit_content","type":"const char *","comment":"the content of the unsigned commit object"},{"name":"signature","type":"const char *","comment":"the signature to add to the commit"},{"name":"signature_field","type":"const char *","comment":"which header field should contain this\n signature. Leave `NULL` for the default of \"gpgsig\""}],"argline":"git_oid *out, git_repository *repo, const char *commit_content, const char *signature, const char *signature_field","sig":"git_oid *::git_repository *::const char *::const char *::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create a commit object from the given buffer and signature</p>\n","comments":"<p>Given the unsigned commit object's contents, its signature and the header field in which to store the signature, attach the signature to the commit and write it into the given repository.</p>\n","group":"commit"},"git_commit_dup":{"type":"function","file":"git2/commit.h","line":474,"lineto":474,"args":[{"name":"out","type":"git_commit **","comment":"Pointer to store the copy of the commit"},{"name":"source","type":"git_commit *","comment":"Original commit to copy"}],"argline":"git_commit **out, git_commit *source","sig":"git_commit **::git_commit *","return":{"type":"int","comment":null},"description":"<p>Create an in-memory copy of a commit. The copy must be explicitly\n free'd or it will leak.</p>\n","comments":"","group":"commit"},"git_libgit2_version":{"type":"function","file":"git2/common.h","line":105,"lineto":105,"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","comment":null},"description":"<p>Return the version of the libgit2 library\n being currently used.</p>\n","comments":"","group":"libgit2"},"git_libgit2_features":{"type":"function","file":"git2/common.h","line":154,"lineto":154,"args":[],"argline":"","sig":"","return":{"type":"int","comment":" A combination of GIT_FEATURE_* values."},"description":"<p>Query compile time options for libgit2.</p>\n","comments":"<ul>\n<li><p>GIT_FEATURE_THREADS Libgit2 was compiled with thread support. Note that thread support is still to be seen as a 'work in progress' - basic object lookups are believed to be threadsafe, but other operations may not be.</p></li>\n<li><p>GIT_FEATURE_HTTPS Libgit2 supports the https:// protocol. This requires the openssl library to be found when compiling libgit2.</p></li>\n<li><p>GIT_FEATURE_SSH Libgit2 supports the SSH protocol for network operations. This requires the libssh2 library to be found when compiling libgit2</p></li>\n</ul>\n","group":"libgit2"},"git_libgit2_opts":{"type":"function","file":"git2/common.h","line":352,"lineto":352,"args":[{"name":"option","type":"int","comment":"Option key"}],"argline":"int option","sig":"int","return":{"type":"int","comment":" 0 on success, \n<\n0 on failure"},"description":"<p>Set or query a library global option</p>\n","comments":"<p>Available options:</p>\n\n<pre><code>* opts(GIT_OPT_GET_MWINDOW_SIZE, size_t *):\n\n > Get the maximum mmap window size\n\n* opts(GIT_OPT_SET_MWINDOW_SIZE, size_t):\n\n > Set the maximum mmap window size\n\n* opts(GIT_OPT_GET_MWINDOW_MAPPED_LIMIT, size_t *):\n\n > Get the maximum memory that will be mapped in total by the library\n\n* opts(GIT_OPT_SET_MWINDOW_MAPPED_LIMIT, size_t):\n\n >Set the maximum amount of memory that can be mapped at any time by the library\n\n* opts(GIT_OPT_GET_SEARCH_PATH, int level, git_buf *buf)\n\n > Get the search path for a given level of config data. "level" must > be one of `GIT_CONFIG_LEVEL_SYSTEM`, `GIT_CONFIG_LEVEL_GLOBAL`, > `GIT_CONFIG_LEVEL_XDG`, or `GIT_CONFIG_LEVEL_PROGRAMDATA`. > The search path is written to the `out` buffer.\n\n* opts(GIT_OPT_SET_SEARCH_PATH, int level, const char *path)\n\n > Set the search path for a level of config data. The search path > applied to shared attributes and ignore files, too. > > - `path` lists directories delimited by GIT_PATH_LIST_SEPARATOR. > Pass NULL to reset to the default (generally based on environment > variables). Use magic path `$PATH` to include the old value > of the path (if you want to prepend or append, for instance). > > - `level` must be `GIT_CONFIG_LEVEL_SYSTEM`, > `GIT_CONFIG_LEVEL_GLOBAL`, `GIT_CONFIG_LEVEL_XDG`, or > `GIT_CONFIG_LEVEL_PROGRAMDATA`.\n\n* opts(GIT_OPT_SET_CACHE_OBJECT_LIMIT, git_otype type, size_t size)\n\n > Set the maximum data size for the given type of object to be > considered eligible for caching in memory. Setting to value to > zero means that that type of object will not be cached. > Defaults to 0 for GIT_OBJ_BLOB (i.e. won't cache blobs) and 4k > for GIT_OBJ_COMMIT, GIT_OBJ_TREE, and GIT_OBJ_TAG.\n\n* opts(GIT_OPT_SET_CACHE_MAX_SIZE, ssize_t max_storage_bytes)\n\n > Set the maximum total data size that will be cached in memory > across all repositories before libgit2 starts evicting objects > from the cache. This is a soft limit, in that the library might > briefly exceed it, but will start aggressively evicting objects > from cache when that happens. The default cache size is 256MB.\n\n* opts(GIT_OPT_ENABLE_CACHING, int enabled)\n\n > Enable or disable caching completely. > > Because caches are repository-specific, disabling the cache > cannot immediately clear all cached objects, but each cache will > be cleared on the next attempt to update anything in it.\n\n* opts(GIT_OPT_GET_CACHED_MEMORY, ssize_t *current, ssize_t *allowed)\n\n > Get the current bytes in cache and the maximum that would be > allowed in the cache.\n\n* opts(GIT_OPT_GET_TEMPLATE_PATH, git_buf *out)\n\n > Get the default template path. > The path is written to the `out` buffer.\n\n* opts(GIT_OPT_SET_TEMPLATE_PATH, const char *path)\n\n > Set the default template path. > > - `path` directory of template.\n\n* opts(GIT_OPT_SET_SSL_CERT_LOCATIONS, const char *file, const char *path)\n\n > Set the SSL certificate-authority locations. > > - `file` is the location of a file containing several > certificates concatenated together. > - `path` is the location of a directory holding several > certificates, one per file. > > Either parameter may be `NULL`, but not both.\n\n* opts(GIT_OPT_SET_USER_AGENT, const char *user_agent)\n\n > Set the value of the User-Agent header. This value will be > appended to "git/1.0", for compatibility with other git clients. > > - `user_agent` is the value that will be delivered as the > User-Agent header on HTTP requests.\n\n* opts(GIT_OPT_SET_WINDOWS_SHAREMODE, unsigned long value)\n\n > Set the share mode used when opening files on Windows. > For more information, see the documentation for CreateFile. > The default is: FILE_SHARE_READ | FILE_SHARE_WRITE. This is > ignored and unused on non-Windows platforms.\n\n* opts(GIT_OPT_GET_WINDOWS_SHAREMODE, unsigned long *value)\n\n > Get the share mode used when opening files on Windows.\n\n* opts(GIT_OPT_ENABLE_STRICT_OBJECT_CREATION, int enabled)\n\n > Enable strict input validation when creating new objects > to ensure that all inputs to the new objects are valid. For > example, when this is enabled, the parent(s) and tree inputs > will be validated when creating a new commit. This defaults > to enabled.\n\n* opts(GIT_OPT_ENABLE_STRICT_SYMBOLIC_REF_CREATION, int enabled)\n\n > Validate the target of a symbolic ref when creating it. For > example, `foobar` is not a valid ref, therefore `foobar` is > not a valid target for a symbolic ref by default, whereas > `refs/heads/foobar` is. Disabling this bypasses validation > so that an arbitrary strings such as `foobar` can be used > for a symbolic ref target. This defaults to enabled.\n\n* opts(GIT_OPT_SET_SSL_CIPHERS, const char *ciphers)\n\n > Set the SSL ciphers use for HTTPS connections. > > - `ciphers` is the list of ciphers that are eanbled.\n\n* opts(GIT_OPT_ENABLE_OFS_DELTA, int enabled)\n\n > Enable or disable the use of "offset deltas" when creating packfiles, > and the negotiation of them when talking to a remote server. > Offset deltas store a delta base location as an offset into the > packfile from the current location, which provides a shorter encoding > and thus smaller resultant packfiles. > Packfiles containing offset deltas can still be read. > This defaults to enabled.\n\n* opts(GIT_OPT_ENABLE_FSYNC_GITDIR, int enabled)\n\n > Enable synchronized writes of files in the gitdir using `fsync` > (or the platform equivalent) to ensure that new object data > is written to permanent storage, not simply cached. This > defaults to disabled.\n\n opts(GIT_OPT_ENABLE_STRICT_HASH_VERIFICATION, int enabled)\n\n > Enable strict verification of object hashsums when reading > objects from disk. This may impact performance due to an > additional checksum calculation on each object. This defaults > to enabled.\n</code></pre>\n","group":"libgit2"},"git_config_entry_free":{"type":"function","file":"git2/config.h","line":75,"lineto":75,"args":[{"name":"","type":"git_config_entry *","comment":null}],"argline":"git_config_entry *","sig":"git_config_entry *","return":{"type":"void","comment":null},"description":"<p>Free a config entry</p>\n","comments":"","group":"config"},"git_config_find_global":{"type":"function","file":"git2/config.h","line":116,"lineto":116,"args":[{"name":"out","type":"git_buf *","comment":"Pointer to a user-allocated git_buf in which to store the path"}],"argline":"git_buf *out","sig":"git_buf *","return":{"type":"int","comment":" 0 if a global configuration file has been found. Its path will be stored in `out`."},"description":"<p>Locate the path to the global configuration file</p>\n","comments":"<p>The user or global configuration file is usually located in <code>$HOME/.gitconfig</code>.</p>\n\n<p>This method will try to guess the full path to that file, if the file exists. The returned path may be used on any <code>git_config</code> call to load the global configuration file.</p>\n\n<p>This method will not guess the path to the xdg compatible config file (.config/git/config).</p>\n","group":"config"},"git_config_find_xdg":{"type":"function","file":"git2/config.h","line":133,"lineto":133,"args":[{"name":"out","type":"git_buf *","comment":"Pointer to a user-allocated git_buf in which to store the path"}],"argline":"git_buf *out","sig":"git_buf *","return":{"type":"int","comment":" 0 if a xdg compatible configuration file has been\n\tfound. Its path will be stored in `out`."},"description":"<p>Locate the path to the global xdg compatible configuration file</p>\n","comments":"<p>The xdg compatible configuration file is usually located in <code>$HOME/.config/git/config</code>.</p>\n\n<p>This method will try to guess the full path to that file, if the file exists. The returned path may be used on any <code>git_config</code> call to load the xdg compatible configuration file.</p>\n","group":"config"},"git_config_find_system":{"type":"function","file":"git2/config.h","line":145,"lineto":145,"args":[{"name":"out","type":"git_buf *","comment":"Pointer to a user-allocated git_buf in which to store the path"}],"argline":"git_buf *out","sig":"git_buf *","return":{"type":"int","comment":" 0 if a system configuration file has been\n\tfound. Its path will be stored in `out`."},"description":"<p>Locate the path to the system configuration file</p>\n","comments":"<p>If /etc/gitconfig doesn't exist, it will look for %PROGRAMFILES%.</p>\n","group":"config"},"git_config_find_programdata":{"type":"function","file":"git2/config.h","line":156,"lineto":156,"args":[{"name":"out","type":"git_buf *","comment":"Pointer to a user-allocated git_buf in which to store the path"}],"argline":"git_buf *out","sig":"git_buf *","return":{"type":"int","comment":" 0 if a ProgramData configuration file has been\n\tfound. Its path will be stored in `out`."},"description":"<p>Locate the path to the configuration file in ProgramData</p>\n","comments":"<p>Look for the file in %PROGRAMDATA% used by portable git.</p>\n","group":"config"},"git_config_open_default":{"type":"function","file":"git2/config.h","line":168,"lineto":168,"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 and opens them into a single prioritized config object that can be used when accessing default config data outside a repository.</p>\n","group":"config"},"git_config_new":{"type":"function","file":"git2/config.h","line":179,"lineto":179,"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 can do anything with it.</p>\n","group":"config"},"git_config_add_file_ondisk":{"type":"function","file":"git2/config.h","line":208,"lineto":213,"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 to add"},{"name":"level","type":"git_config_level_t","comment":"the priority level of the backend"},{"name":"repo","type":"const git_repository *","comment":"optional repository to allow parsing of\n conditional includes"},{"name":"force","type":"int","comment":"replace config file at the given priority level"}],"argline":"git_config *cfg, const char *path, git_config_level_t level, const git_repository *repo, int force","sig":"git_config *::const char *::git_config_level_t::const git_repository *::int","return":{"type":"int","comment":" 0 on success, GIT_EEXISTS when adding more than one file\n for a given priority level (and force_replace set to 0),\n 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 parsed; it's expected to be a native Git config file following the default Git config syntax (see man git-config).</p>\n\n<p>If the file does not exist, the file will still be added and it will be created the first time we write to it.</p>\n\n<p>Note that the configuration object will free the file automatically.</p>\n\n<p>Further queries on this config object will access each of the config file instances in order (instances with a higher priority level will be accessed first).</p>\n","group":"config"},"git_config_open_ondisk":{"type":"function","file":"git2/config.h","line":227,"lineto":227,"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, 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 of calls: - git_config_new - git_config_add_file_ondisk</p>\n","group":"config","examples":{"general.c":["ex/v0.27.1/general.html#git_config_open_ondisk-26"]}},"git_config_open_level":{"type":"function","file":"git2/config.h","line":245,"lineto":248,"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":"git_config_level_t","comment":"Configuration level to search for"}],"argline":"git_config **out, const git_config *parent, git_config_level_t level","sig":"git_config **::const git_config *::git_config_level_t","return":{"type":"int","comment":" 0, GIT_ENOTFOUND if the passed level cannot be found in the\n 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 on a single specific level.</p>\n\n<p>Getting several times the same level from the same parent multi-level config will return different config instances, but containing the same config_file instance.</p>\n","group":"config"},"git_config_open_global":{"type":"function","file":"git2/config.h","line":262,"lineto":262,"args":[{"name":"out","type":"git_config **","comment":"pointer in which to store the config object"},{"name":"config","type":"git_config *","comment":"the config object in which to look"}],"argline":"git_config **out, git_config *config","sig":"git_config **::git_config *","return":{"type":"int","comment":null},"description":"<p>Open the global/XDG configuration file according to git's rules</p>\n","comments":"<p>Git allows you to store your global configuration at <code>$HOME/.config</code> or <code>$XDG_CONFIG_HOME/git/config</code>. For backwards compatability, the XDG file shouldn't be used unless the use has created it explicitly. With this function you'll open the correct one to write to.</p>\n","group":"config"},"git_config_snapshot":{"type":"function","file":"git2/config.h","line":278,"lineto":278,"args":[{"name":"out","type":"git_config **","comment":"pointer in which to store the snapshot config object"},{"name":"config","type":"git_config *","comment":"configuration to snapshot"}],"argline":"git_config **out, git_config *config","sig":"git_config **::git_config *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create a snapshot of the configuration</p>\n","comments":"<p>Create a snapshot of the current state of a configuration, which allows you to look into a consistent view of the configuration for looking up complex values (e.g. a remote, submodule).</p>\n\n<p>The string returned when querying such a config object is valid until it is freed.</p>\n","group":"config"},"git_config_free":{"type":"function","file":"git2/config.h","line":285,"lineto":285,"args":[{"name":"cfg","type":"git_config *","comment":"the configuration to free"}],"argline":"git_config *cfg","sig":"git_config *","return":{"type":"void","comment":null},"description":"<p>Free the configuration and its associated memory and files</p>\n","comments":"","group":"config","examples":{"general.c":["ex/v0.27.1/general.html#git_config_free-27","ex/v0.27.1/general.html#git_config_free-28"]}},"git_config_get_entry":{"type":"function","file":"git2/config.h","line":297,"lineto":300,"args":[{"name":"out","type":"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":"git_config_entry **out, const git_config *cfg, const char *name","sig":"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>Free the git_config_entry after use with <code>git_config_entry_free()</code>.</p>\n","group":"config"},"git_config_get_int32":{"type":"function","file":"git2/config.h","line":314,"lineto":314,"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 defined level. A higher level means a higher priority. The first occurrence of the variable will be returned here.</p>\n","group":"config","examples":{"general.c":["ex/v0.27.1/general.html#git_config_get_int32-29","ex/v0.27.1/general.html#git_config_get_int32-30"]}},"git_config_get_int64":{"type":"function","file":"git2/config.h","line":328,"lineto":328,"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 defined level. A higher level means a higher priority. The first occurrence of the variable will be returned here.</p>\n","group":"config"},"git_config_get_bool":{"type":"function","file":"git2/config.h","line":345,"lineto":345,"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 anything else true.</p>\n\n<p>All config files will be looked into, in the order of their defined level. A higher level means a higher priority. The first occurrence of the variable will be returned here.</p>\n","group":"config"},"git_config_get_path":{"type":"function","file":"git2/config.h","line":363,"lineto":363,"args":[{"name":"out","type":"git_buf *","comment":"the buffer in which to store the result"},{"name":"cfg","type":"const git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"}],"argline":"git_buf *out, const git_config *cfg, const char *name","sig":"git_buf *::const git_config *::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Get the value of a path config variable.</p>\n","comments":"<p>A leading '~' will be expanded to the global search path (which defaults to the user's home directory but can be overridden via <code>git_libgit2_opts()</code>.</p>\n\n<p>All config files will be looked into, in the order of their defined level. A higher level means a higher priority. The first occurrence of the variable will be returned here.</p>\n","group":"config"},"git_config_get_string":{"type":"function","file":"git2/config.h","line":381,"lineto":381,"args":[{"name":"out","type":"const char **","comment":"pointer to the string"},{"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>This function can only be used on snapshot config objects. The string is owned by the config and should not be freed by the user. The pointer will be valid until the config is freed.</p>\n\n<p>All config files will be looked into, in the order of their defined level. A higher level means a higher priority. The first occurrence of the variable will be returned here.</p>\n","group":"config","examples":{"general.c":["ex/v0.27.1/general.html#git_config_get_string-31","ex/v0.27.1/general.html#git_config_get_string-32"]}},"git_config_get_string_buf":{"type":"function","file":"git2/config.h","line":397,"lineto":397,"args":[{"name":"out","type":"git_buf *","comment":"buffer in which to store the string"},{"name":"cfg","type":"const git_config *","comment":"where to look for the variable"},{"name":"name","type":"const char *","comment":"the variable's name"}],"argline":"git_buf *out, const git_config *cfg, const char *name","sig":"git_buf *::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 value of the config will be copied into the buffer.</p>\n\n<p>All config files will be looked into, in the order of their defined level. A higher level means a higher priority. The first occurrence of the variable will be returned here.</p>\n","group":"config"},"git_config_get_multivar_foreach":{"type":"function","file":"git2/config.h","line":415,"lineto":415,"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\n interested in. Use NULL to indicate all"},{"name":"callback","type":"git_config_foreach_cb","comment":"the function to be called on each value of the variable"},{"name":"payload","type":"void *","comment":"opaque pointer to pass to the callback"}],"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","comment":null},"description":"<p>Get each value of a multivar in a foreach callback</p>\n","comments":"<p>The callback will be called on each variable found</p>\n\n<p>The regular expression is applied case-sensitively on the normalized form of the variable name: the section and variable parts are lower-cased. The subsection is left unchanged.</p>\n","group":"config"},"git_config_multivar_iterator_new":{"type":"function","file":"git2/config.h","line":430,"lineto":430,"args":[{"name":"out","type":"git_config_iterator **","comment":"pointer to store the iterator"},{"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\n interested in. Use NULL to indicate all"}],"argline":"git_config_iterator **out, const git_config *cfg, const char *name, const char *regexp","sig":"git_config_iterator **::const git_config *::const char *::const char *","return":{"type":"int","comment":null},"description":"<p>Get each value of a multivar</p>\n","comments":"<p>The regular expression is applied case-sensitively on the normalized form of the variable name: the section and variable parts are lower-cased. The subsection is left unchanged.</p>\n","group":"config"},"git_config_next":{"type":"function","file":"git2/config.h","line":442,"lineto":442,"args":[{"name":"entry","type":"git_config_entry **","comment":"pointer to store the entry"},{"name":"iter","type":"git_config_iterator *","comment":"the iterator"}],"argline":"git_config_entry **entry, git_config_iterator *iter","sig":"git_config_entry **::git_config_iterator *","return":{"type":"int","comment":" 0 or an error code. GIT_ITEROVER if the iteration has completed"},"description":"<p>Return the current entry and advance the iterator</p>\n","comments":"<p>The pointers returned by this function are valid until the iterator is freed.</p>\n","group":"config"},"git_config_iterator_free":{"type":"function","file":"git2/config.h","line":449,"lineto":449,"args":[{"name":"iter","type":"git_config_iterator *","comment":"the iterator to free"}],"argline":"git_config_iterator *iter","sig":"git_config_iterator *","return":{"type":"void","comment":null},"description":"<p>Free a config iterator</p>\n","comments":"","group":"config"},"git_config_set_int32":{"type":"function","file":"git2/config.h","line":460,"lineto":460,"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\n with the highest level (usually the local one).</p>\n","comments":"","group":"config"},"git_config_set_int64":{"type":"function","file":"git2/config.h","line":471,"lineto":471,"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\n with the highest level (usually the local one).</p>\n","comments":"","group":"config"},"git_config_set_bool":{"type":"function","file":"git2/config.h","line":482,"lineto":482,"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\n with the highest level (usually the local one).</p>\n","comments":"","group":"config"},"git_config_set_string":{"type":"function","file":"git2/config.h","line":496,"lineto":496,"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\n with 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 afterwards.</p>\n","group":"config"},"git_config_set_multivar":{"type":"function","file":"git2/config.h","line":508,"lineto":508,"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","comment":null},"description":"<p>Set a multivar in the local config file.</p>\n","comments":"<p>The regular expression is applied case-sensitively on the value.</p>\n","group":"config"},"git_config_delete_entry":{"type":"function","file":"git2/config.h","line":517,"lineto":517,"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","comment":null},"description":"<p>Delete a config variable from the config file\n with the highest level (usually the local one).</p>\n","comments":"","group":"config"},"git_config_delete_multivar":{"type":"function","file":"git2/config.h","line":530,"lineto":530,"args":[{"name":"cfg","type":"git_config *","comment":"where to look for the variables"},{"name":"name","type":"const char *","comment":"the variable's name"},{"name":"regexp","type":"const char *","comment":"a regular expression to indicate which values to delete"}],"argline":"git_config *cfg, const char *name, const char *regexp","sig":"git_config *::const char *::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Deletes one or several entries from a multivar in the local config file.</p>\n","comments":"<p>The regular expression is applied case-sensitively on the value.</p>\n","group":"config"},"git_config_foreach":{"type":"function","file":"git2/config.h","line":548,"lineto":551,"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, git_config_foreach_cb callback, void *payload","sig":"const git_config *::git_config_foreach_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, 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 in the config backend, and the data pointer passed to this function. If the callback returns a non-zero value, the function stops iterating and returns that value to the caller.</p>\n\n<p>The pointers passed to the callback are only valid as long as the iteration is ongoing.</p>\n","group":"config"},"git_config_iterator_new":{"type":"function","file":"git2/config.h","line":562,"lineto":562,"args":[{"name":"out","type":"git_config_iterator **","comment":"pointer to store the iterator"},{"name":"cfg","type":"const git_config *","comment":"where to ge the variables from"}],"argline":"git_config_iterator **out, const git_config *cfg","sig":"git_config_iterator **::const git_config *","return":{"type":"int","comment":null},"description":"<p>Iterate over all the config variables</p>\n","comments":"<p>Use <code>git_config_next</code> to advance the iteration and <code>git_config_iterator_free</code> when done.</p>\n","group":"config"},"git_config_iterator_glob_new":{"type":"function","file":"git2/config.h","line":578,"lineto":578,"args":[{"name":"out","type":"git_config_iterator **","comment":"pointer to store the iterator"},{"name":"cfg","type":"const git_config *","comment":"where to ge the variables from"},{"name":"regexp","type":"const char *","comment":"regular expression to match the names"}],"argline":"git_config_iterator **out, const git_config *cfg, const char *regexp","sig":"git_config_iterator **::const git_config *::const char *","return":{"type":"int","comment":null},"description":"<p>Iterate over all the config variables whose name matches a pattern</p>\n","comments":"<p>Use <code>git_config_next</code> to advance the iteration and <code>git_config_iterator_free</code> when done.</p>\n\n<p>The regular expression is applied case-sensitively on the normalized form of the variable name: the section and variable parts are lower-cased. The subsection is left unchanged.</p>\n","group":"config"},"git_config_foreach_match":{"type":"function","file":"git2/config.h","line":600,"lineto":604,"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, const char *regexp, git_config_foreach_cb callback, void *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 regular expression that filters which config keys are passed to the callback.</p>\n\n<p>The regular expression is applied case-sensitively on the normalized form of the variable name: the section and variable parts are lower-cased. The subsection is left unchanged.</p>\n\n<p>The regular expression is applied case-sensitively on the normalized form of the variable name: the case-insensitive parts are lower-case.</p>\n","group":"config"},"git_config_get_mapped":{"type":"function","file":"git2/config.h","line":640,"lineto":645,"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, const git_config *cfg, const char *name, const git_cvar_map *maps, 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\n an integer constant.</p>\n","comments":"<p>This is a helper method to easily map different possible values to a variable to integer constants that easily identify them.</p>\n\n<p>A mapping array looks as follows:</p>\n\n<pre><code>git_cvar_map autocrlf_mapping[] = { {GIT_CVAR_FALSE, NULL, GIT_AUTO_CRLF_FALSE}, {GIT_CVAR_TRUE, NULL, GIT_AUTO_CRLF_TRUE}, {GIT_CVAR_STRING, "input", GIT_AUTO_CRLF_INPUT}, {GIT_CVAR_STRING, "default", GIT_AUTO_CRLF_DEFAULT}};\n</code></pre>\n\n<p>On any "false" value for the variable (e.g. "false", "FALSE", "no"), the mapping will store <code>GIT_AUTO_CRLF_FALSE</code> in the <code>out</code> parameter.</p>\n\n<p>The same thing applies for any "true" value such as "true", "yes" or "1", storing the <code>GIT_AUTO_CRLF_TRUE</code> variable.</p>\n\n<p>Otherwise, if the value matches the string "input" (with case insensitive comparison), the given constant will be stored in <code>out</code>, and likewise for "default".</p>\n\n<p>If not a single match can be made to store in <code>out</code>, an error code will be returned.</p>\n","group":"config"},"git_config_lookup_map_value":{"type":"function","file":"git2/config.h","line":655,"lineto":659,"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, const git_cvar_map *maps, size_t map_n, const char *value","sig":"int *::const git_cvar_map *::size_t::const char *","return":{"type":"int","comment":null},"description":"<p>Maps a string value to an integer constant</p>\n","comments":"","group":"config"},"git_config_parse_bool":{"type":"function","file":"git2/config.h","line":671,"lineto":671,"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","comment":null},"description":"<p>Parse a string value as a bool.</p>\n","comments":"<p>Valid values for true are: 'true', 'yes', 'on', 1 or any number different from 0 Valid values for false are: 'false', 'no', 'off', 0</p>\n","group":"config"},"git_config_parse_int32":{"type":"function","file":"git2/config.h","line":683,"lineto":683,"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","comment":null},"description":"<p>Parse a string value as an int32.</p>\n","comments":"<p>An optional value suffix of 'k', 'm', or 'g' will cause the value to be multiplied by 1024, 1048576, or 1073741824 prior to output.</p>\n","group":"config"},"git_config_parse_int64":{"type":"function","file":"git2/config.h","line":695,"lineto":695,"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","comment":null},"description":"<p>Parse a string value as an int64.</p>\n","comments":"<p>An optional value suffix of 'k', 'm', or 'g' will cause the value to be multiplied by 1024, 1048576, or 1073741824 prior to output.</p>\n","group":"config"},"git_config_parse_path":{"type":"function","file":"git2/config.h","line":710,"lineto":710,"args":[{"name":"out","type":"git_buf *","comment":"placae to store the result of parsing"},{"name":"value","type":"const char *","comment":"the path to evaluate"}],"argline":"git_buf *out, const char *value","sig":"git_buf *::const char *","return":{"type":"int","comment":null},"description":"<p>Parse a string value as a path.</p>\n","comments":"<p>A leading '~' will be expanded to the global search path (which defaults to the user's home directory but can be overridden via <code>git_libgit2_opts()</code>.</p>\n\n<p>If the value does not begin with a tilde, the input will be returned.</p>\n","group":"config"},"git_config_backend_foreach_match":{"type":"function","file":"git2/config.h","line":728,"lineto":732,"args":[{"name":"backend","type":"git_config_backend *","comment":"where to get the variables from"},{"name":"regexp","type":"const char *","comment":"regular expression to match against config names (can be NULL)"},{"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":"git_config_backend *backend, const char *regexp, git_config_foreach_cb callback, void *payload","sig":"git_config_backend *::const char *::git_config_foreach_cb::void *","return":{"type":"int","comment":null},"description":"<p>Perform an operation on each config variable in given config backend\n matching a regular expression.</p>\n","comments":"<p>This behaviors like <code>git_config_foreach_match</code> except instead of all config entries it just enumerates through the given backend entry.</p>\n\n<p>The regular expression is applied case-sensitively on the normalized form of the variable name: the section and variable parts are lower-cased. The subsection is left unchanged.</p>\n","group":"config"},"git_config_lock":{"type":"function","file":"git2/config.h","line":751,"lineto":751,"args":[{"name":"tx","type":"git_transaction **","comment":"the resulting transaction, use this to commit or undo the\n changes"},{"name":"cfg","type":"git_config *","comment":"the configuration in which to lock"}],"argline":"git_transaction **tx, git_config *cfg","sig":"git_transaction **::git_config *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Lock the backend with the highest priority</p>\n","comments":"<p>Locking disallows anybody else from writing to that backend. Any updates made after locking will not be visible to a reader until the file is unlocked.</p>\n\n<p>You can apply the changes by calling <code>git_transaction_commit()</code> before freeing the transaction. Either of these actions will unlock the config.</p>\n","group":"config"},"git_cred_userpass":{"type":"function","file":"git2/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 *","comment":"The username that was embedded in a \"user\n@\nhost\"\n remote url, or NULL if not included."},{"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\n interpreted as a `git_cred_userpass_payload*`.)"}],"argline":"git_cred **cred, const char *url, const char *user_from_url, unsigned int allowed_types, void *payload","sig":"git_cred **::const char *::const char *::unsigned int::void *","return":{"type":"int","comment":null},"description":"<p>Stock callback usable as a git_cred_acquire_cb. This calls\n git_cred_userpass_plaintext_new unless the protocol has not specified\n <code>GIT_CREDTYPE_USERPASS_PLAINTEXT</code> as an allowed type.</p>\n","comments":"","group":"cred"},"git_describe_commit":{"type":"function","file":"git2/describe.h","line":123,"lineto":126,"args":[{"name":"result","type":"git_describe_result **","comment":"pointer to store the result. You must free this once\n you're done with it."},{"name":"committish","type":"git_object *","comment":"a committish to describe"},{"name":"opts","type":"git_describe_options *","comment":"the lookup options"}],"argline":"git_describe_result **result, git_object *committish, git_describe_options *opts","sig":"git_describe_result **::git_object *::git_describe_options *","return":{"type":"int","comment":null},"description":"<p>Describe a commit</p>\n","comments":"<p>Perform the describe operation on the given committish object.</p>\n","group":"describe","examples":{"describe.c":["ex/v0.27.1/describe.html#git_describe_commit-1"]}},"git_describe_workdir":{"type":"function","file":"git2/describe.h","line":140,"lineto":143,"args":[{"name":"out","type":"git_describe_result **","comment":"pointer to store the result. You must free this once\n you're done with it."},{"name":"repo","type":"git_repository *","comment":"the repository in which to perform the describe"},{"name":"opts","type":"git_describe_options *","comment":"the lookup options"}],"argline":"git_describe_result **out, git_repository *repo, git_describe_options *opts","sig":"git_describe_result **::git_repository *::git_describe_options *","return":{"type":"int","comment":null},"description":"<p>Describe a commit</p>\n","comments":"<p>Perform the describe operation on the current commit and the worktree. After peforming describe on HEAD, a status is run and the description is considered to be dirty if there are.</p>\n","group":"describe","examples":{"describe.c":["ex/v0.27.1/describe.html#git_describe_workdir-2"]}},"git_describe_format":{"type":"function","file":"git2/describe.h","line":153,"lineto":156,"args":[{"name":"out","type":"git_buf *","comment":"The buffer to store the result"},{"name":"result","type":"const git_describe_result *","comment":"the result from `git_describe_commit()` or\n `git_describe_workdir()`."},{"name":"opts","type":"const git_describe_format_options *","comment":"the formatting options"}],"argline":"git_buf *out, const git_describe_result *result, const git_describe_format_options *opts","sig":"git_buf *::const git_describe_result *::const git_describe_format_options *","return":{"type":"int","comment":null},"description":"<p>Print the describe result to a buffer</p>\n","comments":"","group":"describe","examples":{"describe.c":["ex/v0.27.1/describe.html#git_describe_format-3"]}},"git_describe_result_free":{"type":"function","file":"git2/describe.h","line":161,"lineto":161,"args":[{"name":"result","type":"git_describe_result *","comment":null}],"argline":"git_describe_result *result","sig":"git_describe_result *","return":{"type":"void","comment":null},"description":"<p>Free the describe result.</p>\n","comments":"","group":"describe"},"git_diff_init_options":{"type":"function","file":"git2/diff.h","line":447,"lineto":449,"args":[{"name":"opts","type":"git_diff_options *","comment":"The `git_diff_options` struct to initialize"},{"name":"version","type":"unsigned int","comment":"Version of struct; pass `GIT_DIFF_OPTIONS_VERSION`"}],"argline":"git_diff_options *opts, unsigned int version","sig":"git_diff_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_diff_options</code> with default values. Equivalent to\n creating an instance with GIT_DIFF_OPTIONS_INIT.</p>\n","comments":"","group":"diff"},"git_diff_find_init_options":{"type":"function","file":"git2/diff.h","line":742,"lineto":744,"args":[{"name":"opts","type":"git_diff_find_options *","comment":"The `git_diff_find_options` struct to initialize"},{"name":"version","type":"unsigned int","comment":"Version of struct; pass `GIT_DIFF_FIND_OPTIONS_VERSION`"}],"argline":"git_diff_find_options *opts, unsigned int version","sig":"git_diff_find_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_diff_find_options</code> with default values. Equivalent to\n creating an instance with GIT_DIFF_FIND_OPTIONS_INIT.</p>\n","comments":"","group":"diff"},"git_diff_free":{"type":"function","file":"git2/diff.h","line":758,"lineto":758,"args":[{"name":"diff","type":"git_diff *","comment":"The previously created diff; cannot be used after free."}],"argline":"git_diff *diff","sig":"git_diff *","return":{"type":"void","comment":null},"description":"<p>Deallocate a diff.</p>\n","comments":"","group":"diff","examples":{"diff.c":["ex/v0.27.1/diff.html#git_diff_free-2"],"log.c":["ex/v0.27.1/log.html#git_diff_free-25","ex/v0.27.1/log.html#git_diff_free-26"]}},"git_diff_tree_to_tree":{"type":"function","file":"git2/diff.h","line":776,"lineto":781,"args":[{"name":"diff","type":"git_diff **","comment":"Output pointer to a git_diff 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, or NULL for empty tree."},{"name":"new_tree","type":"git_tree *","comment":"A git_tree object to diff to, or NULL for empty tree."},{"name":"opts","type":"const git_diff_options *","comment":"Structure with options to influence diff or NULL for defaults."}],"argline":"git_diff **diff, git_repository *repo, git_tree *old_tree, git_tree *new_tree, const git_diff_options *opts","sig":"git_diff **::git_repository *::git_tree *::git_tree *::const git_diff_options *","return":{"type":"int","comment":null},"description":"<p>Create a diff with the difference between two tree objects.</p>\n","comments":"<p>This is equivalent to <code>git diff <old-tree> <new-tree></code></p>\n\n<p>The first tree will be used for the "old_file" side of the delta and the second tree will be used for the "new_file" side of the delta. You can pass NULL to indicate an empty tree, although it is an error to pass NULL for both the <code>old_tree</code> and <code>new_tree</code>.</p>\n","group":"diff","examples":{"diff.c":["ex/v0.27.1/diff.html#git_diff_tree_to_tree-3"],"log.c":["ex/v0.27.1/log.html#git_diff_tree_to_tree-27","ex/v0.27.1/log.html#git_diff_tree_to_tree-28"]}},"git_diff_tree_to_index":{"type":"function","file":"git2/diff.h","line":802,"lineto":807,"args":[{"name":"diff","type":"git_diff **","comment":"Output pointer to a git_diff 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, or NULL for empty tree."},{"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 **diff, git_repository *repo, git_tree *old_tree, git_index *index, const git_diff_options *opts","sig":"git_diff **::git_repository *::git_tree *::git_index *::const git_diff_options *","return":{"type":"int","comment":null},"description":"<p>Create a diff between a tree and repository index.</p>\n","comments":"<p>This is equivalent to <code>git diff --cached <treeish></code> or if you pass the HEAD tree, then like <code>git diff --cached</code>.</p>\n\n<p>The tree you pass will be used for the "old_file" side of the delta, and the index will be used for the "new_file" side of the delta.</p>\n\n<p>If you pass NULL for the index, then the existing index of the <code>repo</code> will be used. In this case, the index will be refreshed from disk (if it has changed) before the diff is generated.</p>\n","group":"diff","examples":{"diff.c":["ex/v0.27.1/diff.html#git_diff_tree_to_index-4"]}},"git_diff_index_to_workdir":{"type":"function","file":"git2/diff.h","line":829,"lineto":833,"args":[{"name":"diff","type":"git_diff **","comment":"Output pointer to a git_diff 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 **diff, git_repository *repo, git_index *index, const git_diff_options *opts","sig":"git_diff **::git_repository *::git_index *::const git_diff_options *","return":{"type":"int","comment":null},"description":"<p>Create a diff 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 <code>git_diff_tree_to_workdir</code> for a discussion of the difference between <code>git diff</code> and <code>git diff HEAD</code> and how to emulate a <code>git diff <treeish></code> using libgit2.</p>\n\n<p>The index will be used for the "old_file" side of the delta, and the working directory will be used for the "new_file" side of the delta.</p>\n\n<p>If you pass NULL for the index, then the existing index of the <code>repo</code> will be used. In this case, the index will be refreshed from disk (if it has changed) before the diff is generated.</p>\n","group":"diff","examples":{"diff.c":["ex/v0.27.1/diff.html#git_diff_index_to_workdir-5"]}},"git_diff_tree_to_workdir":{"type":"function","file":"git2/diff.h","line":858,"lineto":862,"args":[{"name":"diff","type":"git_diff **","comment":"A pointer to a git_diff 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, or NULL for empty tree."},{"name":"opts","type":"const git_diff_options *","comment":"Structure with options to influence diff or NULL for defaults."}],"argline":"git_diff **diff, git_repository *repo, git_tree *old_tree, const git_diff_options *opts","sig":"git_diff **::git_repository *::git_tree *::const git_diff_options *","return":{"type":"int","comment":null},"description":"<p>Create a diff between a tree and the working directory.</p>\n","comments":"<p>The tree you provide will be used for the "old_file" side of the delta, and the working directory will be used for the "new_file" side.</p>\n\n<p>This is not the same as <code>git diff <treeish></code> or <code>git diff-index <treeish></code>. Those commands use information from the index, whereas this function strictly returns the differences between the tree and the files in the working directory, regardless of the state of the index. Use <code>git_diff_tree_to_workdir_with_index</code> to emulate those commands.</p>\n\n<p>To see difference between this and <code>git_diff_tree_to_workdir_with_index</code>, consider the example of a staged file deletion where the file has then been put back into the working dir and further modified. The tree-to-workdir diff for that file is 'modified', but <code>git diff</code> would show status 'deleted' since there is a staged delete.</p>\n","group":"diff","examples":{"diff.c":["ex/v0.27.1/diff.html#git_diff_tree_to_workdir-6"]}},"git_diff_tree_to_workdir_with_index":{"type":"function","file":"git2/diff.h","line":877,"lineto":881,"args":[{"name":"diff","type":"git_diff **","comment":"A pointer to a git_diff 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, or NULL for empty tree."},{"name":"opts","type":"const git_diff_options *","comment":"Structure with options to influence diff or NULL for defaults."}],"argline":"git_diff **diff, git_repository *repo, git_tree *old_tree, const git_diff_options *opts","sig":"git_diff **::git_repository *::git_tree *::const git_diff_options *","return":{"type":"int","comment":null},"description":"<p>Create a diff between a tree and the working directory using index data\n to account for staged deletes, tracked files, etc.</p>\n","comments":"<p>This emulates <code>git diff <tree></code> by diffing the tree to the index and the index to the working directory and blending the results into a single diff that includes staged deleted, etc.</p>\n","group":"diff","examples":{"diff.c":["ex/v0.27.1/diff.html#git_diff_tree_to_workdir_with_index-7"]}},"git_diff_index_to_index":{"type":"function","file":"git2/diff.h","line":895,"lineto":900,"args":[{"name":"diff","type":"git_diff **","comment":"Output pointer to a git_diff pointer to be allocated."},{"name":"repo","type":"git_repository *","comment":"The repository containing the indexes."},{"name":"old_index","type":"git_index *","comment":"A git_index object to diff from."},{"name":"new_index","type":"git_index *","comment":"A git_index 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 **diff, git_repository *repo, git_index *old_index, git_index *new_index, const git_diff_options *opts","sig":"git_diff **::git_repository *::git_index *::git_index *::const git_diff_options *","return":{"type":"int","comment":null},"description":"<p>Create a diff with the difference between two index objects.</p>\n","comments":"<p>The first index will be used for the "old_file" side of the delta and the second index will be used for the "new_file" side of the delta.</p>\n","group":"diff"},"git_diff_merge":{"type":"function","file":"git2/diff.h","line":915,"lineto":917,"args":[{"name":"onto","type":"git_diff *","comment":"Diff to merge into."},{"name":"from","type":"const git_diff *","comment":"Diff to merge."}],"argline":"git_diff *onto, const git_diff *from","sig":"git_diff *::const git_diff *","return":{"type":"int","comment":null},"description":"<p>Merge one diff into another.</p>\n","comments":"<p>This merges items from the "from" list into the "onto" list. The resulting diff will have all items that appear in either list. If an item appears in both lists, then it will be "merged" to appear as if the old version was from the "onto" list and the new version is from the "from" list (with the exception that if the item has a pending DELETE in the middle, then it will show as deleted).</p>\n","group":"diff"},"git_diff_find_similar":{"type":"function","file":"git2/diff.h","line":931,"lineto":933,"args":[{"name":"diff","type":"git_diff *","comment":"diff to run detection algorithms on"},{"name":"options","type":"const git_diff_find_options *","comment":"Control how detection should be run, NULL for defaults"}],"argline":"git_diff *diff, const git_diff_find_options *options","sig":"git_diff *::const git_diff_find_options *","return":{"type":"int","comment":" 0 on success, -1 on failure"},"description":"<p>Transform a diff marking file renames, copies, etc.</p>\n","comments":"<p>This modifies a diff in place, replacing old entries that look like renames or copies with new entries reflecting those changes. This also will, if requested, break modified files into add/remove pairs if the amount of change is above a threshold.</p>\n","group":"diff","examples":{"diff.c":["ex/v0.27.1/diff.html#git_diff_find_similar-8"]}},"git_diff_num_deltas":{"type":"function","file":"git2/diff.h","line":951,"lineto":951,"args":[{"name":"diff","type":"const git_diff *","comment":"A git_diff generated by one of the above functions"}],"argline":"const git_diff *diff","sig":"const git_diff *","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.</p>\n","comments":"","group":"diff","examples":{"log.c":["ex/v0.27.1/log.html#git_diff_num_deltas-29"]}},"git_diff_num_deltas_of_type":{"type":"function","file":"git2/diff.h","line":964,"lineto":965,"args":[{"name":"diff","type":"const git_diff *","comment":"A git_diff generated by one of the above functions"},{"name":"type","type":"git_delta_t","comment":"A git_delta_t value to filter the count"}],"argline":"const git_diff *diff, git_delta_t type","sig":"const git_diff *::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 filtered by type.</p>\n","comments":"<p>This works just like <code>git_diff_entrycount()</code> with an extra parameter that is a <code>git_delta_t</code> and returns just the count of how many deltas match that particular type.</p>\n","group":"diff"},"git_diff_get_delta":{"type":"function","file":"git2/diff.h","line":984,"lineto":985,"args":[{"name":"diff","type":"const git_diff *","comment":"Diff list object"},{"name":"idx","type":"size_t","comment":"Index into diff list"}],"argline":"const git_diff *diff, size_t idx","sig":"const git_diff *::size_t","return":{"type":"const git_diff_delta *","comment":" Pointer to git_diff_delta (or NULL if `idx` out of range)"},"description":"<p>Return the diff delta for an entry in the diff list.</p>\n","comments":"<p>The <code>git_diff_delta</code> pointer points to internal data and you do not have to release it when you are done with it. It will go away when the * <code>git_diff</code> (or any associated <code>git_patch</code>) goes away.</p>\n\n<p>Note that the flags on the delta related to whether it has binary content or not may not be set if there are no attributes set for the file and there has been no reason to load the file data at this point. For now, if you need those flags to be up to date, your only option is to either use <code>git_diff_foreach</code> or create a <code>git_patch</code>.</p>\n","group":"diff"},"git_diff_is_sorted_icase":{"type":"function","file":"git2/diff.h","line":993,"lineto":993,"args":[{"name":"diff","type":"const git_diff *","comment":"diff to check"}],"argline":"const git_diff *diff","sig":"const git_diff *","return":{"type":"int","comment":" 0 if case sensitive, 1 if case is ignored"},"description":"<p>Check if deltas are sorted case sensitively or insensitively.</p>\n","comments":"","group":"diff"},"git_diff_foreach":{"type":"function","file":"git2/diff.h","line":1021,"lineto":1027,"args":[{"name":"diff","type":"git_diff *","comment":"A git_diff 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":"binary_cb","type":"git_diff_binary_cb","comment":"Optional callback to make for binary files."},{"name":"hunk_cb","type":"git_diff_hunk_cb","comment":"Optional callback to make per hunk of text diff. This\n callback is called to describe a range of lines in the\n diff. It will not be issued for binary files."},{"name":"line_cb","type":"git_diff_line_cb","comment":"Optional callback to make per line of diff text. This\n same callback will be made for context lines, added, and\n 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 *diff, git_diff_file_cb file_cb, git_diff_binary_cb binary_cb, git_diff_hunk_cb hunk_cb, git_diff_line_cb line_cb, void *payload","sig":"git_diff *::git_diff_file_cb::git_diff_binary_cb::git_diff_hunk_cb::git_diff_line_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, or error code"},"description":"<p>Loop over all deltas in a diff issuing callbacks.</p>\n","comments":"<p>This will iterate through all of the files described in a diff. You should provide a file callback to learn about each file.</p>\n\n<p>The "hunk" and "line" callbacks are optional, and the text diff of the files will only be calculated if they are not NULL. Of course, these callbacks will not be invoked for binary files on the diff or for files whose only changed is a file mode change.</p>\n\n<p>Returning a non-zero value from any of the callbacks will terminate the iteration and return the value to the user.</p>\n","group":"diff"},"git_diff_status_char":{"type":"function","file":"git2/diff.h","line":1040,"lineto":1040,"args":[{"name":"status","type":"git_delta_t","comment":"The git_delta_t value to look up"}],"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 run <code>git diff --name-status</code> it uses single letter codes in the output such as 'A' for added, 'D' for deleted, 'M' for modified, etc. This function converts a git_delta_t value into these letters for your own purposes. GIT_DELTA_UNTRACKED will return a space (i.e. ' ').</p>\n","group":"diff"},"git_diff_print":{"type":"function","file":"git2/diff.h","line":1065,"lineto":1069,"args":[{"name":"diff","type":"git_diff *","comment":"A git_diff generated by one of the above functions."},{"name":"format","type":"git_diff_format_t","comment":"A git_diff_format_t value to pick the text format."},{"name":"print_cb","type":"git_diff_line_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 *diff, git_diff_format_t format, git_diff_line_cb print_cb, void *payload","sig":"git_diff *::git_diff_format_t::git_diff_line_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, or error code"},"description":"<p>Iterate over a diff generating formatted text output.</p>\n","comments":"<p>Returning a non-zero value from the callbacks will terminate the iteration and return the non-zero value to the caller.</p>\n","group":"diff","examples":{"diff.c":["ex/v0.27.1/diff.html#git_diff_print-9"],"log.c":["ex/v0.27.1/log.html#git_diff_print-30"]}},"git_diff_to_buf":{"type":"function","file":"git2/diff.h","line":1081,"lineto":1084,"args":[{"name":"out","type":"git_buf *","comment":"A pointer to a user-allocated git_buf that will\n contain the diff text"},{"name":"diff","type":"git_diff *","comment":"A git_diff generated by one of the above functions."},{"name":"format","type":"git_diff_format_t","comment":"A git_diff_format_t value to pick the text format."}],"argline":"git_buf *out, git_diff *diff, git_diff_format_t format","sig":"git_buf *::git_diff *::git_diff_format_t","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Produce the complete formatted text output from a diff into a\n buffer.</p>\n","comments":"","group":"diff"},"git_diff_blobs":{"type":"function","file":"git2/diff.h","line":1121,"lineto":1131,"args":[{"name":"old_blob","type":"const git_blob *","comment":"Blob for old side of diff, or NULL for empty blob"},{"name":"old_as_path","type":"const char *","comment":"Treat old blob as if it had this filename; can be NULL"},{"name":"new_blob","type":"const git_blob *","comment":"Blob for new side of diff, or NULL for empty blob"},{"name":"new_as_path","type":"const char *","comment":"Treat new blob as if it had this filename; can be NULL"},{"name":"options","type":"const git_diff_options *","comment":"Options for diff, or NULL for default options"},{"name":"file_cb","type":"git_diff_file_cb","comment":"Callback for \"file\"; made once if there is a diff; can be NULL"},{"name":"binary_cb","type":"git_diff_binary_cb","comment":"Callback for binary files; can be NULL"},{"name":"hunk_cb","type":"git_diff_hunk_cb","comment":"Callback for each hunk in diff; can be NULL"},{"name":"line_cb","type":"git_diff_line_cb","comment":"Callback for each line in diff; can be NULL"},{"name":"payload","type":"void *","comment":"Payload passed to each callback function"}],"argline":"const git_blob *old_blob, const char *old_as_path, const git_blob *new_blob, const char *new_as_path, const git_diff_options *options, git_diff_file_cb file_cb, git_diff_binary_cb binary_cb, git_diff_hunk_cb hunk_cb, git_diff_line_cb line_cb, void *payload","sig":"const git_blob *::const char *::const git_blob *::const char *::const git_diff_options *::git_diff_file_cb::git_diff_binary_cb::git_diff_hunk_cb::git_diff_line_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, 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, the <code>git_diff_file</code> given to the callback will have some fake data; i.e. <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 as an empty blob, with the <code>oid</code> set to NULL in the <code>git_diff_file</code> data. Passing 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 looks like binary data, the <code>git_diff_delta</code> binary attribute will be set to 1 and no call to the hunk_cb nor line_cb will be made (unless you pass <code>GIT_DIFF_FORCE_TEXT</code> of course).</p>\n","group":"diff"},"git_diff_blob_to_buffer":{"type":"function","file":"git2/diff.h","line":1158,"lineto":1169,"args":[{"name":"old_blob","type":"const git_blob *","comment":"Blob for old side of diff, or NULL for empty blob"},{"name":"old_as_path","type":"const char *","comment":"Treat old blob as if it had this filename; can be NULL"},{"name":"buffer","type":"const char *","comment":"Raw data for new side of diff, or NULL for empty"},{"name":"buffer_len","type":"size_t","comment":"Length of raw data for new side of diff"},{"name":"buffer_as_path","type":"const char *","comment":"Treat buffer as if it had this filename; can be NULL"},{"name":"options","type":"const git_diff_options *","comment":"Options for diff, or NULL for default options"},{"name":"file_cb","type":"git_diff_file_cb","comment":"Callback for \"file\"; made once if there is a diff; can be NULL"},{"name":"binary_cb","type":"git_diff_binary_cb","comment":"Callback for binary files; can be NULL"},{"name":"hunk_cb","type":"git_diff_hunk_cb","comment":"Callback for each hunk in diff; can be NULL"},{"name":"line_cb","type":"git_diff_line_cb","comment":"Callback for each line in diff; can be NULL"},{"name":"payload","type":"void *","comment":"Payload passed to each callback function"}],"argline":"const git_blob *old_blob, const char *old_as_path, const char *buffer, size_t buffer_len, const char *buffer_as_path, const git_diff_options *options, git_diff_file_cb file_cb, git_diff_binary_cb binary_cb, git_diff_hunk_cb hunk_cb, git_diff_line_cb line_cb, void *payload","sig":"const git_blob *::const char *::const char *::size_t::const char *::const git_diff_options *::git_diff_file_cb::git_diff_binary_cb::git_diff_hunk_cb::git_diff_line_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, 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, so the <code>git_diff_file</code> parameters to the callbacks will be faked a la the rules 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 <code>file_cb</code> will be invoked with GIT_DELTA_ADDED and the diff will be the entire content of the buffer added). Passing NULL to the buffer will do the reverse, with GIT_DELTA_REMOVED and blob content removed.</p>\n","group":"diff"},"git_diff_buffers":{"type":"function","file":"git2/diff.h","line":1192,"lineto":1204,"args":[{"name":"old_buffer","type":"const void *","comment":"Raw data for old side of diff, or NULL for empty"},{"name":"old_len","type":"size_t","comment":"Length of the raw data for old side of the diff"},{"name":"old_as_path","type":"const char *","comment":"Treat old buffer as if it had this filename; can be NULL"},{"name":"new_buffer","type":"const void *","comment":"Raw data for new side of diff, or NULL for empty"},{"name":"new_len","type":"size_t","comment":"Length of raw data for new side of diff"},{"name":"new_as_path","type":"const char *","comment":"Treat buffer as if it had this filename; can be NULL"},{"name":"options","type":"const git_diff_options *","comment":"Options for diff, or NULL for default options"},{"name":"file_cb","type":"git_diff_file_cb","comment":"Callback for \"file\"; made once if there is a diff; can be NULL"},{"name":"binary_cb","type":"git_diff_binary_cb","comment":"Callback for binary files; can be NULL"},{"name":"hunk_cb","type":"git_diff_hunk_cb","comment":"Callback for each hunk in diff; can be NULL"},{"name":"line_cb","type":"git_diff_line_cb","comment":"Callback for each line in diff; can be NULL"},{"name":"payload","type":"void *","comment":"Payload passed to each callback function"}],"argline":"const void *old_buffer, size_t old_len, const char *old_as_path, const void *new_buffer, size_t new_len, const char *new_as_path, const git_diff_options *options, git_diff_file_cb file_cb, git_diff_binary_cb binary_cb, git_diff_hunk_cb hunk_cb, git_diff_line_cb line_cb, void *payload","sig":"const void *::size_t::const char *::const void *::size_t::const char *::const git_diff_options *::git_diff_file_cb::git_diff_binary_cb::git_diff_hunk_cb::git_diff_line_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, or error code"},"description":"<p>Directly run a diff between two buffers.</p>\n","comments":"<p>Even more than with <code>git_diff_blobs</code>, comparing two buffer lacks context, so the <code>git_diff_file</code> parameters to the callbacks will be faked a la the rules for <code>git_diff_blobs()</code>.</p>\n","group":"diff"},"git_diff_from_buffer":{"type":"function","file":"git2/diff.h","line":1225,"lineto":1228,"args":[{"name":"out","type":"git_diff **","comment":"A pointer to a git_diff pointer that will be allocated."},{"name":"content","type":"const char *","comment":"The contents of a patch file"},{"name":"content_len","type":"size_t","comment":"The length of the patch file contents"}],"argline":"git_diff **out, const char *content, size_t content_len","sig":"git_diff **::const char *::size_t","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Read the contents of a git patch file into a <code>git_diff</code> object.</p>\n","comments":"<p>The diff object produced is similar to the one that would be produced if you actually produced it computationally by comparing two trees, however there may be subtle differences. For example, a patch file likely contains abbreviated object IDs, so the object IDs in a <code>git_diff_delta</code> produced by this function will also be abbreviated.</p>\n\n<p>This function will only read patch files created by a git implementation, it will not read unified diffs produced by the <code>diff</code> program, nor any other types of patch files.</p>\n","group":"diff"},"git_diff_get_stats":{"type":"function","file":"git2/diff.h","line":1264,"lineto":1266,"args":[{"name":"out","type":"git_diff_stats **","comment":"Structure containg the diff statistics."},{"name":"diff","type":"git_diff *","comment":"A git_diff generated by one of the above functions."}],"argline":"git_diff_stats **out, git_diff *diff","sig":"git_diff_stats **::git_diff *","return":{"type":"int","comment":" 0 on success; non-zero on error"},"description":"<p>Accumulate diff statistics for all patches.</p>\n","comments":"","group":"diff","examples":{"diff.c":["ex/v0.27.1/diff.html#git_diff_get_stats-10"]}},"git_diff_stats_files_changed":{"type":"function","file":"git2/diff.h","line":1274,"lineto":1275,"args":[{"name":"stats","type":"const git_diff_stats *","comment":"A `git_diff_stats` generated by one of the above functions."}],"argline":"const git_diff_stats *stats","sig":"const git_diff_stats *","return":{"type":"size_t","comment":" total number of files changed in the diff"},"description":"<p>Get the total number of files changed in a diff</p>\n","comments":"","group":"diff"},"git_diff_stats_insertions":{"type":"function","file":"git2/diff.h","line":1283,"lineto":1284,"args":[{"name":"stats","type":"const git_diff_stats *","comment":"A `git_diff_stats` generated by one of the above functions."}],"argline":"const git_diff_stats *stats","sig":"const git_diff_stats *","return":{"type":"size_t","comment":" total number of insertions in the diff"},"description":"<p>Get the total number of insertions in a diff</p>\n","comments":"","group":"diff"},"git_diff_stats_deletions":{"type":"function","file":"git2/diff.h","line":1292,"lineto":1293,"args":[{"name":"stats","type":"const git_diff_stats *","comment":"A `git_diff_stats` generated by one of the above functions."}],"argline":"const git_diff_stats *stats","sig":"const git_diff_stats *","return":{"type":"size_t","comment":" total number of deletions in the diff"},"description":"<p>Get the total number of deletions in a diff</p>\n","comments":"","group":"diff"},"git_diff_stats_to_buf":{"type":"function","file":"git2/diff.h","line":1304,"lineto":1308,"args":[{"name":"out","type":"git_buf *","comment":"buffer to store the formatted diff statistics in."},{"name":"stats","type":"const git_diff_stats *","comment":"A `git_diff_stats` generated by one of the above functions."},{"name":"format","type":"git_diff_stats_format_t","comment":"Formatting option."},{"name":"width","type":"size_t","comment":"Target width for output (only affects GIT_DIFF_STATS_FULL)"}],"argline":"git_buf *out, const git_diff_stats *stats, git_diff_stats_format_t format, size_t width","sig":"git_buf *::const git_diff_stats *::git_diff_stats_format_t::size_t","return":{"type":"int","comment":" 0 on success; non-zero on error"},"description":"<p>Print diff statistics to a <code>git_buf</code>.</p>\n","comments":"","group":"diff","examples":{"diff.c":["ex/v0.27.1/diff.html#git_diff_stats_to_buf-11"]}},"git_diff_stats_free":{"type":"function","file":"git2/diff.h","line":1316,"lineto":1316,"args":[{"name":"stats","type":"git_diff_stats *","comment":"The previously created statistics object;\n cannot be used after free."}],"argline":"git_diff_stats *stats","sig":"git_diff_stats *","return":{"type":"void","comment":null},"description":"<p>Deallocate a <code>git_diff_stats</code>.</p>\n","comments":"","group":"diff","examples":{"diff.c":["ex/v0.27.1/diff.html#git_diff_stats_free-12"]}},"git_diff_format_email":{"type":"function","file":"git2/diff.h","line":1368,"lineto":1371,"args":[{"name":"out","type":"git_buf *","comment":"buffer to store the e-mail patch in"},{"name":"diff","type":"git_diff *","comment":"containing the commit"},{"name":"opts","type":"const git_diff_format_email_options *","comment":"structure with options to influence content and formatting."}],"argline":"git_buf *out, git_diff *diff, const git_diff_format_email_options *opts","sig":"git_buf *::git_diff *::const git_diff_format_email_options *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create an e-mail ready patch from a diff.</p>\n","comments":"","group":"diff"},"git_diff_commit_as_email":{"type":"function","file":"git2/diff.h","line":1387,"lineto":1394,"args":[{"name":"out","type":"git_buf *","comment":"buffer to store the e-mail patch in"},{"name":"repo","type":"git_repository *","comment":"containing the commit"},{"name":"commit","type":"git_commit *","comment":"pointer to up commit"},{"name":"patch_no","type":"size_t","comment":"patch number of the commit"},{"name":"total_patches","type":"size_t","comment":"total number of patches in the patch set"},{"name":"flags","type":"git_diff_format_email_flags_t","comment":"determines the formatting of the e-mail"},{"name":"diff_opts","type":"const git_diff_options *","comment":"structure with options to influence diff or NULL for defaults."}],"argline":"git_buf *out, git_repository *repo, git_commit *commit, size_t patch_no, size_t total_patches, git_diff_format_email_flags_t flags, const git_diff_options *diff_opts","sig":"git_buf *::git_repository *::git_commit *::size_t::size_t::git_diff_format_email_flags_t::const git_diff_options *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create an e-mail ready patch for a commit.</p>\n","comments":"<p>Does not support creating patches for merge commits (yet).</p>\n","group":"diff"},"git_diff_format_email_init_options":{"type":"function","file":"git2/diff.h","line":1405,"lineto":1407,"args":[{"name":"opts","type":"git_diff_format_email_options *","comment":"The `git_diff_format_email_options` struct to initialize"},{"name":"version","type":"unsigned int","comment":"Version of struct; pass `GIT_DIFF_FORMAT_EMAIL_OPTIONS_VERSION`"}],"argline":"git_diff_format_email_options *opts, unsigned int version","sig":"git_diff_format_email_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_diff_format_email_options</code> with default values.</p>\n","comments":"<p>Equivalent to creating an instance with GIT_DIFF_FORMAT_EMAIL_OPTIONS_INIT.</p>\n","group":"diff"},"git_diff_patchid_init_options":{"type":"function","file":"git2/diff.h","line":1428,"lineto":1430,"args":[{"name":"opts","type":"git_diff_patchid_options *","comment":null},{"name":"version","type":"unsigned int","comment":null}],"argline":"git_diff_patchid_options *opts, unsigned int version","sig":"git_diff_patchid_options *::unsigned int","return":{"type":"int","comment":null},"description":"<p>Initialize <code>git_diff_patchid_options</code> structure.</p>\n","comments":"<p>Initializes the structure with default values. Equivalent to creating an instance with <code>GIT_DIFF_PATCHID_OPTIONS_INIT</code>.</p>\n","group":"diff"},"git_diff_patchid":{"type":"function","file":"git2/diff.h","line":1452,"lineto":1452,"args":[{"name":"out","type":"git_oid *","comment":"Pointer where the calculated patch ID shoul be\n stored"},{"name":"diff","type":"git_diff *","comment":"The diff to calculate the ID for"},{"name":"opts","type":"git_diff_patchid_options *","comment":"Options for how to calculate the patch ID. This is\n intended for future changes, as currently no options are\n available."}],"argline":"git_oid *out, git_diff *diff, git_diff_patchid_options *opts","sig":"git_oid *::git_diff *::git_diff_patchid_options *","return":{"type":"int","comment":" 0 on success, an error code otherwise."},"description":"<p>Calculate the patch ID for the given patch.</p>\n","comments":"<p>Calculate a stable patch ID for the given patch by summing the hash of the file diffs, ignoring whitespace and line numbers. This can be used to derive whether two diffs are the same with a high probability.</p>\n\n<p>Currently, this function only calculates stable patch IDs, as defined in git-patch-id(1), and should in fact generate the same IDs as the upstream git project does.</p>\n","group":"diff"},"giterr_last":{"type":"function","file":"git2/errors.h","line":115,"lineto":115,"args":[],"argline":"","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\n current thread or NULL if no error has occurred.</p>\n","comments":"","group":"giterr","examples":{"general.c":["ex/v0.27.1/general.html#giterr_last-33"],"merge.c":["ex/v0.27.1/merge.html#giterr_last-10","ex/v0.27.1/merge.html#giterr_last-11"],"network/clone.c":["ex/v0.27.1/network/clone.html#giterr_last-2"]}},"giterr_clear":{"type":"function","file":"git2/errors.h","line":120,"lineto":120,"args":[],"argline":"","sig":"","return":{"type":"void","comment":null},"description":"<p>Clear the last library error that occurred for this thread.</p>\n","comments":"","group":"giterr"},"giterr_set_str":{"type":"function","file":"git2/errors.h","line":138,"lineto":138,"args":[{"name":"error_class","type":"int","comment":"One of the `git_error_t` enum above describing the\n general subsystem that is responsible for the error."},{"name":"string","type":"const char *","comment":"The formatted error message to keep"}],"argline":"int error_class, const char *string","sig":"int::const char *","return":{"type":"void","comment":null},"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 relay an error message through libgit2. Most regular users of libgit2 will never need to call this function -- actually, calling it in most circumstances (for example, calling from within a callback function) will 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 to the particular thread that this libgit2 call is made from.</p>\n","group":"giterr"},"giterr_set_oom":{"type":"function","file":"git2/errors.h","line":149,"lineto":149,"args":[],"argline":"","sig":"","return":{"type":"void","comment":null},"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 that is passed in. This is not a good idea when the error in question is a memory allocation failure. That circumstance has a special setter function that sets the error string to a known and statically allocated internal value.</p>\n","group":"giterr"},"git_filter_list_load":{"type":"function","file":"git2/filter.h","line":90,"lineto":96,"args":[{"name":"filters","type":"git_filter_list **","comment":"Output newly created git_filter_list (or NULL)"},{"name":"repo","type":"git_repository *","comment":"Repository object that contains `path`"},{"name":"blob","type":"git_blob *","comment":"The blob to which the filter will be applied (if known)"},{"name":"path","type":"const char *","comment":"Relative path of the file to be filtered"},{"name":"mode","type":"git_filter_mode_t","comment":"Filtering direction (WT->ODB or ODB->WT)"},{"name":"flags","type":"uint32_t","comment":"Combination of `git_filter_flag_t` flags"}],"argline":"git_filter_list **filters, git_repository *repo, git_blob *blob, const char *path, git_filter_mode_t mode, uint32_t flags","sig":"git_filter_list **::git_repository *::git_blob *::const char *::git_filter_mode_t::uint32_t","return":{"type":"int","comment":" 0 on success (which could still return NULL if no filters are\n needed for the requested file), \n<\n0 on error"},"description":"<p>Load the filter list for a given path.</p>\n","comments":"<p>This will return 0 (success) but set the output git_filter_list to NULL if no filters are requested for the given file.</p>\n","group":"filter"},"git_filter_list_contains":{"type":"function","file":"git2/filter.h","line":110,"lineto":112,"args":[{"name":"filters","type":"git_filter_list *","comment":"A loaded git_filter_list (or NULL)"},{"name":"name","type":"const char *","comment":"The name of the filter to query"}],"argline":"git_filter_list *filters, const char *name","sig":"git_filter_list *::const char *","return":{"type":"int","comment":" 1 if the filter is in the list, 0 otherwise"},"description":"<p>Query the filter list to see if a given filter (by name) will run.\n The built-in filters "crlf" and "ident" can be queried, otherwise this\n is the name of the filter specified by the filter attribute.</p>\n","comments":"<p>This will return 0 if the given filter is not in the list, or 1 if the filter will be applied.</p>\n","group":"filter"},"git_filter_list_apply_to_data":{"type":"function","file":"git2/filter.h","line":134,"lineto":137,"args":[{"name":"out","type":"git_buf *","comment":"Buffer to store the result of the filtering"},{"name":"filters","type":"git_filter_list *","comment":"A loaded git_filter_list (or NULL)"},{"name":"in","type":"git_buf *","comment":"Buffer containing the data to filter"}],"argline":"git_buf *out, git_filter_list *filters, git_buf *in","sig":"git_buf *::git_filter_list *::git_buf *","return":{"type":"int","comment":" 0 on success, an error code otherwise"},"description":"<p>Apply filter list to a data buffer.</p>\n","comments":"<p>See <code>git2/buffer.h</code> for background on <code>git_buf</code> objects.</p>\n\n<p>If the <code>in</code> buffer holds data allocated by libgit2 (i.e. <code>in->asize</code> is not zero), then it will be overwritten when applying the filters. If not, then it will be left untouched.</p>\n\n<p>If there are no filters to apply (or <code>filters</code> is NULL), then the <code>out</code> buffer will reference the <code>in</code> buffer data (with <code>asize</code> set to zero) instead of allocating data. This keeps allocations to a minimum, but it means you have to be careful about freeing the <code>in</code> data since <code>out</code> may be pointing to it!</p>\n","group":"filter"},"git_filter_list_apply_to_file":{"type":"function","file":"git2/filter.h","line":148,"lineto":152,"args":[{"name":"out","type":"git_buf *","comment":"buffer into which to store the filtered file"},{"name":"filters","type":"git_filter_list *","comment":"the list of filters to apply"},{"name":"repo","type":"git_repository *","comment":"the repository in which to perform the filtering"},{"name":"path","type":"const char *","comment":"the path of the file to filter, a relative path will be\n taken as relative to the workdir"}],"argline":"git_buf *out, git_filter_list *filters, git_repository *repo, const char *path","sig":"git_buf *::git_filter_list *::git_repository *::const char *","return":{"type":"int","comment":null},"description":"<p>Apply a filter list to the contents of a file on disk</p>\n","comments":"","group":"filter"},"git_filter_list_apply_to_blob":{"type":"function","file":"git2/filter.h","line":161,"lineto":164,"args":[{"name":"out","type":"git_buf *","comment":"buffer into which to store the filtered file"},{"name":"filters","type":"git_filter_list *","comment":"the list of filters to apply"},{"name":"blob","type":"git_blob *","comment":"the blob to filter"}],"argline":"git_buf *out, git_filter_list *filters, git_blob *blob","sig":"git_buf *::git_filter_list *::git_blob *","return":{"type":"int","comment":null},"description":"<p>Apply a filter list to the contents of a blob</p>\n","comments":"","group":"filter"},"git_filter_list_stream_data":{"type":"function","file":"git2/filter.h","line":173,"lineto":176,"args":[{"name":"filters","type":"git_filter_list *","comment":"the list of filters to apply"},{"name":"data","type":"git_buf *","comment":"the buffer to filter"},{"name":"target","type":"git_writestream *","comment":"the stream into which the data will be written"}],"argline":"git_filter_list *filters, git_buf *data, git_writestream *target","sig":"git_filter_list *::git_buf *::git_writestream *","return":{"type":"int","comment":null},"description":"<p>Apply a filter list to an arbitrary buffer as a stream</p>\n","comments":"","group":"filter"},"git_filter_list_stream_file":{"type":"function","file":"git2/filter.h","line":187,"lineto":191,"args":[{"name":"filters","type":"git_filter_list *","comment":"the list of filters to apply"},{"name":"repo","type":"git_repository *","comment":"the repository in which to perform the filtering"},{"name":"path","type":"const char *","comment":"the path of the file to filter, a relative path will be\n taken as relative to the workdir"},{"name":"target","type":"git_writestream *","comment":"the stream into which the data will be written"}],"argline":"git_filter_list *filters, git_repository *repo, const char *path, git_writestream *target","sig":"git_filter_list *::git_repository *::const char *::git_writestream *","return":{"type":"int","comment":null},"description":"<p>Apply a filter list to a file as a stream</p>\n","comments":"","group":"filter"},"git_filter_list_stream_blob":{"type":"function","file":"git2/filter.h","line":200,"lineto":203,"args":[{"name":"filters","type":"git_filter_list *","comment":"the list of filters to apply"},{"name":"blob","type":"git_blob *","comment":"the blob to filter"},{"name":"target","type":"git_writestream *","comment":"the stream into which the data will be written"}],"argline":"git_filter_list *filters, git_blob *blob, git_writestream *target","sig":"git_filter_list *::git_blob *::git_writestream *","return":{"type":"int","comment":null},"description":"<p>Apply a filter list to a blob as a stream</p>\n","comments":"","group":"filter"},"git_filter_list_free":{"type":"function","file":"git2/filter.h","line":210,"lineto":210,"args":[{"name":"filters","type":"git_filter_list *","comment":"A git_filter_list created by `git_filter_list_load`"}],"argline":"git_filter_list *filters","sig":"git_filter_list *","return":{"type":"void","comment":null},"description":"<p>Free a git_filter_list</p>\n","comments":"","group":"filter"},"git_libgit2_init":{"type":"function","file":"git2/global.h","line":26,"lineto":26,"args":[],"argline":"","sig":"","return":{"type":"int","comment":" the number of initializations of the library, or an error code."},"description":"<p>Init the global state</p>\n","comments":"<p>This function must be called before any other libgit2 function in order to set up global state and threading.</p>\n\n<p>This function may be called multiple times - it will return the number of times the initialization has been called (including this one) that have not subsequently been shutdown.</p>\n","group":"libgit2","examples":{"blame.c":["ex/v0.27.1/blame.html#git_libgit2_init-8"],"cat-file.c":["ex/v0.27.1/cat-file.html#git_libgit2_init-10"],"describe.c":["ex/v0.27.1/describe.html#git_libgit2_init-4"],"diff.c":["ex/v0.27.1/diff.html#git_libgit2_init-13"],"general.c":["ex/v0.27.1/general.html#git_libgit2_init-34"],"init.c":["ex/v0.27.1/init.html#git_libgit2_init-2"],"log.c":["ex/v0.27.1/log.html#git_libgit2_init-31"],"merge.c":["ex/v0.27.1/merge.html#git_libgit2_init-12"],"remote.c":["ex/v0.27.1/remote.html#git_libgit2_init-2"],"rev-parse.c":["ex/v0.27.1/rev-parse.html#git_libgit2_init-1"],"status.c":["ex/v0.27.1/status.html#git_libgit2_init-1"],"tag.c":["ex/v0.27.1/tag.html#git_libgit2_init-3"]}},"git_libgit2_shutdown":{"type":"function","file":"git2/global.h","line":39,"lineto":39,"args":[],"argline":"","sig":"","return":{"type":"int","comment":" the number of remaining initializations of the library, or an\n error code."},"description":"<p>Shutdown the global state</p>\n","comments":"<p>Clean up the global state and threading context after calling it as many times as <code>git_libgit2_init()</code> was called - it will return the number of remainining initializations that have not been shutdown (after this one).</p>\n","group":"libgit2","examples":{"blame.c":["ex/v0.27.1/blame.html#git_libgit2_shutdown-9"],"cat-file.c":["ex/v0.27.1/cat-file.html#git_libgit2_shutdown-11"],"describe.c":["ex/v0.27.1/describe.html#git_libgit2_shutdown-5"],"diff.c":["ex/v0.27.1/diff.html#git_libgit2_shutdown-14"],"init.c":["ex/v0.27.1/init.html#git_libgit2_shutdown-3"],"log.c":["ex/v0.27.1/log.html#git_libgit2_shutdown-32"],"merge.c":["ex/v0.27.1/merge.html#git_libgit2_shutdown-13"],"remote.c":["ex/v0.27.1/remote.html#git_libgit2_shutdown-3"],"rev-parse.c":["ex/v0.27.1/rev-parse.html#git_libgit2_shutdown-2"],"status.c":["ex/v0.27.1/status.html#git_libgit2_shutdown-2"],"tag.c":["ex/v0.27.1/tag.html#git_libgit2_shutdown-4"]}},"git_graph_ahead_behind":{"type":"function","file":"git2/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","comment":null},"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 upstream relationship, but it helps to think of one as a branch and the other as its upstream, the <code>ahead</code> and <code>behind</code> values will be what git would report for the branches.</p>\n","group":"graph"},"git_graph_descendant_of":{"type":"function","file":"git2/graph.h","line":51,"lineto":54,"args":[{"name":"repo","type":"git_repository *","comment":null},{"name":"commit","type":"const git_oid *","comment":"a previously loaded commit."},{"name":"ancestor","type":"const git_oid *","comment":"a potential ancestor commit."}],"argline":"git_repository *repo, const git_oid *commit, const git_oid *ancestor","sig":"git_repository *::const git_oid *::const git_oid *","return":{"type":"int","comment":" 1 if the given commit is a descendant of the potential ancestor,\n 0 if not, error code otherwise."},"description":"<p>Determine if a commit is the descendant of another commit.</p>\n","comments":"<p>Note that a commit is not considered a descendant of itself, in contrast to <code>git merge-base --is-ancestor</code>.</p>\n","group":"graph"},"git_ignore_add_rule":{"type":"function","file":"git2/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.\n It is okay to have multiple rules in the text; if so,\n each rule should be terminated with a newline."}],"argline":"git_repository *repo, const 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 .gitignore files in the repository tree or from a shared system file only if a "core.excludesfile" config value is set. The library also keeps a set of per-repository internal ignores that can be configured in-memory and will not persist. This function allows you to add to that internal rules list.</p>\n\n<p>Example usage:</p>\n\n<pre><code> error = git_ignore_add_rule(myrepo, "*.c/ with space");\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":"git2/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 rules in .gitignore files that actually exist in the filesystem.</p>\n\n<p>The default internal ignores ignore ".", ".." and ".git" entries.</p>\n","group":"ignore"},"git_ignore_path_is_ignored":{"type":"function","file":"git2/ignore.h","line":71,"lineto":74,"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, git_repository *repo, const char *path","sig":"int *::git_repository *::const char *","return":{"type":"int","comment":" 0 if ignore rules could be processed for the file (regardless\n of whether it exists or not), or an error \n<\n 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 given file. This indicates if the file would be ignored regardless of whether 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 "git add ." on the directory containing the file, would it be added or not?</p>\n","group":"ignore"},"git_index_open":{"type":"function","file":"git2/index.h","line":203,"lineto":203,"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\n of the Git index file in 'index_path', without a repository\n to back it.</p>\n","comments":"<p>Since there is no ODB or working directory behind this index, any Index methods which rely on these (e.g. index_add_bypath) will fail with the GIT_ERROR error code.</p>\n\n<p>If you need to access the index of an actual repository, use the <code>git_repository_index</code> wrapper.</p>\n\n<p>The index must be freed once it's no longer in use.</p>\n","group":"index"},"git_index_new":{"type":"function","file":"git2/index.h","line":216,"lineto":216,"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, but may be used to perform in-memory index operations.</p>\n\n<p>The index must be freed once it's no longer in use.</p>\n","group":"index"},"git_index_free":{"type":"function","file":"git2/index.h","line":223,"lineto":223,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"void","comment":null},"description":"<p>Free an existing index object.</p>\n","comments":"","group":"index","examples":{"general.c":["ex/v0.27.1/general.html#git_index_free-35"],"init.c":["ex/v0.27.1/init.html#git_index_free-4"]}},"git_index_owner":{"type":"function","file":"git2/index.h","line":231,"lineto":231,"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":"git2/index.h","line":239,"lineto":239,"args":[{"name":"index","type":"const git_index *","comment":"An existing index object"}],"argline":"const git_index *index","sig":"const git_index *","return":{"type":"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":"git2/index.h","line":252,"lineto":252,"args":[{"name":"index","type":"git_index *","comment":"An existing index object"},{"name":"caps","type":"int","comment":"A combination of GIT_INDEXCAP values"}],"argline":"git_index *index, int caps","sig":"git_index *::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 capabilities will be read from the config of the owner object, looking at <code>core.ignorecase</code>, <code>core.filemode</code>, <code>core.symlinks</code>.</p>\n","group":"index"},"git_index_version":{"type":"function","file":"git2/index.h","line":264,"lineto":264,"args":[{"name":"index","type":"git_index *","comment":"An existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"unsigned int","comment":" the index version"},"description":"<p>Get index on-disk version.</p>\n","comments":"<p>Valid return values are 2, 3, or 4. If 3 is returned, an index with version 2 may be written instead, if the extension data in version 3 is not necessary.</p>\n","group":"index"},"git_index_set_version":{"type":"function","file":"git2/index.h","line":277,"lineto":277,"args":[{"name":"index","type":"git_index *","comment":"An existing index object"},{"name":"version","type":"unsigned int","comment":"The new version number"}],"argline":"git_index *index, unsigned int version","sig":"git_index *::unsigned int","return":{"type":"int","comment":" 0 on success, -1 on failure"},"description":"<p>Set index on-disk version.</p>\n","comments":"<p>Valid values are 2, 3, or 4. If 2 is given, git_index_write may write an index with version 3 instead, if necessary to accurately represent the index.</p>\n","group":"index"},"git_index_read":{"type":"function","file":"git2/index.h","line":296,"lineto":296,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"force","type":"int","comment":"if true, always reload, vs. only read if file has changed"}],"argline":"git_index *index, int force","sig":"git_index *::int","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Update the contents of an existing index object in memory by reading\n from the hard disk.</p>\n","comments":"<p>If <code>force</code> is true, this performs a "hard" read that discards in-memory changes and always reloads the on-disk index data. If there is no on-disk version, the index will be cleared.</p>\n\n<p>If <code>force</code> is false, this does a "soft" read that reloads the index data from disk only if it has changed since the last time it was loaded. Purely in-memory index data will be untouched. Be aware: if there are changes on disk, unwritten in-memory changes are discarded.</p>\n","group":"index"},"git_index_write":{"type":"function","file":"git2/index.h","line":305,"lineto":305,"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\n using an atomic file lock.</p>\n","comments":"","group":"index"},"git_index_path":{"type":"function","file":"git2/index.h","line":313,"lineto":313,"args":[{"name":"index","type":"const git_index *","comment":"an existing index object"}],"argline":"const git_index *index","sig":"const git_index *","return":{"type":"const char *","comment":" path to index file or NULL for in-memory index"},"description":"<p>Get the full path to the index file on disk.</p>\n","comments":"","group":"index"},"git_index_checksum":{"type":"function","file":"git2/index.h","line":325,"lineto":325,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"const git_oid *","comment":" a pointer to the checksum of the index"},"description":"<p>Get the checksum of the index</p>\n","comments":"<p>This checksum is the SHA-1 hash over the index file (except the last 20 bytes which are the checksum itself). In cases where the index does not exist on-disk, it will be zeroed out.</p>\n","group":"index"},"git_index_read_tree":{"type":"function","file":"git2/index.h","line":336,"lineto":336,"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":"git2/index.h","line":357,"lineto":357,"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\n 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 of its current state back to disk; it recursively creates tree objects for each of the subtrees stored in the index, but only returns the OID of the root tree. This is the OID that can be used e.g. to create a commit.</p>\n\n<p>The index instance cannot be bare, and needs to be associated to an existing repository.</p>\n\n<p>The index must not contain any file in conflict.</p>\n","group":"index","examples":{"init.c":["ex/v0.27.1/init.html#git_index_write_tree-5"],"merge.c":["ex/v0.27.1/merge.html#git_index_write_tree-14"]}},"git_index_write_tree_to":{"type":"function","file":"git2/index.h","line":374,"lineto":374,"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\n 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 letting the user choose the repository where the tree will be written.</p>\n\n<p>The index must not contain any file in conflict.</p>\n","group":"index"},"git_index_entrycount":{"type":"function","file":"git2/index.h","line":393,"lineto":393,"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.27.1/general.html#git_index_entrycount-36"]}},"git_index_clear":{"type":"function","file":"git2/index.h","line":404,"lineto":404,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"}],"argline":"git_index *index","sig":"git_index *","return":{"type":"int","comment":" 0 on success, error code \n<\n 0 on failure"},"description":"<p>Clear the contents (all the entries) of an index object.</p>\n","comments":"<p>This clears the index object in memory; changes must be explicitly written to disk for them to take effect persistently.</p>\n","group":"index"},"git_index_get_byindex":{"type":"function","file":"git2/index.h","line":417,"lineto":418,"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 entry is not modifiable and should not be freed. Because the <code>git_index_entry</code> struct is a publicly defined struct, you should be able to make your own permanent copy of the data if necessary.</p>\n","group":"index","examples":{"general.c":["ex/v0.27.1/general.html#git_index_get_byindex-37"]}},"git_index_get_bypath":{"type":"function","file":"git2/index.h","line":432,"lineto":433,"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 entry is not modifiable and should not be freed. Because the <code>git_index_entry</code> struct is a publicly defined struct, you should be able to make your own permanent copy of the data if necessary.</p>\n","group":"index"},"git_index_remove":{"type":"function","file":"git2/index.h","line":443,"lineto":443,"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":"git2/index.h","line":453,"lineto":454,"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":"git2/index.h","line":470,"lineto":470,"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 as the given 'source_entry', it will be replaced. Otherwise, the 'source_entry' will be added.</p>\n\n<p>A full copy (including the 'path' string) of the given 'source_entry' will be inserted on the index.</p>\n","group":"index"},"git_index_entry_stage":{"type":"function","file":"git2/index.h","line":482,"lineto":482,"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","comment":" the stage number"},"description":"<p>Return the stage number from a git index entry</p>\n","comments":"<p>This entry is calculated from the entry's flag attribute like this:</p>\n\n<pre><code>(entry->flags & GIT_IDXENTRY_STAGEMASK) >> GIT_IDXENTRY_STAGESHIFT\n</code></pre>\n","group":"index"},"git_index_entry_is_conflict":{"type":"function","file":"git2/index.h","line":491,"lineto":491,"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","comment":" 1 if the entry is a conflict entry, 0 otherwise"},"description":"<p>Return whether the given index entry is a conflict (has a high stage\n entry). This is simply shorthand for <code>git_index_entry_stage > 0</code>.</p>\n","comments":"","group":"index"},"git_index_add_bypath":{"type":"function","file":"git2/index.h","line":522,"lineto":522,"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's working 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 at gitignore rules. Those rules can be evaluated through the 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 file will no longer be marked as conflicting. The data about the conflict will be moved to the "resolve undo" (REUC) section.</p>\n","group":"index"},"git_index_add_frombuffer":{"type":"function","file":"git2/index.h","line":551,"lineto":554,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"entry","type":"const git_index_entry *","comment":"filename to add"},{"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_index *index, const git_index_entry *entry, const void *buffer, size_t len","sig":"git_index *::const git_index_entry *::const void *::size_t","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Add or update an index entry from a buffer in memory</p>\n","comments":"<p>This method will create a blob in the repository that owns the index and then add the index entry to the index. The <code>path</code> of the entry represents the position of the blob relative to the repository's root folder.</p>\n\n<p>If a previous index entry exists that has the same path as the given 'entry', it will be replaced. Otherwise, the 'entry' will be added. The <code>id</code> and the <code>file_size</code> of the 'entry' are updated with the real value of the blob.</p>\n\n<p>This forces the file to be added to the index, not looking at gitignore rules. Those rules can be evaluated through the 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 file will no longer be marked as conflicting. The data about the conflict will be moved to the "resolve undo" (REUC) section.</p>\n","group":"index"},"git_index_remove_bypath":{"type":"function","file":"git2/index.h","line":570,"lineto":570,"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's working folder. It may exist.</p>\n\n<p>If this file currently is the result of a merge conflict, this file will no longer be marked as conflicting. The data about the conflict will be moved to the "resolve undo" (REUC) section.</p>\n","group":"index"},"git_index_add_all":{"type":"function","file":"git2/index.h","line":618,"lineto":623,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"pathspec","type":"const git_strarray *","comment":"array of path patterns"},{"name":"flags","type":"unsigned int","comment":"combination of git_index_add_option_t flags"},{"name":"callback","type":"git_index_matched_path_cb","comment":"notification callback for each added/updated path (also\n gets index of matching pathspec entry); can be NULL;\n return 0 to add, >0 to skip, \n<\n0 to abort scan."},{"name":"payload","type":"void *","comment":"payload passed through to callback function"}],"argline":"git_index *index, const git_strarray *pathspec, unsigned int flags, git_index_matched_path_cb callback, void *payload","sig":"git_index *::const git_strarray *::unsigned int::git_index_matched_path_cb::void *","return":{"type":"int","comment":" 0 on success, negative callback return value, or error code"},"description":"<p>Add or update index entries matching files in the working directory.</p>\n","comments":"<p>This method will fail in bare index instances.</p>\n\n<p>The <code>pathspec</code> is a list of file names or shell glob patterns that will be matched against files in the repository's working directory. Each file that matches will be added to the index (either updating an existing entry or adding a new entry). You can disable glob expansion and force exact matching with the <code>GIT_INDEX_ADD_DISABLE_PATHSPEC_MATCH</code> flag.</p>\n\n<p>Files that are ignored will be skipped (unlike <code>git_index_add_bypath</code>). If a file is already tracked in the index, then it <em>will</em> be updated even if it is ignored. Pass the <code>GIT_INDEX_ADD_FORCE</code> flag to skip the checking of ignore rules.</p>\n\n<p>To emulate <code>git add -A</code> and generate an error if the pathspec contains the exact path of an ignored file (when not using FORCE), add the <code>GIT_INDEX_ADD_CHECK_PATHSPEC</code> flag. This checks that each entry in the <code>pathspec</code> that is an exact match to a filename on disk is either not ignored or already in the index. If this check fails, the function will return GIT_EINVALIDSPEC.</p>\n\n<p>To emulate <code>git add -A</code> with the "dry-run" option, just use a callback function that always returns a positive value. See below for details.</p>\n\n<p>If any files are currently the result of a merge conflict, those files will no longer be marked as conflicting. The data about the conflicts will be moved to the "resolve undo" (REUC) section.</p>\n\n<p>If you provide a callback function, it will be invoked on each matching item in the working directory immediately <em>before</em> it is added to / updated in the index. Returning zero will add the item to the index, greater than zero will skip the item, and less than zero will abort the scan and return that value to the caller.</p>\n","group":"index"},"git_index_remove_all":{"type":"function","file":"git2/index.h","line":640,"lineto":644,"args":[{"name":"index","type":"git_index *","comment":"An existing index object"},{"name":"pathspec","type":"const git_strarray *","comment":"array of path patterns"},{"name":"callback","type":"git_index_matched_path_cb","comment":"notification callback for each removed path (also\n gets index of matching pathspec entry); can be NULL;\n return 0 to add, >0 to skip, \n<\n0 to abort scan."},{"name":"payload","type":"void *","comment":"payload passed through to callback function"}],"argline":"git_index *index, const git_strarray *pathspec, git_index_matched_path_cb callback, void *payload","sig":"git_index *::const git_strarray *::git_index_matched_path_cb::void *","return":{"type":"int","comment":" 0 on success, negative callback return value, or error code"},"description":"<p>Remove all matching index entries.</p>\n","comments":"<p>If you provide a callback function, it will be invoked on each matching item in the index immediately <em>before</em> it is removed. Return 0 to remove the item, > 0 to skip the item, and < 0 to abort the scan.</p>\n","group":"index"},"git_index_update_all":{"type":"function","file":"git2/index.h","line":669,"lineto":673,"args":[{"name":"index","type":"git_index *","comment":"An existing index object"},{"name":"pathspec","type":"const git_strarray *","comment":"array of path patterns"},{"name":"callback","type":"git_index_matched_path_cb","comment":"notification callback for each updated path (also\n gets index of matching pathspec entry); can be NULL;\n return 0 to add, >0 to skip, \n<\n0 to abort scan."},{"name":"payload","type":"void *","comment":"payload passed through to callback function"}],"argline":"git_index *index, const git_strarray *pathspec, git_index_matched_path_cb callback, void *payload","sig":"git_index *::const git_strarray *::git_index_matched_path_cb::void *","return":{"type":"int","comment":" 0 on success, negative callback return value, or error code"},"description":"<p>Update all index entries to match the working directory</p>\n","comments":"<p>This method will fail in bare index instances.</p>\n\n<p>This scans the existing index entries and synchronizes them with the working directory, deleting them if the corresponding working directory file no longer exists otherwise updating the information (including adding the latest version of file to the ODB if needed).</p>\n\n<p>If you provide a callback function, it will be invoked on each matching item in the index immediately <em>before</em> it is updated (either refreshed or removed depending on working directory state). Return 0 to proceed with updating the item, > 0 to skip the item, and < 0 to abort the scan.</p>\n","group":"index"},"git_index_find":{"type":"function","file":"git2/index.h","line":684,"lineto":684,"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\n path in the Git index.</p>\n","comments":"","group":"index"},"git_index_find_prefix":{"type":"function","file":"git2/index.h","line":695,"lineto":695,"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":"prefix","type":"const char *","comment":"the prefix to search for"}],"argline":"size_t *at_pos, git_index *index, const char *prefix","sig":"size_t *::git_index *::const char *","return":{"type":"int","comment":" 0 with valid value in at_pos; an error code otherwise"},"description":"<p>Find the first position of any entries matching a prefix. To find the first position\n of a path inside a given folder, suffix the prefix with a '/'.</p>\n","comments":"","group":"index"},"git_index_conflict_add":{"type":"function","file":"git2/index.h","line":720,"lineto":724,"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, const git_index_entry *ancestor_entry, const git_index_entry *our_entry, const 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. Any staged\n entries that exist at the given paths will be removed.</p>\n","comments":"<p>The entries are the entries from the tree included in the merge. Any entry may be null to indicate that that file was not present in the trees during the merge. For example, ancestor_entry may be NULL to indicate that a file was added in both branches and must be resolved.</p>\n","group":"index"},"git_index_conflict_get":{"type":"function","file":"git2/index.h","line":740,"lineto":745,"args":[{"name":"ancestor_out","type":"const git_index_entry **","comment":"Pointer to store the ancestor entry"},{"name":"our_out","type":"const git_index_entry **","comment":"Pointer to store the our entry"},{"name":"their_out","type":"const 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":"const git_index_entry **ancestor_out, const git_index_entry **our_out, const git_index_entry **their_out, git_index *index, const char *path","sig":"const git_index_entry **::const git_index_entry **::const git_index_entry **::git_index *::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Get the index entries that represent a conflict of a single file.</p>\n","comments":"<p>The entries are not modifiable and should not be freed. Because the <code>git_index_entry</code> struct is a publicly defined struct, you should be able to make your own permanent copy of the data if necessary.</p>\n","group":"index"},"git_index_conflict_remove":{"type":"function","file":"git2/index.h","line":754,"lineto":754,"args":[{"name":"index","type":"git_index *","comment":"an existing index object"},{"name":"path","type":"const char *","comment":"path to remove conflicts for"}],"argline":"git_index *index, const char *path","sig":"git_index *::const char *","return":{"type":"int","comment":" 0 or an error code"},"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":"git2/index.h","line":762,"lineto":762,"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>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":"git2/index.h","line":769,"lineto":769,"args":[{"name":"index","type":"const git_index *","comment":null}],"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","examples":{"merge.c":["ex/v0.27.1/merge.html#git_index_has_conflicts-15"]}},"git_index_conflict_iterator_new":{"type":"function","file":"git2/index.h","line":780,"lineto":782,"args":[{"name":"iterator_out","type":"git_index_conflict_iterator **","comment":"The newly created conflict iterator"},{"name":"index","type":"git_index *","comment":"The index to scan"}],"argline":"git_index_conflict_iterator **iterator_out, git_index *index","sig":"git_index_conflict_iterator **::git_index *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create an iterator for the conflicts in the index.</p>\n","comments":"<p>The index must not be modified while iterating; the results are undefined.</p>\n","group":"index","examples":{"merge.c":["ex/v0.27.1/merge.html#git_index_conflict_iterator_new-16"]}},"git_index_conflict_next":{"type":"function","file":"git2/index.h","line":794,"lineto":798,"args":[{"name":"ancestor_out","type":"const git_index_entry **","comment":"Pointer to store the ancestor side of the conflict"},{"name":"our_out","type":"const git_index_entry **","comment":"Pointer to store our side of the conflict"},{"name":"their_out","type":"const git_index_entry **","comment":"Pointer to store their side of the conflict"},{"name":"iterator","type":"git_index_conflict_iterator *","comment":null}],"argline":"const git_index_entry **ancestor_out, const git_index_entry **our_out, const git_index_entry **their_out, git_index_conflict_iterator *iterator","sig":"const git_index_entry **::const git_index_entry **::const git_index_entry **::git_index_conflict_iterator *","return":{"type":"int","comment":" 0 (no error), GIT_ITEROVER (iteration is done) or an error code\n (negative value)"},"description":"<p>Returns the current conflict (ancestor, ours and theirs entry) and\n advance the iterator internally to the next value.</p>\n","comments":"","group":"index","examples":{"merge.c":["ex/v0.27.1/merge.html#git_index_conflict_next-17"]}},"git_index_conflict_iterator_free":{"type":"function","file":"git2/index.h","line":805,"lineto":806,"args":[{"name":"iterator","type":"git_index_conflict_iterator *","comment":"pointer to the iterator"}],"argline":"git_index_conflict_iterator *iterator","sig":"git_index_conflict_iterator *","return":{"type":"void","comment":null},"description":"<p>Frees a <code>git_index_conflict_iterator</code>.</p>\n","comments":"","group":"index","examples":{"merge.c":["ex/v0.27.1/merge.html#git_index_conflict_iterator_free-18"]}},"git_indexer_new":{"type":"function","file":"git2/indexer.h","line":30,"lineto":36,"args":[{"name":"out","type":"git_indexer **","comment":"where to store the indexer instance"},{"name":"path","type":"const char *","comment":"to the directory where the packfile should be stored"},{"name":"mode","type":"unsigned int","comment":"permissions to use creating packfile or 0 for defaults"},{"name":"odb","type":"git_odb *","comment":"object database from which to read base objects when\n fixing thin packs. Pass NULL if no thin pack is expected (an error\n will be returned if there are bases missing)"},{"name":"progress_cb","type":"git_transfer_progress_cb","comment":"function to call with progress information"},{"name":"progress_cb_payload","type":"void *","comment":"payload for the progress callback"}],"argline":"git_indexer **out, const char *path, unsigned int mode, git_odb *odb, git_transfer_progress_cb progress_cb, void *progress_cb_payload","sig":"git_indexer **::const char *::unsigned int::git_odb *::git_transfer_progress_cb::void *","return":{"type":"int","comment":null},"description":"<p>Create a new indexer instance</p>\n","comments":"","group":"indexer","examples":{"network/index-pack.c":["ex/v0.27.1/network/index-pack.html#git_indexer_new-1"]}},"git_indexer_append":{"type":"function","file":"git2/indexer.h","line":46,"lineto":46,"args":[{"name":"idx","type":"git_indexer *","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 *idx, const void *data, size_t size, git_transfer_progress *stats","sig":"git_indexer *::const void *::size_t::git_transfer_progress *","return":{"type":"int","comment":null},"description":"<p>Add data to the indexer</p>\n","comments":"","group":"indexer","examples":{"network/index-pack.c":["ex/v0.27.1/network/index-pack.html#git_indexer_append-2"]}},"git_indexer_commit":{"type":"function","file":"git2/indexer.h","line":55,"lineto":55,"args":[{"name":"idx","type":"git_indexer *","comment":"the indexer"},{"name":"stats","type":"git_transfer_progress *","comment":null}],"argline":"git_indexer *idx, git_transfer_progress *stats","sig":"git_indexer *::git_transfer_progress *","return":{"type":"int","comment":null},"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.27.1/network/index-pack.html#git_indexer_commit-3"]}},"git_indexer_hash":{"type":"function","file":"git2/indexer.h","line":65,"lineto":65,"args":[{"name":"idx","type":"const git_indexer *","comment":"the indexer instance"}],"argline":"const git_indexer *idx","sig":"const git_indexer *","return":{"type":"const git_oid *","comment":null},"description":"<p>Get the packfile's hash</p>\n","comments":"<p>A packfile's name is derived from the sorted hashing of all object names. This is only correct after the index has been finalized.</p>\n","group":"indexer","examples":{"network/index-pack.c":["ex/v0.27.1/network/index-pack.html#git_indexer_hash-4"]}},"git_indexer_free":{"type":"function","file":"git2/indexer.h","line":72,"lineto":72,"args":[{"name":"idx","type":"git_indexer *","comment":"the indexer to free"}],"argline":"git_indexer *idx","sig":"git_indexer *","return":{"type":"void","comment":null},"description":"<p>Free the indexer and its resources</p>\n","comments":"","group":"indexer","examples":{"network/index-pack.c":["ex/v0.27.1/network/index-pack.html#git_indexer_free-5"]}},"git_merge_file_init_input":{"type":"function","file":"git2/merge.h","line":60,"lineto":62,"args":[{"name":"opts","type":"git_merge_file_input *","comment":"the `git_merge_file_input` instance to initialize."},{"name":"version","type":"unsigned int","comment":"the version of the struct; you should pass\n `GIT_MERGE_FILE_INPUT_VERSION` here."}],"argline":"git_merge_file_input *opts, unsigned int version","sig":"git_merge_file_input *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_merge_file_input</code> with default values. Equivalent to\n creating an instance with GIT_MERGE_FILE_INPUT_INIT.</p>\n","comments":"","group":"merge"},"git_merge_file_init_options":{"type":"function","file":"git2/merge.h","line":214,"lineto":216,"args":[{"name":"opts","type":"git_merge_file_options *","comment":"the `git_merge_file_options` instance to initialize."},{"name":"version","type":"unsigned int","comment":"the version of the struct; you should pass\n `GIT_MERGE_FILE_OPTIONS_VERSION` here."}],"argline":"git_merge_file_options *opts, unsigned int version","sig":"git_merge_file_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_merge_file_options</code> with default values. Equivalent to\n creating an instance with GIT_MERGE_FILE_OPTIONS_INIT.</p>\n","comments":"","group":"merge"},"git_merge_init_options":{"type":"function","file":"git2/merge.h","line":311,"lineto":313,"args":[{"name":"opts","type":"git_merge_options *","comment":"the `git_merge_options` instance to initialize."},{"name":"version","type":"unsigned int","comment":"the version of the struct; you should pass\n `GIT_MERGE_OPTIONS_VERSION` here."}],"argline":"git_merge_options *opts, unsigned int version","sig":"git_merge_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_merge_options</code> with default values. Equivalent to\n creating an instance with GIT_MERGE_OPTIONS_INIT.</p>\n","comments":"","group":"merge"},"git_merge_analysis":{"type":"function","file":"git2/merge.h","line":382,"lineto":387,"args":[{"name":"analysis_out","type":"git_merge_analysis_t *","comment":"analysis enumeration that the result is written into"},{"name":"preference_out","type":"git_merge_preference_t *","comment":null},{"name":"repo","type":"git_repository *","comment":"the repository to merge"},{"name":"their_heads","type":"const git_annotated_commit **","comment":"the heads to merge into"},{"name":"their_heads_len","type":"size_t","comment":"the number of heads to merge"}],"argline":"git_merge_analysis_t *analysis_out, git_merge_preference_t *preference_out, git_repository *repo, const git_annotated_commit **their_heads, size_t their_heads_len","sig":"git_merge_analysis_t *::git_merge_preference_t *::git_repository *::const git_annotated_commit **::size_t","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Analyzes the given branch(es) and determines the opportunities for\n merging them into the HEAD of the repository.</p>\n","comments":"","group":"merge","examples":{"merge.c":["ex/v0.27.1/merge.html#git_merge_analysis-19"]}},"git_merge_base":{"type":"function","file":"git2/merge.h","line":398,"lineto":402,"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, git_repository *repo, const git_oid *one, const git_oid *two","sig":"git_oid *::git_repository *::const git_oid *::const git_oid *","return":{"type":"int","comment":" 0 on success, GIT_ENOTFOUND if not found or error code"},"description":"<p>Find a merge base between two commits</p>\n","comments":"","group":"merge","examples":{"log.c":["ex/v0.27.1/log.html#git_merge_base-33"],"rev-parse.c":["ex/v0.27.1/rev-parse.html#git_merge_base-3"]}},"git_merge_bases":{"type":"function","file":"git2/merge.h","line":413,"lineto":417,"args":[{"name":"out","type":"git_oidarray *","comment":"array in which to store the resulting ids"},{"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_oidarray *out, git_repository *repo, const git_oid *one, const git_oid *two","sig":"git_oidarray *::git_repository *::const git_oid *::const git_oid *","return":{"type":"int","comment":" 0 on success, GIT_ENOTFOUND if not found or error code"},"description":"<p>Find merge bases between two commits</p>\n","comments":"","group":"merge"},"git_merge_base_many":{"type":"function","file":"git2/merge.h","line":428,"lineto":432,"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`"},{"name":"input_array","type":"const git_oid []","comment":"oids of the commits"}],"argline":"git_oid *out, git_repository *repo, size_t length, const git_oid [] input_array","sig":"git_oid *::git_repository *::size_t::const git_oid []","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_merge_bases_many":{"type":"function","file":"git2/merge.h","line":443,"lineto":447,"args":[{"name":"out","type":"git_oidarray *","comment":"array in which to store the resulting ids"},{"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`"},{"name":"input_array","type":"const git_oid []","comment":"oids of the commits"}],"argline":"git_oidarray *out, git_repository *repo, size_t length, const git_oid [] input_array","sig":"git_oidarray *::git_repository *::size_t::const git_oid []","return":{"type":"int","comment":" Zero on success; GIT_ENOTFOUND or -1 on failure."},"description":"<p>Find all merge bases given a list of commits</p>\n","comments":"","group":"merge"},"git_merge_base_octopus":{"type":"function","file":"git2/merge.h","line":458,"lineto":462,"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`"},{"name":"input_array","type":"const git_oid []","comment":"oids of the commits"}],"argline":"git_oid *out, git_repository *repo, size_t length, const git_oid [] input_array","sig":"git_oid *::git_repository *::size_t::const git_oid []","return":{"type":"int","comment":" Zero on success; GIT_ENOTFOUND or -1 on failure."},"description":"<p>Find a merge base in preparation for an octopus merge</p>\n","comments":"","group":"merge"},"git_merge_file":{"type":"function","file":"git2/merge.h","line":480,"lineto":485,"args":[{"name":"out","type":"git_merge_file_result *","comment":"The git_merge_file_result to be filled in"},{"name":"ancestor","type":"const git_merge_file_input *","comment":"The contents of the ancestor file"},{"name":"ours","type":"const git_merge_file_input *","comment":"The contents of the file in \"our\" side"},{"name":"theirs","type":"const git_merge_file_input *","comment":"The contents of the file in \"their\" side"},{"name":"opts","type":"const git_merge_file_options *","comment":"The merge file options or `NULL` for defaults"}],"argline":"git_merge_file_result *out, const git_merge_file_input *ancestor, const git_merge_file_input *ours, const git_merge_file_input *theirs, const git_merge_file_options *opts","sig":"git_merge_file_result *::const git_merge_file_input *::const git_merge_file_input *::const git_merge_file_input *::const git_merge_file_options *","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Merge two files as they exist in the in-memory data structures, using\n the given common ancestor as the baseline, producing a\n <code>git_merge_file_result</code> that reflects the merge result. The\n <code>git_merge_file_result</code> must be freed with <code>git_merge_file_result_free</code>.</p>\n","comments":"<p>Note that this function does not reference a repository and any configuration must be passed as <code>git_merge_file_options</code>.</p>\n","group":"merge"},"git_merge_file_from_index":{"type":"function","file":"git2/merge.h","line":501,"lineto":507,"args":[{"name":"out","type":"git_merge_file_result *","comment":"The git_merge_file_result to be filled in"},{"name":"repo","type":"git_repository *","comment":"The repository"},{"name":"ancestor","type":"const git_index_entry *","comment":"The index entry for the ancestor file (stage level 1)"},{"name":"ours","type":"const git_index_entry *","comment":"The index entry for our file (stage level 2)"},{"name":"theirs","type":"const git_index_entry *","comment":"The index entry for their file (stage level 3)"},{"name":"opts","type":"const git_merge_file_options *","comment":"The merge file options or NULL"}],"argline":"git_merge_file_result *out, git_repository *repo, const git_index_entry *ancestor, const git_index_entry *ours, const git_index_entry *theirs, const git_merge_file_options *opts","sig":"git_merge_file_result *::git_repository *::const git_index_entry *::const git_index_entry *::const git_index_entry *::const git_merge_file_options *","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Merge two files as they exist in the index, using the given common\n ancestor as the baseline, producing a <code>git_merge_file_result</code> that\n reflects the merge result. The <code>git_merge_file_result</code> must be freed with\n <code>git_merge_file_result_free</code>.</p>\n","comments":"","group":"merge"},"git_merge_file_result_free":{"type":"function","file":"git2/merge.h","line":514,"lineto":514,"args":[{"name":"result","type":"git_merge_file_result *","comment":"The result to free or `NULL`"}],"argline":"git_merge_file_result *result","sig":"git_merge_file_result *","return":{"type":"void","comment":null},"description":"<p>Frees a <code>git_merge_file_result</code>.</p>\n","comments":"","group":"merge"},"git_merge_trees":{"type":"function","file":"git2/merge.h","line":532,"lineto":538,"args":[{"name":"out","type":"git_index **","comment":"pointer to store the index result in"},{"name":"repo","type":"git_repository *","comment":"repository that contains the given trees"},{"name":"ancestor_tree","type":"const git_tree *","comment":"the common ancestor between the trees (or null if none)"},{"name":"our_tree","type":"const git_tree *","comment":"the tree that reflects the destination tree"},{"name":"their_tree","type":"const git_tree *","comment":"the tree to merge in to `our_tree`"},{"name":"opts","type":"const git_merge_options *","comment":"the merge tree options (or null for defaults)"}],"argline":"git_index **out, git_repository *repo, const git_tree *ancestor_tree, const git_tree *our_tree, const git_tree *their_tree, const git_merge_options *opts","sig":"git_index **::git_repository *::const git_tree *::const git_tree *::const git_tree *::const git_merge_options *","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Merge two trees, producing a <code>git_index</code> that reflects the result of\n the merge. The index may be written as-is to the working directory\n or checked out. If the index is to be converted to a tree, the caller\n should resolve any conflicts that arose as part of the merge.</p>\n","comments":"<p>The returned index must be freed explicitly with <code>git_index_free</code>.</p>\n","group":"merge"},"git_merge_commits":{"type":"function","file":"git2/merge.h","line":555,"lineto":560,"args":[{"name":"out","type":"git_index **","comment":"pointer to store the index result in"},{"name":"repo","type":"git_repository *","comment":"repository that contains the given trees"},{"name":"our_commit","type":"const git_commit *","comment":"the commit that reflects the destination tree"},{"name":"their_commit","type":"const git_commit *","comment":"the commit to merge in to `our_commit`"},{"name":"opts","type":"const git_merge_options *","comment":"the merge tree options (or null for defaults)"}],"argline":"git_index **out, git_repository *repo, const git_commit *our_commit, const git_commit *their_commit, const git_merge_options *opts","sig":"git_index **::git_repository *::const git_commit *::const git_commit *::const git_merge_options *","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Merge two commits, producing a <code>git_index</code> that reflects the result of\n the merge. The index may be written as-is to the working directory\n or checked out. If the index is to be converted to a tree, the caller\n should resolve any conflicts that arose as part of the merge.</p>\n","comments":"<p>The returned index must be freed explicitly with <code>git_index_free</code>.</p>\n","group":"merge"},"git_merge":{"type":"function","file":"git2/merge.h","line":580,"lineto":585,"args":[{"name":"repo","type":"git_repository *","comment":"the repository to merge"},{"name":"their_heads","type":"const git_annotated_commit **","comment":"the heads to merge into"},{"name":"their_heads_len","type":"size_t","comment":"the number of heads to merge"},{"name":"merge_opts","type":"const git_merge_options *","comment":"merge options"},{"name":"checkout_opts","type":"const git_checkout_options *","comment":"checkout options"}],"argline":"git_repository *repo, const git_annotated_commit **their_heads, size_t their_heads_len, const git_merge_options *merge_opts, const git_checkout_options *checkout_opts","sig":"git_repository *::const git_annotated_commit **::size_t::const git_merge_options *::const git_checkout_options *","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Merges the given commit(s) into HEAD, writing the results into the working\n directory. Any changes are staged for commit and any conflicts are written\n to the index. Callers should inspect the repository's index after this\n completes, resolve any conflicts and prepare a commit.</p>\n","comments":"<p>For compatibility with git, the repository is put into a merging state. Once the commit is done (or if the uses wishes to abort), you should clear this state by calling <code>git_repository_state_cleanup()</code>.</p>\n","group":"merge","examples":{"merge.c":["ex/v0.27.1/merge.html#git_merge-20"]}},"git_message_prettify":{"type":"function","file":"git2/message.h","line":38,"lineto":38,"args":[{"name":"out","type":"git_buf *","comment":"The user-allocated git_buf which will be filled with the\n cleaned up message."},{"name":"message","type":"const char *","comment":"The message to be prettified."},{"name":"strip_comments","type":"int","comment":"Non-zero to remove comment lines, 0 to leave them in."},{"name":"comment_char","type":"char","comment":"Comment character. Lines starting with this character\n are considered to be comments and removed if `strip_comments` is non-zero."}],"argline":"git_buf *out, const char *message, int strip_comments, char comment_char","sig":"git_buf *::const char *::int::char","return":{"type":"int","comment":" 0 or an error code."},"description":"<p>Clean up excess whitespace and make sure there is a trailing newline in the message.</p>\n","comments":"<p>Optionally, it can remove lines which start with the comment character.</p>\n","group":"message"},"git_message_trailers":{"type":"function","file":"git2/message.h","line":73,"lineto":73,"args":[{"name":"arr","type":"git_message_trailer_array *","comment":"A pre-allocated git_message_trailer_array struct to be filled in\n with any trailers found during parsing."},{"name":"message","type":"const char *","comment":"The message to be parsed"}],"argline":"git_message_trailer_array *arr, const char *message","sig":"git_message_trailer_array *::const char *","return":{"type":"int","comment":" 0 on success, or non-zero on error."},"description":"<p>Parse trailers out of a message, filling the array pointed to by +arr+.</p>\n","comments":"<p>Trailers are key/value pairs in the last paragraph of a message, not including any patches or conflicts that may be present.</p>\n","group":"message"},"git_message_trailer_array_free":{"type":"function","file":"git2/message.h","line":79,"lineto":79,"args":[{"name":"arr","type":"git_message_trailer_array *","comment":null}],"argline":"git_message_trailer_array *arr","sig":"git_message_trailer_array *","return":{"type":"void","comment":null},"description":"<p>Clean's up any allocated memory in the git_message_trailer_array filled by\n a call to git_message_trailers.</p>\n","comments":"","group":"message"},"git_note_iterator_new":{"type":"function","file":"git2/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\n \"refs/notes/commits\""}],"argline":"git_note_iterator **out, git_repository *repo, const 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_commit_iterator_new":{"type":"function","file":"git2/notes.h","line":64,"lineto":66,"args":[{"name":"out","type":"git_note_iterator **","comment":"pointer to the iterator"},{"name":"notes_commit","type":"git_commit *","comment":"a pointer to the notes commit object"}],"argline":"git_note_iterator **out, git_commit *notes_commit","sig":"git_note_iterator **::git_commit *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Creates a new iterator for notes from a commit</p>\n","comments":"<p>The iterator must be freed manually by the user.</p>\n","group":"note"},"git_note_iterator_free":{"type":"function","file":"git2/notes.h","line":73,"lineto":73,"args":[{"name":"it","type":"git_note_iterator *","comment":"pointer to the iterator"}],"argline":"git_note_iterator *it","sig":"git_note_iterator *","return":{"type":"void","comment":null},"description":"<p>Frees an git_note_iterator</p>\n","comments":"","group":"note"},"git_note_next":{"type":"function","file":"git2/notes.h","line":86,"lineto":89,"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, git_oid *annotated_id, git_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\n (negative value)"},"description":"<p>Return the current item (note_id and annotated_id) and advance the iterator\n internally to the next value</p>\n","comments":"","group":"note"},"git_note_read":{"type":"function","file":"git2/notes.h","line":105,"lineto":109,"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\n \"refs/notes/commits\""},{"name":"oid","type":"const git_oid *","comment":"OID of the git object to read the note from"}],"argline":"git_note **out, git_repository *repo, const char *notes_ref, const 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_commit_read":{"type":"function","file":"git2/notes.h","line":124,"lineto":128,"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_commit","type":"git_commit *","comment":"a pointer to the notes commit object"},{"name":"oid","type":"const git_oid *","comment":"OID of the git object to read the note from"}],"argline":"git_note **out, git_repository *repo, git_commit *notes_commit, const git_oid *oid","sig":"git_note **::git_repository *::git_commit *::const git_oid *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Read the note for an object from a note commit</p>\n","comments":"<p>The note must be freed manually by the user.</p>\n","group":"note"},"git_note_author":{"type":"function","file":"git2/notes.h","line":136,"lineto":136,"args":[{"name":"note","type":"const git_note *","comment":"the note"}],"argline":"const git_note *note","sig":"const git_note *","return":{"type":"const git_signature *","comment":" the author"},"description":"<p>Get the note author</p>\n","comments":"","group":"note"},"git_note_committer":{"type":"function","file":"git2/notes.h","line":144,"lineto":144,"args":[{"name":"note","type":"const git_note *","comment":"the note"}],"argline":"const git_note *note","sig":"const git_note *","return":{"type":"const git_signature *","comment":" the committer"},"description":"<p>Get the note committer</p>\n","comments":"","group":"note"},"git_note_message":{"type":"function","file":"git2/notes.h","line":153,"lineto":153,"args":[{"name":"note","type":"const git_note *","comment":"the note"}],"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_id":{"type":"function","file":"git2/notes.h","line":162,"lineto":162,"args":[{"name":"note","type":"const git_note *","comment":"the note"}],"argline":"const git_note *note","sig":"const git_note *","return":{"type":"const git_oid *","comment":" the note object's id"},"description":"<p>Get the note object's id</p>\n","comments":"","group":"note"},"git_note_create":{"type":"function","file":"git2/notes.h","line":179,"lineto":187,"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":"notes_ref","type":"const char *","comment":"canonical name of the reference to use (optional);\n\t\t\t\t\tdefaults 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 decorate"},{"name":"note","type":"const char *","comment":"Content of the note to add for object oid"},{"name":"force","type":"int","comment":"Overwrite existing note"}],"argline":"git_oid *out, git_repository *repo, const char *notes_ref, const git_signature *author, const git_signature *committer, const git_oid *oid, const char *note, int force","sig":"git_oid *::git_repository *::const char *::const git_signature *::const git_signature *::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_commit_create":{"type":"function","file":"git2/notes.h","line":209,"lineto":218,"args":[{"name":"notes_commit_out","type":"git_oid *","comment":"pointer to store the commit (optional);\n\t\t\t\t\tNULL in case of error"},{"name":"notes_blob_out","type":"git_oid *","comment":"a point to the id of a note blob (optional)"},{"name":"repo","type":"git_repository *","comment":"repository where the note will live"},{"name":"parent","type":"git_commit *","comment":"Pointer to parent note\n\t\t\t\t\tor NULL if this shall start a new notes tree"},{"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 decorate"},{"name":"note","type":"const char *","comment":"Content of the note to add for object oid"},{"name":"allow_note_overwrite","type":"int","comment":"Overwrite existing note"}],"argline":"git_oid *notes_commit_out, git_oid *notes_blob_out, git_repository *repo, git_commit *parent, const git_signature *author, const git_signature *committer, const git_oid *oid, const char *note, int allow_note_overwrite","sig":"git_oid *::git_oid *::git_repository *::git_commit *::const git_signature *::const git_signature *::const git_oid *::const char *::int","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Add a note for an object from a commit</p>\n","comments":"<p>This function will create a notes commit for a given object, the commit is a dangling commit, no reference is created.</p>\n","group":"note"},"git_note_remove":{"type":"function","file":"git2/notes.h","line":232,"lineto":237,"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);\n\t\t\t\t\tdefaults 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, const char *notes_ref, const git_signature *author, const git_signature *committer, const 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_commit_remove":{"type":"function","file":"git2/notes.h","line":257,"lineto":263,"args":[{"name":"notes_commit_out","type":"git_oid *","comment":"pointer to store the new notes commit (optional);\n\t\t\t\t\tNULL in case of error.\n\t\t\t\t\tWhen removing a note a new tree containing all notes\n\t\t\t\t\tsans the note to be removed is created and a new commit\n\t\t\t\t\tpointing to that tree is also created.\n\t\t\t\t\tIn the case where the resulting tree is an empty tree\n\t\t\t\t\ta new commit pointing to this empty tree will be returned."},{"name":"repo","type":"git_repository *","comment":"repository where the note lives"},{"name":"notes_commit","type":"git_commit *","comment":"a pointer to the notes commit object"},{"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_oid *notes_commit_out, git_repository *repo, git_commit *notes_commit, const git_signature *author, const git_signature *committer, const git_oid *oid","sig":"git_oid *::git_repository *::git_commit *::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":"git2/notes.h","line":270,"lineto":270,"args":[{"name":"note","type":"git_note *","comment":"git_note object"}],"argline":"git_note *note","sig":"git_note *","return":{"type":"void","comment":null},"description":"<p>Free a git_note object</p>\n","comments":"","group":"note"},"git_note_foreach":{"type":"function","file":"git2/notes.h","line":298,"lineto":302,"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\n \"refs/notes/commits\"."},{"name":"note_cb","type":"git_note_foreach_cb","comment":"Callback to invoke per found annotation. Return non-zero\n to stop looping."},{"name":"payload","type":"void *","comment":"Extra parameter to callback function."}],"argline":"git_repository *repo, const char *notes_ref, git_note_foreach_cb note_cb, void *payload","sig":"git_repository *::const char *::git_note_foreach_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, or error code"},"description":"<p>Loop over all the notes within a specified namespace\n and issue a callback for each one.</p>\n","comments":"","group":"note"},"git_object_lookup":{"type":"function","file":"git2/object.h","line":42,"lineto":46,"args":[{"name":"object","type":"git_object **","comment":"pointer to the looked-up object"},{"name":"repo","type":"git_repository *","comment":"the repository to look up the object"},{"name":"id","type":"const git_oid *","comment":"the unique identifier for the object"},{"name":"type","type":"git_otype","comment":"the type of the object"}],"argline":"git_object **object, git_repository *repo, const git_oid *id, git_otype type","sig":"git_object **::git_repository *::const git_oid *::git_otype","return":{"type":"int","comment":" 0 or an error code"},"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 should be closed with the <code>git_object_free</code> method instead of free'd manually.</p>\n\n<p>The 'type' parameter must match the type of the object in the odb; the method will fail otherwise. The special value 'GIT_OBJ_ANY' may be passed to let the method guess the object's type.</p>\n","group":"object","examples":{"log.c":["ex/v0.27.1/log.html#git_object_lookup-34"],"merge.c":["ex/v0.27.1/merge.html#git_object_lookup-21"]}},"git_object_lookup_prefix":{"type":"function","file":"git2/object.h","line":75,"lineto":80,"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, git_repository *repo, const git_oid *id, size_t len, git_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,\n given a prefix of its identifier (short id).</p>\n","comments":"<p>The object obtained will be so that its identifier matches the first 'len' hexadecimal characters (packets of 4 bits) of the given 'id'. 'len' must be at least GIT_OID_MINPREFIXLEN, and long enough to identify a unique object matching the prefix; otherwise the method will fail.</p>\n\n<p>The generated reference is owned by the repository and should be closed with the <code>git_object_free</code> method instead of free'd manually.</p>\n\n<p>The 'type' parameter must match the type of the object in the odb; the method will fail otherwise. The special value 'GIT_OBJ_ANY' may be passed to let the method guess the object's type.</p>\n","group":"object"},"git_object_lookup_bypath":{"type":"function","file":"git2/object.h","line":93,"lineto":97,"args":[{"name":"out","type":"git_object **","comment":"buffer that receives a pointer to the object (which must be freed\n by the caller)"},{"name":"treeish","type":"const git_object *","comment":"root object that can be peeled to a tree"},{"name":"path","type":"const char *","comment":"relative path from the root object to the desired object"},{"name":"type","type":"git_otype","comment":"type of object desired"}],"argline":"git_object **out, const git_object *treeish, const char *path, git_otype type","sig":"git_object **::const git_object *::const char *::git_otype","return":{"type":"int","comment":" 0 on success, or an error code"},"description":"<p>Lookup an object that represents a tree entry.</p>\n","comments":"","group":"object"},"git_object_id":{"type":"function","file":"git2/object.h","line":105,"lineto":105,"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","examples":{"blame.c":["ex/v0.27.1/blame.html#git_object_id-10","ex/v0.27.1/blame.html#git_object_id-11","ex/v0.27.1/blame.html#git_object_id-12","ex/v0.27.1/blame.html#git_object_id-13"],"cat-file.c":["ex/v0.27.1/cat-file.html#git_object_id-12","ex/v0.27.1/cat-file.html#git_object_id-13"],"log.c":["ex/v0.27.1/log.html#git_object_id-35","ex/v0.27.1/log.html#git_object_id-36","ex/v0.27.1/log.html#git_object_id-37","ex/v0.27.1/log.html#git_object_id-38"],"rev-parse.c":["ex/v0.27.1/rev-parse.html#git_object_id-4","ex/v0.27.1/rev-parse.html#git_object_id-5","ex/v0.27.1/rev-parse.html#git_object_id-6","ex/v0.27.1/rev-parse.html#git_object_id-7","ex/v0.27.1/rev-parse.html#git_object_id-8"]}},"git_object_short_id":{"type":"function","file":"git2/object.h","line":119,"lineto":119,"args":[{"name":"out","type":"git_buf *","comment":"Buffer to write string into"},{"name":"obj","type":"const git_object *","comment":"The object to get an ID for"}],"argline":"git_buf *out, const git_object *obj","sig":"git_buf *::const git_object *","return":{"type":"int","comment":" 0 on success, \n<\n0 for error"},"description":"<p>Get a short abbreviated OID string for the object</p>\n","comments":"<p>This starts at the "core.abbrev" length (default 7 characters) and iteratively extends to a longer string if that length is ambiguous. The result will be unambiguous (at least until new objects are added to the repository).</p>\n","group":"object","examples":{"tag.c":["ex/v0.27.1/tag.html#git_object_short_id-5"]}},"git_object_type":{"type":"function","file":"git2/object.h","line":127,"lineto":127,"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","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_object_type-14","ex/v0.27.1/cat-file.html#git_object_type-15","ex/v0.27.1/cat-file.html#git_object_type-16"],"tag.c":["ex/v0.27.1/tag.html#git_object_type-6"]}},"git_object_owner":{"type":"function","file":"git2/object.h","line":141,"lineto":141,"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 returned pointer will invalidate the actual object.</p>\n\n<p>Any other operation may be run on the repository without affecting the object.</p>\n","group":"object"},"git_object_free":{"type":"function","file":"git2/object.h","line":158,"lineto":158,"args":[{"name":"object","type":"git_object *","comment":"the object to close"}],"argline":"git_object *object","sig":"git_object *","return":{"type":"void","comment":null},"description":"<p>Close an open object</p>\n","comments":"<p>This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how aggressive is the caching mechanism used by the repository.</p>\n\n<p>IMPORTANT: It <em>is</em> necessary to call this method when you stop using an object. Failure to do so will cause a memory leak.</p>\n","group":"object","examples":{"blame.c":["ex/v0.27.1/blame.html#git_object_free-14","ex/v0.27.1/blame.html#git_object_free-15","ex/v0.27.1/blame.html#git_object_free-16","ex/v0.27.1/blame.html#git_object_free-17"],"cat-file.c":["ex/v0.27.1/cat-file.html#git_object_free-17"],"general.c":["ex/v0.27.1/general.html#git_object_free-38"],"log.c":["ex/v0.27.1/log.html#git_object_free-39"],"merge.c":["ex/v0.27.1/merge.html#git_object_free-22"],"rev-parse.c":["ex/v0.27.1/rev-parse.html#git_object_free-9","ex/v0.27.1/rev-parse.html#git_object_free-10","ex/v0.27.1/rev-parse.html#git_object_free-11"],"tag.c":["ex/v0.27.1/tag.html#git_object_free-7","ex/v0.27.1/tag.html#git_object_free-8","ex/v0.27.1/tag.html#git_object_free-9","ex/v0.27.1/tag.html#git_object_free-10"]}},"git_object_type2string":{"type":"function","file":"git2/object.h","line":169,"lineto":169,"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 its string representation.</p>\n","comments":"<p>The result is a pointer to a string in static memory and should not be free()'ed.</p>\n","group":"object","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_object_type2string-18","ex/v0.27.1/cat-file.html#git_object_type2string-19","ex/v0.27.1/cat-file.html#git_object_type2string-20","ex/v0.27.1/cat-file.html#git_object_type2string-21"],"general.c":["ex/v0.27.1/general.html#git_object_type2string-39","ex/v0.27.1/general.html#git_object_type2string-40"]}},"git_object_string2type":{"type":"function","file":"git2/object.h","line":177,"lineto":177,"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's git_otype.</p>\n","comments":"","group":"object"},"git_object_typeisloose":{"type":"function","file":"git2/object.h","line":186,"lineto":186,"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,\n 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":"git2/object.h","line":200,"lineto":200,"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\n acts as an in-memory representation of any given\n object type.</p>\n","comments":"<p>For all the core types, this would the equivalent of calling <code>sizeof(git_commit)</code> if the core types were not opaque on the external API.</p>\n","group":"object"},"git_object_peel":{"type":"function","file":"git2/object.h","line":225,"lineto":228,"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 (a GIT_OBJ_ value)"}],"argline":"git_object **peeled, const git_object *object, git_otype target_type","sig":"git_object **::const git_object *::git_otype","return":{"type":"int","comment":" 0 on success, GIT_EINVALIDSPEC, GIT_EPEEL, or an error code"},"description":"<p>Recursively peel an object until an object of the specified type is met.</p>\n","comments":"<p>If the query cannot be satisfied due to the object model, GIT_EINVALIDSPEC will be returned (e.g. trying to peel a blob to a tree).</p>\n\n<p>If you pass <code>GIT_OBJ_ANY</code> as the target type, then the object will be peeled until the type changes. A tag will be peeled until the referenced object is no longer a tag, and a commit will be peeled to a tree. Any other object type will return GIT_EINVALIDSPEC.</p>\n\n<p>If peeling a tag we discover an object which cannot be peeled to the target type due to the object model, GIT_EPEEL will be returned.</p>\n\n<p>You must free the returned object.</p>\n","group":"object"},"git_object_dup":{"type":"function","file":"git2/object.h","line":237,"lineto":237,"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","comment":null},"description":"<p>Create an in-memory copy of a Git object. The copy must be\n explicitly free'd or it will leak.</p>\n","comments":"","group":"object"},"git_odb_new":{"type":"function","file":"git2/odb.h","line":39,"lineto":39,"args":[{"name":"out","type":"git_odb **","comment":"location to store the database pointer, if opened.\n\t\t\tSet 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 backend must be manually added using <code>git_odb_add_backend()</code></p>\n","group":"odb"},"git_odb_open":{"type":"function","file":"git2/odb.h","line":57,"lineto":57,"args":[{"name":"out","type":"git_odb **","comment":"location to store the database pointer, if opened.\n\t\t\tSet 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\n the two default backends:</p>\n","comments":"<pre><code>- git_odb_backend_loose: read and write loose object files from disk, assuming `objects_dir` as the Objects folder\n\n- git_odb_backend_pack: read objects from packfiles, assuming `objects_dir` as the Objects folder which contains a 'pack/' folder with the corresponding data\n</code></pre>\n","group":"odb"},"git_odb_add_disk_alternate":{"type":"function","file":"git2/odb.h","line":74,"lineto":74,"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 to a full repository, to use it as an alternate store.</p>\n\n<p>Alternate backends are always checked for objects <em>after</em> all 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":"git2/odb.h","line":81,"lineto":81,"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","comment":null},"description":"<p>Close an open object database.</p>\n","comments":"","group":"odb","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_odb_free-22"],"general.c":["ex/v0.27.1/general.html#git_odb_free-41"]}},"git_odb_read":{"type":"function","file":"git2/odb.h","line":100,"lineto":100,"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;\n - 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 trying to read the given OID.</p>\n\n<p>The returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use.</p>\n","group":"odb","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_odb_read-23"],"general.c":["ex/v0.27.1/general.html#git_odb_read-42"]}},"git_odb_read_prefix":{"type":"function","file":"git2/odb.h","line":129,"lineto":129,"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;\n - GIT_ENOTFOUND if the object is not in the database.\n - GIT_EAMBIGUOUS if the prefix is ambiguous (several objects match the prefix)"},"description":"<p>Read an object from the database, given a prefix\n of its identifier.</p>\n","comments":"<p>This method queries all available ODB backends trying to match the 'len' first hexadecimal characters of the 'short_id'. The remaining (GIT_OID_HEXSZ-len)*4 bits of 'short_id' must be 0s. 'len' must be at least GIT_OID_MINPREFIXLEN, and the prefix must be long enough to identify a unique object in all the backends; the method will fail otherwise.</p>\n\n<p>The returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use.</p>\n","group":"odb"},"git_odb_read_header":{"type":"function","file":"git2/odb.h","line":149,"lineto":149,"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;\n - GIT_ENOTFOUND if the object is not in the database."},"description":"<p>Read the header of an object from the database, without\n reading 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 of an object, so the whole object will be read and then the header will be returned.</p>\n","group":"odb"},"git_odb_exists":{"type":"function","file":"git2/odb.h","line":160,"lineto":160,"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\n - 0, otherwise"},"description":"<p>Determine if the given object can be found in the object database.</p>\n","comments":"","group":"odb"},"git_odb_exists_prefix":{"type":"function","file":"git2/odb.h","line":173,"lineto":174,"args":[{"name":"out","type":"git_oid *","comment":"The full OID of the found object if just one is found."},{"name":"db","type":"git_odb *","comment":"The database to be searched for the given object."},{"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_oid *out, git_odb *db, const git_oid *short_id, size_t len","sig":"git_oid *::git_odb *::const git_oid *::size_t","return":{"type":"int","comment":" 0 if found, GIT_ENOTFOUND if not found, GIT_EAMBIGUOUS if multiple\n matches were found, other value \n<\n 0 if there was a read error."},"description":"<p>Determine if an object can be found in the object database by an\n abbreviated object ID.</p>\n","comments":"","group":"odb"},"git_odb_expand_ids":{"type":"function","file":"git2/odb.h","line":215,"lineto":218,"args":[{"name":"db","type":"git_odb *","comment":"The database to be searched for the given objects."},{"name":"ids","type":"git_odb_expand_id *","comment":"An array of short object IDs to search for"},{"name":"count","type":"size_t","comment":"The length of the `ids` array"}],"argline":"git_odb *db, git_odb_expand_id *ids, size_t count","sig":"git_odb *::git_odb_expand_id *::size_t","return":{"type":"int","comment":" 0 on success or an error code on failure"},"description":"<p>Determine if one or more objects can be found in the object database\n by their abbreviated object ID and type. The given array will be\n updated in place: for each abbreviated ID that is unique in the\n database, and of the given type (if specified), the full object ID,\n object ID length (<code>GIT_OID_HEXSZ</code>) and type will be written back to\n the array. For IDs that are not found (or are ambiguous), the\n array entry will be zeroed.</p>\n","comments":"<p>Note that since this function operates on multiple objects, the underlying database will not be asked to be reloaded if an object is not found (which is unlike other object database operations.)</p>\n","group":"odb"},"git_odb_refresh":{"type":"function","file":"git2/odb.h","line":238,"lineto":238,"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 is running, this function will force a reload of the underlying indexes.</p>\n\n<p>Use this function when you're confident that an external application has tampered with the ODB.</p>\n\n<p>NOTE that it is not necessary to call this function at all. The library will automatically attempt to refresh the ODB when a lookup fails, to see if the looked up object exists on disk but hasn't been loaded yet.</p>\n","group":"odb"},"git_odb_foreach":{"type":"function","file":"git2/odb.h","line":253,"lineto":253,"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, non-zero callback return value, 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 database. Note that the objects are likely to be returned in the index order, which would make accessing the objects in that order inefficient. Return a non-zero value from the callback to stop looping.</p>\n","group":"odb"},"git_odb_write":{"type":"function","file":"git2/odb.h","line":273,"lineto":273,"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. For most cases, it is preferred to write objects through a write stream, which is both faster and less memory intensive, specially for big objects.</p>\n\n<p>This method is provided for compatibility with custom backends which are not able to support streaming writes</p>\n","group":"odb","examples":{"general.c":["ex/v0.27.1/general.html#git_odb_write-43"]}},"git_odb_open_wstream":{"type":"function","file":"git2/odb.h","line":296,"lineto":296,"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":"git_off_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, git_off_t size, git_otype type","sig":"git_odb_stream **::git_odb *::git_off_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 when opening the stream.</p>\n\n<p>The returned stream will be of type <code>GIT_STREAM_WRONLY</code>, and it won't be effective until <code>git_odb_stream_finalize_write</code> is called and returns without an error</p>\n\n<p>The stream must always be freed when done with <code>git_odb_stream_free</code> or will leak memory.</p>\n","group":"odb"},"git_odb_stream_write":{"type":"function","file":"git2/odb.h","line":309,"lineto":309,"args":[{"name":"stream","type":"git_odb_stream *","comment":"the stream"},{"name":"buffer","type":"const char *","comment":"the data to write"},{"name":"len","type":"size_t","comment":"the buffer's length"}],"argline":"git_odb_stream *stream, const char *buffer, size_t len","sig":"git_odb_stream *::const char *::size_t","return":{"type":"int","comment":" 0 if the write succeeded; error code otherwise"},"description":"<p>Write to an odb stream</p>\n","comments":"<p>This method will fail if the total number of received bytes exceeds the size declared with <code>git_odb_open_wstream()</code></p>\n","group":"odb"},"git_odb_stream_finalize_write":{"type":"function","file":"git2/odb.h","line":324,"lineto":324,"args":[{"name":"out","type":"git_oid *","comment":"pointer to store the resulting object's id"},{"name":"stream","type":"git_odb_stream *","comment":"the stream"}],"argline":"git_oid *out, git_odb_stream *stream","sig":"git_oid *::git_odb_stream *","return":{"type":"int","comment":" 0 on success; an error code otherwise"},"description":"<p>Finish writing to an odb stream</p>\n","comments":"<p>The object will take its final name and will be available to the odb.</p>\n\n<p>This method will fail if the total number of received bytes differs from the size declared with <code>git_odb_open_wstream()</code></p>\n","group":"odb"},"git_odb_stream_read":{"type":"function","file":"git2/odb.h","line":331,"lineto":331,"args":[{"name":"stream","type":"git_odb_stream *","comment":null},{"name":"buffer","type":"char *","comment":null},{"name":"len","type":"size_t","comment":null}],"argline":"git_odb_stream *stream, char *buffer, size_t len","sig":"git_odb_stream *::char *::size_t","return":{"type":"int","comment":null},"description":"<p>Read from an odb stream</p>\n","comments":"<p>Most backends don't implement streaming reads</p>\n","group":"odb"},"git_odb_stream_free":{"type":"function","file":"git2/odb.h","line":338,"lineto":338,"args":[{"name":"stream","type":"git_odb_stream *","comment":"the stream to free"}],"argline":"git_odb_stream *stream","sig":"git_odb_stream *","return":{"type":"void","comment":null},"description":"<p>Free an odb stream</p>\n","comments":"","group":"odb"},"git_odb_open_rstream":{"type":"function","file":"git2/odb.h","line":366,"lineto":371,"args":[{"name":"out","type":"git_odb_stream **","comment":"pointer where to store the stream"},{"name":"len","type":"size_t *","comment":"pointer where to store the length of the object"},{"name":"type","type":"git_otype *","comment":"pointer where to store the type of the object"},{"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, size_t *len, git_otype *type, git_odb *db, const git_oid *oid","sig":"git_odb_stream **::size_t *::git_otype *::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 because they store their objects as compressed/delta'ed blobs.</p>\n\n<p>It's recommended to use <code>git_odb_read</code> instead, which is assured to work on all backends.</p>\n\n<p>The returned stream will be of type <code>GIT_STREAM_RDONLY</code> and will have the following methods:</p>\n\n<pre><code> - stream->read: read `n` bytes from the stream - stream->free: free the stream\n</code></pre>\n\n<p>The stream must always be free'd or will leak memory.</p>\n","group":"odb"},"git_odb_write_pack":{"type":"function","file":"git2/odb.h","line":391,"lineto":395,"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_cb","comment":"function to call with progress information.\n Be aware that this is called inline with network and indexing operations,\n so performance may be affected."},{"name":"progress_payload","type":"void *","comment":"payload for the progress callback"}],"argline":"git_odb_writepack **out, git_odb *db, git_transfer_progress_cb progress_cb, void *progress_payload","sig":"git_odb_writepack **::git_odb *::git_transfer_progress_cb::void *","return":{"type":"int","comment":null},"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 packfile will likely be streamed directly to disk (and a corresponding index created). If the ODB layer does not understand pack files, the objects will be stored in whatever format the ODB layer uses.</p>\n","group":"odb"},"git_odb_hash":{"type":"function","file":"git2/odb.h","line":409,"lineto":409,"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 buffer as if the data buffer it were to written to the ODB.</p>\n","group":"odb"},"git_odb_hashfile":{"type":"function","file":"git2/odb.h","line":424,"lineto":424,"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\n that the file would have if it were written to the Object\n Database as an object of the given type (w/o applying filters).\n Similar functionality to git.git's <code>git hash-object</code> without\n the <code>-w</code> flag, however, with the --no-filters flag.\n If you need filters, see git_repository_hashfile.</p>\n","comments":"","group":"odb"},"git_odb_object_dup":{"type":"function","file":"git2/odb.h","line":438,"lineto":438,"args":[{"name":"dest","type":"git_odb_object **","comment":"pointer where to store the copy"},{"name":"source","type":"git_odb_object *","comment":"object to copy"}],"argline":"git_odb_object **dest, git_odb_object *source","sig":"git_odb_object **::git_odb_object *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create a copy of an odb_object</p>\n","comments":"<p>The returned copy must be manually freed with <code>git_odb_object_free</code>. Note that because of an implementation detail, the returned copy will be the same pointer as <code>source</code>: the object is internally refcounted, so the copy still needs to be freed twice.</p>\n","group":"odb"},"git_odb_object_free":{"type":"function","file":"git2/odb.h","line":448,"lineto":448,"args":[{"name":"object","type":"git_odb_object *","comment":"object to close"}],"argline":"git_odb_object *object","sig":"git_odb_object *","return":{"type":"void","comment":null},"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 longer needed, otherwise memory will leak.</p>\n","group":"odb","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_odb_object_free-24"],"general.c":["ex/v0.27.1/general.html#git_odb_object_free-44"]}},"git_odb_object_id":{"type":"function","file":"git2/odb.h","line":458,"lineto":458,"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":"git2/odb.h","line":471,"lineto":471,"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, without the leading header.</p>\n\n<p>This pointer is owned by the object and shall not be free'd.</p>\n","group":"odb","examples":{"general.c":["ex/v0.27.1/general.html#git_odb_object_data-45"]}},"git_odb_object_size":{"type":"function","file":"git2/odb.h","line":482,"lineto":482,"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 actual size of the object.</p>\n","group":"odb","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_odb_object_size-25"],"general.c":["ex/v0.27.1/general.html#git_odb_object_size-46"]}},"git_odb_object_type":{"type":"function","file":"git2/odb.h","line":490,"lineto":490,"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.27.1/general.html#git_odb_object_type-47"]}},"git_odb_add_backend":{"type":"function","file":"git2/odb.h","line":505,"lineto":505,"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 value of the <code>priority</code> parameter.</p>\n\n<p>Read <sys/odb_backend.h> for more information.</p>\n","group":"odb"},"git_odb_add_alternate":{"type":"function","file":"git2/odb.h","line":526,"lineto":526,"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\n backend will work as an alternate.</p>\n","comments":"<p>Alternate backends are always checked for objects <em>after</em> all the main backends have been exhausted.</p>\n\n<p>The backends are checked in relative ordering, based on the value of the <code>priority</code> parameter.</p>\n\n<p>Writing is disabled on alternate backends.</p>\n\n<p>Read <sys/odb_backend.h> for more information.</p>\n","group":"odb"},"git_odb_num_backends":{"type":"function","file":"git2/odb.h","line":534,"lineto":534,"args":[{"name":"odb","type":"git_odb *","comment":"object database"}],"argline":"git_odb *odb","sig":"git_odb *","return":{"type":"size_t","comment":" number of backends in the ODB"},"description":"<p>Get the number of ODB backend objects</p>\n","comments":"","group":"odb"},"git_odb_get_backend":{"type":"function","file":"git2/odb.h","line":544,"lineto":544,"args":[{"name":"out","type":"git_odb_backend **","comment":"output pointer to ODB backend at pos"},{"name":"odb","type":"git_odb *","comment":"object database"},{"name":"pos","type":"size_t","comment":"index into object database backend list"}],"argline":"git_odb_backend **out, git_odb *odb, size_t pos","sig":"git_odb_backend **::git_odb *::size_t","return":{"type":"int","comment":" 0 on success; GIT_ENOTFOUND if pos is invalid; other errors \n<\n 0"},"description":"<p>Lookup an ODB backend object by index</p>\n","comments":"","group":"odb"},"git_odb_backend_pack":{"type":"function","file":"git2/odb_backend.h","line":34,"lineto":34,"args":[{"name":"out","type":"git_odb_backend **","comment":"location to store the odb backend pointer"},{"name":"objects_dir","type":"const char *","comment":"the Git repository's objects directory"}],"argline":"git_odb_backend **out, const char *objects_dir","sig":"git_odb_backend **::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create a backend for the packfiles.</p>\n","comments":"","group":"odb"},"git_odb_backend_loose":{"type":"function","file":"git2/odb_backend.h","line":48,"lineto":54,"args":[{"name":"out","type":"git_odb_backend **","comment":"location to store the odb backend pointer"},{"name":"objects_dir","type":"const char *","comment":"the Git repository's objects directory"},{"name":"compression_level","type":"int","comment":"zlib compression level to use"},{"name":"do_fsync","type":"int","comment":"whether to do an fsync() after writing"},{"name":"dir_mode","type":"unsigned int","comment":"permissions to use creating a directory or 0 for defaults"},{"name":"file_mode","type":"unsigned int","comment":"permissions to use creating a file or 0 for defaults"}],"argline":"git_odb_backend **out, const char *objects_dir, int compression_level, int do_fsync, unsigned int dir_mode, unsigned int file_mode","sig":"git_odb_backend **::const char *::int::int::unsigned int::unsigned int","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create a backend for loose objects</p>\n","comments":"","group":"odb"},"git_odb_backend_one_pack":{"type":"function","file":"git2/odb_backend.h","line":67,"lineto":67,"args":[{"name":"out","type":"git_odb_backend **","comment":"location to store the odb backend pointer"},{"name":"index_file","type":"const char *","comment":"path to the packfile's .idx file"}],"argline":"git_odb_backend **out, const char *index_file","sig":"git_odb_backend **::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create a backend out of a single packfile</p>\n","comments":"<p>This can be useful for inspecting the contents of a single packfile.</p>\n","group":"odb"},"git_oid_fromstr":{"type":"function","file":"git2/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\n\t\tthe hex sequence and have at least the number of bytes\n\t\tneeded 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.27.1/general.html#git_oid_fromstr-48","ex/v0.27.1/general.html#git_oid_fromstr-49","ex/v0.27.1/general.html#git_oid_fromstr-50","ex/v0.27.1/general.html#git_oid_fromstr-51","ex/v0.27.1/general.html#git_oid_fromstr-52","ex/v0.27.1/general.html#git_oid_fromstr-53","ex/v0.27.1/general.html#git_oid_fromstr-54","ex/v0.27.1/general.html#git_oid_fromstr-55"],"merge.c":["ex/v0.27.1/merge.html#git_oid_fromstr-23"]}},"git_oid_fromstrp":{"type":"function","file":"git2/oid.h","line":56,"lineto":56,"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 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":"git2/oid.h","line":69,"lineto":69,"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, the last byte's high nibble will be read in and the low nibble set to zero.</p>\n","group":"oid"},"git_oid_fromraw":{"type":"function","file":"git2/oid.h","line":77,"lineto":77,"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","comment":null},"description":"<p>Copy an already raw oid into a git_oid structure.</p>\n","comments":"","group":"oid"},"git_oid_fmt":{"type":"function","file":"git2/oid.h","line":89,"lineto":89,"args":[{"name":"out","type":"char *","comment":"output hex string; must be pointing at the start of\n\t\tthe hex sequence and have at least the number of bytes\n\t\tneeded for an oid encoded in hex (40 bytes). Only the\n\t\toid digits are written; a '\n\\\n0' terminator must be added\n\t\tby 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","comment":null},"description":"<p>Format a git_oid into a hex string.</p>\n","comments":"","group":"oid","examples":{"general.c":["ex/v0.27.1/general.html#git_oid_fmt-56","ex/v0.27.1/general.html#git_oid_fmt-57","ex/v0.27.1/general.html#git_oid_fmt-58","ex/v0.27.1/general.html#git_oid_fmt-59","ex/v0.27.1/general.html#git_oid_fmt-60","ex/v0.27.1/general.html#git_oid_fmt-61"],"network/fetch.c":["ex/v0.27.1/network/fetch.html#git_oid_fmt-1","ex/v0.27.1/network/fetch.html#git_oid_fmt-2"],"network/index-pack.c":["ex/v0.27.1/network/index-pack.html#git_oid_fmt-6"],"network/ls-remote.c":["ex/v0.27.1/network/ls-remote.html#git_oid_fmt-1"]}},"git_oid_nfmt":{"type":"function","file":"git2/oid.h","line":100,"lineto":100,"args":[{"name":"out","type":"char *","comment":"output hex string; you say how many bytes to write.\n\t\tIf the number of bytes is > GIT_OID_HEXSZ, extra bytes\n\t\twill be zeroed; if not, a '\n\\\n0' terminator is NOT added."},{"name":"n","type":"size_t","comment":"number of characters to write into out string"},{"name":"id","type":"const git_oid *","comment":"oid structure to format."}],"argline":"char *out, size_t n, const git_oid *id","sig":"char *::size_t::const git_oid *","return":{"type":"void","comment":null},"description":"<p>Format a git_oid into a partial hex string.</p>\n","comments":"","group":"oid"},"git_oid_pathfmt":{"type":"function","file":"git2/oid.h","line":115,"lineto":115,"args":[{"name":"out","type":"char *","comment":"output hex string; must be pointing at the start of\n\t\tthe hex sequence and have at least the number of bytes\n\t\tneeded for an oid encoded in hex (41 bytes). Only the\n\t\toid digits are written; a '\n\\\n0' terminator must be added\n\t\tby 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","comment":null},"description":"<p>Format a git_oid into a loose-object path string.</p>\n","comments":"<p>The resulting string is "aa/...", where "aa" is the first two hex digits of the oid and "..." is the remaining 38 digits.</p>\n","group":"oid"},"git_oid_tostr_s":{"type":"function","file":"git2/oid.h","line":128,"lineto":128,"args":[{"name":"oid","type":"const git_oid *","comment":"The oid structure to format"}],"argline":"const git_oid *oid","sig":"const git_oid *","return":{"type":"char *","comment":" the c-string"},"description":"<p>Format a git_oid into a statically allocated c-string.</p>\n","comments":"<p>The c-string is owned by the library and should not be freed by the user. If libgit2 is built with thread support, the string will be stored in TLS (i.e. one buffer per thread) to allow for concurrent calls of the function.</p>\n","group":"oid","examples":{"merge.c":["ex/v0.27.1/merge.html#git_oid_tostr_s-24","ex/v0.27.1/merge.html#git_oid_tostr_s-25"]}},"git_oid_tostr":{"type":"function","file":"git2/oid.h","line":147,"lineto":147,"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\n\t\t\terrors, 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 oid c-string will be truncated to n-1 characters (but will still be NUL-byte terminated).</p>\n\n<p>If there are any input parameter errors (out == NULL, n == 0, oid == NULL), then a pointer to an empty string is returned, so that the return value can always be printed.</p>\n","group":"oid","examples":{"blame.c":["ex/v0.27.1/blame.html#git_oid_tostr-18","ex/v0.27.1/blame.html#git_oid_tostr-19"],"cat-file.c":["ex/v0.27.1/cat-file.html#git_oid_tostr-26","ex/v0.27.1/cat-file.html#git_oid_tostr-27","ex/v0.27.1/cat-file.html#git_oid_tostr-28","ex/v0.27.1/cat-file.html#git_oid_tostr-29","ex/v0.27.1/cat-file.html#git_oid_tostr-30"],"log.c":["ex/v0.27.1/log.html#git_oid_tostr-40","ex/v0.27.1/log.html#git_oid_tostr-41"],"rev-parse.c":["ex/v0.27.1/rev-parse.html#git_oid_tostr-12","ex/v0.27.1/rev-parse.html#git_oid_tostr-13","ex/v0.27.1/rev-parse.html#git_oid_tostr-14","ex/v0.27.1/rev-parse.html#git_oid_tostr-15"]}},"git_oid_cpy":{"type":"function","file":"git2/oid.h","line":155,"lineto":155,"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","comment":null},"description":"<p>Copy an oid from one structure to another.</p>\n","comments":"","group":"oid","examples":{"blame.c":["ex/v0.27.1/blame.html#git_oid_cpy-20","ex/v0.27.1/blame.html#git_oid_cpy-21","ex/v0.27.1/blame.html#git_oid_cpy-22"]}},"git_oid_cmp":{"type":"function","file":"git2/oid.h","line":164,"lineto":164,"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":" \n<\n0, 0, >0 if a \n<\n b, a == b, a > b."},"description":"<p>Compare two oid structures.</p>\n","comments":"","group":"oid"},"git_oid_equal":{"type":"function","file":"git2/oid.h","line":173,"lineto":173,"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":"git2/oid.h","line":184,"lineto":184,"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 'len' hexadecimal characters (packets of 4 bits)\n of two oid structures.</p>\n","comments":"","group":"oid"},"git_oid_streq":{"type":"function","file":"git2/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":" 0 in case of a match, -1 otherwise."},"description":"<p>Check if an oid equals an hex formatted object id.</p>\n","comments":"","group":"oid"},"git_oid_strcmp":{"type":"function","file":"git2/oid.h","line":203,"lineto":203,"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":" -1 if str is not valid, \n<\n0 if id sorts before str,\n 0 if id matches str, >0 if id sorts after str."},"description":"<p>Compare an oid to an hex formatted object id.</p>\n","comments":"","group":"oid"},"git_oid_iszero":{"type":"function","file":"git2/oid.h","line":210,"lineto":210,"args":[{"name":"id","type":"const git_oid *","comment":null}],"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":{"blame.c":["ex/v0.27.1/blame.html#git_oid_iszero-23"],"network/fetch.c":["ex/v0.27.1/network/fetch.html#git_oid_iszero-3"]}},"git_oid_shorten_new":{"type":"function","file":"git2/oid.h","line":231,"lineto":231,"args":[{"name":"min_length","type":"size_t","comment":"The minimal length for all identifiers,\n\t\twhich will be used even if shorter OIDs would still\n\t\tbe 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 in text form and return the shortest length that would uniquely 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":"git2/oid.h","line":257,"lineto":257,"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\n\t\tadded so far to the set; or an error code (\n<\n0) if an\n\t\terror occurs."},"description":"<p>Add a new OID to set of shortened OIDs and calculate\n the minimal length to uniquely identify all the OIDs in\n the set.</p>\n","comments":"<p>The OID is expected to be a 40-char hexadecimal string. The OID is owned by the user and will not be modified or freed.</p>\n\n<p>For performance reasons, there is a hard-limit of how many OIDs can be added to a single set (around ~32000, assuming a mostly randomized distribution), which should be enough for any kind of program, and keeps the algorithm fast and memory-efficient.</p>\n\n<p>Attempting to add more than those OIDs will result in a GITERR_INVALID error</p>\n","group":"oid"},"git_oid_shorten_free":{"type":"function","file":"git2/oid.h","line":264,"lineto":264,"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","comment":null},"description":"<p>Free an OID shortener instance</p>\n","comments":"","group":"oid"},"git_oidarray_free":{"type":"function","file":"git2/oidarray.h","line":34,"lineto":34,"args":[{"name":"array","type":"git_oidarray *","comment":"git_oidarray from which to free oid data"}],"argline":"git_oidarray *array","sig":"git_oidarray *","return":{"type":"void","comment":null},"description":"<p>Free the OID array</p>\n","comments":"<p>This method must (and must only) be called on <code>git_oidarray</code> objects where the array is allocated by the library. Not doing so, will result in a memory leak.</p>\n\n<p>This does not free the <code>git_oidarray</code> itself, since the library will never allocate that object directly itself (it is more commonly embedded inside another struct or created on the stack).</p>\n","group":"oidarray"},"git_packbuilder_new":{"type":"function","file":"git2/pack.h","line":64,"lineto":64,"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":"git2/pack.h","line":77,"lineto":77,"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't spawn any threads at all; when set to 0, libgit2 will autodetect the number of CPUs.</p>\n","group":"packbuilder"},"git_packbuilder_insert":{"type":"function","file":"git2/pack.h","line":91,"lineto":91,"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's mandatory to insert objects in recency order, commits followed by trees and blobs.</p>\n","group":"packbuilder"},"git_packbuilder_insert_tree":{"type":"function","file":"git2/pack.h","line":103,"lineto":103,"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_insert_commit":{"type":"function","file":"git2/pack.h","line":115,"lineto":115,"args":[{"name":"pb","type":"git_packbuilder *","comment":"The packbuilder"},{"name":"id","type":"const git_oid *","comment":"The oid of the commit"}],"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 commit object</p>\n","comments":"<p>This will add a commit as well as the completed referenced tree.</p>\n","group":"packbuilder"},"git_packbuilder_insert_walk":{"type":"function","file":"git2/pack.h","line":128,"lineto":128,"args":[{"name":"pb","type":"git_packbuilder *","comment":"the packbuilder"},{"name":"walk","type":"git_revwalk *","comment":"the revwalk to use to fill the packbuilder"}],"argline":"git_packbuilder *pb, git_revwalk *walk","sig":"git_packbuilder *::git_revwalk *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Insert objects as given by the walk</p>\n","comments":"<p>Those commits and all objects they reference will be inserted into the packbuilder.</p>\n","group":"packbuilder"},"git_packbuilder_insert_recur":{"type":"function","file":"git2/pack.h","line":140,"lineto":140,"args":[{"name":"pb","type":"git_packbuilder *","comment":"the packbuilder"},{"name":"id","type":"const git_oid *","comment":"the id of the root object to insert"},{"name":"name","type":"const char *","comment":"optional name for the object"}],"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>Recursively insert an object and its referenced objects</p>\n","comments":"<p>Insert the object as well as any object it references.</p>\n","group":"packbuilder"},"git_packbuilder_write":{"type":"function","file":"git2/pack.h","line":164,"lineto":169,"args":[{"name":"pb","type":"git_packbuilder *","comment":"The packbuilder"},{"name":"path","type":"const char *","comment":"to the directory where the packfile and index should be stored"},{"name":"mode","type":"unsigned int","comment":"permissions to use creating a packfile or 0 for defaults"},{"name":"progress_cb","type":"git_transfer_progress_cb","comment":"function to call with progress information from the indexer (optional)"},{"name":"progress_cb_payload","type":"void *","comment":"payload for the progress callback (optional)"}],"argline":"git_packbuilder *pb, const char *path, unsigned int mode, git_transfer_progress_cb progress_cb, void *progress_cb_payload","sig":"git_packbuilder *::const char *::unsigned int::git_transfer_progress_cb::void *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Write the new pack and corresponding index file to path.</p>\n","comments":"","group":"packbuilder"},"git_packbuilder_hash":{"type":"function","file":"git2/pack.h","line":179,"lineto":179,"args":[{"name":"pb","type":"git_packbuilder *","comment":"The packbuilder object"}],"argline":"git_packbuilder *pb","sig":"git_packbuilder *","return":{"type":"const git_oid *","comment":null},"description":"<p>Get the packfile's hash</p>\n","comments":"<p>A packfile's name is derived from the sorted hashing of all object names. This is only correct after the packfile has been written.</p>\n","group":"packbuilder"},"git_packbuilder_foreach":{"type":"function","file":"git2/pack.h","line":191,"lineto":191,"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":"git2/pack.h","line":199,"lineto":199,"args":[{"name":"pb","type":"git_packbuilder *","comment":"the packbuilder"}],"argline":"git_packbuilder *pb","sig":"git_packbuilder *","return":{"type":"size_t","comment":" the number of objects in the packfile"},"description":"<p>Get the total number of objects the packbuilder will write out</p>\n","comments":"","group":"packbuilder"},"git_packbuilder_written":{"type":"function","file":"git2/pack.h","line":207,"lineto":207,"args":[{"name":"pb","type":"git_packbuilder *","comment":"the packbuilder"}],"argline":"git_packbuilder *pb","sig":"git_packbuilder *","return":{"type":"size_t","comment":" the number of objects which have already been written"},"description":"<p>Get the number of objects the packbuilder has already written out</p>\n","comments":"","group":"packbuilder"},"git_packbuilder_set_callbacks":{"type":"function","file":"git2/pack.h","line":226,"lineto":229,"args":[{"name":"pb","type":"git_packbuilder *","comment":"The packbuilder object"},{"name":"progress_cb","type":"git_packbuilder_progress","comment":"Function to call with progress information during\n pack building. Be aware that this is called inline with pack building\n operations, so performance may be affected."},{"name":"progress_cb_payload","type":"void *","comment":"Payload for progress callback."}],"argline":"git_packbuilder *pb, git_packbuilder_progress progress_cb, void *progress_cb_payload","sig":"git_packbuilder *::git_packbuilder_progress::void *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Set the callbacks for a packbuilder</p>\n","comments":"","group":"packbuilder"},"git_packbuilder_free":{"type":"function","file":"git2/pack.h","line":236,"lineto":236,"args":[{"name":"pb","type":"git_packbuilder *","comment":"The packbuilder"}],"argline":"git_packbuilder *pb","sig":"git_packbuilder *","return":{"type":"void","comment":null},"description":"<p>Free the packbuilder and all associated data</p>\n","comments":"","group":"packbuilder"},"git_patch_from_diff":{"type":"function","file":"git2/patch.h","line":51,"lineto":52,"args":[{"name":"out","type":"git_patch **","comment":"Output parameter for the delta patch object"},{"name":"diff","type":"git_diff *","comment":"Diff list object"},{"name":"idx","type":"size_t","comment":"Index into diff list"}],"argline":"git_patch **out, git_diff *diff, size_t idx","sig":"git_patch **::git_diff *::size_t","return":{"type":"int","comment":" 0 on success, other value \n<\n 0 on error"},"description":"<p>Return a patch for an entry in the diff list.</p>\n","comments":"<p>The <code>git_patch</code> is a newly created object contains the text diffs for the delta. You have to call <code>git_patch_free()</code> when you are done with it. You can use the patch object to loop over all the hunks and lines in the diff of the one delta.</p>\n\n<p>For an unchanged file or a binary file, no <code>git_patch</code> will be created, the output will be set to NULL, and the <code>binary</code> flag will be set true in the <code>git_diff_delta</code> structure.</p>\n\n<p>It is okay to pass NULL for either of the output parameters; if you pass NULL for the <code>git_patch</code>, then the text diff will not be calculated.</p>\n","group":"patch"},"git_patch_from_blobs":{"type":"function","file":"git2/patch.h","line":70,"lineto":76,"args":[{"name":"out","type":"git_patch **","comment":"The generated patch; NULL on error"},{"name":"old_blob","type":"const git_blob *","comment":"Blob for old side of diff, or NULL for empty blob"},{"name":"old_as_path","type":"const char *","comment":"Treat old blob as if it had this filename; can be NULL"},{"name":"new_blob","type":"const git_blob *","comment":"Blob for new side of diff, or NULL for empty blob"},{"name":"new_as_path","type":"const char *","comment":"Treat new blob as if it had this filename; can be NULL"},{"name":"opts","type":"const git_diff_options *","comment":"Options for diff, or NULL for default options"}],"argline":"git_patch **out, const git_blob *old_blob, const char *old_as_path, const git_blob *new_blob, const char *new_as_path, const git_diff_options *opts","sig":"git_patch **::const git_blob *::const char *::const git_blob *::const char *::const git_diff_options *","return":{"type":"int","comment":" 0 on success or error code \n<\n 0"},"description":"<p>Directly generate a patch from the difference between two blobs.</p>\n","comments":"<p>This is just like <code>git_diff_blobs()</code> except it generates a patch object for the difference instead of directly making callbacks. You can use the standard <code>git_patch</code> accessor functions to read the patch data, and you must call <code>git_patch_free()</code> on the patch when done.</p>\n","group":"patch"},"git_patch_from_blob_and_buffer":{"type":"function","file":"git2/patch.h","line":95,"lineto":102,"args":[{"name":"out","type":"git_patch **","comment":"The generated patch; NULL on error"},{"name":"old_blob","type":"const git_blob *","comment":"Blob for old side of diff, or NULL for empty blob"},{"name":"old_as_path","type":"const char *","comment":"Treat old blob as if it had this filename; can be NULL"},{"name":"buffer","type":"const void *","comment":"Raw data for new side of diff, or NULL for empty"},{"name":"buffer_len","type":"size_t","comment":"Length of raw data for new side of diff"},{"name":"buffer_as_path","type":"const char *","comment":"Treat buffer as if it had this filename; can be NULL"},{"name":"opts","type":"const git_diff_options *","comment":"Options for diff, or NULL for default options"}],"argline":"git_patch **out, const git_blob *old_blob, const char *old_as_path, const void *buffer, size_t buffer_len, const char *buffer_as_path, const git_diff_options *opts","sig":"git_patch **::const git_blob *::const char *::const void *::size_t::const char *::const git_diff_options *","return":{"type":"int","comment":" 0 on success or error code \n<\n 0"},"description":"<p>Directly generate a patch from the difference between a blob and a buffer.</p>\n","comments":"<p>This is just like <code>git_diff_blob_to_buffer()</code> except it generates a patch object for the difference instead of directly making callbacks. You can use the standard <code>git_patch</code> accessor functions to read the patch data, and you must call <code>git_patch_free()</code> on the patch when done.</p>\n","group":"patch"},"git_patch_from_buffers":{"type":"function","file":"git2/patch.h","line":122,"lineto":130,"args":[{"name":"out","type":"git_patch **","comment":"The generated patch; NULL on error"},{"name":"old_buffer","type":"const void *","comment":"Raw data for old side of diff, or NULL for empty"},{"name":"old_len","type":"size_t","comment":"Length of the raw data for old side of the diff"},{"name":"old_as_path","type":"const char *","comment":"Treat old buffer as if it had this filename; can be NULL"},{"name":"new_buffer","type":"const void *","comment":"Raw data for new side of diff, or NULL for empty"},{"name":"new_len","type":"size_t","comment":"Length of raw data for new side of diff"},{"name":"new_as_path","type":"const char *","comment":"Treat buffer as if it had this filename; can be NULL"},{"name":"opts","type":"const git_diff_options *","comment":"Options for diff, or NULL for default options"}],"argline":"git_patch **out, const void *old_buffer, size_t old_len, const char *old_as_path, const void *new_buffer, size_t new_len, const char *new_as_path, const git_diff_options *opts","sig":"git_patch **::const void *::size_t::const char *::const void *::size_t::const char *::const git_diff_options *","return":{"type":"int","comment":" 0 on success or error code \n<\n 0"},"description":"<p>Directly generate a patch from the difference between two buffers.</p>\n","comments":"<p>This is just like <code>git_diff_buffers()</code> except it generates a patch object for the difference instead of directly making callbacks. You can use the standard <code>git_patch</code> accessor functions to read the patch data, and you must call <code>git_patch_free()</code> on the patch when done.</p>\n","group":"patch"},"git_patch_free":{"type":"function","file":"git2/patch.h","line":135,"lineto":135,"args":[{"name":"patch","type":"git_patch *","comment":null}],"argline":"git_patch *patch","sig":"git_patch *","return":{"type":"void","comment":null},"description":"<p>Free a git_patch object.</p>\n","comments":"","group":"patch"},"git_patch_get_delta":{"type":"function","file":"git2/patch.h","line":141,"lineto":141,"args":[{"name":"patch","type":"const git_patch *","comment":null}],"argline":"const git_patch *patch","sig":"const git_patch *","return":{"type":"const git_diff_delta *","comment":null},"description":"<p>Get the delta associated with a patch. This delta points to internal\n data and you do not have to release it when you are done with it.</p>\n","comments":"","group":"patch"},"git_patch_num_hunks":{"type":"function","file":"git2/patch.h","line":146,"lineto":146,"args":[{"name":"patch","type":"const git_patch *","comment":null}],"argline":"const git_patch *patch","sig":"const git_patch *","return":{"type":"size_t","comment":null},"description":"<p>Get the number of hunks in a patch</p>\n","comments":"","group":"patch"},"git_patch_line_stats":{"type":"function","file":"git2/patch.h","line":164,"lineto":168,"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_patch *","comment":"The git_patch object"}],"argline":"size_t *total_context, size_t *total_additions, size_t *total_deletions, const git_patch *patch","sig":"size_t *::size_t *::size_t *::const git_patch *","return":{"type":"int","comment":" 0 on success, \n<\n0 on error"},"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, you only need the <code>total_additions</code> and <code>total_deletions</code> values, but we include the <code>total_context</code> line count in case you want the total number of lines of diff output that will be generated.</p>\n\n<p>All outputs are optional. Pass NULL if you don't need a particular count.</p>\n","group":"patch"},"git_patch_get_hunk":{"type":"function","file":"git2/patch.h","line":183,"lineto":187,"args":[{"name":"out","type":"const git_diff_hunk **","comment":"Output pointer to git_diff_hunk of hunk"},{"name":"lines_in_hunk","type":"size_t *","comment":"Output count of total lines in this hunk"},{"name":"patch","type":"git_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_hunk **out, size_t *lines_in_hunk, git_patch *patch, size_t hunk_idx","sig":"const git_diff_hunk **::size_t *::git_patch *::size_t","return":{"type":"int","comment":" 0 on success, GIT_ENOTFOUND if hunk_idx out of range, \n<\n0 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 information about that hunk. Any of the output pointers can be passed as NULL if you don't care about that particular piece of information.</p>\n","group":"patch"},"git_patch_num_lines_in_hunk":{"type":"function","file":"git2/patch.h","line":196,"lineto":198,"args":[{"name":"patch","type":"const git_patch *","comment":"The git_patch object"},{"name":"hunk_idx","type":"size_t","comment":"Index of the hunk"}],"argline":"const git_patch *patch, size_t hunk_idx","sig":"const git_patch *::size_t","return":{"type":"int","comment":" Number of lines in hunk or GIT_ENOTFOUND if invalid hunk index"},"description":"<p>Get the number of lines in a hunk.</p>\n","comments":"","group":"patch"},"git_patch_get_line_in_hunk":{"type":"function","file":"git2/patch.h","line":214,"lineto":218,"args":[{"name":"out","type":"const git_diff_line **","comment":"The git_diff_line data for this line"},{"name":"patch","type":"git_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","comment":"The index of the line in the hunk"}],"argline":"const git_diff_line **out, git_patch *patch, size_t hunk_idx, size_t line_of_hunk","sig":"const git_diff_line **::git_patch *::size_t::size_t","return":{"type":"int","comment":" 0 on success, \n<\n0 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 will return a lot of details about that line. If you pass a hunk index larger than the number of hunks or a line index larger than the number of lines in the hunk, this will return -1.</p>\n","group":"patch"},"git_patch_size":{"type":"function","file":"git2/patch.h","line":236,"lineto":240,"args":[{"name":"patch","type":"git_patch *","comment":"A git_patch representing changes to one file"},{"name":"include_context","type":"int","comment":"Include context lines in size if non-zero"},{"name":"include_hunk_headers","type":"int","comment":"Include hunk header lines if non-zero"},{"name":"include_file_headers","type":"int","comment":"Include file header lines if non-zero"}],"argline":"git_patch *patch, int include_context, int include_hunk_headers, int include_file_headers","sig":"git_patch *::int::int::int","return":{"type":"size_t","comment":" The number of bytes of data"},"description":"<p>Look up size of patch diff data in bytes</p>\n","comments":"<p>This returns the raw size of the patch data. This only includes the actual data from the lines of the diff, not the file or hunk headers.</p>\n\n<p>If you pass <code>include_context</code> as true (non-zero), this will be the size of all of the diff output; if you pass it as false (zero), this will only include the actual changed lines (as if <code>context_lines</code> was 0).</p>\n","group":"patch"},"git_patch_print":{"type":"function","file":"git2/patch.h","line":254,"lineto":257,"args":[{"name":"patch","type":"git_patch *","comment":"A git_patch representing changes to one file"},{"name":"print_cb","type":"git_diff_line_cb","comment":"Callback function to output lines of the patch. Will be\n 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_patch *patch, git_diff_line_cb print_cb, void *payload","sig":"git_patch *::git_diff_line_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, 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 and return that value to the caller.</p>\n","group":"patch"},"git_patch_to_buf":{"type":"function","file":"git2/patch.h","line":266,"lineto":268,"args":[{"name":"out","type":"git_buf *","comment":"The git_buf to be filled in"},{"name":"patch","type":"git_patch *","comment":"A git_patch representing changes to one file"}],"argline":"git_buf *out, git_patch *patch","sig":"git_buf *::git_patch *","return":{"type":"int","comment":" 0 on success, \n<\n0 on failure."},"description":"<p>Get the content of a patch as a single diff text.</p>\n","comments":"","group":"patch"},"git_proxy_init_options":{"type":"function","file":"git2/proxy.h","line":88,"lineto":88,"args":[{"name":"opts","type":"git_proxy_options *","comment":"the options struct to initialize"},{"name":"version","type":"unsigned int","comment":"the version of the struct, use `GIT_PROXY_OPTIONS_VERSION`"}],"argline":"git_proxy_options *opts, unsigned int version","sig":"git_proxy_options *::unsigned int","return":{"type":"int","comment":null},"description":"<p>Initialize a proxy options structure</p>\n","comments":"","group":"proxy"},"git_rebase_init_options":{"type":"function","file":"git2/rebase.h","line":156,"lineto":158,"args":[{"name":"opts","type":"git_rebase_options *","comment":"the `git_rebase_options` instance to initialize."},{"name":"version","type":"unsigned int","comment":"the version of the struct; you should pass\n `GIT_REBASE_OPTIONS_VERSION` here."}],"argline":"git_rebase_options *opts, unsigned int version","sig":"git_rebase_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_rebase_options</code> with default values. Equivalent to\n creating an instance with GIT_REBASE_OPTIONS_INIT.</p>\n","comments":"","group":"rebase"},"git_rebase_init":{"type":"function","file":"git2/rebase.h","line":177,"lineto":183,"args":[{"name":"out","type":"git_rebase **","comment":"Pointer to store the rebase object"},{"name":"repo","type":"git_repository *","comment":"The repository to perform the rebase"},{"name":"branch","type":"const git_annotated_commit *","comment":"The terminal commit to rebase, or NULL to rebase the\n current branch"},{"name":"upstream","type":"const git_annotated_commit *","comment":"The commit to begin rebasing from, or NULL to rebase all\n reachable commits"},{"name":"onto","type":"const git_annotated_commit *","comment":"The branch to rebase onto, or NULL to rebase onto the given\n upstream"},{"name":"opts","type":"const git_rebase_options *","comment":"Options to specify how rebase is performed, or NULL"}],"argline":"git_rebase **out, git_repository *repo, const git_annotated_commit *branch, const git_annotated_commit *upstream, const git_annotated_commit *onto, const git_rebase_options *opts","sig":"git_rebase **::git_repository *::const git_annotated_commit *::const git_annotated_commit *::const git_annotated_commit *::const git_rebase_options *","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a rebase operation to rebase the changes in <code>branch</code>\n relative to <code>upstream</code> onto another branch. To begin the rebase\n process, call <code>git_rebase_next</code>. When you have finished with this\n object, call <code>git_rebase_free</code>.</p>\n","comments":"","group":"rebase"},"git_rebase_open":{"type":"function","file":"git2/rebase.h","line":194,"lineto":197,"args":[{"name":"out","type":"git_rebase **","comment":"Pointer to store the rebase object"},{"name":"repo","type":"git_repository *","comment":"The repository that has a rebase in-progress"},{"name":"opts","type":"const git_rebase_options *","comment":"Options to specify how rebase is performed"}],"argline":"git_rebase **out, git_repository *repo, const git_rebase_options *opts","sig":"git_rebase **::git_repository *::const git_rebase_options *","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Opens an existing rebase that was previously started by either an\n invocation of <code>git_rebase_init</code> or by another client.</p>\n","comments":"","group":"rebase"},"git_rebase_operation_entrycount":{"type":"function","file":"git2/rebase.h","line":205,"lineto":205,"args":[{"name":"rebase","type":"git_rebase *","comment":"The in-progress rebase"}],"argline":"git_rebase *rebase","sig":"git_rebase *","return":{"type":"size_t","comment":" The number of rebase operations in total"},"description":"<p>Gets the count of rebase operations that are to be applied.</p>\n","comments":"","group":"rebase"},"git_rebase_operation_current":{"type":"function","file":"git2/rebase.h","line":216,"lineto":216,"args":[{"name":"rebase","type":"git_rebase *","comment":"The in-progress rebase"}],"argline":"git_rebase *rebase","sig":"git_rebase *","return":{"type":"size_t","comment":" The index of the rebase operation currently being applied."},"description":"<p>Gets the index of the rebase operation that is currently being applied.\n If the first operation has not yet been applied (because you have\n called <code>init</code> but not yet <code>next</code>) then this returns\n <code>GIT_REBASE_NO_OPERATION</code>.</p>\n","comments":"","group":"rebase"},"git_rebase_operation_byindex":{"type":"function","file":"git2/rebase.h","line":225,"lineto":227,"args":[{"name":"rebase","type":"git_rebase *","comment":"The in-progress rebase"},{"name":"idx","type":"size_t","comment":"The index of the rebase operation to retrieve"}],"argline":"git_rebase *rebase, size_t idx","sig":"git_rebase *::size_t","return":{"type":"git_rebase_operation *","comment":" The rebase operation or NULL if `idx` was out of bounds"},"description":"<p>Gets the rebase operation specified by the given index.</p>\n","comments":"","group":"rebase"},"git_rebase_next":{"type":"function","file":"git2/rebase.h","line":240,"lineto":242,"args":[{"name":"operation","type":"git_rebase_operation **","comment":"Pointer to store the rebase operation that is to be performed next"},{"name":"rebase","type":"git_rebase *","comment":"The rebase in progress"}],"argline":"git_rebase_operation **operation, git_rebase *rebase","sig":"git_rebase_operation **::git_rebase *","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Performs the next rebase operation and returns the information about it.\n If the operation is one that applies a patch (which is any operation except\n GIT_REBASE_OPERATION_EXEC) then the patch will be applied and the index and\n working directory will be updated with the changes. If there are conflicts,\n you will need to address those before committing the changes.</p>\n","comments":"","group":"rebase"},"git_rebase_inmemory_index":{"type":"function","file":"git2/rebase.h","line":255,"lineto":257,"args":[{"name":"index","type":"git_index **","comment":null},{"name":"rebase","type":"git_rebase *","comment":null}],"argline":"git_index **index, git_rebase *rebase","sig":"git_index **::git_rebase *","return":{"type":"int","comment":null},"description":"<p>Gets the index produced by the last operation, which is the result\n of <code>git_rebase_next</code> and which will be committed by the next\n invocation of <code>git_rebase_commit</code>. This is useful for resolving\n conflicts in an in-memory rebase before committing them. You must\n call <code>git_index_free</code> when you are finished with this.</p>\n","comments":"<p>This is only applicable for in-memory rebases; for rebases within a working directory, the changes were applied to the repository's index.</p>\n","group":"rebase"},"git_rebase_commit":{"type":"function","file":"git2/rebase.h","line":281,"lineto":287,"args":[{"name":"id","type":"git_oid *","comment":"Pointer in which to store the OID of the newly created commit"},{"name":"rebase","type":"git_rebase *","comment":"The rebase that is in-progress"},{"name":"author","type":"const git_signature *","comment":"The author of the updated commit, or NULL to keep the\n author from the original commit"},{"name":"committer","type":"const git_signature *","comment":"The committer of the rebase"},{"name":"message_encoding","type":"const char *","comment":"The encoding for the message in the commit,\n represented with a standard encoding name. If message is NULL,\n this should also be NULL, and the encoding from the original\n commit will be maintained. If message is specified, this may be\n NULL to indicate that \"UTF-8\" is to be used."},{"name":"message","type":"const char *","comment":"The message for this commit, or NULL to use the message\n from the original commit."}],"argline":"git_oid *id, git_rebase *rebase, const git_signature *author, const git_signature *committer, const char *message_encoding, const char *message","sig":"git_oid *::git_rebase *::const git_signature *::const git_signature *::const char *::const char *","return":{"type":"int","comment":" Zero on success, GIT_EUNMERGED if there are unmerged changes in\n the index, GIT_EAPPLIED if the current commit has already\n been applied to the upstream and there is nothing to commit,\n -1 on failure."},"description":"<p>Commits the current patch. You must have resolved any conflicts that\n were introduced during the patch application from the <code>git_rebase_next</code>\n invocation.</p>\n","comments":"","group":"rebase"},"git_rebase_abort":{"type":"function","file":"git2/rebase.h","line":297,"lineto":297,"args":[{"name":"rebase","type":"git_rebase *","comment":"The rebase that is in-progress"}],"argline":"git_rebase *rebase","sig":"git_rebase *","return":{"type":"int","comment":" Zero on success; GIT_ENOTFOUND if a rebase is not in progress,\n -1 on other errors."},"description":"<p>Aborts a rebase that is currently in progress, resetting the repository\n and working directory to their state before rebase began.</p>\n","comments":"","group":"rebase"},"git_rebase_finish":{"type":"function","file":"git2/rebase.h","line":307,"lineto":309,"args":[{"name":"rebase","type":"git_rebase *","comment":"The rebase that is in-progress"},{"name":"signature","type":"const git_signature *","comment":"The identity that is finishing the rebase (optional)"}],"argline":"git_rebase *rebase, const git_signature *signature","sig":"git_rebase *::const git_signature *","return":{"type":"int","comment":" Zero on success; -1 on error"},"description":"<p>Finishes a rebase that is currently in progress once all patches have\n been applied.</p>\n","comments":"","group":"rebase"},"git_rebase_free":{"type":"function","file":"git2/rebase.h","line":316,"lineto":316,"args":[{"name":"rebase","type":"git_rebase *","comment":"The rebase object"}],"argline":"git_rebase *rebase","sig":"git_rebase *","return":{"type":"void","comment":null},"description":"<p>Frees the <code>git_rebase</code> object.</p>\n","comments":"","group":"rebase"},"git_refdb_new":{"type":"function","file":"git2/refdb.h","line":35,"lineto":35,"args":[{"name":"out","type":"git_refdb **","comment":"location to store the database pointer, if opened.\n\t\t\tSet 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 backend must be manually set using <code>git_refdb_set_backend()</code></p>\n","group":"refdb"},"git_refdb_open":{"type":"function","file":"git2/refdb.h","line":49,"lineto":49,"args":[{"name":"out","type":"git_refdb **","comment":"location to store the database pointer, if opened.\n\t\t\tSet 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\n the default backends:</p>\n","comments":"<ul>\n<li>git_refdb_dir: read and write loose and packed refs from disk, assuming the repository dir as the folder</li>\n</ul>\n","group":"refdb"},"git_refdb_compress":{"type":"function","file":"git2/refdb.h","line":56,"lineto":56,"args":[{"name":"refdb","type":"git_refdb *","comment":null}],"argline":"git_refdb *refdb","sig":"git_refdb *","return":{"type":"int","comment":null},"description":"<p>Suggests that the given refdb compress or optimize its references.\n This mechanism is implementation specific. For on-disk reference\n databases, for example, this may pack all loose references.</p>\n","comments":"","group":"refdb"},"git_refdb_free":{"type":"function","file":"git2/refdb.h","line":63,"lineto":63,"args":[{"name":"refdb","type":"git_refdb *","comment":"reference database pointer or NULL"}],"argline":"git_refdb *refdb","sig":"git_refdb *","return":{"type":"void","comment":null},"description":"<p>Close an open reference database.</p>\n","comments":"","group":"refdb"},"git_reflog_read":{"type":"function","file":"git2/reflog.h","line":38,"lineto":38,"args":[{"name":"out","type":"git_reflog **","comment":"pointer to reflog"},{"name":"repo","type":"git_repository *","comment":"the repostiory"},{"name":"name","type":"const char *","comment":"reference to look up"}],"argline":"git_reflog **out, git_repository *repo, const char *name","sig":"git_reflog **::git_repository *::const char *","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 reference yet, an empty reflog object will be returned.</p>\n\n<p>The reflog must be freed manually by using git_reflog_free().</p>\n","group":"reflog"},"git_reflog_write":{"type":"function","file":"git2/reflog.h","line":47,"lineto":47,"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\n using an atomic file lock.</p>\n","comments":"","group":"reflog"},"git_reflog_append":{"type":"function","file":"git2/reflog.h","line":60,"lineto":60,"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 in-memory reflog.</p>\n","comments":"<p><code>msg</code> is optional and can be NULL.</p>\n","group":"reflog"},"git_reflog_rename":{"type":"function","file":"git2/reflog.h","line":75,"lineto":75,"args":[{"name":"repo","type":"git_repository *","comment":"the repository"},{"name":"old_name","type":"const char *","comment":"the old name of the reference"},{"name":"name","type":"const char *","comment":"the new name of the reference"}],"argline":"git_repository *repo, const char *old_name, const char *name","sig":"git_repository *::const char *::const char *","return":{"type":"int","comment":" 0 on success, GIT_EINVALIDSPEC or an error code"},"description":"<p>Rename a reflog</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. See <code>git_reference_create_symbolic()</code> for rules about valid names.</p>\n","group":"reflog"},"git_reflog_delete":{"type":"function","file":"git2/reflog.h","line":84,"lineto":84,"args":[{"name":"repo","type":"git_repository *","comment":"the repository"},{"name":"name","type":"const char *","comment":"the reflog to delete"}],"argline":"git_repository *repo, const char *name","sig":"git_repository *::const char *","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":"git2/reflog.h","line":92,"lineto":92,"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":"git2/reflog.h","line":105,"lineto":105,"args":[{"name":"reflog","type":"const 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\n equal to 0 (zero) and less than `git_reflog_entrycount()`."}],"argline":"const git_reflog *reflog, size_t idx","sig":"const 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 return the most recently created entry.</p>\n","group":"reflog"},"git_reflog_drop":{"type":"function","file":"git2/reflog.h","line":124,"lineto":127,"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\n 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, size_t idx, int rewrite_previous_entry","sig":"git_reflog *::size_t::int","return":{"type":"int","comment":" 0 on success, GIT_ENOTFOUND if the entry doesn't exist\n or an error code."},"description":"<p>Remove an entry from the reflog by its index</p>\n","comments":"<p>To ensure there's no gap in the log history, set <code>rewrite_previous_entry</code> param value to 1. When deleting entry <code>n</code>, member old_oid of entry <code>n-1</code> (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":"git2/reflog.h","line":135,"lineto":135,"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":"git2/reflog.h","line":143,"lineto":143,"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":"git2/reflog.h","line":151,"lineto":151,"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":"git2/reflog.h","line":159,"lineto":159,"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":"git2/reflog.h","line":166,"lineto":166,"args":[{"name":"reflog","type":"git_reflog *","comment":"reflog to free"}],"argline":"git_reflog *reflog","sig":"git_reflog *","return":{"type":"void","comment":null},"description":"<p>Free the reflog</p>\n","comments":"","group":"reflog"},"git_reference_lookup":{"type":"function","file":"git2/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, GIT_ENOTFOUND, GIT_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. See <code>git_reference_symbolic_create()</code> for rules about valid names.</p>\n","group":"reference","examples":{"general.c":["ex/v0.27.1/general.html#git_reference_lookup-62"],"merge.c":["ex/v0.27.1/merge.html#git_reference_lookup-26"]}},"git_reference_name_to_id":{"type":"function","file":"git2/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 (e.g. HEAD, refs/heads/master, refs/tags/v0.1.0, ...)"}],"argline":"git_oid *out, git_repository *repo, const char *name","sig":"git_oid *::git_repository *::const char *","return":{"type":"int","comment":" 0 on success, GIT_ENOTFOUND, GIT_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 through to the object id that it refers to. This avoids having to allocate or free any <code>git_reference</code> objects for simple situations.</p>\n\n<p>The name will be checked for validity. See <code>git_reference_symbolic_create()</code> for rules about valid names.</p>\n","group":"reference"},"git_reference_dwim":{"type":"function","file":"git2/refs.h","line":68,"lineto":68,"args":[{"name":"out","type":"git_reference **","comment":"pointer in which to store the reference"},{"name":"repo","type":"git_repository *","comment":"the repository in which to look"},{"name":"shorthand","type":"const char *","comment":"the short name for the reference"}],"argline":"git_reference **out, git_repository *repo, const char *shorthand","sig":"git_reference **::git_repository *::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Lookup a reference by DWIMing its short name</p>\n","comments":"<p>Apply the git precendence rules to the given shorthand to determine which reference the user is referring to.</p>\n","group":"reference","examples":{"merge.c":["ex/v0.27.1/merge.html#git_reference_dwim-27","ex/v0.27.1/merge.html#git_reference_dwim-28"]}},"git_reference_symbolic_create_matching":{"type":"function","file":"git2/refs.h","line":109,"lineto":109,"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"},{"name":"current_value","type":"const char *","comment":"The expected value of the reference when updating"},{"name":"log_message","type":"const char *","comment":"The one line long message to be appended to the reflog"}],"argline":"git_reference **out, git_repository *repo, const char *name, const char *target, int force, const char *current_value, const char *log_message","sig":"git_reference **::git_repository *::const char *::const char *::int::const char *::const char *","return":{"type":"int","comment":" 0 on success, GIT_EEXISTS, GIT_EINVALIDSPEC, GIT_EMODIFIED or an error code"},"description":"<p>Conditionally create a new symbolic reference.</p>\n","comments":"<p>A symbolic reference is a reference name that refers to another reference name. If the other name moves, the symbolic name will move, too. As a simple example, the "HEAD" reference might refer to "refs/heads/master" while on the "master" branch of a repository.</p>\n\n<p>The symbolic reference will be created in the repository and written to the 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, and must begin and end with a letter. (e.g. "HEAD", "ORIG_HEAD"). 2. Names prefixed with "refs/" can be almost anything. You must avoid the characters '~', '^', ':', '\\', '?', '[', and '*', and the sequences ".." and "@{" 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 given name unless <code>force</code> is true, in which case it will be overwritten.</p>\n\n<p>The message for the reflog will be ignored if the reference does not belong in the standard set (HEAD, branches and remote-tracking branches) and it does not have a reflog.</p>\n\n<p>It will return GIT_EMODIFIED if the reference's value at the time of updating does not match the one passed through <code>current_value</code> (i.e. if the ref has changed since the user read it).</p>\n","group":"reference"},"git_reference_symbolic_create":{"type":"function","file":"git2/refs.h","line":145,"lineto":145,"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"},{"name":"log_message","type":"const char *","comment":"The one line long message to be appended to the reflog"}],"argline":"git_reference **out, git_repository *repo, const char *name, const char *target, int force, const char *log_message","sig":"git_reference **::git_repository *::const char *::const char *::int::const char *","return":{"type":"int","comment":" 0 on success, GIT_EEXISTS, GIT_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 reference name. If the other name moves, the symbolic name will move, too. As a simple example, the "HEAD" reference might refer to "refs/heads/master" while on the "master" branch of a repository.</p>\n\n<p>The symbolic reference will be created in the repository and written to the 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, and must begin and end with a letter. (e.g. "HEAD", "ORIG_HEAD"). 2. Names prefixed with "refs/" can be almost anything. You must avoid the characters '~', '^', ':', '\\', '?', '[', and '*', and the sequences ".." and "@{" 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 given name unless <code>force</code> is true, in which case it will be overwritten.</p>\n\n<p>The message for the reflog will be ignored if the reference does not belong in the standard set (HEAD, branches and remote-tracking branches) and it does not have a reflog.</p>\n","group":"reference"},"git_reference_create":{"type":"function","file":"git2/refs.h","line":182,"lineto":182,"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"},{"name":"log_message","type":"const char *","comment":"The one line long message to be appended to the reflog"}],"argline":"git_reference **out, git_repository *repo, const char *name, const git_oid *id, int force, const char *log_message","sig":"git_reference **::git_repository *::const char *::const git_oid *::int::const char *","return":{"type":"int","comment":" 0 on success, GIT_EEXISTS, GIT_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 to a specific object id (a.k.a. OID or SHA) in the repository. The id permanently refers to the object (although the reference itself can be moved). For example, in libgit2 the direct ref "refs/tags/v0.17.0" refers to OID 5b9fac39d8a76b9139667c26a63e6b3f204b3977.</p>\n\n<p>The direct reference will be created in the repository and written to the 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, and must begin and end with a letter. (e.g. "HEAD", "ORIG_HEAD"). 2. Names prefixed with "refs/" can be almost anything. You must avoid the characters '~', '^', ':', '\\', '?', '[', and '*', and the sequences ".." and "@{" 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 given name unless <code>force</code> is true, in which case it will be overwritten.</p>\n\n<p>The message for the reflog will be ignored if the reference does not belong in the standard set (HEAD, branches and remote-tracking branches) and and it does not have a reflog.</p>\n","group":"reference","examples":{"merge.c":["ex/v0.27.1/merge.html#git_reference_create-29"]}},"git_reference_create_matching":{"type":"function","file":"git2/refs.h","line":225,"lineto":225,"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"},{"name":"current_id","type":"const git_oid *","comment":"The expected value of the reference at the time of update"},{"name":"log_message","type":"const char *","comment":"The one line long message to be appended to the reflog"}],"argline":"git_reference **out, git_repository *repo, const char *name, const git_oid *id, int force, const git_oid *current_id, const char *log_message","sig":"git_reference **::git_repository *::const char *::const git_oid *::int::const git_oid *::const char *","return":{"type":"int","comment":" 0 on success, GIT_EMODIFIED if the value of the reference\n has changed, GIT_EEXISTS, GIT_EINVALIDSPEC or an error code"},"description":"<p>Conditionally create new direct reference</p>\n","comments":"<p>A direct reference (also called an object id reference) refers directly to a specific object id (a.k.a. OID or SHA) in the repository. The id permanently refers to the object (although the reference itself can be moved). For example, in libgit2 the direct ref "refs/tags/v0.17.0" refers to OID 5b9fac39d8a76b9139667c26a63e6b3f204b3977.</p>\n\n<p>The direct reference will be created in the repository and written to the 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, and must begin and end with a letter. (e.g. "HEAD", "ORIG_HEAD"). 2. Names prefixed with "refs/" can be almost anything. You must avoid the characters '~', '^', ':', '\\', '?', '[', and '*', and the sequences ".." and "@{" 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 given name unless <code>force</code> is true, in which case it will be overwritten.</p>\n\n<p>The message for the reflog will be ignored if the reference does not belong in the standard set (HEAD, branches and remote-tracking branches) and and it does not have a reflog.</p>\n\n<p>It will return GIT_EMODIFIED if the reference's value at the time of updating does not match the one passed through <code>current_id</code> (i.e. if the ref has changed since the user read it).</p>\n","group":"reference"},"git_reference_target":{"type":"function","file":"git2/refs.h","line":240,"lineto":240,"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, not a symbolic one).</p>\n\n<p>To find the OID of a symbolic ref, call <code>git_reference_resolve()</code> and then this function (or maybe use <code>git_reference_name_to_id()</code> to directly resolve a reference name all the way through to an OID).</p>\n","group":"reference","examples":{"general.c":["ex/v0.27.1/general.html#git_reference_target-63"]}},"git_reference_target_peel":{"type":"function","file":"git2/refs.h","line":251,"lineto":251,"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>Return the peeled OID target of this reference.</p>\n","comments":"<p>This peeled OID only applies to direct references that point to a hard Tag object: it is the result of peeling such Tag.</p>\n","group":"reference"},"git_reference_symbolic_target":{"type":"function","file":"git2/refs.h","line":261,"lineto":261,"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.27.1/general.html#git_reference_symbolic_target-64"],"merge.c":["ex/v0.27.1/merge.html#git_reference_symbolic_target-30"]}},"git_reference_type":{"type":"function","file":"git2/refs.h","line":271,"lineto":271,"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.27.1/general.html#git_reference_type-65"]}},"git_reference_name":{"type":"function","file":"git2/refs.h","line":281,"lineto":281,"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_symbolic_create()</code> for rules about valid names.</p>\n","group":"reference","examples":{"merge.c":["ex/v0.27.1/merge.html#git_reference_name-31"]}},"git_reference_resolve":{"type":"function","file":"git2/refs.h","line":299,"lineto":299,"args":[{"name":"out","type":"git_reference **","comment":"Pointer to the peeled 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 a direct reference to an OID.</p>\n\n<p>The peeled reference is returned in the <code>resolved_ref</code> argument, and must be freed manually once it's no longer needed.</p>\n\n<p>If a direct reference is passed as an argument, a copy of that reference is returned. This copy must be manually freed too.</p>\n","group":"reference"},"git_reference_owner":{"type":"function","file":"git2/refs.h","line":307,"lineto":307,"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":"git2/refs.h","line":329,"lineto":333,"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"},{"name":"log_message","type":"const char *","comment":"The one line long message to be appended to the reflog"}],"argline":"git_reference **out, git_reference *ref, const char *target, const char *log_message","sig":"git_reference **::git_reference *::const char *::const char *","return":{"type":"int","comment":" 0 on success, GIT_EINVALIDSPEC or an error code"},"description":"<p>Create a new reference with the same name as the given reference but a\n different symbolic target. The reference must be a symbolic reference,\n otherwise 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. See <code>git_reference_symbolic_create()</code> for rules about valid names.</p>\n\n<p>The message for the reflog will be ignored if the reference does not belong in the standard set (HEAD, branches and remote-tracking branches) and and it does not have a reflog.</p>\n","group":"reference"},"git_reference_set_target":{"type":"function","file":"git2/refs.h","line":349,"lineto":353,"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"},{"name":"log_message","type":"const char *","comment":"The one line long message to be appended to the reflog"}],"argline":"git_reference **out, git_reference *ref, const git_oid *id, const char *log_message","sig":"git_reference **::git_reference *::const git_oid *::const char *","return":{"type":"int","comment":" 0 on success, GIT_EMODIFIED if the value of the reference\n has changed since it was read, or an error code"},"description":"<p>Conditionally create a new reference with the same name as the given reference but a\n different OID target. The reference must be a direct reference, otherwise\n this will fail.</p>\n","comments":"<p>The new reference will be written to disk, overwriting the given reference.</p>\n","group":"reference","examples":{"merge.c":["ex/v0.27.1/merge.html#git_reference_set_target-32"]}},"git_reference_rename":{"type":"function","file":"git2/refs.h","line":378,"lineto":383,"args":[{"name":"new_ref","type":"git_reference **","comment":null},{"name":"ref","type":"git_reference *","comment":"The reference to rename"},{"name":"new_name","type":"const char *","comment":"The new name for the reference"},{"name":"force","type":"int","comment":"Overwrite an existing reference"},{"name":"log_message","type":"const char *","comment":"The one line long message to be appended to the reflog"}],"argline":"git_reference **new_ref, git_reference *ref, const char *new_name, int force, const char *log_message","sig":"git_reference **::git_reference *::const char *::int::const char *","return":{"type":"int","comment":" 0 on success, GIT_EINVALIDSPEC, GIT_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. See <code>git_reference_symbolic_create()</code> for rules about valid names.</p>\n\n<p>If the <code>force</code> flag is not enabled, and there's already a reference with the given name, the renaming will fail.</p>\n\n<p>IMPORTANT: The user needs to write a proper reflog entry if the reflog is enabled for the repository. We only rename the reflog if it exists.</p>\n","group":"reference"},"git_reference_delete":{"type":"function","file":"git2/refs.h","line":398,"lineto":398,"args":[{"name":"ref","type":"git_reference *","comment":"The reference to remove"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"int","comment":" 0, GIT_EMODIFIED 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 will be immediately removed on disk but the memory will not be freed. Callers must call <code>git_reference_free</code>.</p>\n\n<p>This function will return an error if the reference has changed from the time it was looked up.</p>\n","group":"reference"},"git_reference_remove":{"type":"function","file":"git2/refs.h","line":409,"lineto":409,"args":[{"name":"repo","type":"git_repository *","comment":null},{"name":"name","type":"const char *","comment":"The reference to remove"}],"argline":"git_repository *repo, const char *name","sig":"git_repository *::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Delete an existing reference by name</p>\n","comments":"<p>This method removes the named reference from the repository without looking at its old value.</p>\n","group":"reference"},"git_reference_list":{"type":"function","file":"git2/refs.h","line":423,"lineto":423,"args":[{"name":"array","type":"git_strarray *","comment":"Pointer to a git_strarray structure where\n\t\tthe reference names will be stored"},{"name":"repo","type":"git_repository *","comment":"Repository where to find the refs"}],"argline":"git_strarray *array, git_repository *repo","sig":"git_strarray *::git_repository *","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>The string array will be filled with the names of all references; these values are owned by the user and should be free'd manually when no longer needed, using <code>git_strarray_free()</code>.</p>\n","group":"reference","examples":{"general.c":["ex/v0.27.1/general.html#git_reference_list-66"]}},"git_reference_foreach":{"type":"function","file":"git2/refs.h","line":444,"lineto":447,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where to find the refs"},{"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, git_reference_foreach_cb callback, void *payload","sig":"git_repository *::git_reference_foreach_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, or error code"},"description":"<p>Perform a callback on each reference in the repository.</p>\n","comments":"<p>The <code>callback</code> function will be called for each reference in the repository, receiving the reference object and the <code>payload</code> value passed to this method. Returning a non-zero value from the callback will terminate the iteration.</p>\n\n<p>Note that the callback function is responsible to call <code>git_reference_free</code> on each reference passed to it.</p>\n","group":"reference"},"git_reference_foreach_name":{"type":"function","file":"git2/refs.h","line":462,"lineto":465,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where to find the refs"},{"name":"callback","type":"git_reference_foreach_name_cb","comment":"Function which will be called for every listed ref name"},{"name":"payload","type":"void *","comment":"Additional data to pass to the callback"}],"argline":"git_repository *repo, git_reference_foreach_name_cb callback, void *payload","sig":"git_repository *::git_reference_foreach_name_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, or error code"},"description":"<p>Perform a callback on the fully-qualified name of each reference.</p>\n","comments":"<p>The <code>callback</code> function will be called for each reference in the repository, receiving the name of the reference and the <code>payload</code> value passed to this method. Returning a non-zero value from the callback will terminate the iteration.</p>\n","group":"reference"},"git_reference_dup":{"type":"function","file":"git2/refs.h","line":476,"lineto":476,"args":[{"name":"dest","type":"git_reference **","comment":"pointer where to store the copy"},{"name":"source","type":"git_reference *","comment":"object to copy"}],"argline":"git_reference **dest, git_reference *source","sig":"git_reference **::git_reference *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create a copy of an existing reference.</p>\n","comments":"<p>Call <code>git_reference_free</code> to free the data.</p>\n","group":"reference"},"git_reference_free":{"type":"function","file":"git2/refs.h","line":483,"lineto":483,"args":[{"name":"ref","type":"git_reference *","comment":"git_reference"}],"argline":"git_reference *ref","sig":"git_reference *","return":{"type":"void","comment":null},"description":"<p>Free the given reference.</p>\n","comments":"","group":"reference","examples":{"general.c":["ex/v0.27.1/general.html#git_reference_free-67"],"merge.c":["ex/v0.27.1/merge.html#git_reference_free-33","ex/v0.27.1/merge.html#git_reference_free-34","ex/v0.27.1/merge.html#git_reference_free-35","ex/v0.27.1/merge.html#git_reference_free-36"],"status.c":["ex/v0.27.1/status.html#git_reference_free-3"]}},"git_reference_cmp":{"type":"function","file":"git2/refs.h","line":492,"lineto":494,"args":[{"name":"ref1","type":"const git_reference *","comment":"The first git_reference"},{"name":"ref2","type":"const git_reference *","comment":"The second git_reference"}],"argline":"const git_reference *ref1, const git_reference *ref2","sig":"const git_reference *::const 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_iterator_new":{"type":"function","file":"git2/refs.h","line":503,"lineto":505,"args":[{"name":"out","type":"git_reference_iterator **","comment":"pointer in which to store the iterator"},{"name":"repo","type":"git_repository *","comment":"the repository"}],"argline":"git_reference_iterator **out, git_repository *repo","sig":"git_reference_iterator **::git_repository *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create an iterator for the repo's references</p>\n","comments":"","group":"reference"},"git_reference_iterator_glob_new":{"type":"function","file":"git2/refs.h","line":516,"lineto":519,"args":[{"name":"out","type":"git_reference_iterator **","comment":"pointer in which to store the iterator"},{"name":"repo","type":"git_repository *","comment":"the repository"},{"name":"glob","type":"const char *","comment":"the glob to match against the reference names"}],"argline":"git_reference_iterator **out, git_repository *repo, const char *glob","sig":"git_reference_iterator **::git_repository *::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create an iterator for the repo's references that match the\n specified glob</p>\n","comments":"","group":"reference"},"git_reference_next":{"type":"function","file":"git2/refs.h","line":528,"lineto":528,"args":[{"name":"out","type":"git_reference **","comment":"pointer in which to store the reference"},{"name":"iter","type":"git_reference_iterator *","comment":"the iterator"}],"argline":"git_reference **out, git_reference_iterator *iter","sig":"git_reference **::git_reference_iterator *","return":{"type":"int","comment":" 0, GIT_ITEROVER if there are no more; or an error code"},"description":"<p>Get the next reference</p>\n","comments":"","group":"reference"},"git_reference_next_name":{"type":"function","file":"git2/refs.h","line":541,"lineto":541,"args":[{"name":"out","type":"const char **","comment":"pointer in which to store the string"},{"name":"iter","type":"git_reference_iterator *","comment":"the iterator"}],"argline":"const char **out, git_reference_iterator *iter","sig":"const char **::git_reference_iterator *","return":{"type":"int","comment":" 0, GIT_ITEROVER if there are no more; or an error code"},"description":"<p>Get the next reference's name</p>\n","comments":"<p>This function is provided for convenience in case only the names are interesting as it avoids the allocation of the <code>git_reference</code> object which <code>git_reference_next()</code> needs.</p>\n","group":"reference"},"git_reference_iterator_free":{"type":"function","file":"git2/refs.h","line":548,"lineto":548,"args":[{"name":"iter","type":"git_reference_iterator *","comment":"the iterator to free"}],"argline":"git_reference_iterator *iter","sig":"git_reference_iterator *","return":{"type":"void","comment":null},"description":"<p>Free the iterator and its associated resources</p>\n","comments":"","group":"reference"},"git_reference_foreach_glob":{"type":"function","file":"git2/refs.h","line":568,"lineto":572,"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":"callback","type":"git_reference_foreach_name_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, const char *glob, git_reference_foreach_name_cb callback, void *payload","sig":"git_repository *::const char *::git_reference_foreach_name_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\n matches the given pattern.</p>\n","comments":"<p>This function acts like <code>git_reference_foreach()</code> with an additional pattern match being applied to the reference name before issuing the callback function. See that function for more information.</p>\n\n<p>The pattern is matched using fnmatch or "glob" style where a '*' matches any sequence of letters, a '?' matches any letter, and square brackets can be used to define character ranges (such as "[0-9]" for digits).</p>\n","group":"reference"},"git_reference_has_log":{"type":"function","file":"git2/refs.h","line":582,"lineto":582,"args":[{"name":"repo","type":"git_repository *","comment":"the repository"},{"name":"refname","type":"const char *","comment":"the reference's name"}],"argline":"git_repository *repo, const char *refname","sig":"git_repository *::const char *","return":{"type":"int","comment":" 0 when no reflog can be found, 1 when it exists;\n otherwise an error code."},"description":"<p>Check if a reflog exists for the specified reference.</p>\n","comments":"","group":"reference"},"git_reference_ensure_log":{"type":"function","file":"git2/refs.h","line":594,"lineto":594,"args":[{"name":"repo","type":"git_repository *","comment":"the repository"},{"name":"refname","type":"const char *","comment":"the reference's name"}],"argline":"git_repository *repo, const char *refname","sig":"git_repository *::const char *","return":{"type":"int","comment":" 0 or an error code."},"description":"<p>Ensure there is a reflog for a particular reference.</p>\n","comments":"<p>Make sure that successive updates to the reference will append to its log.</p>\n","group":"reference"},"git_reference_is_branch":{"type":"function","file":"git2/refs.h","line":604,"lineto":604,"args":[{"name":"ref","type":"const git_reference *","comment":"A git reference"}],"argline":"const git_reference *ref","sig":"const git_reference *","return":{"type":"int","comment":" 1 when the reference lives in the refs/heads\n 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":"git2/refs.h","line":614,"lineto":614,"args":[{"name":"ref","type":"const git_reference *","comment":"A git reference"}],"argline":"const git_reference *ref","sig":"const git_reference *","return":{"type":"int","comment":" 1 when the reference lives in the refs/remotes\n namespace; 0 otherwise."},"description":"<p>Check if a reference is a remote tracking branch</p>\n","comments":"","group":"reference"},"git_reference_is_tag":{"type":"function","file":"git2/refs.h","line":624,"lineto":624,"args":[{"name":"ref","type":"const git_reference *","comment":"A git reference"}],"argline":"const git_reference *ref","sig":"const git_reference *","return":{"type":"int","comment":" 1 when the reference lives in the refs/tags\n namespace; 0 otherwise."},"description":"<p>Check if a reference is a tag</p>\n","comments":"","group":"reference"},"git_reference_is_note":{"type":"function","file":"git2/refs.h","line":634,"lineto":634,"args":[{"name":"ref","type":"const git_reference *","comment":"A git reference"}],"argline":"const git_reference *ref","sig":"const git_reference *","return":{"type":"int","comment":" 1 when the reference lives in the refs/notes\n namespace; 0 otherwise."},"description":"<p>Check if a reference is a note</p>\n","comments":"","group":"reference"},"git_reference_normalize_name":{"type":"function","file":"git2/refs.h","line":690,"lineto":694,"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\n GIT_REF_FORMAT constants above."}],"argline":"char *buffer_out, size_t buffer_size, const char *name, unsigned int flags","sig":"char *::size_t::const char *::unsigned int","return":{"type":"int","comment":" 0 on success, GIT_EBUFS if buffer is too small, GIT_EINVALIDSPEC\n 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 '/' characters and collapsing runs of adjacent slashes between name components into a single slash.</p>\n\n<p>Once normalized, if the reference name is valid, it will be returned in the user allocated buffer.</p>\n\n<p>See <code>git_reference_symbolic_create()</code> for rules about valid names.</p>\n","group":"reference"},"git_reference_peel":{"type":"function","file":"git2/refs.h","line":711,"lineto":714,"args":[{"name":"out","type":"git_object **","comment":"Pointer to the peeled git_object"},{"name":"ref","type":"git_reference *","comment":"The reference to be processed"},{"name":"type","type":"git_otype","comment":"The type of the requested object (GIT_OBJ_COMMIT,\n GIT_OBJ_TAG, GIT_OBJ_TREE, GIT_OBJ_BLOB or GIT_OBJ_ANY)."}],"argline":"git_object **out, git_reference *ref, git_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 and 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 will be peeled until a non-tag object is met.</p>\n","group":"reference","examples":{"merge.c":["ex/v0.27.1/merge.html#git_reference_peel-37"]}},"git_reference_is_valid_name":{"type":"function","file":"git2/refs.h","line":730,"lineto":730,"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, and must begin and end with a letter. (e.g. "HEAD", "ORIG_HEAD"). 2. Names prefixed with "refs/" can be almost anything. You must avoid the characters '~', '^', ':', '\\', '?', '[', and '*', and the sequences ".." and "@{" which have special meaning to revparse.</li>\n</ol>\n","group":"reference"},"git_reference_shorthand":{"type":"function","file":"git2/refs.h","line":744,"lineto":744,"args":[{"name":"ref","type":"const git_reference *","comment":"a reference"}],"argline":"const git_reference *ref","sig":"const git_reference *","return":{"type":"const char *","comment":" the human-readable version of the name"},"description":"<p>Get the reference's short name</p>\n","comments":"<p>This will transform the reference name into a name "human-readable" version. If no shortname is appropriate, it will return the full name.</p>\n\n<p>The memory is owned by the reference and must not be freed.</p>\n","group":"reference","examples":{"status.c":["ex/v0.27.1/status.html#git_reference_shorthand-4"]}},"git_refspec_src":{"type":"function","file":"git2/refspec.h","line":30,"lineto":30,"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":"git2/refspec.h","line":38,"lineto":38,"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_string":{"type":"function","file":"git2/refspec.h","line":46,"lineto":46,"args":[{"name":"refspec","type":"const git_refspec *","comment":"the refspec"}],"argline":"const git_refspec *refspec","sig":"const git_refspec *","return":{"type":"const char *","comment":null},"description":"<p>Get the refspec's string</p>\n","comments":"","group":"refspec"},"git_refspec_force":{"type":"function","file":"git2/refspec.h","line":54,"lineto":54,"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_direction":{"type":"function","file":"git2/refspec.h","line":62,"lineto":62,"args":[{"name":"spec","type":"const git_refspec *","comment":"refspec"}],"argline":"const git_refspec *spec","sig":"const git_refspec *","return":{"type":"git_direction","comment":" GIT_DIRECTION_FETCH or GIT_DIRECTION_PUSH"},"description":"<p>Get the refspec's direction.</p>\n","comments":"","group":"refspec"},"git_refspec_src_matches":{"type":"function","file":"git2/refspec.h","line":71,"lineto":71,"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's source descriptor matches a reference </p>\n","comments":"","group":"refspec"},"git_refspec_dst_matches":{"type":"function","file":"git2/refspec.h","line":80,"lineto":80,"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's destination descriptor matches a reference</p>\n","comments":"","group":"refspec"},"git_refspec_transform":{"type":"function","file":"git2/refspec.h","line":90,"lineto":90,"args":[{"name":"out","type":"git_buf *","comment":"where to store the target name"},{"name":"spec","type":"const git_refspec *","comment":"the refspec"},{"name":"name","type":"const char *","comment":"the name of the reference to transform"}],"argline":"git_buf *out, const git_refspec *spec, const char *name","sig":"git_buf *::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's rules</p>\n","comments":"","group":"refspec"},"git_refspec_rtransform":{"type":"function","file":"git2/refspec.h","line":100,"lineto":100,"args":[{"name":"out","type":"git_buf *","comment":"where to store the source reference name"},{"name":"spec","type":"const git_refspec *","comment":"the refspec"},{"name":"name","type":"const char *","comment":"the name of the reference to transform"}],"argline":"git_buf *out, const git_refspec *spec, const char *name","sig":"git_buf *::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's rules</p>\n","comments":"","group":"refspec"},"git_remote_create":{"type":"function","file":"git2/remote.h","line":38,"lineto":42,"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, git_repository *repo, const char *name, const 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's configuration.</p>\n","comments":"","group":"remote","examples":{"remote.c":["ex/v0.27.1/remote.html#git_remote_create-4"]}},"git_remote_create_with_fetchspec":{"type":"function","file":"git2/remote.h","line":55,"lineto":60,"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"},{"name":"fetch","type":"const char *","comment":"the remote fetch value"}],"argline":"git_remote **out, git_repository *repo, const char *name, const char *url, const char *fetch","sig":"git_remote **::git_repository *::const char *::const char *::const char *","return":{"type":"int","comment":" 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code"},"description":"<p>Add a remote with the provided fetch refspec (or default if NULL) to the repository's\n configuration.</p>\n","comments":"","group":"remote"},"git_remote_create_anonymous":{"type":"function","file":"git2/remote.h","line":73,"lineto":76,"args":[{"name":"out","type":"git_remote **","comment":"pointer to the new remote objects"},{"name":"repo","type":"git_repository *","comment":"the associated repository"},{"name":"url","type":"const char *","comment":"the remote repository's URL"}],"argline":"git_remote **out, git_repository *repo, const char *url","sig":"git_remote **::git_repository *::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create an anonymous remote</p>\n","comments":"<p>Create a remote with the given url in-memory. You can use this when you have a URL instead of a remote's name.</p>\n","group":"remote","examples":{"network/fetch.c":["ex/v0.27.1/network/fetch.html#git_remote_create_anonymous-4"],"network/ls-remote.c":["ex/v0.27.1/network/ls-remote.html#git_remote_create_anonymous-2"]}},"git_remote_create_detached":{"type":"function","file":"git2/remote.h","line":92,"lineto":94,"args":[{"name":"out","type":"git_remote **","comment":"pointer to the new remote objects"},{"name":"url","type":"const char *","comment":"the remote repository's URL"}],"argline":"git_remote **out, const char *url","sig":"git_remote **::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create a remote without a connected local repo</p>\n","comments":"<p>Create a remote with the given url in-memory. You can use this when you have a URL instead of a remote's name.</p>\n\n<p>Contrasted with git_remote_create_anonymous, a detached remote will not consider any repo configuration values (such as insteadof url substitutions).</p>\n","group":"remote"},"git_remote_lookup":{"type":"function","file":"git2/remote.h","line":107,"lineto":107,"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. See <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"remote","examples":{"network/fetch.c":["ex/v0.27.1/network/fetch.html#git_remote_lookup-5"],"network/ls-remote.c":["ex/v0.27.1/network/ls-remote.html#git_remote_lookup-3"],"remote.c":["ex/v0.27.1/remote.html#git_remote_lookup-5"]}},"git_remote_dup":{"type":"function","file":"git2/remote.h","line":119,"lineto":119,"args":[{"name":"dest","type":"git_remote **","comment":"pointer where to store the copy"},{"name":"source","type":"git_remote *","comment":"object to copy"}],"argline":"git_remote **dest, git_remote *source","sig":"git_remote **::git_remote *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create a copy of an existing remote. All internal strings are also\n duplicated. Callbacks are not duplicated.</p>\n","comments":"<p>Call <code>git_remote_free</code> to free the data.</p>\n","group":"remote"},"git_remote_owner":{"type":"function","file":"git2/remote.h","line":127,"lineto":127,"args":[{"name":"remote","type":"const git_remote *","comment":"the remote"}],"argline":"const git_remote *remote","sig":"const git_remote *","return":{"type":"git_repository *","comment":" a pointer to the repository"},"description":"<p>Get the remote's repository</p>\n","comments":"","group":"remote"},"git_remote_name":{"type":"function","file":"git2/remote.h","line":135,"lineto":135,"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's name</p>\n","comments":"","group":"remote"},"git_remote_url":{"type":"function","file":"git2/remote.h","line":146,"lineto":146,"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's url</p>\n","comments":"<p>If url.*.insteadOf has been configured for this URL, it will return the modified URL.</p>\n","group":"remote","examples":{"remote.c":["ex/v0.27.1/remote.html#git_remote_url-6"]}},"git_remote_pushurl":{"type":"function","file":"git2/remote.h","line":157,"lineto":157,"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's url for pushing</p>\n","comments":"<p>If url.*.pushInsteadOf has been configured for this URL, it will return the modified URL.</p>\n","group":"remote","examples":{"remote.c":["ex/v0.27.1/remote.html#git_remote_pushurl-7"]}},"git_remote_set_url":{"type":"function","file":"git2/remote.h","line":170,"lineto":170,"args":[{"name":"repo","type":"git_repository *","comment":"the repository in which to perform the change"},{"name":"remote","type":"const char *","comment":"the remote's name"},{"name":"url","type":"const char *","comment":"the url to set"}],"argline":"git_repository *repo, const char *remote, const char *url","sig":"git_repository *::const char *::const char *","return":{"type":"int","comment":" 0 or an error value"},"description":"<p>Set the remote's url in the configuration</p>\n","comments":"<p>Remote objects already in memory will not be affected. This assumes the common case of a single-url remote and will otherwise return an error.</p>\n","group":"remote","examples":{"remote.c":["ex/v0.27.1/remote.html#git_remote_set_url-8"]}},"git_remote_set_pushurl":{"type":"function","file":"git2/remote.h","line":183,"lineto":183,"args":[{"name":"repo","type":"git_repository *","comment":"the repository in which to perform the change"},{"name":"remote","type":"const char *","comment":"the remote's name"},{"name":"url","type":"const char *","comment":"the url to set"}],"argline":"git_repository *repo, const char *remote, const char *url","sig":"git_repository *::const char *::const char *","return":{"type":"int","comment":null},"description":"<p>Set the remote's url for pushing in the configuration.</p>\n","comments":"<p>Remote objects already in memory will not be affected. This assumes the common case of a single-url remote and will otherwise return an error.</p>\n","group":"remote","examples":{"remote.c":["ex/v0.27.1/remote.html#git_remote_set_pushurl-9"]}},"git_remote_add_fetch":{"type":"function","file":"git2/remote.h","line":196,"lineto":196,"args":[{"name":"repo","type":"git_repository *","comment":"the repository in which to change the configuration"},{"name":"remote","type":"const char *","comment":"the name of the remote to change"},{"name":"refspec","type":"const char *","comment":"the new fetch refspec"}],"argline":"git_repository *repo, const char *remote, const char *refspec","sig":"git_repository *::const char *::const char *","return":{"type":"int","comment":" 0, GIT_EINVALIDSPEC if refspec is invalid or an error value"},"description":"<p>Add a fetch refspec to the remote's configuration</p>\n","comments":"<p>Add the given refspec to the fetch list in the configuration. No loaded remote instances will be affected.</p>\n","group":"remote"},"git_remote_get_fetch_refspecs":{"type":"function","file":"git2/remote.h","line":207,"lineto":207,"args":[{"name":"array","type":"git_strarray *","comment":"pointer to the array in which to store the strings"},{"name":"remote","type":"const git_remote *","comment":"the remote to query"}],"argline":"git_strarray *array, const git_remote *remote","sig":"git_strarray *::const git_remote *","return":{"type":"int","comment":null},"description":"<p>Get the remote's list of fetch refspecs</p>\n","comments":"<p>The memory is owned by the user and should be freed with <code>git_strarray_free</code>.</p>\n","group":"remote"},"git_remote_add_push":{"type":"function","file":"git2/remote.h","line":220,"lineto":220,"args":[{"name":"repo","type":"git_repository *","comment":"the repository in which to change the configuration"},{"name":"remote","type":"const char *","comment":"the name of the remote to change"},{"name":"refspec","type":"const char *","comment":"the new push refspec"}],"argline":"git_repository *repo, const char *remote, const char *refspec","sig":"git_repository *::const char *::const char *","return":{"type":"int","comment":" 0, GIT_EINVALIDSPEC if refspec is invalid or an error value"},"description":"<p>Add a push refspec to the remote's configuration</p>\n","comments":"<p>Add the given refspec to the push list in the configuration. No loaded remote instances will be affected.</p>\n","group":"remote"},"git_remote_get_push_refspecs":{"type":"function","file":"git2/remote.h","line":231,"lineto":231,"args":[{"name":"array","type":"git_strarray *","comment":"pointer to the array in which to store the strings"},{"name":"remote","type":"const git_remote *","comment":"the remote to query"}],"argline":"git_strarray *array, const git_remote *remote","sig":"git_strarray *::const git_remote *","return":{"type":"int","comment":null},"description":"<p>Get the remote's list of push refspecs</p>\n","comments":"<p>The memory is owned by the user and should be freed with <code>git_strarray_free</code>.</p>\n","group":"remote"},"git_remote_refspec_count":{"type":"function","file":"git2/remote.h","line":239,"lineto":239,"args":[{"name":"remote","type":"const git_remote *","comment":"the remote"}],"argline":"const git_remote *remote","sig":"const git_remote *","return":{"type":"size_t","comment":" the amount of refspecs configured in this remote"},"description":"<p>Get the number of refspecs for a remote</p>\n","comments":"","group":"remote"},"git_remote_get_refspec":{"type":"function","file":"git2/remote.h","line":248,"lineto":248,"args":[{"name":"remote","type":"const git_remote *","comment":"the remote to query"},{"name":"n","type":"size_t","comment":"the refspec to get"}],"argline":"const git_remote *remote, size_t n","sig":"const git_remote *::size_t","return":{"type":"const git_refspec *","comment":" the nth refspec"},"description":"<p>Get a refspec from the remote</p>\n","comments":"","group":"remote"},"git_remote_connect":{"type":"function","file":"git2/remote.h","line":265,"lineto":265,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to connect to"},{"name":"direction","type":"git_direction","comment":"GIT_DIRECTION_FETCH if you want to fetch or\n GIT_DIRECTION_PUSH if you want to push"},{"name":"callbacks","type":"const git_remote_callbacks *","comment":"the callbacks to use for this connection"},{"name":"proxy_opts","type":"const git_proxy_options *","comment":"proxy settings"},{"name":"custom_headers","type":"const git_strarray *","comment":"extra HTTP headers to use in this connection"}],"argline":"git_remote *remote, git_direction direction, const git_remote_callbacks *callbacks, const git_proxy_options *proxy_opts, const git_strarray *custom_headers","sig":"git_remote *::git_direction::const git_remote_callbacks *::const git_proxy_options *::const git_strarray *","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 is due to a limitation of the git protocol (over TCP or SSH) which starts up a specific binary which can only do the one or the other.</p>\n","group":"remote","examples":{"network/ls-remote.c":["ex/v0.27.1/network/ls-remote.html#git_remote_connect-4"]}},"git_remote_ls":{"type":"function","file":"git2/remote.h","line":287,"lineto":287,"args":[{"name":"out","type":"const git_remote_head ***","comment":"pointer to the array"},{"name":"size","type":"size_t *","comment":"the number of remote heads"},{"name":"remote","type":"git_remote *","comment":"the remote"}],"argline":"const git_remote_head ***out, size_t *size, git_remote *remote","sig":"const git_remote_head ***::size_t *::git_remote *","return":{"type":"int","comment":" 0 on success, or an error code"},"description":"<p>Get the remote repository's reference advertisement list</p>\n","comments":"<p>Get the list of references with which the server responds to a new connection.</p>\n\n<p>The remote (or more exactly its transport) must have connected to the remote repository. This list is available as soon as the connection to the remote is initiated and it remains available after disconnecting.</p>\n\n<p>The memory belongs to the remote. The pointer will be valid as long as a new connection is not initiated, but it is recommended that you make a copy in order to make use of the data.</p>\n","group":"remote","examples":{"network/ls-remote.c":["ex/v0.27.1/network/ls-remote.html#git_remote_ls-5"]}},"git_remote_connected":{"type":"function","file":"git2/remote.h","line":298,"lineto":298,"args":[{"name":"remote","type":"const git_remote *","comment":"the remote"}],"argline":"const git_remote *remote","sig":"const 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's underlying transport is connected to the remote host.</p>\n","group":"remote"},"git_remote_stop":{"type":"function","file":"git2/remote.h","line":308,"lineto":308,"args":[{"name":"remote","type":"git_remote *","comment":"the remote"}],"argline":"git_remote *remote","sig":"git_remote *","return":{"type":"void","comment":null},"description":"<p>Cancel the operation</p>\n","comments":"<p>At certain points in its operation, the network code checks whether the operation has been cancelled and if so stops the operation.</p>\n","group":"remote"},"git_remote_disconnect":{"type":"function","file":"git2/remote.h","line":317,"lineto":317,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to disconnect from"}],"argline":"git_remote *remote","sig":"git_remote *","return":{"type":"void","comment":null},"description":"<p>Disconnect from the remote</p>\n","comments":"<p>Close the connection to the remote.</p>\n","group":"remote"},"git_remote_free":{"type":"function","file":"git2/remote.h","line":327,"lineto":327,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to free"}],"argline":"git_remote *remote","sig":"git_remote *","return":{"type":"void","comment":null},"description":"<p>Free the memory associated with a remote</p>\n","comments":"<p>This also disconnects from the remote, if the connection has not been closed yet (using git_remote_disconnect).</p>\n","group":"remote","examples":{"network/fetch.c":["ex/v0.27.1/network/fetch.html#git_remote_free-6","ex/v0.27.1/network/fetch.html#git_remote_free-7"],"network/ls-remote.c":["ex/v0.27.1/network/ls-remote.html#git_remote_free-6"],"remote.c":["ex/v0.27.1/remote.html#git_remote_free-10"]}},"git_remote_list":{"type":"function","file":"git2/remote.h","line":338,"lineto":338,"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","examples":{"remote.c":["ex/v0.27.1/remote.html#git_remote_list-11"]}},"git_remote_init_callbacks":{"type":"function","file":"git2/remote.h","line":503,"lineto":505,"args":[{"name":"opts","type":"git_remote_callbacks *","comment":"the `git_remote_callbacks` struct to initialize"},{"name":"version","type":"unsigned int","comment":"Version of struct; pass `GIT_REMOTE_CALLBACKS_VERSION`"}],"argline":"git_remote_callbacks *opts, unsigned int version","sig":"git_remote_callbacks *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_remote_callbacks</code> with default values. Equivalent to\n creating an instance with GIT_REMOTE_CALLBACKS_INIT.</p>\n","comments":"","group":"remote"},"git_fetch_init_options":{"type":"function","file":"git2/remote.h","line":607,"lineto":609,"args":[{"name":"opts","type":"git_fetch_options *","comment":"the `git_fetch_options` instance to initialize."},{"name":"version","type":"unsigned int","comment":"the version of the struct; you should pass\n `GIT_FETCH_OPTIONS_VERSION` here."}],"argline":"git_fetch_options *opts, unsigned int version","sig":"git_fetch_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_fetch_options</code> with default values. Equivalent to\n creating an instance with GIT_FETCH_OPTIONS_INIT.</p>\n","comments":"","group":"fetch"},"git_push_init_options":{"type":"function","file":"git2/remote.h","line":656,"lineto":658,"args":[{"name":"opts","type":"git_push_options *","comment":"the `git_push_options` instance to initialize."},{"name":"version","type":"unsigned int","comment":"the version of the struct; you should pass\n `GIT_PUSH_OPTIONS_VERSION` here."}],"argline":"git_push_options *opts, unsigned int version","sig":"git_push_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_push_options</code> with default values. Equivalent to\n creating an instance with GIT_PUSH_OPTIONS_INIT.</p>\n","comments":"","group":"push"},"git_remote_download":{"type":"function","file":"git2/remote.h","line":676,"lineto":676,"args":[{"name":"remote","type":"git_remote *","comment":"the remote"},{"name":"refspecs","type":"const git_strarray *","comment":"the refspecs to use for this negotiation and\n download. Use NULL or an empty array to use the base refspecs"},{"name":"opts","type":"const git_fetch_options *","comment":"the options to use for this fetch"}],"argline":"git_remote *remote, const git_strarray *refspecs, const git_fetch_options *opts","sig":"git_remote *::const git_strarray *::const git_fetch_options *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Download and index the packfile</p>\n","comments":"<p>Connect to the remote if it hasn't been done yet, negotiate with the remote git which objects are missing, download and index the packfile.</p>\n\n<p>The .idx file will be created and both it and the packfile with be renamed to their final name.</p>\n","group":"remote"},"git_remote_upload":{"type":"function","file":"git2/remote.h","line":690,"lineto":690,"args":[{"name":"remote","type":"git_remote *","comment":"the remote"},{"name":"refspecs","type":"const git_strarray *","comment":"the refspecs to use for this negotiation and\n upload. Use NULL or an empty array to use the base refspecs"},{"name":"opts","type":"const git_push_options *","comment":"the options to use for this push"}],"argline":"git_remote *remote, const git_strarray *refspecs, const git_push_options *opts","sig":"git_remote *::const git_strarray *::const git_push_options *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create a packfile and send it to the server</p>\n","comments":"<p>Connect to the remote if it hasn't been done yet, negotiate with the remote git which objects are missing, create a packfile with the missing objects and send it.</p>\n","group":"remote"},"git_remote_update_tips":{"type":"function","file":"git2/remote.h","line":706,"lineto":711,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to update"},{"name":"callbacks","type":"const git_remote_callbacks *","comment":"pointer to the callback structure to use"},{"name":"update_fetchhead","type":"int","comment":"whether to write to FETCH_HEAD. Pass 1 to behave like git."},{"name":"download_tags","type":"git_remote_autotag_option_t","comment":"what the behaviour for downloading tags is for this fetch. This is\n ignored for push. This must be the same value passed to `git_remote_download()`."},{"name":"reflog_message","type":"const char *","comment":"The message to insert into the reflogs. If\n NULL and fetching, the default is \"fetch \n<name\n>\", where \n<name\n> is\n the name of the remote (or its url, for in-memory remotes). This\n parameter is ignored when pushing."}],"argline":"git_remote *remote, const git_remote_callbacks *callbacks, int update_fetchhead, git_remote_autotag_option_t download_tags, const char *reflog_message","sig":"git_remote *::const git_remote_callbacks *::int::git_remote_autotag_option_t::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Update the tips to the new state</p>\n","comments":"","group":"remote"},"git_remote_fetch":{"type":"function","file":"git2/remote.h","line":727,"lineto":731,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to fetch from"},{"name":"refspecs","type":"const git_strarray *","comment":"the refspecs to use for this fetch. Pass NULL or an\n empty array to use the base refspecs."},{"name":"opts","type":"const git_fetch_options *","comment":"options to use for this fetch"},{"name":"reflog_message","type":"const char *","comment":"The message to insert into the reflogs. If NULL, the\n\t\t\t\t\t\t\t\t default is \"fetch\""}],"argline":"git_remote *remote, const git_strarray *refspecs, const git_fetch_options *opts, const char *reflog_message","sig":"git_remote *::const git_strarray *::const git_fetch_options *::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Download new data and update tips</p>\n","comments":"<p>Convenience function to connect to a remote, download the data, disconnect and update the remote-tracking branches.</p>\n","group":"remote","examples":{"network/fetch.c":["ex/v0.27.1/network/fetch.html#git_remote_fetch-8"]}},"git_remote_prune":{"type":"function","file":"git2/remote.h","line":740,"lineto":740,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to prune"},{"name":"callbacks","type":"const git_remote_callbacks *","comment":"callbacks to use for this prune"}],"argline":"git_remote *remote, const git_remote_callbacks *callbacks","sig":"git_remote *::const git_remote_callbacks *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Prune tracking refs that are no longer present on remote</p>\n","comments":"","group":"remote"},"git_remote_push":{"type":"function","file":"git2/remote.h","line":752,"lineto":754,"args":[{"name":"remote","type":"git_remote *","comment":"the remote to push to"},{"name":"refspecs","type":"const git_strarray *","comment":"the refspecs to use for pushing. If NULL or an empty\n array, the configured refspecs will be used"},{"name":"opts","type":"const git_push_options *","comment":"options to use for this push"}],"argline":"git_remote *remote, const git_strarray *refspecs, const git_push_options *opts","sig":"git_remote *::const git_strarray *::const git_push_options *","return":{"type":"int","comment":null},"description":"<p>Perform a push</p>\n","comments":"<p>Peform all the steps from a push.</p>\n","group":"remote"},"git_remote_stats":{"type":"function","file":"git2/remote.h","line":759,"lineto":759,"args":[{"name":"remote","type":"git_remote *","comment":null}],"argline":"git_remote *remote","sig":"git_remote *","return":{"type":"const git_transfer_progress *","comment":null},"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.27.1/network/fetch.html#git_remote_stats-9"]}},"git_remote_autotag":{"type":"function","file":"git2/remote.h","line":767,"lineto":767,"args":[{"name":"remote","type":"const git_remote *","comment":"the remote to query"}],"argline":"const git_remote *remote","sig":"const 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":"git2/remote.h","line":779,"lineto":779,"args":[{"name":"repo","type":"git_repository *","comment":"the repository in which to make the change"},{"name":"remote","type":"const char *","comment":"the name of the remote"},{"name":"value","type":"git_remote_autotag_option_t","comment":"the new value to take."}],"argline":"git_repository *repo, const char *remote, git_remote_autotag_option_t value","sig":"git_repository *::const char *::git_remote_autotag_option_t","return":{"type":"int","comment":null},"description":"<p>Set the remote's tag following setting.</p>\n","comments":"<p>The change will be made in the configuration. No loaded remotes will be affected.</p>\n","group":"remote"},"git_remote_prune_refs":{"type":"function","file":"git2/remote.h","line":786,"lineto":786,"args":[{"name":"remote","type":"const git_remote *","comment":"the remote to query"}],"argline":"const git_remote *remote","sig":"const git_remote *","return":{"type":"int","comment":" the ref-prune setting"},"description":"<p>Retrieve the ref-prune setting</p>\n","comments":"","group":"remote"},"git_remote_rename":{"type":"function","file":"git2/remote.h","line":808,"lineto":812,"args":[{"name":"problems","type":"git_strarray *","comment":"non-default refspecs cannot be renamed and will be\n stored here for further processing by the caller. Always free this\n strarray on successful return."},{"name":"repo","type":"git_repository *","comment":"the repository in which to rename"},{"name":"name","type":"const char *","comment":"the current name of the remote"},{"name":"new_name","type":"const char *","comment":"the new name the remote should bear"}],"argline":"git_strarray *problems, git_repository *repo, const char *name, const char *new_name","sig":"git_strarray *::git_repository *::const char *::const char *","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 for the remote are updated.</p>\n\n<p>The new name will be checked for validity. See <code>git_tag_create()</code> for rules about valid names.</p>\n\n<p>No loaded instances of a the remote with the old name will change their name or their list of refspecs.</p>\n","group":"remote","examples":{"remote.c":["ex/v0.27.1/remote.html#git_remote_rename-12"]}},"git_remote_is_valid_name":{"type":"function","file":"git2/remote.h","line":820,"lineto":820,"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_remote_delete":{"type":"function","file":"git2/remote.h","line":832,"lineto":832,"args":[{"name":"repo","type":"git_repository *","comment":"the repository in which to act"},{"name":"name","type":"const char *","comment":"the name of the remote to delete"}],"argline":"git_repository *repo, const char *name","sig":"git_repository *::const char *","return":{"type":"int","comment":" 0 on success, or an error code."},"description":"<p>Delete an existing persisted remote.</p>\n","comments":"<p>All remote-tracking branches and configuration settings for the remote will be removed.</p>\n","group":"remote","examples":{"remote.c":["ex/v0.27.1/remote.html#git_remote_delete-13"]}},"git_remote_default_branch":{"type":"function","file":"git2/remote.h","line":850,"lineto":850,"args":[{"name":"out","type":"git_buf *","comment":"the buffern in which to store the reference name"},{"name":"remote","type":"git_remote *","comment":"the remote"}],"argline":"git_buf *out, git_remote *remote","sig":"git_buf *::git_remote *","return":{"type":"int","comment":" 0, GIT_ENOTFOUND if the remote does not have any references\n or none of them point to HEAD's commit, or an error message."},"description":"<p>Retrieve the name of the remote's default branch</p>\n","comments":"<p>The default branch of a repository is the branch which HEAD points to. If the remote does not support reporting this information directly, it performs the guess as git does; that is, if there are multiple branches which point to the same commit, the first one is chosen. If the master branch is a candidate, it wins.</p>\n\n<p>This function must only be called after connecting.</p>\n","group":"remote"},"git_repository_open":{"type":"function","file":"git2/repository.h","line":37,"lineto":37,"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 'path' argument must point to either a git repository folder, or an existing work dir.</p>\n\n<p>The method will automatically detect if 'path' is a normal or bare repository or fail is 'path' is neither.</p>\n","group":"repository","examples":{"general.c":["ex/v0.27.1/general.html#git_repository_open-68"],"remote.c":["ex/v0.27.1/remote.html#git_repository_open-14"]}},"git_repository_open_from_worktree":{"type":"function","file":"git2/repository.h","line":48,"lineto":48,"args":[{"name":"out","type":"git_repository **","comment":"Output pointer containing opened repository"},{"name":"wt","type":"git_worktree *","comment":"Working tree to open"}],"argline":"git_repository **out, git_worktree *wt","sig":"git_repository **::git_worktree *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Open working tree as a repository</p>\n","comments":"<p>Open the working directory of the working tree as a normal repository that can then be worked on.</p>\n","group":"repository"},"git_repository_wrap_odb":{"type":"function","file":"git2/repository.h","line":61,"lineto":61,"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 "fake" repository to wrap an object database</p>\n","comments":"<p>Create a repository object to wrap an object database to be used with the API when all you have is an object database. This doesn't have any paths associated with it, so use with care.</p>\n","group":"repository"},"git_repository_discover":{"type":"function","file":"git2/repository.h","line":89,"lineto":93,"args":[{"name":"out","type":"git_buf *","comment":"A pointer to a user-allocated git_buf which will contain\n the found path."},{"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\n filesystem device change is detected while exploring parent directories."},{"name":"ceiling_dirs","type":"const char *","comment":"A GIT_PATH_LIST_SEPARATOR separated list of\n absolute symbolic link free paths. The lookup will stop when any\n of this paths is reached. Note that the lookup always performs on\n start_path no matter start_path appears in ceiling_dirs ceiling_dirs\n might be NULL (which is equivalent to an empty string)"}],"argline":"git_buf *out, const char *start_path, int across_fs, const char *ceiling_dirs","sig":"git_buf *::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.\n The lookup start from base_path and walk across parent directories\n if nothing has been found. The lookup ends when the first repository\n is found, or when reaching a directory referenced in ceiling_dirs\n or when the filesystem changes (in case across_fs is true).</p>\n","comments":"<p>The method will automatically detect if the repository is bare (if there is a repository).</p>\n","group":"repository","examples":{"remote.c":["ex/v0.27.1/remote.html#git_repository_discover-15"]}},"git_repository_open_ext":{"type":"function","file":"git2/repository.h","line":152,"lineto":156,"args":[{"name":"out","type":"git_repository **","comment":"Pointer to the repo which will be opened. This can\n actually be NULL if you only want to use the error code to\n 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\n permit \"searching\", then this can be a path to a subdirectory\n inside the working directory of the repository. May be NULL if\n flags is GIT_REPOSITORY_OPEN_FROM_ENV."},{"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\n prefixes at which the search for a containing repository should\n terminate."}],"argline":"git_repository **out, const char *path, unsigned int flags, const 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,\n or -1 if there was a repository but open failed for some reason\n (such as repo corruption or system errors)."},"description":"<p>Find and open a repository with extended controls.</p>\n","comments":"","group":"repository","examples":{"blame.c":["ex/v0.27.1/blame.html#git_repository_open_ext-24"],"cat-file.c":["ex/v0.27.1/cat-file.html#git_repository_open_ext-31"],"describe.c":["ex/v0.27.1/describe.html#git_repository_open_ext-6"],"diff.c":["ex/v0.27.1/diff.html#git_repository_open_ext-15"],"log.c":["ex/v0.27.1/log.html#git_repository_open_ext-42","ex/v0.27.1/log.html#git_repository_open_ext-43"],"merge.c":["ex/v0.27.1/merge.html#git_repository_open_ext-38"],"rev-parse.c":["ex/v0.27.1/rev-parse.html#git_repository_open_ext-16"],"status.c":["ex/v0.27.1/status.html#git_repository_open_ext-5"],"tag.c":["ex/v0.27.1/tag.html#git_repository_open_ext-11"]}},"git_repository_open_bare":{"type":"function","file":"git2/repository.h","line":169,"lineto":169,"args":[{"name":"out","type":"git_repository **","comment":"Pointer to the repo which will be opened."},{"name":"bare_path","type":"const char *","comment":"Direct path to the bare repository"}],"argline":"git_repository **out, const char *bare_path","sig":"git_repository **::const char *","return":{"type":"int","comment":" 0 on success, or an error code"},"description":"<p>Open a bare repository on the serverside.</p>\n","comments":"<p>This is a fast open for bare repositories that will come in handy if you're e.g. hosting git repositories and need to access them efficiently</p>\n","group":"repository"},"git_repository_free":{"type":"function","file":"git2/repository.h","line":182,"lineto":182,"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","comment":null},"description":"<p>Free a previously allocated repository</p>\n","comments":"<p>Note that after a repository is free'd, all the objects it has spawned will still exist until they are manually closed by the user with <code>git_object_free</code>, but accessing any of the attributes of an object without a backing repository will result in undefined behavior</p>\n","group":"repository","examples":{"blame.c":["ex/v0.27.1/blame.html#git_repository_free-25"],"cat-file.c":["ex/v0.27.1/cat-file.html#git_repository_free-32"],"describe.c":["ex/v0.27.1/describe.html#git_repository_free-7"],"diff.c":["ex/v0.27.1/diff.html#git_repository_free-16"],"general.c":["ex/v0.27.1/general.html#git_repository_free-69"],"init.c":["ex/v0.27.1/init.html#git_repository_free-6"],"log.c":["ex/v0.27.1/log.html#git_repository_free-44"],"merge.c":["ex/v0.27.1/merge.html#git_repository_free-39"],"network/clone.c":["ex/v0.27.1/network/clone.html#git_repository_free-3"],"rev-parse.c":["ex/v0.27.1/rev-parse.html#git_repository_free-17"],"status.c":["ex/v0.27.1/status.html#git_repository_free-6"],"tag.c":["ex/v0.27.1/tag.html#git_repository_free-12"]}},"git_repository_init":{"type":"function","file":"git2/repository.h","line":199,"lineto":202,"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 int","comment":"if true, a Git repository without a working directory is\n\t\tcreated at the pointed path. If false, provided path will be\n\t\tconsidered as the working directory into which the .git directory\n\t\twill be created."}],"argline":"git_repository **out, const char *path, unsigned int is_bare","sig":"git_repository **::const char *::unsigned int","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: - Reinit the repository</p>\n","group":"repository","examples":{"init.c":["ex/v0.27.1/init.html#git_repository_init-7"]}},"git_repository_init_init_options":{"type":"function","file":"git2/repository.h","line":311,"lineto":313,"args":[{"name":"opts","type":"git_repository_init_options *","comment":"the `git_repository_init_options` struct to initialize"},{"name":"version","type":"unsigned int","comment":"Version of struct; pass `GIT_REPOSITORY_INIT_OPTIONS_VERSION`"}],"argline":"git_repository_init_options *opts, unsigned int version","sig":"git_repository_init_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_repository_init_options</code> with default values. Equivalent\n to creating an instance with GIT_REPOSITORY_INIT_OPTIONS_INIT.</p>\n","comments":"","group":"repository"},"git_repository_init_ext":{"type":"function","file":"git2/repository.h","line":328,"lineto":331,"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, const char *repo_path, git_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 if requested by flags) and working directory as needed. It will auto-detect the case sensitivity of the file system and if the file system supports file mode bits correctly.</p>\n","group":"repository","examples":{"init.c":["ex/v0.27.1/init.html#git_repository_init_ext-8"]}},"git_repository_head":{"type":"function","file":"git2/repository.h","line":346,"lineto":346,"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_EUNBORNBRANCH when HEAD points to a non existing\n 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 <code>git_reference_free()</code> must be called when done with it to release the allocated memory and prevent a leak.</p>\n","group":"repository","examples":{"merge.c":["ex/v0.27.1/merge.html#git_repository_head-40","ex/v0.27.1/merge.html#git_repository_head-41"],"status.c":["ex/v0.27.1/status.html#git_repository_head-7"]}},"git_repository_head_for_worktree":{"type":"function","file":"git2/repository.h","line":356,"lineto":357,"args":[{"name":"out","type":"git_reference **","comment":"pointer to the reference which will be retrieved"},{"name":"repo","type":"git_repository *","comment":"a repository object"},{"name":"name","type":"const char *","comment":"name of the worktree to retrieve HEAD for"}],"argline":"git_reference **out, git_repository *repo, const char *name","sig":"git_reference **::git_repository *::const char *","return":{"type":"int","comment":" 0 when successful, error-code otherwise"},"description":"<p>Retrieve the referenced HEAD for the worktree</p>\n","comments":"","group":"repository"},"git_repository_head_detached":{"type":"function","file":"git2/repository.h","line":369,"lineto":369,"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\n was an error."},"description":"<p>Check if a repository's HEAD is detached</p>\n","comments":"<p>A repository's HEAD is detached when it points directly to a commit instead of a branch.</p>\n","group":"repository"},"git_repository_head_unborn":{"type":"function","file":"git2/repository.h","line":395,"lineto":395,"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 unborn, 0 if it's not; error\n code if there was an error"},"description":"<p>Check if the current branch is unborn</p>\n","comments":"<p>An unborn branch is one named from HEAD but which doesn't exist in the refs namespace, because it doesn't have any commit to point to.</p>\n","group":"repository"},"git_repository_is_empty":{"type":"function","file":"git2/repository.h","line":407,"lineto":407,"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\n 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 no references apart from HEAD, which must be pointing to the unborn master branch.</p>\n","group":"repository"},"git_repository_item_path":{"type":"function","file":"git2/repository.h","line":443,"lineto":443,"args":[{"name":"out","type":"git_buf *","comment":"Buffer to store the path at"},{"name":"repo","type":"const git_repository *","comment":"Repository to get path for"},{"name":"item","type":"git_repository_item_t","comment":"The repository item for which to retrieve the path"}],"argline":"git_buf *out, const git_repository *repo, git_repository_item_t item","sig":"git_buf *::const git_repository *::git_repository_item_t","return":{"type":"int","comment":" 0, GIT_ENOTFOUND if the path cannot exist or an error code"},"description":"<p>Get the location of a specific repository file or directory</p>\n","comments":"<p>This function will retrieve the path of a specific repository item. It will thereby honor things like the repository's common directory, gitdir, etc. In case a file path cannot exist for a given item (e.g. the working directory of a bare repository), GIT_ENOTFOUND is returned.</p>\n","group":"repository"},"git_repository_path":{"type":"function","file":"git2/repository.h","line":454,"lineto":454,"args":[{"name":"repo","type":"const git_repository *","comment":"A repository object"}],"argline":"const git_repository *repo","sig":"const 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, or of the repository itself for bare repositories.</p>\n","group":"repository","examples":{"init.c":["ex/v0.27.1/init.html#git_repository_path-9"],"status.c":["ex/v0.27.1/status.html#git_repository_path-8"]}},"git_repository_workdir":{"type":"function","file":"git2/repository.h","line":465,"lineto":465,"args":[{"name":"repo","type":"const git_repository *","comment":"A repository object"}],"argline":"const git_repository *repo","sig":"const 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 NULL.</p>\n","group":"repository","examples":{"init.c":["ex/v0.27.1/init.html#git_repository_workdir-10"]}},"git_repository_commondir":{"type":"function","file":"git2/repository.h","line":476,"lineto":476,"args":[{"name":"repo","type":"const git_repository *","comment":"A repository object"}],"argline":"const git_repository *repo","sig":"const git_repository *","return":{"type":"const char *","comment":" the path to the common dir"},"description":"<p>Get the path of the shared common directory for this repository</p>\n","comments":"<p>If the repository is bare is not a worktree, the git directory path is returned.</p>\n","group":"repository"},"git_repository_set_workdir":{"type":"function","file":"git2/repository.h","line":495,"lineto":496,"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\n \"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't need to be the same one that contains the <code>.git</code> folder for this repository.</p>\n\n<p>If this repository is bare, setting its working directory will turn it into a normal repository, capable of performing all the common workdir operations (checkout, status, index manipulation, etc).</p>\n","group":"repository"},"git_repository_is_bare":{"type":"function","file":"git2/repository.h","line":504,"lineto":504,"args":[{"name":"repo","type":"const git_repository *","comment":"Repo to test"}],"argline":"const git_repository *repo","sig":"const 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","examples":{"status.c":["ex/v0.27.1/status.html#git_repository_is_bare-9"]}},"git_repository_is_worktree":{"type":"function","file":"git2/repository.h","line":512,"lineto":512,"args":[{"name":"repo","type":"const git_repository *","comment":"Repo to test"}],"argline":"const git_repository *repo","sig":"const git_repository *","return":{"type":"int","comment":" 1 if the repository is a linked work tree, 0 otherwise."},"description":"<p>Check if a repository is a linked work tree</p>\n","comments":"","group":"repository"},"git_repository_config":{"type":"function","file":"git2/repository.h","line":528,"lineto":528,"args":[{"name":"out","type":"git_config **","comment":"Pointer to store the loaded configuration"},{"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 config set for the repository will be returned, including global and system configurations (if they are available).</p>\n\n<p>The configuration file must be freed once it's no longer being used by the user.</p>\n","group":"repository"},"git_repository_config_snapshot":{"type":"function","file":"git2/repository.h","line":544,"lineto":544,"args":[{"name":"out","type":"git_config **","comment":"Pointer to store the loaded configuration"},{"name":"repo","type":"git_repository *","comment":"the repository"}],"argline":"git_config **out, git_repository *repo","sig":"git_config **::git_repository *","return":{"type":"int","comment":" 0, or an error code"},"description":"<p>Get a snapshot of the repository's configuration</p>\n","comments":"<p>Convenience function to take a snapshot from the repository's configuration. The contents of this snapshot will not change, even if the underlying config files are modified.</p>\n\n<p>The configuration file must be freed once it's no longer being used by the user.</p>\n","group":"repository","examples":{"general.c":["ex/v0.27.1/general.html#git_repository_config_snapshot-70","ex/v0.27.1/general.html#git_repository_config_snapshot-71"]}},"git_repository_odb":{"type":"function","file":"git2/repository.h","line":560,"lineto":560,"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 database for the repository will be returned (the one located in <code>.git/objects</code>).</p>\n\n<p>The ODB must be freed once it's no longer being used by the user.</p>\n","group":"repository","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_repository_odb-33"],"general.c":["ex/v0.27.1/general.html#git_repository_odb-72"]}},"git_repository_refdb":{"type":"function","file":"git2/repository.h","line":576,"lineto":576,"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 the repository will be returned (the one that manipulates loose and packed references in the <code>.git</code> directory).</p>\n\n<p>The refdb must be freed once it's no longer being used by the user.</p>\n","group":"repository"},"git_repository_index":{"type":"function","file":"git2/repository.h","line":592,"lineto":592,"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 index for the repository will be returned (the one located in <code>.git/index</code>).</p>\n\n<p>The index must be freed once it's no longer being used by the user.</p>\n","group":"repository","examples":{"general.c":["ex/v0.27.1/general.html#git_repository_index-73"],"init.c":["ex/v0.27.1/init.html#git_repository_index-11"],"merge.c":["ex/v0.27.1/merge.html#git_repository_index-42"]}},"git_repository_message":{"type":"function","file":"git2/repository.h","line":610,"lineto":610,"args":[{"name":"out","type":"git_buf *","comment":"git_buf to write data into"},{"name":"repo","type":"git_repository *","comment":"Repository to read prepared message from"}],"argline":"git_buf *out, git_repository *repo","sig":"git_buf *::git_repository *","return":{"type":"int","comment":" 0, GIT_ENOTFOUND if no message exists or an error code"},"description":"<p>Retrieve git's prepared message</p>\n","comments":"<p>Operations such as git revert/cherry-pick/merge with the -n option stop just short of creating a commit with the changes and save their prepared message in .git/MERGE_MSG so the next git-commit execution can present it to the user for them to amend if they wish.</p>\n\n<p>Use this function to get the contents of this file. Don't forget to remove the file after you create the commit.</p>\n","group":"repository"},"git_repository_message_remove":{"type":"function","file":"git2/repository.h","line":617,"lineto":617,"args":[{"name":"repo","type":"git_repository *","comment":null}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"int","comment":null},"description":"<p>Remove git's prepared message.</p>\n","comments":"<p>Remove the message that <code>git_repository_message</code> retrieves.</p>\n","group":"repository"},"git_repository_state_cleanup":{"type":"function","file":"git2/repository.h","line":626,"lineto":626,"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 command like merge,\n revert, cherry-pick, etc. For example: MERGE_HEAD, MERGE_MSG, etc.</p>\n","comments":"","group":"repository","examples":{"merge.c":["ex/v0.27.1/merge.html#git_repository_state_cleanup-43"]}},"git_repository_fetchhead_foreach":{"type":"function","file":"git2/repository.h","line":645,"lineto":648,"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, git_repository_fetchhead_foreach_cb callback, void *payload","sig":"git_repository *::git_repository_fetchhead_foreach_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, GIT_ENOTFOUND if\n there is no FETCH_HEAD file, or other error code."},"description":"<p>Invoke 'callback' for each entry in the given FETCH_HEAD file.</p>\n","comments":"<p>Return a non-zero value from the callback to stop the loop.</p>\n","group":"repository"},"git_repository_mergehead_foreach":{"type":"function","file":"git2/repository.h","line":665,"lineto":668,"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 *","comment":"Pointer to callback data (optional)"}],"argline":"git_repository *repo, git_repository_mergehead_foreach_cb callback, void *payload","sig":"git_repository *::git_repository_mergehead_foreach_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, GIT_ENOTFOUND if\n there is no MERGE_HEAD file, or other error code."},"description":"<p>If a merge is in progress, invoke 'callback' for each commit ID in the\n MERGE_HEAD file.</p>\n","comments":"<p>Return a non-zero value from the callback to stop the loop.</p>\n","group":"repository"},"git_repository_hashfile":{"type":"function","file":"git2/repository.h","line":693,"lineto":698,"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\n 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\n NULL, then the `path` parameter will be used instead. If\n this is passed as the empty string, then no filters will be\n applied when calculating the hash."}],"argline":"git_oid *out, git_repository *repo, const char *path, git_otype type, const char *as_path","sig":"git_oid *::git_repository *::const char *::git_otype::const char *","return":{"type":"int","comment":" 0 on success, or an error code"},"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, you can just use the <code>git_odb_hashfile()</code> API. However, if you want to hash a file in the repository and you want to apply filtering rules (e.g. crlf filters) before generating the SHA, then use this function.</p>\n\n<p>Note: if the repository has <code>core.safecrlf</code> set to fail and the filtering triggers that failure, then this function will return an error and not calculate the hash of the file.</p>\n","group":"repository"},"git_repository_set_head":{"type":"function","file":"git2/repository.h","line":718,"lineto":720,"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, const 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 unaltered and -1 is returned.</p>\n\n<p>If the provided reference points to a branch, the HEAD will point to that branch, staying attached, or become attached if it isn't yet. If the branch doesn't exist yet, no error will be return. The HEAD will then be attached to an unborn branch.</p>\n\n<p>Otherwise, the HEAD will be detached and will directly point to the Commit.</p>\n","group":"repository"},"git_repository_set_head_detached":{"type":"function","file":"git2/repository.h","line":738,"lineto":740,"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, const 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 is unaltered and GIT_ENOTFOUND is returned.</p>\n\n<p>If the provided commitish cannot be peeled into a commit, the HEAD is unaltered and -1 is returned.</p>\n\n<p>Otherwise, the HEAD will eventually be detached and will directly point to the peeled Commit.</p>\n","group":"repository"},"git_repository_set_head_detached_from_annotated":{"type":"function","file":"git2/repository.h","line":754,"lineto":756,"args":[{"name":"repo","type":"git_repository *","comment":null},{"name":"commitish","type":"const git_annotated_commit *","comment":null}],"argline":"git_repository *repo, const git_annotated_commit *commitish","sig":"git_repository *::const git_annotated_commit *","return":{"type":"int","comment":null},"description":"<p>Make the repository HEAD directly point to the Commit.</p>\n","comments":"<p>This behaves like <code>git_repository_set_head_detached()</code> but takes an annotated commit, which lets you specify which extended sha syntax string was specified by a user, allowing for more exact reflog messages.</p>\n\n<p>See the documentation for <code>git_repository_set_head_detached()</code>.</p>\n","group":"repository"},"git_repository_detach_head":{"type":"function","file":"git2/repository.h","line":775,"lineto":776,"args":[{"name":"repo","type":"git_repository *","comment":"Repository pointer"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"int","comment":" 0 on success, GIT_EUNBORNBRANCH when HEAD points to a non existing\n 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 updated 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 unaltered, 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":"git2/repository.h","line":806,"lineto":806,"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","examples":{"merge.c":["ex/v0.27.1/merge.html#git_repository_state-44"]}},"git_repository_set_namespace":{"type":"function","file":"git2/repository.h","line":820,"lineto":820,"args":[{"name":"repo","type":"git_repository *","comment":"The repo"},{"name":"nmspace","type":"const char *","comment":"The namespace. This should not include the refs\n\tfolder, e.g. to namespace all references under `refs/namespaces/foo/`,\n\tuse `foo` as the namespace."}],"argline":"git_repository *repo, const char *nmspace","sig":"git_repository *::const char *","return":{"type":"int","comment":" 0 on success, -1 on error"},"description":"<p>Sets the active namespace for this Git Repository</p>\n","comments":"<p>This namespace affects all reference operations for the repo. See <code>man gitnamespaces</code></p>\n","group":"repository"},"git_repository_get_namespace":{"type":"function","file":"git2/repository.h","line":828,"lineto":828,"args":[{"name":"repo","type":"git_repository *","comment":"The repo"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"const char *","comment":" the active namespace, or NULL if there isn't one"},"description":"<p>Get the currently active namespace for this repository</p>\n","comments":"","group":"repository"},"git_repository_is_shallow":{"type":"function","file":"git2/repository.h","line":837,"lineto":837,"args":[{"name":"repo","type":"git_repository *","comment":"The repository"}],"argline":"git_repository *repo","sig":"git_repository *","return":{"type":"int","comment":" 1 if shallow, zero if not"},"description":"<p>Determine if the repository was a shallow clone</p>\n","comments":"","group":"repository"},"git_repository_ident":{"type":"function","file":"git2/repository.h","line":849,"lineto":849,"args":[{"name":"name","type":"const char **","comment":"where to store the pointer to the name"},{"name":"email","type":"const char **","comment":"where to store the pointer to the email"},{"name":"repo","type":"const git_repository *","comment":"the repository"}],"argline":"const char **name, const char **email, const git_repository *repo","sig":"const char **::const char **::const git_repository *","return":{"type":"int","comment":null},"description":"<p>Retrieve the configured identity to use for reflogs</p>\n","comments":"<p>The memory is owned by the repository and must not be freed by the user.</p>\n","group":"repository"},"git_repository_set_ident":{"type":"function","file":"git2/repository.h","line":862,"lineto":862,"args":[{"name":"repo","type":"git_repository *","comment":"the repository to configure"},{"name":"name","type":"const char *","comment":"the name to use for the reflog entries"},{"name":"email","type":"const char *","comment":"the email to use for the reflog entries"}],"argline":"git_repository *repo, const char *name, const char *email","sig":"git_repository *::const char *::const char *","return":{"type":"int","comment":null},"description":"<p>Set the identity to be used for writing reflogs</p>\n","comments":"<p>If both are set, this name and email will be used to write to the reflog. Pass NULL to unset. When unset, the identity will be taken from the repository's configuration.</p>\n","group":"repository"},"git_reset":{"type":"function","file":"git2/reset.h","line":62,"lineto":66,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where to perform the reset operation."},{"name":"target","type":"const git_object *","comment":"Committish to which the Head should be moved to. This object\n must belong to the given `repo` and can either be a git_commit or a\n git_tag. When a git_tag is being passed, it should be dereferencable\n 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."},{"name":"checkout_opts","type":"const git_checkout_options *","comment":"Optional checkout options to be used for a HARD reset.\n The checkout_strategy field will be overridden (based on reset_type).\n This parameter can be used to propagate notify and progress callbacks."}],"argline":"git_repository *repo, const git_object *target, git_reset_t reset_type, const git_checkout_options *checkout_opts","sig":"git_repository *::const git_object *::git_reset_t::const git_checkout_options *","return":{"type":"int","comment":" 0 on success or an error code"},"description":"<p>Sets the current head to the specified commit oid and optionally\n resets 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 with the content of the commit tree.</p>\n\n<p>HARD reset will trigger a MIXED reset and the working directory will be replaced with the content of the index. (Untracked and ignored files will be left alone, however.)</p>\n\n<p>TODO: Implement remaining kinds of resets.</p>\n","group":"reset"},"git_reset_from_annotated":{"type":"function","file":"git2/reset.h","line":80,"lineto":84,"args":[{"name":"repo","type":"git_repository *","comment":null},{"name":"commit","type":"const git_annotated_commit *","comment":null},{"name":"reset_type","type":"git_reset_t","comment":null},{"name":"checkout_opts","type":"const git_checkout_options *","comment":null}],"argline":"git_repository *repo, const git_annotated_commit *commit, git_reset_t reset_type, const git_checkout_options *checkout_opts","sig":"git_repository *::const git_annotated_commit *::git_reset_t::const git_checkout_options *","return":{"type":"int","comment":null},"description":"<p>Sets the current head to the specified commit oid and optionally\n resets the index and working tree to match.</p>\n","comments":"<p>This behaves like <code>git_reset()</code> but takes an annotated commit, which lets you specify which extended sha syntax string was specified by a user, allowing for more exact reflog messages.</p>\n\n<p>See the documentation for <code>git_reset()</code>.</p>\n","group":"reset"},"git_reset_default":{"type":"function","file":"git2/reset.h","line":104,"lineto":107,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where to perform the reset operation."},{"name":"target","type":"const git_object *","comment":"The committish which content will be used to reset the content\n of the index."},{"name":"pathspecs","type":"const git_strarray *","comment":"List of pathspecs to operate on."}],"argline":"git_repository *repo, const git_object *target, const git_strarray *pathspecs","sig":"git_repository *::const git_object *::const git_strarray *","return":{"type":"int","comment":" 0 on success or an error code \n<\n 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 being passed in the <code>pathspec</code> parameters.</p>\n\n<p>Passing a NULL <code>target</code> will result in removing entries in the index matching the provided pathspecs.</p>\n","group":"reset"},"git_revert_init_options":{"type":"function","file":"git2/revert.h","line":47,"lineto":49,"args":[{"name":"opts","type":"git_revert_options *","comment":"the `git_revert_options` struct to initialize"},{"name":"version","type":"unsigned int","comment":"Version of struct; pass `GIT_REVERT_OPTIONS_VERSION`"}],"argline":"git_revert_options *opts, unsigned int version","sig":"git_revert_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_revert_options</code> with default values. Equivalent to\n creating an instance with GIT_REVERT_OPTIONS_INIT.</p>\n","comments":"","group":"revert"},"git_revert_commit":{"type":"function","file":"git2/revert.h","line":65,"lineto":71,"args":[{"name":"out","type":"git_index **","comment":"pointer to store the index result in"},{"name":"repo","type":"git_repository *","comment":"the repository that contains the given commits"},{"name":"revert_commit","type":"git_commit *","comment":"the commit to revert"},{"name":"our_commit","type":"git_commit *","comment":"the commit to revert against (eg, HEAD)"},{"name":"mainline","type":"unsigned int","comment":"the parent of the revert commit, if it is a merge"},{"name":"merge_options","type":"const git_merge_options *","comment":"the merge options (or null for defaults)"}],"argline":"git_index **out, git_repository *repo, git_commit *revert_commit, git_commit *our_commit, unsigned int mainline, const git_merge_options *merge_options","sig":"git_index **::git_repository *::git_commit *::git_commit *::unsigned int::const git_merge_options *","return":{"type":"int","comment":" zero on success, -1 on failure."},"description":"<p>Reverts the given commit against the given "our" commit, producing an\n index that reflects the result of the revert.</p>\n","comments":"<p>The returned index must be freed explicitly with <code>git_index_free</code>.</p>\n","group":"revert"},"git_revert":{"type":"function","file":"git2/revert.h","line":81,"lineto":84,"args":[{"name":"repo","type":"git_repository *","comment":"the repository to revert"},{"name":"commit","type":"git_commit *","comment":"the commit to revert"},{"name":"given_opts","type":"const git_revert_options *","comment":"the revert options (or null for defaults)"}],"argline":"git_repository *repo, git_commit *commit, const git_revert_options *given_opts","sig":"git_repository *::git_commit *::const git_revert_options *","return":{"type":"int","comment":" zero on success, -1 on failure."},"description":"<p>Reverts the given commit, producing changes in the index and working directory.</p>\n","comments":"","group":"revert"},"git_revparse_single":{"type":"function","file":"git2/revparse.h","line":37,"lineto":38,"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.</p>\n","comments":"<p>See <code>man gitrevisions</code>, or http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for information on the syntax accepted.</p>\n\n<p>The returned object should be released with <code>git_object_free</code> when no longer needed.</p>\n","group":"revparse","examples":{"blame.c":["ex/v0.27.1/blame.html#git_revparse_single-26"],"cat-file.c":["ex/v0.27.1/cat-file.html#git_revparse_single-34"],"describe.c":["ex/v0.27.1/describe.html#git_revparse_single-8"],"log.c":["ex/v0.27.1/log.html#git_revparse_single-45"],"tag.c":["ex/v0.27.1/tag.html#git_revparse_single-13","ex/v0.27.1/tag.html#git_revparse_single-14","ex/v0.27.1/tag.html#git_revparse_single-15","ex/v0.27.1/tag.html#git_revparse_single-16"]}},"git_revparse_ext":{"type":"function","file":"git2/revparse.h","line":61,"lineto":65,"args":[{"name":"object_out","type":"git_object **","comment":"pointer to output object"},{"name":"reference_out","type":"git_reference **","comment":"pointer to output reference or NULL"},{"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 **object_out, git_reference **reference_out, git_repository *repo, const char *spec","sig":"git_object **::git_reference **::git_repository *::const char *","return":{"type":"int","comment":" 0 on success, GIT_ENOTFOUND, GIT_EAMBIGUOUS, GIT_EINVALIDSPEC\n or an error code"},"description":"<p>Find a single object and intermediate reference by a revision string.</p>\n","comments":"<p>See <code>man gitrevisions</code>, or http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for information on the syntax accepted.</p>\n\n<p>In some cases (<code>@{<-n>}</code> or <code><branchname>@{upstream}</code>), the expression may point to an intermediate reference. When such expressions are being passed in, <code>reference_out</code> will be valued as well.</p>\n\n<p>The returned object should be released with <code>git_object_free</code> and the returned reference with <code>git_reference_free</code> when no longer needed.</p>\n","group":"revparse"},"git_revparse":{"type":"function","file":"git2/revparse.h","line":105,"lineto":108,"args":[{"name":"revspec","type":"git_revspec *","comment":"Pointer to an user-allocated git_revspec struct where\n\t 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, git_repository *repo, const 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.</p>\n","comments":"<p>See <code>man gitrevisions</code> or http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for information on the syntax accepted.</p>\n","group":"revparse","examples":{"blame.c":["ex/v0.27.1/blame.html#git_revparse-27"],"log.c":["ex/v0.27.1/log.html#git_revparse-46"],"rev-parse.c":["ex/v0.27.1/rev-parse.html#git_revparse-18","ex/v0.27.1/rev-parse.html#git_revparse-19"]}},"git_revwalk_new":{"type":"function","file":"git2/revwalk.h","line":73,"lineto":73,"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 commit cache, so it is relatively expensive to allocate.</p>\n\n<p>For maximum performance, this revision walker should be reused for different walks.</p>\n\n<p>This revision walker is <em>not</em> thread safe: it may only be used to walk a repository on a single thread; however, it is possible to have several revision walkers in several different threads walking the same repository.</p>\n","group":"revwalk","examples":{"general.c":["ex/v0.27.1/general.html#git_revwalk_new-74"],"log.c":["ex/v0.27.1/log.html#git_revwalk_new-47","ex/v0.27.1/log.html#git_revwalk_new-48"]}},"git_revwalk_reset":{"type":"function","file":"git2/revwalk.h","line":88,"lineto":88,"args":[{"name":"walker","type":"git_revwalk *","comment":"handle to reset."}],"argline":"git_revwalk *walker","sig":"git_revwalk *","return":{"type":"void","comment":null},"description":"<p>Reset the revision walker for reuse.</p>\n","comments":"<p>This will clear all the pushed and hidden commits, and leave the walker in a blank state (just like at creation) ready to receive new commit pushes and start a new walk.</p>\n\n<p>The revision walk is automatically reset when a walk is over.</p>\n","group":"revwalk"},"git_revwalk_push":{"type":"function","file":"git2/revwalk.h","line":107,"lineto":107,"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>Add a new root for the traversal</p>\n","comments":"<p>The pushed commit will be marked as one of the roots from which to start the walk. This commit may not be walked if it or a child is hidden.</p>\n\n<p>At least one commit must be pushed onto the walker before a walk can be started.</p>\n\n<p>The given id must belong to a committish on the walked repository.</p>\n","group":"revwalk","examples":{"general.c":["ex/v0.27.1/general.html#git_revwalk_push-75"],"log.c":["ex/v0.27.1/log.html#git_revwalk_push-49"]}},"git_revwalk_push_glob":{"type":"function","file":"git2/revwalk.h","line":125,"lineto":125,"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 pattern will be pushed to the revision walker.</p>\n\n<p>A leading 'refs/' is implied if not present as well as a trailing '/*' if the glob lacks '?', '*' or '['.</p>\n\n<p>Any references matching this glob which do not point to a committish will be ignored.</p>\n","group":"revwalk"},"git_revwalk_push_head":{"type":"function","file":"git2/revwalk.h","line":133,"lineto":133,"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's HEAD</p>\n","comments":"","group":"revwalk","examples":{"log.c":["ex/v0.27.1/log.html#git_revwalk_push_head-50"]}},"git_revwalk_hide":{"type":"function","file":"git2/revwalk.h","line":148,"lineto":148,"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 id must belong to a committish on the walked repository.</p>\n\n<p>The resolved commit and all its parents will be hidden from the output on the revision walk.</p>\n","group":"revwalk","examples":{"log.c":["ex/v0.27.1/log.html#git_revwalk_hide-51"]}},"git_revwalk_hide_glob":{"type":"function","file":"git2/revwalk.h","line":167,"lineto":167,"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 pattern and their ancestors will be hidden from the output on the revision walk.</p>\n\n<p>A leading 'refs/' is implied if not present as well as a trailing '/*' if the glob lacks '?', '*' or '['.</p>\n\n<p>Any references matching this glob which do not point to a committish will be ignored.</p>\n","group":"revwalk"},"git_revwalk_hide_head":{"type":"function","file":"git2/revwalk.h","line":175,"lineto":175,"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's HEAD</p>\n","comments":"","group":"revwalk"},"git_revwalk_push_ref":{"type":"function","file":"git2/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 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 committish.</p>\n","group":"revwalk"},"git_revwalk_hide_ref":{"type":"function","file":"git2/revwalk.h","line":197,"lineto":197,"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 committish.</p>\n","group":"revwalk"},"git_revwalk_next":{"type":"function","file":"git2/revwalk.h","line":217,"lineto":217,"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;\n\tGIT_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 iterating through a repo with a time-sorting mode.</p>\n\n<p>Iterating with Topological or inverted modes makes the initial call blocking to preprocess the commit list, but this block should be mostly unnoticeable on most repositories (topological preprocessing times 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.27.1/general.html#git_revwalk_next-76"],"log.c":["ex/v0.27.1/log.html#git_revwalk_next-52"]}},"git_revwalk_sorting":{"type":"function","file":"git2/revwalk.h","line":228,"lineto":228,"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","comment":null},"description":"<p>Change the sorting mode when iterating through the\n repository's contents.</p>\n","comments":"<p>Changing the sorting mode resets the walker.</p>\n","group":"revwalk","examples":{"general.c":["ex/v0.27.1/general.html#git_revwalk_sorting-77"],"log.c":["ex/v0.27.1/log.html#git_revwalk_sorting-53","ex/v0.27.1/log.html#git_revwalk_sorting-54"]}},"git_revwalk_push_range":{"type":"function","file":"git2/revwalk.h","line":243,"lineto":243,"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 <commit>..<commit> where each <commit> is in the form accepted by 'git_revparse_single'. The left-hand commit will be hidden and the right-hand commit pushed.</p>\n","group":"revwalk"},"git_revwalk_simplify_first_parent":{"type":"function","file":"git2/revwalk.h","line":250,"lineto":250,"args":[{"name":"walk","type":"git_revwalk *","comment":null}],"argline":"git_revwalk *walk","sig":"git_revwalk *","return":{"type":"void","comment":null},"description":"<p>Simplify the history by first-parent</p>\n","comments":"<p>No parents other than the first for each commit will be enqueued.</p>\n","group":"revwalk"},"git_revwalk_free":{"type":"function","file":"git2/revwalk.h","line":258,"lineto":258,"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","comment":null},"description":"<p>Free a revision walker previously allocated.</p>\n","comments":"","group":"revwalk","examples":{"general.c":["ex/v0.27.1/general.html#git_revwalk_free-78"],"log.c":["ex/v0.27.1/log.html#git_revwalk_free-55"]}},"git_revwalk_repository":{"type":"function","file":"git2/revwalk.h","line":267,"lineto":267,"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\n is operating.</p>\n","comments":"","group":"revwalk"},"git_revwalk_add_hide_cb":{"type":"function","file":"git2/revwalk.h","line":288,"lineto":291,"args":[{"name":"walk","type":"git_revwalk *","comment":"the revision walker"},{"name":"hide_cb","type":"git_revwalk_hide_cb","comment":"callback function to hide a commit and its parents"},{"name":"payload","type":"void *","comment":"data payload to be passed to callback function"}],"argline":"git_revwalk *walk, git_revwalk_hide_cb hide_cb, void *payload","sig":"git_revwalk *::git_revwalk_hide_cb::void *","return":{"type":"int","comment":null},"description":"<p>Adds a callback function to hide a commit and its parents</p>\n","comments":"","group":"revwalk"},"git_signature_new":{"type":"function","file":"git2/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 ('<' and '>') characters are not allowed to be used in either the <code>name</code> or the <code>email</code> parameter.</p>\n","group":"signature","examples":{"general.c":["ex/v0.27.1/general.html#git_signature_new-79","ex/v0.27.1/general.html#git_signature_new-80"]}},"git_signature_now":{"type":"function","file":"git2/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 'now'.</p>\n","comments":"<p>Call <code>git_signature_free()</code> to free the data.</p>\n","group":"signature","examples":{"merge.c":["ex/v0.27.1/merge.html#git_signature_now-45"]}},"git_signature_default":{"type":"function","file":"git2/signature.h","line":63,"lineto":63,"args":[{"name":"out","type":"git_signature **","comment":"new signature"},{"name":"repo","type":"git_repository *","comment":"repository pointer"}],"argline":"git_signature **out, git_repository *repo","sig":"git_signature **::git_repository *","return":{"type":"int","comment":" 0 on success, GIT_ENOTFOUND if config is missing, or error code"},"description":"<p>Create a new action signature with default user and now timestamp.</p>\n","comments":"<p>This looks up the user.name and user.email from the configuration and uses the current time as the timestamp, and creates a new signature based on that information. It will return GIT_ENOTFOUND if either the user.name or user.email are not set.</p>\n","group":"signature","examples":{"init.c":["ex/v0.27.1/init.html#git_signature_default-12"],"tag.c":["ex/v0.27.1/tag.html#git_signature_default-17"]}},"git_signature_from_buffer":{"type":"function","file":"git2/signature.h","line":76,"lineto":76,"args":[{"name":"out","type":"git_signature **","comment":"new signature"},{"name":"buf","type":"const char *","comment":"signature string"}],"argline":"git_signature **out, const char *buf","sig":"git_signature **::const char *","return":{"type":"int","comment":" 0 on success, or an error code"},"description":"<p>Create a new signature by parsing the given buffer, which is\n expected to be in the format "Real Name \n<email</p>\n\n<blockquote>\n<p>timestamp tzoffset",\n where <code>timestamp</code> is the number of seconds since the Unix epoch and\n <code>tzoffset</code> is the timezone offset in <code>hhmm</code> format (note the lack\n of a colon separator).</p>\n</blockquote>\n","comments":"","group":"signature"},"git_signature_dup":{"type":"function","file":"git2/signature.h","line":88,"lineto":88,"args":[{"name":"dest","type":"git_signature **","comment":"pointer where to store the copy"},{"name":"sig","type":"const git_signature *","comment":"signature to duplicate"}],"argline":"git_signature **dest, const git_signature *sig","sig":"git_signature **::const git_signature *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Create a copy of an existing signature. All internal strings are also\n duplicated.</p>\n","comments":"<p>Call <code>git_signature_free()</code> to free the data.</p>\n","group":"signature"},"git_signature_free":{"type":"function","file":"git2/signature.h","line":99,"lineto":99,"args":[{"name":"sig","type":"git_signature *","comment":"signature to free"}],"argline":"git_signature *sig","sig":"git_signature *","return":{"type":"void","comment":null},"description":"<p>Free an existing signature.</p>\n","comments":"<p>Because the signature is not an opaque structure, it is legal to free it manually, but be sure to free the "name" and "email" strings in addition to the structure itself.</p>\n","group":"signature","examples":{"general.c":["ex/v0.27.1/general.html#git_signature_free-81","ex/v0.27.1/general.html#git_signature_free-82"],"init.c":["ex/v0.27.1/init.html#git_signature_free-13"],"tag.c":["ex/v0.27.1/tag.html#git_signature_free-18"]}},"git_stash_apply_init_options":{"type":"function","file":"git2/stash.h","line":153,"lineto":154,"args":[{"name":"opts","type":"git_stash_apply_options *","comment":"the `git_stash_apply_options` instance to initialize."},{"name":"version","type":"unsigned int","comment":"the version of the struct; you should pass\n `GIT_STASH_APPLY_OPTIONS_INIT` here."}],"argline":"git_stash_apply_options *opts, unsigned int version","sig":"git_stash_apply_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_stash_apply_options</code> with default values. Equivalent to\n creating an instance with GIT_STASH_APPLY_OPTIONS_INIT.</p>\n","comments":"","group":"stash"},"git_stash_apply":{"type":"function","file":"git2/stash.h","line":182,"lineto":185,"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\n most recent stashed state."},{"name":"options","type":"const git_stash_apply_options *","comment":"Optional options to control how stashes are applied."}],"argline":"git_repository *repo, size_t index, const git_stash_apply_options *options","sig":"git_repository *::size_t::const git_stash_apply_options *","return":{"type":"int","comment":" 0 on success, GIT_ENOTFOUND if there's no stashed state for the\n given index, GIT_EMERGECONFLICT if changes exist in the working\n directory, or an error code"},"description":"<p>Apply a single stashed state from the stash list.</p>\n","comments":"<p>If local changes in the working directory conflict with changes in the stash then GIT_EMERGECONFLICT will be returned. In this case, the index will always remain unmodified and all files in the working directory will remain unmodified. However, if you are restoring untracked files or ignored files and there is a conflict when applying the modified files, then those files will remain in the working directory.</p>\n\n<p>If passing the GIT_STASH_APPLY_REINSTATE_INDEX flag and there would be conflicts when reinstating the index, the function will return GIT_EMERGECONFLICT and both the working directory and index will be left unmodified.</p>\n\n<p>Note that a minimum checkout strategy of <code>GIT_CHECKOUT_SAFE</code> is implied.</p>\n","group":"stash"},"git_stash_foreach":{"type":"function","file":"git2/stash.h","line":218,"lineto":221,"args":[{"name":"repo","type":"git_repository *","comment":"Repository where to find the stash."},{"name":"callback","type":"git_stash_cb","comment":"Callback to invoke per found stashed state. The most\n recent stash state will be enumerated first."},{"name":"payload","type":"void *","comment":"Extra parameter to callback function."}],"argline":"git_repository *repo, git_stash_cb callback, void *payload","sig":"git_repository *::git_stash_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, 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":"git2/stash.h","line":234,"lineto":236,"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\n most recent stashed state."}],"argline":"git_repository *repo, size_t index","sig":"git_repository *::size_t","return":{"type":"int","comment":" 0 on success, GIT_ENOTFOUND if there's no stashed state for the given\n index, or error code."},"description":"<p>Remove a single stashed state from the stash list.</p>\n","comments":"","group":"stash"},"git_stash_pop":{"type":"function","file":"git2/stash.h","line":250,"lineto":253,"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\n most recent stashed state."},{"name":"options","type":"const git_stash_apply_options *","comment":"Optional options to control how stashes are applied."}],"argline":"git_repository *repo, size_t index, const git_stash_apply_options *options","sig":"git_repository *::size_t::const git_stash_apply_options *","return":{"type":"int","comment":" 0 on success, GIT_ENOTFOUND if there's no stashed state for the given\n index, or error code. (see git_stash_apply() above for details)"},"description":"<p>Apply a single stashed state from the stash list and remove it from the list\n if successful.</p>\n","comments":"","group":"stash"},"git_status_init_options":{"type":"function","file":"git2/status.h","line":199,"lineto":201,"args":[{"name":"opts","type":"git_status_options *","comment":"The `git_status_options` instance to initialize."},{"name":"version","type":"unsigned int","comment":"Version of struct; pass `GIT_STATUS_OPTIONS_VERSION`"}],"argline":"git_status_options *opts, unsigned int version","sig":"git_status_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_status_options</code> with default values. Equivalent to\n creating an instance with GIT_STATUS_OPTIONS_INIT.</p>\n","comments":"","group":"status"},"git_status_foreach":{"type":"function","file":"git2/status.h","line":239,"lineto":242,"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, git_status_cb callback, void *payload","sig":"git_repository *::git_status_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, 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 the <code>git_status_t</code> values above) and the <code>payload</code> data pointer passed into this function.</p>\n\n<p>If the callback returns a non-zero value, this function will stop looping and return that value to caller.</p>\n","group":"status","examples":{"status.c":["ex/v0.27.1/status.html#git_status_foreach-10"]}},"git_status_foreach_ext":{"type":"function","file":"git2/status.h","line":263,"lineto":267,"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, const git_status_options *opts, git_status_cb callback, void *payload","sig":"git_repository *::const git_status_options *::git_status_cb::void *","return":{"type":"int","comment":" 0 on success, non-zero callback return value, 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 allows for more granular control over which paths will be processed and in what order. See the <code>git_status_options</code> structure for details about the additional controls that this makes available.</p>\n\n<p>Note that if a <code>pathspec</code> is given in the <code>git_status_options</code> to filter the status, then the results from rename detection (if you enable it) may not be accurate. To do rename detection properly, this must be called with no <code>pathspec</code> so that all files can be considered.</p>\n","group":"status","examples":{"status.c":["ex/v0.27.1/status.html#git_status_foreach_ext-11"]}},"git_status_file":{"type":"function","file":"git2/status.h","line":295,"lineto":298,"args":[{"name":"status_flags","type":"unsigned int *","comment":"Output combination of git_status_t values for file"},{"name":"repo","type":"git_repository *","comment":"A repository object"},{"name":"path","type":"const char *","comment":"The exact path to retrieve status for relative to the\n repository working directory"}],"argline":"unsigned int *status_flags, git_repository *repo, const 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,\n index, and work tree, GIT_EAMBIGUOUS if `path` matches multiple files\n or if it refers to a folder, and -1 on other errors."},"description":"<p>Get file status for a single file.</p>\n","comments":"<p>This tries to get status for the filename that you give. If no files match that name (in either the HEAD, index, or working directory), this returns GIT_ENOTFOUND.</p>\n\n<p>If the name matches multiple files (for example, if the <code>path</code> names a directory or if running on a case- insensitive filesystem and yet the HEAD has two entries that both match the path), then this returns GIT_EAMBIGUOUS because it cannot give correct results.</p>\n\n<p>This does not do any sort of rename detection. Renames require a set of targets and because of the path filtering, there is not enough information to check renames correctly. To check file status with rename detection, there is no choice but to do a full <code>git_status_list_new</code> and scan through looking for the path that you are interested in.</p>\n","group":"status"},"git_status_list_new":{"type":"function","file":"git2/status.h","line":313,"lineto":316,"args":[{"name":"out","type":"git_status_list **","comment":"Pointer to store the status results in"},{"name":"repo","type":"git_repository *","comment":"Repository object"},{"name":"opts","type":"const git_status_options *","comment":"Status options structure"}],"argline":"git_status_list **out, git_repository *repo, const git_status_options *opts","sig":"git_status_list **::git_repository *::const git_status_options *","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Gather file status information and populate the <code>git_status_list</code>.</p>\n","comments":"<p>Note that if a <code>pathspec</code> is given in the <code>git_status_options</code> to filter the status, then the results from rename detection (if you enable it) may not be accurate. To do rename detection properly, this must be called with no <code>pathspec</code> so that all files can be considered.</p>\n","group":"status","examples":{"status.c":["ex/v0.27.1/status.html#git_status_list_new-12","ex/v0.27.1/status.html#git_status_list_new-13"]}},"git_status_list_entrycount":{"type":"function","file":"git2/status.h","line":327,"lineto":328,"args":[{"name":"statuslist","type":"git_status_list *","comment":"Existing status list object"}],"argline":"git_status_list *statuslist","sig":"git_status_list *","return":{"type":"size_t","comment":" the number of status entries"},"description":"<p>Gets the count of status entries in this list.</p>\n","comments":"<p>If there are no changes in status (at least according the options given when the status list was created), this can return 0.</p>\n","group":"status","examples":{"status.c":["ex/v0.27.1/status.html#git_status_list_entrycount-14","ex/v0.27.1/status.html#git_status_list_entrycount-15"]}},"git_status_byindex":{"type":"function","file":"git2/status.h","line":339,"lineto":341,"args":[{"name":"statuslist","type":"git_status_list *","comment":"Existing status list object"},{"name":"idx","type":"size_t","comment":"Position of the entry"}],"argline":"git_status_list *statuslist, size_t idx","sig":"git_status_list *::size_t","return":{"type":"const git_status_entry *","comment":" Pointer to the entry; NULL if out of bounds"},"description":"<p>Get a pointer to one of the entries in the status list.</p>\n","comments":"<p>The entry is not modifiable and should not be freed.</p>\n","group":"status","examples":{"status.c":["ex/v0.27.1/status.html#git_status_byindex-16","ex/v0.27.1/status.html#git_status_byindex-17","ex/v0.27.1/status.html#git_status_byindex-18","ex/v0.27.1/status.html#git_status_byindex-19","ex/v0.27.1/status.html#git_status_byindex-20","ex/v0.27.1/status.html#git_status_byindex-21"]}},"git_status_list_free":{"type":"function","file":"git2/status.h","line":348,"lineto":349,"args":[{"name":"statuslist","type":"git_status_list *","comment":"Existing status list object"}],"argline":"git_status_list *statuslist","sig":"git_status_list *","return":{"type":"void","comment":null},"description":"<p>Free an existing status list</p>\n","comments":"","group":"status","examples":{"status.c":["ex/v0.27.1/status.html#git_status_list_free-22"]}},"git_status_should_ignore":{"type":"function","file":"git2/status.h","line":367,"lineto":370,"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, git_repository *repo, const char *path","sig":"int *::git_repository *::const char *","return":{"type":"int","comment":" 0 if ignore rules could be processed for the file (regardless\n of whether it exists or not), or an error \n<\n 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 given file. This indicates if the file would be ignored regardless of whether 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 "git add ." on the directory containing the file, would it be added or not?</p>\n","group":"status"},"git_strarray_free":{"type":"function","file":"git2/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","comment":null},"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 array is allocated and contains allocated strings, such as what you would get from <code>git_strarray_copy()</code>. Not doing so, will result in a memory leak.</p>\n\n<p>This does not free the <code>git_strarray</code> itself, since the library will never allocate that object directly itself (it is more commonly embedded inside another struct or created on the stack).</p>\n","group":"strarray","examples":{"general.c":["ex/v0.27.1/general.html#git_strarray_free-83"],"remote.c":["ex/v0.27.1/remote.html#git_strarray_free-16","ex/v0.27.1/remote.html#git_strarray_free-17"],"tag.c":["ex/v0.27.1/tag.html#git_strarray_free-19"]}},"git_strarray_copy":{"type":"function","file":"git2/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, \n<\n 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 contents are leaked. Call git_strarray_free() if necessary.</p>\n","group":"strarray"},"git_submodule_update_init_options":{"type":"function","file":"git2/submodule.h","line":170,"lineto":171,"args":[{"name":"opts","type":"git_submodule_update_options *","comment":"The `git_submodule_update_options` instance to initialize."},{"name":"version","type":"unsigned int","comment":"Version of struct; pass `GIT_SUBMODULE_UPDATE_OPTIONS_VERSION`"}],"argline":"git_submodule_update_options *opts, unsigned int version","sig":"git_submodule_update_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_submodule_update_options</code> with default values.\n Equivalent to creating an instance with GIT_SUBMODULE_UPDATE_OPTIONS_INIT.</p>\n","comments":"","group":"submodule"},"git_submodule_update":{"type":"function","file":"git2/submodule.h","line":191,"lineto":191,"args":[{"name":"submodule","type":"git_submodule *","comment":"Submodule object"},{"name":"init","type":"int","comment":"If the submodule is not initialized, setting this flag to true\n will initialize the submodule before updating. Otherwise, this will\n return an error if attempting to update an uninitialzed repository.\n but setting this to true forces them to be updated."},{"name":"options","type":"git_submodule_update_options *","comment":"configuration options for the update. If NULL, the\n function works as though GIT_SUBMODULE_UPDATE_OPTIONS_INIT was passed."}],"argline":"git_submodule *submodule, int init, git_submodule_update_options *options","sig":"git_submodule *::int::git_submodule_update_options *","return":{"type":"int","comment":" 0 on success, any non-zero return value from a callback\n function, or a negative value to indicate an error (use\n `giterr_last` for a detailed error message)."},"description":"<p>Update a submodule. This will clone a missing submodule and\n checkout the subrepository to the commit specified in the index of\n the containing repository. If the submodule repository doesn't contain\n the target commit (e.g. because fetchRecurseSubmodules isn't set), then\n the submodule is fetched using the fetch options supplied in options.</p>\n","comments":"","group":"submodule"},"git_submodule_lookup":{"type":"function","file":"git2/submodule.h","line":220,"lineto":223,"args":[{"name":"out","type":"git_submodule **","comment":"Output ptr to submodule; pass NULL to just get return code"},{"name":"repo","type":"git_repository *","comment":"The parent repository"},{"name":"name","type":"const char *","comment":"The name of or path to the submodule; trailing slashes okay"}],"argline":"git_submodule **out, git_repository *repo, const char *name","sig":"git_submodule **::git_repository *::const char *","return":{"type":"int","comment":" 0 on success, GIT_ENOTFOUND if submodule does not exist,\n GIT_EEXISTS if a repository is found in working directory only,\n -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 returns 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, but does "exist" in the working directory (i.e. there is a subdirectory that appears to be a Git repository). In this case, this function returns GIT_EEXISTS to indicate a sub-repository exists but not in a state where a git_submodule can be instantiated. - The submodule is not mentioned in the HEAD, index, or config and the working directory doesn't contain a value git repo at that path. There may or may not be anything else at that path, but nothing that looks like a submodule. In this case, this returns GIT_ENOTFOUND.</li>\n</ul>\n\n<p>You must call <code>git_submodule_free</code> when done with the submodule.</p>\n","group":"submodule"},"git_submodule_free":{"type":"function","file":"git2/submodule.h","line":230,"lineto":230,"args":[{"name":"submodule","type":"git_submodule *","comment":"Submodule object"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"void","comment":null},"description":"<p>Release a submodule</p>\n","comments":"","group":"submodule"},"git_submodule_foreach":{"type":"function","file":"git2/submodule.h","line":250,"lineto":253,"args":[{"name":"repo","type":"git_repository *","comment":"The repository"},{"name":"callback","type":"git_submodule_cb","comment":"Function to be called with the name of each submodule.\n Return a non-zero value to terminate the iteration."},{"name":"payload","type":"void *","comment":"Extra data to pass to callback"}],"argline":"git_repository *repo, git_submodule_cb callback, void *payload","sig":"git_repository *::git_submodule_cb::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 submodules as described therein.</p>\n\n<p>If you are concerned about items in the working directory that look like submodules but are not tracked, the diff API will generate a diff record for workdir items that look like submodules but are not tracked, showing them as added in the workdir. Also, the status API will treat the entire subdirectory of a contained git repo as a single GIT_STATUS_WT_NEW item.</p>\n","group":"submodule","examples":{"status.c":["ex/v0.27.1/status.html#git_submodule_foreach-23"]}},"git_submodule_add_setup":{"type":"function","file":"git2/submodule.h","line":280,"lineto":285,"args":[{"name":"out","type":"git_submodule **","comment":"The newly created submodule ready to open for clone"},{"name":"repo","type":"git_repository *","comment":"The repository in which you want to create the submodule"},{"name":"url","type":"const char *","comment":"URL for the submodule's 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\n .git/modules vs. repo directly in workdir."}],"argline":"git_submodule **out, git_repository *repo, const char *url, const char *path, int 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,\n -1 on other errors."},"description":"<p>Set up a new git submodule for checkout.</p>\n","comments":"<p>This does "git submodule add" up to the fetch and checkout of the submodule contents. It preps a new submodule, creates an entry in .gitmodules and creates an empty initialized repository either at the given path in the working directory or in .git/modules with a gitlink from the working directory to the new repo.</p>\n\n<p>To fully emulate "git submodule add" call this function, then open the submodule repo and perform the clone step as needed. Lastly, call <code>git_submodule_add_finalize()</code> to wrap up adding the new submodule and .gitmodules to the index to be ready to commit.</p>\n\n<p>You must call <code>git_submodule_free</code> on the submodule object when done.</p>\n","group":"submodule"},"git_submodule_add_finalize":{"type":"function","file":"git2/submodule.h","line":297,"lineto":297,"args":[{"name":"submodule","type":"git_submodule *","comment":"The submodule to finish adding."}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"int","comment":null},"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 and done the clone of the submodule. This adds the .gitmodules file and the newly cloned submodule to the index to be ready to be committed (but doesn't actually do the commit).</p>\n","group":"submodule"},"git_submodule_add_to_index":{"type":"function","file":"git2/submodule.h","line":309,"lineto":311,"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\n file. If you pass this as false, you will have to get the\n git_index and explicitly call `git_index_write()` on it to\n save the change."}],"argline":"git_submodule *submodule, int write_index","sig":"git_submodule *::int","return":{"type":"int","comment":" 0 on success, \n<\n0 on failure"},"description":"<p>Add current submodule HEAD commit to index of superproject.</p>\n","comments":"","group":"submodule"},"git_submodule_owner":{"type":"function","file":"git2/submodule.h","line":324,"lineto":324,"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. This is a just a reference to the repository that was passed to the original <code>git_submodule_lookup()</code> call, so if that repository has been freed, then this may be a dangling reference.</p>\n","group":"submodule"},"git_submodule_name":{"type":"function","file":"git2/submodule.h","line":332,"lineto":332,"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","examples":{"status.c":["ex/v0.27.1/status.html#git_submodule_name-24"]}},"git_submodule_path":{"type":"function","file":"git2/submodule.h","line":343,"lineto":343,"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 two are actually not required to match.</p>\n","group":"submodule","examples":{"status.c":["ex/v0.27.1/status.html#git_submodule_path-25"]}},"git_submodule_url":{"type":"function","file":"git2/submodule.h","line":351,"lineto":351,"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_resolve_url":{"type":"function","file":"git2/submodule.h","line":361,"lineto":361,"args":[{"name":"out","type":"git_buf *","comment":"buffer to store the absolute submodule url in"},{"name":"repo","type":"git_repository *","comment":"Pointer to repository object"},{"name":"url","type":"const char *","comment":"Relative url"}],"argline":"git_buf *out, git_repository *repo, const char *url","sig":"git_buf *::git_repository *::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Resolve a submodule url relative to the given repository.</p>\n","comments":"","group":"submodule"},"git_submodule_branch":{"type":"function","file":"git2/submodule.h","line":369,"lineto":369,"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 branch"},"description":"<p>Get the branch for the submodule.</p>\n","comments":"","group":"submodule"},"git_submodule_set_branch":{"type":"function","file":"git2/submodule.h","line":382,"lineto":382,"args":[{"name":"repo","type":"git_repository *","comment":"the repository to affect"},{"name":"name","type":"const char *","comment":"the name of the submodule to configure"},{"name":"branch","type":"const char *","comment":"Branch that should be used for the submodule"}],"argline":"git_repository *repo, const char *name, const char *branch","sig":"git_repository *::const char *::const char *","return":{"type":"int","comment":" 0 on success, \n<\n0 on failure"},"description":"<p>Set the branch for the submodule in the configuration</p>\n","comments":"<p>After calling this, you may wish to call <code>git_submodule_sync()</code> to write the changes to the checked out submodule repository.</p>\n","group":"submodule"},"git_submodule_set_url":{"type":"function","file":"git2/submodule.h","line":396,"lineto":396,"args":[{"name":"repo","type":"git_repository *","comment":"the repository to affect"},{"name":"name","type":"const char *","comment":"the name of the submodule to configure"},{"name":"url","type":"const char *","comment":"URL that should be used for the submodule"}],"argline":"git_repository *repo, const char *name, const char *url","sig":"git_repository *::const char *::const char *","return":{"type":"int","comment":" 0 on success, \n<\n0 on failure"},"description":"<p>Set the URL for the submodule in the configuration</p>\n","comments":"<p>After calling this, you may wish to call <code>git_submodule_sync()</code> to write the changes to the checked out submodule repository.</p>\n","group":"submodule"},"git_submodule_index_id":{"type":"function","file":"git2/submodule.h","line":404,"lineto":404,"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":"git2/submodule.h","line":412,"lineto":412,"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":"git2/submodule.h","line":425,"lineto":425,"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 'HEAD' in the checked out submodule. If there are pending changes in the index or anything else, this won't notice that. You should call <code>git_submodule_status()</code> for a more complete picture about the state of the working directory.</p>\n","group":"submodule"},"git_submodule_ignore":{"type":"function","file":"git2/submodule.h","line":450,"lineto":451,"args":[{"name":"submodule","type":"git_submodule *","comment":"The submodule to check"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"git_submodule_ignore_t","comment":" The current git_submodule_ignore_t valyue what will be used for\n this submodule."},"description":"<p>Get the ignore rule that will be used for the submodule.</p>\n","comments":"<p>These values control the behavior of <code>git_submodule_status()</code> for this submodule. There are four ignore values:</p>\n\n<ul>\n<li><strong>GIT_SUBMODULE_IGNORE_NONE</strong> will consider any change to the contents of the submodule from a clean checkout to be dirty, including the addition of untracked files. This is the default if unspecified. - <strong>GIT_SUBMODULE_IGNORE_UNTRACKED</strong> examines the contents of the working tree (i.e. call <code>git_status_foreach()</code> on the submodule) but UNTRACKED files will not count as making the submodule dirty. - <strong>GIT_SUBMODULE_IGNORE_DIRTY</strong> means to only check if the HEAD of the submodule has moved for status. This is fast since it does not need to scan the working tree of the submodule at all. - <strong>GIT_SUBMODULE_IGNORE_ALL</strong> means not to open the submodule repo. The working directory will be consider clean so long as there is a checked out version present.</li>\n</ul>\n","group":"submodule"},"git_submodule_set_ignore":{"type":"function","file":"git2/submodule.h","line":463,"lineto":466,"args":[{"name":"repo","type":"git_repository *","comment":"the repository to affect"},{"name":"name","type":"const char *","comment":"the name of the submdule"},{"name":"ignore","type":"git_submodule_ignore_t","comment":"The new value for the ignore rule"}],"argline":"git_repository *repo, const char *name, git_submodule_ignore_t ignore","sig":"git_repository *::const char *::git_submodule_ignore_t","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Set the ignore rule for the submodule in the configuration</p>\n","comments":"<p>This does not affect any currently-loaded instances.</p>\n","group":"submodule"},"git_submodule_update_strategy":{"type":"function","file":"git2/submodule.h","line":478,"lineto":479,"args":[{"name":"submodule","type":"git_submodule *","comment":"The submodule to check"}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"git_submodule_update_t","comment":" The current git_submodule_update_t value that will be used\n for this submodule."},"description":"<p>Get the update rule that will be used for the submodule.</p>\n","comments":"<p>This value controls the behavior of the <code>git submodule update</code> command. There are four useful values documented with <code>git_submodule_update_t</code>.</p>\n","group":"submodule"},"git_submodule_set_update":{"type":"function","file":"git2/submodule.h","line":491,"lineto":494,"args":[{"name":"repo","type":"git_repository *","comment":"the repository to affect"},{"name":"name","type":"const char *","comment":"the name of the submodule to configure"},{"name":"update","type":"git_submodule_update_t","comment":"The new value to use"}],"argline":"git_repository *repo, const char *name, git_submodule_update_t update","sig":"git_repository *::const char *::git_submodule_update_t","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Set the update rule for the submodule in the configuration</p>\n","comments":"<p>This setting won't affect any existing instances.</p>\n","group":"submodule"},"git_submodule_fetch_recurse_submodules":{"type":"function","file":"git2/submodule.h","line":507,"lineto":508,"args":[{"name":"submodule","type":"git_submodule *","comment":null}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"git_submodule_recurse_t","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 the 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 fetch functionality current ignores submodules.</p>\n","group":"submodule"},"git_submodule_set_fetch_recurse_submodules":{"type":"function","file":"git2/submodule.h","line":520,"lineto":523,"args":[{"name":"repo","type":"git_repository *","comment":"the repository to affect"},{"name":"name","type":"const char *","comment":"the submodule to configure"},{"name":"fetch_recurse_submodules","type":"git_submodule_recurse_t","comment":"Boolean value"}],"argline":"git_repository *repo, const char *name, git_submodule_recurse_t fetch_recurse_submodules","sig":"git_repository *::const char *::git_submodule_recurse_t","return":{"type":"int","comment":" old value for fetchRecurseSubmodules"},"description":"<p>Set the fetchRecurseSubmodules rule for a submodule in the configuration</p>\n","comments":"<p>This setting won't affect any existing instances.</p>\n","group":"submodule"},"git_submodule_init":{"type":"function","file":"git2/submodule.h","line":538,"lineto":538,"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,\n 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, \n<\n0 on failure."},"description":"<p>Copy submodule info into ".git/config" file.</p>\n","comments":"<p>Just like "git submodule init", this copies information about the submodule into ".git/config". You can use the accessor functions above to alter the in-memory git_submodule object and control what is written to the config, overriding what is in .gitmodules.</p>\n","group":"submodule"},"git_submodule_repo_init":{"type":"function","file":"git2/submodule.h","line":553,"lineto":556,"args":[{"name":"out","type":"git_repository **","comment":"Output pointer to the created git repository."},{"name":"sm","type":"const git_submodule *","comment":"The submodule to create a new subrepository from."},{"name":"use_gitlink","type":"int","comment":"Should the workdir contain a gitlink to\n the repo in .git/modules vs. repo directly in workdir."}],"argline":"git_repository **out, const git_submodule *sm, int use_gitlink","sig":"git_repository **::const git_submodule *::int","return":{"type":"int","comment":" 0 on success, \n<\n0 on failure."},"description":"<p>Set up the subrepository for a submodule in preparation for clone.</p>\n","comments":"<p>This function can be called to init and set up a submodule repository from a submodule in preparation to clone it from its remote.</p>\n","group":"submodule"},"git_submodule_sync":{"type":"function","file":"git2/submodule.h","line":566,"lineto":566,"args":[{"name":"submodule","type":"git_submodule *","comment":null}],"argline":"git_submodule *submodule","sig":"git_submodule *","return":{"type":"int","comment":null},"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 submodule config, acting like "git submodule sync". This is useful if you have altered the URL for the submodule (or it has been altered by a fetch of upstream changes) and you need to update your local repo.</p>\n","group":"submodule"},"git_submodule_open":{"type":"function","file":"git2/submodule.h","line":580,"lineto":582,"args":[{"name":"repo","type":"git_repository **","comment":"Pointer to the submodule repo which was opened"},{"name":"submodule","type":"git_submodule *","comment":"Submodule to be opened"}],"argline":"git_repository **repo, git_submodule *submodule","sig":"git_repository **::git_submodule *","return":{"type":"int","comment":" 0 on success, \n<\n0 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 calling <code>git_repository_free()</code> on it when done. Multiple calls to this function will return distinct <code>git_repository</code> objects. This will only work if the submodule is checked out into the working directory.</p>\n","group":"submodule"},"git_submodule_reload":{"type":"function","file":"git2/submodule.h","line":594,"lineto":594,"args":[{"name":"submodule","type":"git_submodule *","comment":"The submodule to reload"},{"name":"force","type":"int","comment":"Force reload even if the data doesn't seem out of date"}],"argline":"git_submodule *submodule, int force","sig":"git_submodule *::int","return":{"type":"int","comment":" 0 on success, \n<\n0 on error"},"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 you have reason to believe that it has changed.</p>\n","group":"submodule"},"git_submodule_status":{"type":"function","file":"git2/submodule.h","line":610,"lineto":614,"args":[{"name":"status","type":"unsigned int *","comment":"Combination of `GIT_SUBMODULE_STATUS` flags"},{"name":"repo","type":"git_repository *","comment":"the repository in which to look"},{"name":"name","type":"const char *","comment":"name of the submodule"},{"name":"ignore","type":"git_submodule_ignore_t","comment":"the ignore rules to follow"}],"argline":"unsigned int *status, git_repository *repo, const char *name, git_submodule_ignore_t ignore","sig":"unsigned int *::git_repository *::const char *::git_submodule_ignore_t","return":{"type":"int","comment":" 0 on success, \n<\n0 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 will return a combination of the <code>GIT_SUBMODULE_STATUS</code> values above. How deeply it examines the working directory to do this will depend on the <code>git_submodule_ignore_t</code> value for the submodule.</p>\n","group":"submodule","examples":{"status.c":["ex/v0.27.1/status.html#git_submodule_status-26"]}},"git_submodule_location":{"type":"function","file":"git2/submodule.h","line":630,"lineto":632,"args":[{"name":"location_status","type":"unsigned int *","comment":"Combination of first four `GIT_SUBMODULE_STATUS` flags"},{"name":"submodule","type":"git_submodule *","comment":"Submodule for which to get status"}],"argline":"unsigned int *location_status, git_submodule *submodule","sig":"unsigned int *::git_submodule *","return":{"type":"int","comment":" 0 on success, \n<\n0 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>. It just returns a made of the first four submodule status values (i.e. the ones like GIT_SUBMODULE_STATUS_IN_HEAD, etc) that tell you where the submodule data comes from (i.e. the HEAD commit, gitmodules file, etc.). This can be useful if you want to know if the submodule is present in the working directory at this point in time, etc.</p>\n","group":"submodule"},"git_tag_lookup":{"type":"function","file":"git2/tag.h","line":33,"lineto":34,"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.27.1/general.html#git_tag_lookup-84"]}},"git_tag_lookup_prefix":{"type":"function","file":"git2/tag.h","line":48,"lineto":49,"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,\n given a prefix of its identifier (short id).</p>\n","comments":"","group":"tag"},"git_tag_free":{"type":"function","file":"git2/tag.h","line":61,"lineto":61,"args":[{"name":"tag","type":"git_tag *","comment":"the tag to close"}],"argline":"git_tag *tag","sig":"git_tag *","return":{"type":"void","comment":null},"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 release memory. Failure to do so will cause a memory leak.</p>\n","group":"tag","examples":{"general.c":["ex/v0.27.1/general.html#git_tag_free-85"]}},"git_tag_id":{"type":"function","file":"git2/tag.h","line":69,"lineto":69,"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_owner":{"type":"function","file":"git2/tag.h","line":77,"lineto":77,"args":[{"name":"tag","type":"const git_tag *","comment":"A previously loaded tag."}],"argline":"const git_tag *tag","sig":"const git_tag *","return":{"type":"git_repository *","comment":" Repository that contains this tag."},"description":"<p>Get the repository that contains the tag.</p>\n","comments":"","group":"tag"},"git_tag_target":{"type":"function","file":"git2/tag.h","line":89,"lineto":89,"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 given object and returns it</p>\n","group":"tag","examples":{"general.c":["ex/v0.27.1/general.html#git_tag_target-86"]}},"git_tag_target_id":{"type":"function","file":"git2/tag.h","line":97,"lineto":97,"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","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_tag_target_id-35"]}},"git_tag_target_type":{"type":"function","file":"git2/tag.h","line":105,"lineto":105,"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's tagged object</p>\n","comments":"","group":"tag","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_tag_target_type-36"],"general.c":["ex/v0.27.1/general.html#git_tag_target_type-87"]}},"git_tag_name":{"type":"function","file":"git2/tag.h","line":113,"lineto":113,"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":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_tag_name-37"],"general.c":["ex/v0.27.1/general.html#git_tag_name-88"],"tag.c":["ex/v0.27.1/tag.html#git_tag_name-20"]}},"git_tag_tagger":{"type":"function","file":"git2/tag.h","line":121,"lineto":121,"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","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_tag_tagger-38"]}},"git_tag_message":{"type":"function","file":"git2/tag.h","line":129,"lineto":129,"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":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_tag_message-39","ex/v0.27.1/cat-file.html#git_tag_message-40"],"general.c":["ex/v0.27.1/general.html#git_tag_message-89"],"tag.c":["ex/v0.27.1/tag.html#git_tag_message-21"]}},"git_tag_create":{"type":"function","file":"git2/tag.h","line":171,"lineto":178,"args":[{"name":"oid","type":"git_oid *","comment":"Pointer where to store the OID of the\n newly created tag. If the tag already exists, this parameter\n will be the oid of the existing tag, and the function will\n 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\n for consistency. It should also not conflict with an\n already existing tag name"},{"name":"target","type":"const git_object *","comment":"Object to which this tag points. This object\n must belong to the given `repo`."},{"name":"tagger","type":"const git_signature *","comment":"Signature of the tagger for this tag, and\n 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, git_repository *repo, const char *tag_name, const git_object *target, const git_signature *tagger, const char *message, int 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\n\tA tag object is written to the ODB, and a proper reference\n\tis 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 this tag object. If <code>force</code> is true and a reference already exists with the given name, it'll be replaced.</p>\n\n<p>The message will not be cleaned up. This can be achieved through <code>git_message_prettify()</code>.</p>\n\n<p>The tag name will be checked for validity. You must avoid the characters '~', '^', ':', '\\', '?', '[', and '*', and the sequences ".." and "@{" which have special meaning to revparse.</p>\n","group":"tag","examples":{"tag.c":["ex/v0.27.1/tag.html#git_tag_create-22"]}},"git_tag_annotation_create":{"type":"function","file":"git2/tag.h","line":203,"lineto":209,"args":[{"name":"oid","type":"git_oid *","comment":"Pointer where to store the OID of the\n newly created tag"},{"name":"repo","type":"git_repository *","comment":"Repository where to store the tag"},{"name":"tag_name","type":"const char *","comment":"Name for the tag"},{"name":"target","type":"const git_object *","comment":"Object to which this tag points. This object\n must belong to the given `repo`."},{"name":"tagger","type":"const git_signature *","comment":"Signature of the tagger for this tag, and\n of the tagging time"},{"name":"message","type":"const char *","comment":"Full message for this tag"}],"argline":"git_oid *oid, git_repository *repo, const char *tag_name, const git_object *target, const git_signature *tagger, const char *message","sig":"git_oid *::git_repository *::const char *::const git_object *::const git_signature *::const char *","return":{"type":"int","comment":" 0 on success or an error code"},"description":"<p>Create a new tag in the object database pointing to a git_object</p>\n","comments":"<p>The message will not be cleaned up. This can be achieved through <code>git_message_prettify()</code>.</p>\n","group":"tag"},"git_tag_create_frombuffer":{"type":"function","file":"git2/tag.h","line":220,"lineto":224,"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, git_repository *repo, const char *buffer, int 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":"git2/tag.h","line":256,"lineto":261,"args":[{"name":"oid","type":"git_oid *","comment":"Pointer where to store the OID of the provided\n target object. If the tag already exists, this parameter\n will be filled with the oid of the existing pointed object\n 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\n for consistency. It should also not conflict with an\n already existing tag name"},{"name":"target","type":"const git_object *","comment":"Object to which this tag points. This object\n must belong to the given `repo`."},{"name":"force","type":"int","comment":"Overwrite existing references"}],"argline":"git_oid *oid, git_repository *repo, const char *tag_name, const git_object *target, int 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\n\tA proper reference is written in the /refs/tags folder,\n 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 this target object. If <code>force</code> is true and a reference already exists with the given name, it'll be replaced.</p>\n\n<p>The tag name will be checked for validity. See <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"tag","examples":{"tag.c":["ex/v0.27.1/tag.html#git_tag_create_lightweight-23"]}},"git_tag_delete":{"type":"function","file":"git2/tag.h","line":276,"lineto":278,"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;\n this name is validated for consistency."}],"argline":"git_repository *repo, const 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. See <code>git_tag_create()</code> for rules about valid names.</p>\n","group":"tag","examples":{"tag.c":["ex/v0.27.1/tag.html#git_tag_delete-24"]}},"git_tag_list":{"type":"function","file":"git2/tag.h","line":293,"lineto":295,"args":[{"name":"tag_names","type":"git_strarray *","comment":"Pointer to a git_strarray structure where\n\t\tthe tag names will be stored"},{"name":"repo","type":"git_repository *","comment":"Repository where to find the tags"}],"argline":"git_strarray *tag_names, git_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 matching tags; these values are owned by the user and should be free'd manually when no longer needed, using <code>git_strarray_free</code>.</p>\n","group":"tag"},"git_tag_list_match":{"type":"function","file":"git2/tag.h","line":315,"lineto":318,"args":[{"name":"tag_names","type":"git_strarray *","comment":"Pointer to a git_strarray structure where\n\t\tthe 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, const char *pattern, git_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\n which name match a defined pattern</p>\n","comments":"<p>If an empty pattern is provided, all the tags will be returned.</p>\n\n<p>The string array will be filled with the names of the matching tags; these values are owned by the user and should be free'd manually when no longer needed, using <code>git_strarray_free</code>.</p>\n","group":"tag","examples":{"tag.c":["ex/v0.27.1/tag.html#git_tag_list_match-25"]}},"git_tag_foreach":{"type":"function","file":"git2/tag.h","line":330,"lineto":333,"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, git_tag_foreach_cb callback, void *payload","sig":"git_repository *::git_tag_foreach_cb::void *","return":{"type":"int","comment":null},"description":"<p>Call callback `cb' for each tag in the repository</p>\n","comments":"","group":"tag"},"git_tag_peel":{"type":"function","file":"git2/tag.h","line":346,"lineto":348,"args":[{"name":"tag_target_out","type":"git_object **","comment":"Pointer to the peeled git_object"},{"name":"tag","type":"const git_tag *","comment":"The tag to be processed"}],"argline":"git_object **tag_target_out, const 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 and should be closed with the <code>git_object_free</code> method.</p>\n","group":"tag"},"git_tag_dup":{"type":"function","file":"git2/tag.h","line":357,"lineto":357,"args":[{"name":"out","type":"git_tag **","comment":"Pointer to store the copy of the tag"},{"name":"source","type":"git_tag *","comment":"Original tag to copy"}],"argline":"git_tag **out, git_tag *source","sig":"git_tag **::git_tag *","return":{"type":"int","comment":null},"description":"<p>Create an in-memory copy of a tag. The copy must be explicitly\n free'd or it will leak.</p>\n","comments":"","group":"tag"},"git_trace_set":{"type":"function","file":"git2/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\n specified callback. When system events occur at a level equal to, or\n lower than, the given level they will be reported to the given callback.</p>\n","comments":"","group":"trace"},"git_cred_has_username":{"type":"function","file":"git2/transport.h","line":190,"lineto":190,"args":[{"name":"cred","type":"git_cred *","comment":"object to check"}],"argline":"git_cred *cred","sig":"git_cred *","return":{"type":"int","comment":" 1 if the credential object has non-NULL username, 0 otherwise"},"description":"<p>Check whether a credential object contains username information.</p>\n","comments":"","group":"cred"},"git_cred_userpass_plaintext_new":{"type":"function","file":"git2/transport.h","line":201,"lineto":204,"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, const char *username, const char *password","sig":"git_cred **::const char *::const char *","return":{"type":"int","comment":" 0 for success or an error code for failure"},"description":"<p>Create a new plain-text username and password credential object.\n The supplied credential parameter will be internally duplicated.</p>\n","comments":"","group":"cred"},"git_cred_ssh_key_new":{"type":"function","file":"git2/transport.h","line":217,"lineto":222,"args":[{"name":"out","type":"git_cred **","comment":"The newly created credential object."},{"name":"username","type":"const char *","comment":"username to use to authenticate"},{"name":"publickey","type":"const char *","comment":"The path to the public key of the credential."},{"name":"privatekey","type":"const char *","comment":"The path to the private key of the credential."},{"name":"passphrase","type":"const char *","comment":"The passphrase of the credential."}],"argline":"git_cred **out, const char *username, const char *publickey, const char *privatekey, const char *passphrase","sig":"git_cred **::const char *::const char *::const char *::const char *","return":{"type":"int","comment":" 0 for success or an error code for failure"},"description":"<p>Create a new passphrase-protected ssh key credential object.\n The supplied credential parameter will be internally duplicated.</p>\n","comments":"","group":"cred"},"git_cred_ssh_interactive_new":{"type":"function","file":"git2/transport.h","line":233,"lineto":237,"args":[{"name":"out","type":"git_cred **","comment":null},{"name":"username","type":"const char *","comment":"Username to use to authenticate."},{"name":"prompt_callback","type":"git_cred_ssh_interactive_callback","comment":"The callback method used for prompts."},{"name":"payload","type":"void *","comment":"Additional data to pass to the callback."}],"argline":"git_cred **out, const char *username, git_cred_ssh_interactive_callback prompt_callback, void *payload","sig":"git_cred **::const char *::git_cred_ssh_interactive_callback::void *","return":{"type":"int","comment":" 0 for success or an error code for failure."},"description":"<p>Create a new ssh keyboard-interactive based credential object.\n The supplied credential parameter will be internally duplicated.</p>\n","comments":"","group":"cred"},"git_cred_ssh_key_from_agent":{"type":"function","file":"git2/transport.h","line":247,"lineto":249,"args":[{"name":"out","type":"git_cred **","comment":"The newly created credential object."},{"name":"username","type":"const char *","comment":"username to use to authenticate"}],"argline":"git_cred **out, const char *username","sig":"git_cred **::const char *","return":{"type":"int","comment":" 0 for success or an error code for failure"},"description":"<p>Create a new ssh key credential object used for querying an ssh-agent.\n The supplied credential parameter will be internally duplicated.</p>\n","comments":"","group":"cred"},"git_cred_ssh_custom_new":{"type":"function","file":"git2/transport.h","line":269,"lineto":275,"args":[{"name":"out","type":"git_cred **","comment":"The newly created credential object."},{"name":"username","type":"const char *","comment":"username to use to authenticate"},{"name":"publickey","type":"const char *","comment":"The bytes of the public key."},{"name":"publickey_len","type":"size_t","comment":"The length of the public key in bytes."},{"name":"sign_callback","type":"git_cred_sign_callback","comment":"The callback method to sign the data during the challenge."},{"name":"payload","type":"void *","comment":"Additional data to pass to the callback."}],"argline":"git_cred **out, const char *username, const char *publickey, size_t publickey_len, git_cred_sign_callback sign_callback, void *payload","sig":"git_cred **::const char *::const char *::size_t::git_cred_sign_callback::void *","return":{"type":"int","comment":" 0 for success or an error code for failure"},"description":"<p>Create an ssh key credential with a custom signing function.</p>\n","comments":"<p>This lets you use your own function to sign the challenge.</p>\n\n<p>This function and its credential type is provided for completeness and wraps <code>libssh2_userauth_publickey()</code>, which is undocumented.</p>\n\n<p>The supplied credential parameter will be internally duplicated.</p>\n","group":"cred"},"git_cred_default_new":{"type":"function","file":"git2/transport.h","line":283,"lineto":283,"args":[{"name":"out","type":"git_cred **","comment":null}],"argline":"git_cred **out","sig":"git_cred **","return":{"type":"int","comment":" 0 for success or an error code for failure"},"description":"<p>Create a "default" credential usable for Negotiate mechanisms like NTLM\n or Kerberos authentication.</p>\n","comments":"","group":"cred"},"git_cred_username_new":{"type":"function","file":"git2/transport.h","line":291,"lineto":291,"args":[{"name":"cred","type":"git_cred **","comment":null},{"name":"username","type":"const char *","comment":null}],"argline":"git_cred **cred, const char *username","sig":"git_cred **::const char *","return":{"type":"int","comment":null},"description":"<p>Create a credential to specify a username.</p>\n","comments":"<p>This is used with ssh authentication to query for the username if none is specified in the url.</p>\n","group":"cred"},"git_cred_ssh_key_memory_new":{"type":"function","file":"git2/transport.h","line":303,"lineto":308,"args":[{"name":"out","type":"git_cred **","comment":"The newly created credential object."},{"name":"username","type":"const char *","comment":"username to use to authenticate."},{"name":"publickey","type":"const char *","comment":"The public key of the credential."},{"name":"privatekey","type":"const char *","comment":"The private key of the credential."},{"name":"passphrase","type":"const char *","comment":"The passphrase of the credential."}],"argline":"git_cred **out, const char *username, const char *publickey, const char *privatekey, const char *passphrase","sig":"git_cred **::const char *::const char *::const char *::const char *","return":{"type":"int","comment":" 0 for success or an error code for failure"},"description":"<p>Create a new ssh key credential object reading the keys from memory.</p>\n","comments":"","group":"cred"},"git_cred_free":{"type":"function","file":"git2/transport.h","line":319,"lineto":319,"args":[{"name":"cred","type":"git_cred *","comment":"the object to free"}],"argline":"git_cred *cred","sig":"git_cred *","return":{"type":"void","comment":null},"description":"<p>Free a credential.</p>\n","comments":"<p>This is only necessary if you own the object; that is, if you are a transport.</p>\n","group":"cred"},"git_tree_lookup":{"type":"function","file":"git2/tree.h","line":32,"lineto":33,"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.27.1/general.html#git_tree_lookup-90","ex/v0.27.1/general.html#git_tree_lookup-91"],"init.c":["ex/v0.27.1/init.html#git_tree_lookup-14"],"merge.c":["ex/v0.27.1/merge.html#git_tree_lookup-46"]}},"git_tree_lookup_prefix":{"type":"function","file":"git2/tree.h","line":47,"lineto":51,"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."},{"name":"len","type":"size_t","comment":"the length of the short identifier"}],"argline":"git_tree **out, git_repository *repo, const git_oid *id, size_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,\n given a prefix of its identifier (short id).</p>\n","comments":"","group":"tree"},"git_tree_free":{"type":"function","file":"git2/tree.h","line":63,"lineto":63,"args":[{"name":"tree","type":"git_tree *","comment":"The tree to close"}],"argline":"git_tree *tree","sig":"git_tree *","return":{"type":"void","comment":null},"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 release memory. Failure to do so will cause a memory leak.</p>\n","group":"tree","examples":{"diff.c":["ex/v0.27.1/diff.html#git_tree_free-17","ex/v0.27.1/diff.html#git_tree_free-18"],"general.c":["ex/v0.27.1/general.html#git_tree_free-92","ex/v0.27.1/general.html#git_tree_free-93"],"init.c":["ex/v0.27.1/init.html#git_tree_free-15"],"log.c":["ex/v0.27.1/log.html#git_tree_free-56","ex/v0.27.1/log.html#git_tree_free-57","ex/v0.27.1/log.html#git_tree_free-58","ex/v0.27.1/log.html#git_tree_free-59","ex/v0.27.1/log.html#git_tree_free-60"]}},"git_tree_id":{"type":"function","file":"git2/tree.h","line":71,"lineto":71,"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":"git2/tree.h","line":79,"lineto":79,"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":"git2/tree.h","line":87,"lineto":87,"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":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_tree_entrycount-41"],"general.c":["ex/v0.27.1/general.html#git_tree_entrycount-94"]}},"git_tree_entry_byname":{"type":"function","file":"git2/tree.h","line":99,"lineto":100,"args":[{"name":"tree","type":"const git_tree *","comment":"a previously loaded tree."},{"name":"filename","type":"const char *","comment":"the filename of the desired entry"}],"argline":"const git_tree *tree, const char *filename","sig":"const 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't have to free it, but you must not use it after the git_tree is released.</p>\n","group":"tree","examples":{"general.c":["ex/v0.27.1/general.html#git_tree_entry_byname-95"]}},"git_tree_entry_byindex":{"type":"function","file":"git2/tree.h","line":112,"lineto":113,"args":[{"name":"tree","type":"const git_tree *","comment":"a previously loaded tree."},{"name":"idx","type":"size_t","comment":"the position in the entry list"}],"argline":"const git_tree *tree, size_t idx","sig":"const 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't have to free it, but you must not use it after the git_tree is released.</p>\n","group":"tree","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_tree_entry_byindex-42"],"general.c":["ex/v0.27.1/general.html#git_tree_entry_byindex-96"]}},"git_tree_entry_byid":{"type":"function","file":"git2/tree.h","line":127,"lineto":128,"args":[{"name":"tree","type":"const git_tree *","comment":"a previously loaded tree."},{"name":"id","type":"const git_oid *","comment":"the sha being looked for"}],"argline":"const git_tree *tree, const git_oid *id","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't have 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":"git2/tree.h","line":142,"lineto":145,"args":[{"name":"out","type":"git_tree_entry **","comment":"Pointer where to store the tree entry"},{"name":"root","type":"const git_tree *","comment":"Previously loaded tree which is the root of the relative path"},{"name":"path","type":"const char *","comment":"Path to the contained entry"}],"argline":"git_tree_entry **out, const git_tree *root, const char *path","sig":"git_tree_entry **::const 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,\n given its relative path.</p>\n","comments":"<p>Unlike the other lookup functions, the returned tree entry is owned by the user and must be freed explicitly with <code>git_tree_entry_free()</code>.</p>\n","group":"tree"},"git_tree_entry_dup":{"type":"function","file":"git2/tree.h","line":157,"lineto":157,"args":[{"name":"dest","type":"git_tree_entry **","comment":"pointer where to store the copy"},{"name":"source","type":"const git_tree_entry *","comment":"tree entry to duplicate"}],"argline":"git_tree_entry **dest, const git_tree_entry *source","sig":"git_tree_entry **::const git_tree_entry *","return":{"type":"int","comment":" 0 or an error code"},"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, and must be freed explicitly with <code>git_tree_entry_free()</code>.</p>\n","group":"tree"},"git_tree_entry_free":{"type":"function","file":"git2/tree.h","line":168,"lineto":168,"args":[{"name":"entry","type":"git_tree_entry *","comment":"The entry to free"}],"argline":"git_tree_entry *entry","sig":"git_tree_entry *","return":{"type":"void","comment":null},"description":"<p>Free a user-owned tree entry</p>\n","comments":"<p>IMPORTANT: This function is only needed for tree entries owned by the user, such as the ones returned by <code>git_tree_entry_dup()</code> or <code>git_tree_entry_bypath()</code>.</p>\n","group":"tree"},"git_tree_entry_name":{"type":"function","file":"git2/tree.h","line":176,"lineto":176,"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":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_tree_entry_name-43"],"general.c":["ex/v0.27.1/general.html#git_tree_entry_name-97","ex/v0.27.1/general.html#git_tree_entry_name-98"]}},"git_tree_entry_id":{"type":"function","file":"git2/tree.h","line":184,"lineto":184,"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","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_tree_entry_id-44"]}},"git_tree_entry_type":{"type":"function","file":"git2/tree.h","line":192,"lineto":192,"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","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_tree_entry_type-45"]}},"git_tree_entry_filemode":{"type":"function","file":"git2/tree.h","line":200,"lineto":200,"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","examples":{"cat-file.c":["ex/v0.27.1/cat-file.html#git_tree_entry_filemode-46"]}},"git_tree_entry_filemode_raw":{"type":"function","file":"git2/tree.h","line":212,"lineto":212,"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 raw UNIX file attributes of a tree entry</p>\n","comments":"<p>This function does not perform any normalization and is only useful if you need to be able to recreate the original tree object.</p>\n","group":"tree"},"git_tree_entry_cmp":{"type":"function","file":"git2/tree.h","line":220,"lineto":220,"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":" \n<\n0 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":"git2/tree.h","line":232,"lineto":235,"args":[{"name":"object_out","type":"git_object **","comment":"pointer to the converted 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, git_repository *repo, const 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 to.</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.27.1/general.html#git_tree_entry_to_object-99"]}},"git_treebuilder_new":{"type":"function","file":"git2/tree.h","line":254,"lineto":255,"args":[{"name":"out","type":"git_treebuilder **","comment":"Pointer where to store the tree builder"},{"name":"repo","type":"git_repository *","comment":"Repository in which to store the object"},{"name":"source","type":"const git_tree *","comment":"Source tree to initialize the builder (optional)"}],"argline":"git_treebuilder **out, git_repository *repo, const git_tree *source","sig":"git_treebuilder **::git_repository *::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 write 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 initialized 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 entries and will have to be filled manually.</p>\n","group":"treebuilder"},"git_treebuilder_clear":{"type":"function","file":"git2/tree.h","line":262,"lineto":262,"args":[{"name":"bld","type":"git_treebuilder *","comment":"Builder to clear"}],"argline":"git_treebuilder *bld","sig":"git_treebuilder *","return":{"type":"void","comment":null},"description":"<p>Clear all the entires in the builder</p>\n","comments":"","group":"treebuilder"},"git_treebuilder_entrycount":{"type":"function","file":"git2/tree.h","line":270,"lineto":270,"args":[{"name":"bld","type":"git_treebuilder *","comment":"a previously loaded 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":"git2/tree.h","line":281,"lineto":281,"args":[{"name":"bld","type":"git_treebuilder *","comment":"Builder to free"}],"argline":"git_treebuilder *bld","sig":"git_treebuilder *","return":{"type":"void","comment":null},"description":"<p>Free a tree builder</p>\n","comments":"<p>This will clear all the entries and free to builder. Failing to free the builder after you're done using it will result in a memory leak</p>\n","group":"treebuilder"},"git_treebuilder_get":{"type":"function","file":"git2/tree.h","line":293,"lineto":294,"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 not be freed manually.</p>\n","group":"treebuilder"},"git_treebuilder_insert":{"type":"function","file":"git2/tree.h","line":324,"lineto":329,"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\n\t\t\tbe valued with one of the following entries: 0040000, 0100644,\n\t\t\t0100755, 0120000 or 0160000."}],"argline":"const git_tree_entry **out, git_treebuilder *bld, const char *filename, const git_oid *id, git_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 given attributes.</p>\n\n<p>If an entry named <code>filename</code> already exists, its attributes will be updated with the given ones.</p>\n\n<p>The optional pointer <code>out</code> can be used to retrieve a pointer to the newly created/updated entry. Pass NULL if you do not need it. The pointer may not be valid past the next operation in this builder. Duplicate the entry if you want to keep it.</p>\n\n<p>By default the entry that you are inserting will be checked for validity; that it exists in the object database and is of the correct type. If you do not want this behavior, set the <code>GIT_OPT_ENABLE_STRICT_OBJECT_CREATION</code> library option to false.</p>\n","group":"treebuilder"},"git_treebuilder_remove":{"type":"function","file":"git2/tree.h","line":337,"lineto":338,"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","comment":null},"description":"<p>Remove an entry from the builder by its filename</p>\n","comments":"","group":"treebuilder"},"git_treebuilder_filter":{"type":"function","file":"git2/tree.h","line":361,"lineto":364,"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 callback"}],"argline":"git_treebuilder *bld, git_treebuilder_filter_cb filter, void *payload","sig":"git_treebuilder *::git_treebuilder_filter_cb::void *","return":{"type":"void","comment":null},"description":"<p>Selectively remove entries in the tree</p>\n","comments":"<p>The <code>filter</code> callback will be called for each entry in the tree with a pointer to the entry and the provided <code>payload</code>; if the callback returns non-zero, the entry will be filtered (removed from the builder).</p>\n","group":"treebuilder"},"git_treebuilder_write":{"type":"function","file":"git2/tree.h","line":376,"lineto":377,"args":[{"name":"id","type":"git_oid *","comment":"Pointer to store the OID of the newly written tree"},{"name":"bld","type":"git_treebuilder *","comment":"Tree builder to write"}],"argline":"git_oid *id, git_treebuilder *bld","sig":"git_oid *::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 identifying SHA1 hash will be stored in the <code>id</code> pointer.</p>\n","group":"treebuilder"},"git_treebuilder_write_with_buffer":{"type":"function","file":"git2/tree.h","line":390,"lineto":391,"args":[{"name":"oid","type":"git_oid *","comment":"Pointer to store the OID of the newly written tree"},{"name":"bld","type":"git_treebuilder *","comment":"Tree builder to write"},{"name":"tree","type":"git_buf *","comment":"Shared buffer for writing the tree. Will be grown as necessary."}],"argline":"git_oid *oid, git_treebuilder *bld, git_buf *tree","sig":"git_oid *::git_treebuilder *::git_buf *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Write the contents of the tree builder as a tree object\n using a shared git_buf.</p>\n","comments":"","group":"treebuilder"},"git_tree_walk":{"type":"function","file":"git2/tree.h","line":420,"lineto":424,"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, git_treewalk_mode mode, git_treewalk_cb callback, void *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 will be automatically loaded as required, and the <code>callback</code> will be called once per entry with the current (relative) root for the entry and the entry data itself.</p>\n\n<p>If the callback returns a positive value, the passed entry will be skipped on the traversal (in pre mode). A negative value stops the walk.</p>\n","group":"tree"},"git_tree_dup":{"type":"function","file":"git2/tree.h","line":433,"lineto":433,"args":[{"name":"out","type":"git_tree **","comment":"Pointer to store the copy of the tree"},{"name":"source","type":"git_tree *","comment":"Original tree to copy"}],"argline":"git_tree **out, git_tree *source","sig":"git_tree **::git_tree *","return":{"type":"int","comment":null},"description":"<p>Create an in-memory copy of a tree. The copy must be explicitly\n free'd or it will leak.</p>\n","comments":"","group":"tree"},"git_tree_create_updated":{"type":"function","file":"git2/tree.h","line":479,"lineto":479,"args":[{"name":"out","type":"git_oid *","comment":"id of the new tree"},{"name":"repo","type":"git_repository *","comment":"the repository in which to create the tree, must be the\n same as for `baseline`"},{"name":"baseline","type":"git_tree *","comment":"the tree to base these changes on"},{"name":"nupdates","type":"size_t","comment":"the number of elements in the update list"},{"name":"updates","type":"const git_tree_update *","comment":"the list of updates to perform"}],"argline":"git_oid *out, git_repository *repo, git_tree *baseline, size_t nupdates, const git_tree_update *updates","sig":"git_oid *::git_repository *::git_tree *::size_t::const git_tree_update *","return":{"type":"int","comment":null},"description":"<p>Create a tree based on another one with the specified modifications</p>\n","comments":"<p>Given the <code>baseline</code> perform the changes described in the list of <code>updates</code> and create a new tree.</p>\n\n<p>This function is optimized for common file/directory addition, removal and replacement in trees. It is much more efficient than reading the tree into a <code>git_index</code> and modifying that, but in exchange it is not as flexible.</p>\n\n<p>Deleting and adding the same entry is undefined behaviour, changing a tree to a blob or viceversa is not supported.</p>\n","group":"tree"},"git_worktree_list":{"type":"function","file":"git2/worktree.h","line":34,"lineto":34,"args":[{"name":"out","type":"git_strarray *","comment":"pointer to the array of working tree names"},{"name":"repo","type":"git_repository *","comment":"the repo to use when listing working trees"}],"argline":"git_strarray *out, git_repository *repo","sig":"git_strarray *::git_repository *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>List names of linked working trees</p>\n","comments":"<p>The returned list should be released with <code>git_strarray_free</code> when no longer needed.</p>\n","group":"worktree"},"git_worktree_lookup":{"type":"function","file":"git2/worktree.h","line":44,"lineto":44,"args":[{"name":"out","type":"git_worktree **","comment":"Output pointer to looked up worktree or `NULL`"},{"name":"repo","type":"git_repository *","comment":"The repository containing worktrees"},{"name":"name","type":"const char *","comment":"Name of the working tree to look up"}],"argline":"git_worktree **out, git_repository *repo, const char *name","sig":"git_worktree **::git_repository *::const char *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Lookup a working tree by its name for a given repository</p>\n","comments":"","group":"worktree"},"git_worktree_open_from_repository":{"type":"function","file":"git2/worktree.h","line":56,"lineto":56,"args":[{"name":"out","type":"git_worktree **","comment":"Out-pointer for the newly allocated worktree"},{"name":"repo","type":"git_repository *","comment":"Repository to look up worktree for"}],"argline":"git_worktree **out, git_repository *repo","sig":"git_worktree **::git_repository *","return":{"type":"int","comment":null},"description":"<p>Open a worktree of a given repository</p>\n","comments":"<p>If a repository is not the main tree but a worktree, this function will look up the worktree inside the parent repository and create a new <code>git_worktree</code> structure.</p>\n","group":"worktree"},"git_worktree_free":{"type":"function","file":"git2/worktree.h","line":63,"lineto":63,"args":[{"name":"wt","type":"git_worktree *","comment":"worktree handle to close. If NULL nothing occurs."}],"argline":"git_worktree *wt","sig":"git_worktree *","return":{"type":"void","comment":null},"description":"<p>Free a previously allocated worktree</p>\n","comments":"","group":"worktree"},"git_worktree_validate":{"type":"function","file":"git2/worktree.h","line":75,"lineto":75,"args":[{"name":"wt","type":"const git_worktree *","comment":"Worktree to check"}],"argline":"const git_worktree *wt","sig":"const git_worktree *","return":{"type":"int","comment":" 0 when worktree is valid, error-code otherwise"},"description":"<p>Check if worktree is valid</p>\n","comments":"<p>A valid worktree requires both the git data structures inside the linked parent repository and the linked working copy to be present.</p>\n","group":"worktree"},"git_worktree_add_init_options":{"type":"function","file":"git2/worktree.h","line":95,"lineto":96,"args":[{"name":"opts","type":"git_worktree_add_options *","comment":"the struct to initialize"},{"name":"version","type":"unsigned int","comment":"Verison of struct; pass `GIT_WORKTREE_ADD_OPTIONS_VERSION`"}],"argline":"git_worktree_add_options *opts, unsigned int version","sig":"git_worktree_add_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_worktree_add_options</code> with default vaules.\n Equivalent to creating an instance with\n GIT_WORKTREE_ADD_OPTIONS_INIT.</p>\n","comments":"","group":"worktree"},"git_worktree_add":{"type":"function","file":"git2/worktree.h","line":112,"lineto":114,"args":[{"name":"out","type":"git_worktree **","comment":"Output pointer containing new working tree"},{"name":"repo","type":"git_repository *","comment":"Repository to create working tree for"},{"name":"name","type":"const char *","comment":"Name of the working tree"},{"name":"path","type":"const char *","comment":"Path to create working tree at"},{"name":"opts","type":"const git_worktree_add_options *","comment":"Options to modify default behavior. May be NULL"}],"argline":"git_worktree **out, git_repository *repo, const char *name, const char *path, const git_worktree_add_options *opts","sig":"git_worktree **::git_repository *::const char *::const char *::const git_worktree_add_options *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Add a new working tree</p>\n","comments":"<p>Add a new working tree for the repository, that is create the required data structures inside the repository and check out the current HEAD at <code>path</code></p>\n","group":"worktree"},"git_worktree_lock":{"type":"function","file":"git2/worktree.h","line":126,"lineto":126,"args":[{"name":"wt","type":"git_worktree *","comment":"Worktree to lock"},{"name":"reason","type":"const char *","comment":"Reason why the working tree is being locked"}],"argline":"git_worktree *wt, const char *reason","sig":"git_worktree *::const char *","return":{"type":"int","comment":" 0 on success, non-zero otherwise"},"description":"<p>Lock worktree if not already locked</p>\n","comments":"<p>Lock a worktree, optionally specifying a reason why the linked working tree is being locked.</p>\n","group":"worktree"},"git_worktree_unlock":{"type":"function","file":"git2/worktree.h","line":135,"lineto":135,"args":[{"name":"wt","type":"git_worktree *","comment":"Worktree to unlock"}],"argline":"git_worktree *wt","sig":"git_worktree *","return":{"type":"int","comment":" 0 on success, 1 if worktree was not locked, error-code\n otherwise"},"description":"<p>Unlock a locked worktree</p>\n","comments":"","group":"worktree"},"git_worktree_is_locked":{"type":"function","file":"git2/worktree.h","line":149,"lineto":149,"args":[{"name":"reason","type":"git_buf *","comment":"Buffer to store reason in. If NULL no reason is stored."},{"name":"wt","type":"const git_worktree *","comment":"Worktree to check"}],"argline":"git_buf *reason, const git_worktree *wt","sig":"git_buf *::const git_worktree *","return":{"type":"int","comment":" 0 when the working tree not locked, a value greater\n than zero if it is locked, less than zero if there was an\n error"},"description":"<p>Check if worktree is locked</p>\n","comments":"<p>A worktree may be locked if the linked working tree is stored on a portable device which is not available.</p>\n","group":"worktree"},"git_worktree_prune_init_options":{"type":"function","file":"git2/worktree.h","line":182,"lineto":184,"args":[{"name":"opts","type":"git_worktree_prune_options *","comment":"the struct to initialize"},{"name":"version","type":"unsigned int","comment":"Verison of struct; pass `GIT_WORKTREE_PRUNE_OPTIONS_VERSION`"}],"argline":"git_worktree_prune_options *opts, unsigned int version","sig":"git_worktree_prune_options *::unsigned int","return":{"type":"int","comment":" Zero on success; -1 on failure."},"description":"<p>Initializes a <code>git_worktree_prune_options</code> with default vaules.\n Equivalent to creating an instance with\n GIT_WORKTREE_PRUNE_OPTIONS_INIT.</p>\n","comments":"","group":"worktree"},"git_worktree_is_prunable":{"type":"function","file":"git2/worktree.h","line":200,"lineto":201,"args":[{"name":"wt","type":"git_worktree *","comment":null},{"name":"opts","type":"git_worktree_prune_options *","comment":null}],"argline":"git_worktree *wt, git_worktree_prune_options *opts","sig":"git_worktree *::git_worktree_prune_options *","return":{"type":"int","comment":null},"description":"<p>Is the worktree prunable with the given options?</p>\n","comments":"<p>A worktree is not prunable in the following scenarios:</p>\n\n<ul>\n<li>the worktree is linking to a valid on-disk worktree. The <code>valid</code> member will cause this check to be ignored. - the worktree is locked. The <code>locked</code> flag will cause this check to be ignored.</li>\n</ul>\n\n<p>If the worktree is not valid and not locked or if the above flags have been passed in, this function will return a positive value.</p>\n","group":"worktree"},"git_worktree_prune":{"type":"function","file":"git2/worktree.h","line":215,"lineto":216,"args":[{"name":"wt","type":"git_worktree *","comment":"Worktree to prune"},{"name":"opts","type":"git_worktree_prune_options *","comment":"Specifies which checks to override. See\n `git_worktree_is_prunable`. May be NULL"}],"argline":"git_worktree *wt, git_worktree_prune_options *opts","sig":"git_worktree *::git_worktree_prune_options *","return":{"type":"int","comment":" 0 or an error code"},"description":"<p>Prune working tree</p>\n","comments":"<p>Prune the working tree, that is remove the git data structures on disk. The repository will only be pruned of <code>git_worktree_is_prunable</code> succeeds.</p>\n","group":"worktree"}},"callbacks":{"git_checkout_notify_cb":{"type":"callback","file":"git2/checkout.h","line":223,"lineto":229,"args":[{"name":"why","type":"git_checkout_notify_t","comment":null},{"name":"path","type":"const char *","comment":null},{"name":"baseline","type":"const git_diff_file *","comment":null},{"name":"target","type":"const git_diff_file *","comment":null},{"name":"workdir","type":"const git_diff_file *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"git_checkout_notify_t why, const char *path, const git_diff_file *baseline, const git_diff_file *target, const git_diff_file *workdir, void *payload","sig":"git_checkout_notify_t::const char *::const git_diff_file *::const git_diff_file *::const git_diff_file *::void *","return":{"type":"int","comment":null},"description":"<p>Checkout notification callback function </p>\n","comments":""},"git_checkout_progress_cb":{"type":"callback","file":"git2/checkout.h","line":232,"lineto":236,"args":[{"name":"path","type":"const char *","comment":null},{"name":"completed_steps","type":"size_t","comment":null},{"name":"total_steps","type":"size_t","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"const char *path, size_t completed_steps, size_t total_steps, void *payload","sig":"const char *::size_t::size_t::void *","return":{"type":"void","comment":null},"description":"<p>Checkout progress notification function </p>\n","comments":""},"git_checkout_perfdata_cb":{"type":"callback","file":"git2/checkout.h","line":239,"lineto":241,"args":[{"name":"perfdata","type":"const git_checkout_perfdata *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"const git_checkout_perfdata *perfdata, void *payload","sig":"const git_checkout_perfdata *::void *","return":{"type":"void","comment":null},"description":"<p>Checkout perfdata notification function </p>\n","comments":""},"git_remote_create_cb":{"type":"callback","file":"git2/clone.h","line":69,"lineto":74,"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"},{"name":"payload","type":"void *","comment":"an opaque payload"}],"argline":"git_remote **out, git_repository *repo, const char *name, const char *url, void *payload","sig":"git_remote **::git_repository *::const char *::const char *::void *","return":{"type":"int","comment":" 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code"},"description":"<p>The signature of a function matching git_remote_create, with an additional\n void* as a callback payload.</p>\n","comments":"<p>Callers of git_clone may provide a function matching this signature to override the remote creation and customization process during a clone operation.</p>\n"},"git_repository_create_cb":{"type":"callback","file":"git2/clone.h","line":90,"lineto":94,"args":[{"name":"out","type":"git_repository **","comment":"the resulting repository"},{"name":"path","type":"const char *","comment":"path in which to create the repository"},{"name":"bare","type":"int","comment":"whether the repository is bare. This is the value from the clone options"},{"name":"payload","type":"void *","comment":"payload specified by the options"}],"argline":"git_repository **out, const char *path, int bare, void *payload","sig":"git_repository **::const char *::int::void *","return":{"type":"int","comment":" 0, or a negative value to indicate error"},"description":"<p>The signature of a function matchin git_repository_init, with an\n aditional void * as callback payload.</p>\n","comments":"<p>Callers of git_clone my provide a function matching this signature to override the repository creation and customization process during a clone operation.</p>\n"},"git_diff_notify_cb":{"type":"callback","file":"git2/diff.h","line":359,"lineto":363,"args":[{"name":"diff_so_far","type":"const git_diff *","comment":null},{"name":"delta_to_add","type":"const git_diff_delta *","comment":null},{"name":"matched_pathspec","type":"const char *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"const git_diff *diff_so_far, const git_diff_delta *delta_to_add, const char *matched_pathspec, void *payload","sig":"const git_diff *::const git_diff_delta *::const char *::void *","return":{"type":"int","comment":null},"description":"<p>Diff notification callback function.</p>\n","comments":"<p>The callback will be called for each file, just before the <code>git_delta_t</code> gets inserted into the diff.</p>\n\n<p>When the callback: - returns < 0, the diff process will be aborted. - returns > 0, the delta will not be inserted into the diff, but the diff process continues. - returns 0, the delta is inserted into the diff, and the diff process continues.</p>\n"},"git_diff_progress_cb":{"type":"callback","file":"git2/diff.h","line":375,"lineto":379,"args":[{"name":"diff_so_far","type":"const git_diff *","comment":"The diff being generated."},{"name":"old_path","type":"const char *","comment":"The path to the old file or NULL."},{"name":"new_path","type":"const char *","comment":"The path to the new file or NULL."},{"name":"payload","type":"void *","comment":null}],"argline":"const git_diff *diff_so_far, const char *old_path, const char *new_path, void *payload","sig":"const git_diff *::const char *::const char *::void *","return":{"type":"int","comment":" Non-zero to abort the diff."},"description":"<p>Diff progress callback.</p>\n","comments":"<p>Called before each file comparison.</p>\n"},"git_diff_file_cb":{"type":"callback","file":"git2/diff.h","line":458,"lineto":461,"args":[{"name":"delta","type":"const git_diff_delta *","comment":"A pointer to the delta data for the file"},{"name":"progress","type":"float","comment":"Goes from 0 to 1 over the diff"},{"name":"payload","type":"void *","comment":"User-specified pointer from foreach function"}],"argline":"const git_diff_delta *delta, float progress, void *payload","sig":"const git_diff_delta *::float::void *","return":{"type":"int","comment":null},"description":"<p>When iterating over a diff, callback that will be made per file.</p>\n","comments":""},"git_diff_binary_cb":{"type":"callback","file":"git2/diff.h","line":515,"lineto":518,"args":[{"name":"delta","type":"const git_diff_delta *","comment":null},{"name":"binary","type":"const git_diff_binary *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"const git_diff_delta *delta, const git_diff_binary *binary, void *payload","sig":"const git_diff_delta *::const git_diff_binary *::void *","return":{"type":"int","comment":null},"description":"<p>When iterating over a diff, callback that will be made for\n binary content within the diff.</p>\n","comments":""},"git_diff_hunk_cb":{"type":"callback","file":"git2/diff.h","line":535,"lineto":538,"args":[{"name":"delta","type":"const git_diff_delta *","comment":null},{"name":"hunk","type":"const git_diff_hunk *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"const git_diff_delta *delta, const git_diff_hunk *hunk, void *payload","sig":"const git_diff_delta *::const git_diff_hunk *::void *","return":{"type":"int","comment":null},"description":"<p>When iterating over a diff, callback that will be made per hunk.</p>\n","comments":""},"git_diff_line_cb":{"type":"callback","file":"git2/diff.h","line":588,"lineto":592,"args":[{"name":"delta","type":"const git_diff_delta *","comment":null},{"name":"hunk","type":"const git_diff_hunk *","comment":null},{"name":"line","type":"const git_diff_line *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"const git_diff_delta *delta, const git_diff_hunk *hunk, const git_diff_line *line, void *payload","sig":"const git_diff_delta *::const git_diff_hunk *::const git_diff_line *::void *","return":{"type":"int","comment":null},"description":"<p>When iterating over a diff, callback that will be made per text diff\n line. In this context, the provided range will be NULL.</p>\n","comments":"<p>When printing a diff, callback that will be made to output each line of text. This uses some extra GIT_DIFF_LINE_... constants for output of lines of file and hunk headers.</p>\n"},"git_index_matched_path_cb":{"type":"callback","file":"git2/index.h","line":146,"lineto":147,"args":[{"name":"path","type":"const char *","comment":null},{"name":"matched_pathspec","type":"const char *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"const char *path, const char *matched_pathspec, void *payload","sig":"const char *::const char *::void *","return":{"type":"int","comment":null},"description":"<p>Callback for APIs that add/remove/update files matching pathspec </p>\n","comments":""},"git_headlist_cb":{"type":"callback","file":"git2/net.h","line":55,"lineto":55,"args":[{"name":"rhead","type":"git_remote_head *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"git_remote_head *rhead, void *payload","sig":"git_remote_head *::void *","return":{"type":"int","comment":null},"description":"<p>Callback for listing the remote heads</p>\n","comments":""},"git_note_foreach_cb":{"type":"callback","file":"git2/notes.h","line":29,"lineto":30,"args":[{"name":"blob_id","type":"const git_oid *","comment":null},{"name":"annotated_object_id","type":"const git_oid *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"const git_oid *blob_id, const git_oid *annotated_object_id, void *payload","sig":"const git_oid *::const git_oid *::void *","return":{"type":"int","comment":null},"description":"<p>Callback for git_note_foreach.</p>\n","comments":"<p>Receives: - blob_id: Oid of the blob containing the message - annotated_object_id: Oid of the git object being annotated - payload: Payload data passed to <code>git_note_foreach</code></p>\n"},"git_odb_foreach_cb":{"type":"callback","file":"git2/odb.h","line":27,"lineto":27,"args":[{"name":"id","type":"const git_oid *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"const git_oid *id, void *payload","sig":"const git_oid *::void *","return":{"type":"int","comment":null},"description":"<p>Function type for callbacks from git_odb_foreach.</p>\n","comments":""},"git_packbuilder_progress":{"type":"callback","file":"git2/pack.h","line":210,"lineto":214,"args":[{"name":"stage","type":"int","comment":null},{"name":"current","type":"uint32_t","comment":null},{"name":"total","type":"uint32_t","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"int stage, uint32_t current, uint32_t total, void *payload","sig":"int::uint32_t::uint32_t::void *","return":{"type":"int","comment":null},"description":"<p>Packbuilder progress notification function </p>\n","comments":""},"git_push_transfer_progress":{"type":"callback","file":"git2/remote.h","line":351,"lineto":355,"args":[{"name":"current","type":"unsigned int","comment":null},{"name":"total","type":"unsigned int","comment":null},{"name":"bytes","type":"size_t","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"unsigned int current, unsigned int total, size_t bytes, void *payload","sig":"unsigned int::unsigned int::size_t::void *","return":{"type":"int","comment":null},"description":"<p>Push network progress notification function </p>\n","comments":""},"git_push_negotiation":{"type":"callback","file":"git2/remote.h","line":386,"lineto":386,"args":[{"name":"updates","type":"const git_push_update **","comment":"an array containing the updates which will be sent\n as commands to the destination."},{"name":"len","type":"size_t","comment":"number of elements in `updates`"},{"name":"payload","type":"void *","comment":"Payload provided by the caller"}],"argline":"const git_push_update **updates, size_t len, void *payload","sig":"const git_push_update **::size_t::void *","return":{"type":"int","comment":null},"description":"<p>Callback used to inform of upcoming updates.</p>\n","comments":""},"git_push_update_reference_cb":{"type":"callback","file":"git2/remote.h","line":400,"lineto":400,"args":[{"name":"refname","type":"const char *","comment":"refname specifying to the remote ref"},{"name":"status","type":"const char *","comment":"status message sent from the remote"},{"name":"data","type":"void *","comment":"data provided by the caller"}],"argline":"const char *refname, const char *status, void *data","sig":"const char *::const char *::void *","return":{"type":"int","comment":" 0 on success, otherwise an error"},"description":"<p>Callback used to inform of the update status from the remote.</p>\n","comments":"<p>Called for each updated reference on push. If <code>status</code> is not <code>NULL</code>, the update was rejected by the remote server and <code>status</code> contains the reason given.</p>\n"},"git_revwalk_hide_cb":{"type":"callback","file":"git2/revwalk.h","line":277,"lineto":279,"args":[{"name":"commit_id","type":"const git_oid *","comment":"oid of Commit"},{"name":"payload","type":"void *","comment":"User-specified pointer to data to be passed as data payload"}],"argline":"const git_oid *commit_id, void *payload","sig":"const git_oid *::void *","return":{"type":"int","comment":null},"description":"<p>This is a callback function that user can provide to hide a\n commit and its parents. If the callback function returns non-zero value,\n then this commit and its parents will be hidden.</p>\n","comments":""},"git_stash_apply_progress_cb":{"type":"callback","file":"git2/stash.h","line":113,"lineto":115,"args":[{"name":"progress","type":"git_stash_apply_progress_t","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"git_stash_apply_progress_t progress, void *payload","sig":"git_stash_apply_progress_t::void *","return":{"type":"int","comment":null},"description":"<p>Stash application progress notification function.\n Return 0 to continue processing, or a negative value to\n abort the stash application.</p>\n","comments":""},"git_stash_cb":{"type":"callback","file":"git2/stash.h","line":198,"lineto":202,"args":[{"name":"index","type":"size_t","comment":"The position within the stash list. 0 points to the\n most recent stashed state."},{"name":"message","type":"const char *","comment":"The stash message."},{"name":"stash_id","type":"const int *","comment":"The commit oid of the stashed state."},{"name":"payload","type":"void *","comment":"Extra parameter to callback function."}],"argline":"size_t index, const char *message, const int *stash_id, void *payload","sig":"size_t::const char *::const int *::void *","return":{"type":"int","comment":" 0 to continue iterating or non-zero to stop."},"description":"<p>This is a callback function you can provide to iterate over all the\n stashed states that will be invoked per entry.</p>\n","comments":""},"git_status_cb":{"type":"callback","file":"git2/status.h","line":61,"lineto":62,"args":[{"name":"path","type":"const char *","comment":null},{"name":"status_flags","type":"unsigned int","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"const char *path, unsigned int status_flags, void *payload","sig":"const char *::unsigned int::void *","return":{"type":"int","comment":null},"description":"<p>Function pointer to receive status on individual files</p>\n","comments":"<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"},"git_submodule_cb":{"type":"callback","file":"git2/submodule.h","line":118,"lineto":119,"args":[{"name":"sm","type":"git_submodule *","comment":"git_submodule currently being visited"},{"name":"name","type":"const char *","comment":"name of the submodule"},{"name":"payload","type":"void *","comment":"value you passed to the foreach function as payload"}],"argline":"git_submodule *sm, const char *name, void *payload","sig":"git_submodule *::const char *::void *","return":{"type":"int","comment":" 0 on success or error code"},"description":"<p>Function pointer to receive each submodule</p>\n","comments":""},"git_filter_init_fn":{"type":"callback","file":"git2/sys/filter.h","line":141,"lineto":141,"args":[{"name":"self","type":"int *","comment":null}],"argline":"int *self","sig":"int *","return":{"type":"int","comment":null},"description":"<p>Initialize callback on filter</p>\n","comments":"<p>Specified as <code>filter.initialize</code>, this is an optional callback invoked before a filter is first used. It will be called once at most.</p>\n\n<p>If non-NULL, the filter's <code>initialize</code> callback will be invoked right before the first use of the filter, so you can defer expensive initialization operations (in case libgit2 is being used in a way that doesn't need the filter).</p>\n"},"git_filter_shutdown_fn":{"type":"callback","file":"git2/sys/filter.h","line":153,"lineto":153,"args":[{"name":"self","type":"int *","comment":null}],"argline":"int *self","sig":"int *","return":{"type":"void","comment":null},"description":"<p>Shutdown callback on filter</p>\n","comments":"<p>Specified as <code>filter.shutdown</code>, this is an optional callback invoked when the filter is unregistered or when libgit2 is shutting down. It will be called once at most and should release resources as needed. This may be called even if the <code>initialize</code> callback was not made.</p>\n\n<p>Typically this function will free the <code>git_filter</code> object itself.</p>\n"},"git_filter_check_fn":{"type":"callback","file":"git2/sys/filter.h","line":175,"lineto":179,"args":[{"name":"self","type":"int *","comment":null},{"name":"payload","type":"void **","comment":null},{"name":"src","type":"const git_filter_source *","comment":null},{"name":"attr_values","type":"const char **","comment":null}],"argline":"int *self, void **payload, const git_filter_source *src, const char **attr_values","sig":"int *::void **::const git_filter_source *::const char **","return":{"type":"int","comment":null},"description":"<p>Callback to decide if a given source needs this filter</p>\n","comments":"<p>Specified as <code>filter.check</code>, this is an optional callback that checks if filtering is needed for a given source.</p>\n\n<p>It should return 0 if the filter should be applied (i.e. success), GIT_PASSTHROUGH if the filter should not be applied, or an error code to fail out of the filter processing pipeline and return to the caller.</p>\n\n<p>The <code>attr_values</code> will be set to the values of any attributes given in the filter definition. See <code>git_filter</code> below for more detail.</p>\n\n<p>The <code>payload</code> will be a pointer to a reference payload for the filter. This will start as NULL, but <code>check</code> can assign to this pointer for later use by the <code>apply</code> callback. Note that the value should be heap allocated (not stack), so that it doesn't go away before the <code>apply</code> callback can use it. If a filter allocates and assigns a value to the <code>payload</code>, it will need a <code>cleanup</code> callback to free the payload.</p>\n"},"git_filter_apply_fn":{"type":"callback","file":"git2/sys/filter.h","line":193,"lineto":198,"args":[{"name":"self","type":"int *","comment":null},{"name":"payload","type":"void **","comment":null},{"name":"to","type":"int *","comment":null},{"name":"from","type":"const int *","comment":null},{"name":"src","type":"const git_filter_source *","comment":null}],"argline":"int *self, void **payload, int *to, const int *from, const git_filter_source *src","sig":"int *::void **::int *::const int *::const git_filter_source *","return":{"type":"int","comment":null},"description":"<p>Callback to actually perform the data filtering</p>\n","comments":"<p>Specified as <code>filter.apply</code>, this is the callback that actually filters data. If it successfully writes the output, it should return 0. Like <code>check</code>, it can return GIT_PASSTHROUGH to indicate that the filter doesn't want to run. Other error codes will stop filter processing and return to the caller.</p>\n\n<p>The <code>payload</code> value will refer to any payload that was set by the <code>check</code> callback. It may be read from or written to as needed.</p>\n"},"git_filter_cleanup_fn":{"type":"callback","file":"git2/sys/filter.h","line":215,"lineto":217,"args":[{"name":"self","type":"int *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"int *self, void *payload","sig":"int *::void *","return":{"type":"void","comment":null},"description":"<p>Callback to clean up after filtering has been applied</p>\n","comments":"<p>Specified as <code>filter.cleanup</code>, this is an optional callback invoked after the filter has been applied. If the <code>check</code> or <code>apply</code> callbacks allocated a <code>payload</code> to keep per-source filter state, use this callback to free that payload and release resources as required.</p>\n"},"git_merge_driver_init_fn":{"type":"callback","file":"git2/sys/merge.h","line":71,"lineto":71,"args":[{"name":"self","type":"int *","comment":null}],"argline":"int *self","sig":"int *","return":{"type":"int","comment":null},"description":"<p>Initialize callback on merge driver</p>\n","comments":"<p>Specified as <code>driver.initialize</code>, this is an optional callback invoked before a merge driver is first used. It will be called once at most per library lifetime.</p>\n\n<p>If non-NULL, the merge driver's <code>initialize</code> callback will be invoked right before the first use of the driver, so you can defer expensive initialization operations (in case libgit2 is being used in a way that doesn't need the merge driver).</p>\n"},"git_merge_driver_shutdown_fn":{"type":"callback","file":"git2/sys/merge.h","line":83,"lineto":83,"args":[{"name":"self","type":"int *","comment":null}],"argline":"int *self","sig":"int *","return":{"type":"void","comment":null},"description":"<p>Shutdown callback on merge driver</p>\n","comments":"<p>Specified as <code>driver.shutdown</code>, this is an optional callback invoked when the merge driver is unregistered or when libgit2 is shutting down. It will be called once at most and should release resources as needed. This may be called even if the <code>initialize</code> callback was not made.</p>\n\n<p>Typically this function will free the <code>git_merge_driver</code> object itself.</p>\n"},"git_merge_driver_apply_fn":{"type":"callback","file":"git2/sys/merge.h","line":103,"lineto":109,"args":[{"name":"self","type":"int *","comment":null},{"name":"path_out","type":"const char **","comment":null},{"name":"mode_out","type":"int *","comment":null},{"name":"merged_out","type":"int *","comment":null},{"name":"filter_name","type":"const char *","comment":null},{"name":"src","type":"const git_merge_driver_source *","comment":null}],"argline":"int *self, const char **path_out, int *mode_out, int *merged_out, const char *filter_name, const git_merge_driver_source *src","sig":"int *::const char **::int *::int *::const char *::const git_merge_driver_source *","return":{"type":"int","comment":null},"description":"<p>Callback to perform the merge.</p>\n","comments":"<p>Specified as <code>driver.apply</code>, this is the callback that actually does the merge. If it can successfully perform a merge, it should populate <code>path_out</code> with a pointer to the filename to accept, <code>mode_out</code> with the resultant mode, and <code>merged_out</code> with the buffer of the merged file and then return 0. If the driver returns <code>GIT_PASSTHROUGH</code>, then the default merge driver should instead be run. It can also return <code>GIT_EMERGECONFLICT</code> if the driver is not able to produce a merge result, and the file will remain conflicted. Any other errors will fail and return to the caller.</p>\n\n<p>The <code>filter_name</code> contains the name of the filter that was invoked, as specified by the file's attributes.</p>\n\n<p>The <code>src</code> contains the data about the file to be merged.</p>\n"},"git_trace_callback":{"type":"callback","file":"git2/trace.h","line":52,"lineto":52,"args":[{"name":"level","type":"git_trace_level_t","comment":null},{"name":"msg","type":"const char *","comment":null}],"argline":"git_trace_level_t level, const char *msg","sig":"git_trace_level_t::const char *","return":{"type":"void","comment":null},"description":"<p>An instance for a tracing function</p>\n","comments":""},"git_transport_cb":{"type":"callback","file":"git2/transport.h","line":24,"lineto":24,"args":[{"name":"out","type":"git_transport **","comment":null},{"name":"owner","type":"git_remote *","comment":null},{"name":"param","type":"void *","comment":null}],"argline":"git_transport **out, git_remote *owner, void *param","sig":"git_transport **::git_remote *::void *","return":{"type":"int","comment":null},"description":"<p>Signature of a function which creates a transport </p>\n","comments":""},"git_cred_acquire_cb":{"type":"callback","file":"git2/transport.h","line":333,"lineto":338,"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":"username_from_url","type":"const char *","comment":"The username that was embedded in a \"user\n@\nhost\"\n remote url, or NULL if not included."},{"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."}],"argline":"git_cred **cred, const char *url, const char *username_from_url, unsigned int allowed_types, void *payload","sig":"git_cred **::const char *::const char *::unsigned int::void *","return":{"type":"int","comment":" 0 for success, \n<\n 0 to indicate an error, > 0 to indicate\n no credential was acquired"},"description":"<p>Signature of a function which acquires a credential object.</p>\n","comments":""},"git_treebuilder_filter_cb":{"type":"callback","file":"git2/tree.h","line":347,"lineto":348,"args":[{"name":"entry","type":"const git_tree_entry *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"const git_tree_entry *entry, void *payload","sig":"const git_tree_entry *::void *","return":{"type":"int","comment":null},"description":"<p>Callback for git_treebuilder_filter</p>\n","comments":"<p>The return value is treated as a boolean, with zero indicating that the entry should be left alone and any non-zero value meaning that the entry should be removed from the treebuilder list (i.e. filtered out).</p>\n"},"git_treewalk_cb":{"type":"callback","file":"git2/tree.h","line":394,"lineto":395,"args":[{"name":"root","type":"const char *","comment":null},{"name":"entry","type":"const git_tree_entry *","comment":null},{"name":"payload","type":"void *","comment":null}],"argline":"const char *root, const git_tree_entry *entry, void *payload","sig":"const char *::const git_tree_entry *::void *","return":{"type":"int","comment":null},"description":"<p>Callback for the tree traversal method </p>\n","comments":""},"git_transfer_progress_cb":{"type":"callback","file":"git2/types.h","line":274,"lineto":274,"args":[{"name":"stats","type":"const git_transfer_progress *","comment":"Structure containing information about the state of the transfer"},{"name":"payload","type":"void *","comment":"Payload provided by caller"}],"argline":"const git_transfer_progress *stats, void *payload","sig":"const git_transfer_progress *::void *","return":{"type":"int","comment":null},"description":"<p>Type for progress callbacks during indexing. Return a value less than zero\n to cancel the transfer.</p>\n","comments":""},"git_transport_message_cb":{"type":"callback","file":"git2/types.h","line":284,"lineto":284,"args":[{"name":"str","type":"const char *","comment":"The message from the transport"},{"name":"len","type":"int","comment":"The length of the message"},{"name":"payload","type":"void *","comment":"Payload provided by the caller"}],"argline":"const char *str, int len, void *payload","sig":"const char *::int::void *","return":{"type":"int","comment":null},"description":"<p>Type for messages delivered by the transport. Return a negative value\n to cancel the network operation.</p>\n","comments":""},"git_transport_certificate_check_cb":{"type":"callback","file":"git2/types.h","line":334,"lineto":334,"args":[{"name":"cert","type":"git_cert *","comment":"The host certificate"},{"name":"valid","type":"int","comment":"Whether the libgit2 checks (OpenSSL or WinHTTP) think\n this certificate is valid"},{"name":"host","type":"const char *","comment":"Hostname of the host libgit2 connected to"},{"name":"payload","type":"void *","comment":"Payload provided by the caller"}],"argline":"git_cert *cert, int valid, const char *host, void *payload","sig":"git_cert *::int::const char *::void *","return":{"type":"int","comment":null},"description":"<p>Callback for the user's custom certificate checks.</p>\n","comments":""}},"globals":{},"types":[["git_annotated_commit",{"decl":"git_annotated_commit","type":"struct","value":"git_annotated_commit","file":"git2/types.h","line":182,"lineto":182,"tdef":"typedef","description":" Annotated commits, the input to merge and rebase. ","comments":"","used":{"returns":[],"needs":["git_annotated_commit_free","git_annotated_commit_from_fetchhead","git_annotated_commit_from_ref","git_annotated_commit_from_revspec","git_annotated_commit_id","git_annotated_commit_lookup","git_branch_create_from_annotated","git_merge","git_merge_analysis","git_rebase_init","git_repository_set_head_detached_from_annotated","git_reset_from_annotated"]}}],["git_attr_t",{"decl":["GIT_ATTR_UNSPECIFIED_T","GIT_ATTR_TRUE_T","GIT_ATTR_FALSE_T","GIT_ATTR_VALUE_T"],"type":"enum","file":"git2/attr.h","line":82,"lineto":87,"block":"GIT_ATTR_UNSPECIFIED_T\nGIT_ATTR_TRUE_T\nGIT_ATTR_FALSE_T\nGIT_ATTR_VALUE_T","tdef":"typedef","description":" Possible states for an attribute","comments":"","fields":[{"type":"int","name":"GIT_ATTR_UNSPECIFIED_T","comments":"<p>The attribute has been left unspecified </p>\n","value":0},{"type":"int","name":"GIT_ATTR_TRUE_T","comments":"<p>The attribute has been set </p>\n","value":1},{"type":"int","name":"GIT_ATTR_FALSE_T","comments":"<p>The attribute has been unset </p>\n","value":2},{"type":"int","name":"GIT_ATTR_VALUE_T","comments":"<p>This attribute has a value </p>\n","value":3}],"used":{"returns":["git_attr_value"],"needs":[]}}],["git_blame_flag_t",{"decl":["GIT_BLAME_NORMAL","GIT_BLAME_TRACK_COPIES_SAME_FILE","GIT_BLAME_TRACK_COPIES_SAME_COMMIT_MOVES","GIT_BLAME_TRACK_COPIES_SAME_COMMIT_COPIES","GIT_BLAME_TRACK_COPIES_ANY_COMMIT_COPIES","GIT_BLAME_FIRST_PARENT"],"type":"enum","file":"git2/blame.h","line":26,"lineto":46,"block":"GIT_BLAME_NORMAL\nGIT_BLAME_TRACK_COPIES_SAME_FILE\nGIT_BLAME_TRACK_COPIES_SAME_COMMIT_MOVES\nGIT_BLAME_TRACK_COPIES_SAME_COMMIT_COPIES\nGIT_BLAME_TRACK_COPIES_ANY_COMMIT_COPIES\nGIT_BLAME_FIRST_PARENT","tdef":"typedef","description":" Flags for indicating option behavior for git_blame APIs.","comments":"","fields":[{"type":"int","name":"GIT_BLAME_NORMAL","comments":"<p>Normal blame, the default </p>\n","value":0},{"type":"int","name":"GIT_BLAME_TRACK_COPIES_SAME_FILE","comments":"<p>Track lines that have moved within a file (like <code>git blame -M</code>).\n NOT IMPLEMENTED. </p>\n","value":1},{"type":"int","name":"GIT_BLAME_TRACK_COPIES_SAME_COMMIT_MOVES","comments":"<p>Track lines that have moved across files in the same commit (like <code>git blame -C</code>).\n NOT IMPLEMENTED. </p>\n","value":2},{"type":"int","name":"GIT_BLAME_TRACK_COPIES_SAME_COMMIT_COPIES","comments":"<p>Track lines that have been copied from another file that exists in the\n same commit (like <code>git blame -CC</code>). Implies SAME_FILE.\n NOT IMPLEMENTED. </p>\n","value":4},{"type":"int","name":"GIT_BLAME_TRACK_COPIES_ANY_COMMIT_COPIES","comments":"<p>Track lines that have been copied from another file that exists in <em>any</em>\n commit (like <code>git blame -CCC</code>). Implies SAME_COMMIT_COPIES.\n NOT IMPLEMENTED. </p>\n","value":8},{"type":"int","name":"GIT_BLAME_FIRST_PARENT","comments":"<p>Restrict the search of commits to those reachable following only the\n first parents. </p>\n","value":16}],"used":{"returns":[],"needs":[]}}],["git_blame_hunk",{"decl":["size_t lines_in_hunk","git_oid final_commit_id","size_t final_start_line_number","git_signature * final_signature","git_oid orig_commit_id","const char * orig_path","size_t orig_start_line_number","git_signature * orig_signature","char boundary"],"type":"struct","value":"git_blame_hunk","file":"git2/blame.h","line":115,"lineto":128,"block":"size_t lines_in_hunk\ngit_oid final_commit_id\nsize_t final_start_line_number\ngit_signature * final_signature\ngit_oid orig_commit_id\nconst char * orig_path\nsize_t orig_start_line_number\ngit_signature * orig_signature\nchar boundary","tdef":"typedef","description":" Structure that represents a blame hunk.","comments":"<ul>\n<li><code>lines_in_hunk</code> is the number of lines in this hunk - <code>final_commit_id</code> is the OID of the commit where this line was last changed. - <code>final_start_line_number</code> is the 1-based line number where this hunk begins, in the final version of the file - <code>orig_commit_id</code> is the OID of the commit where this hunk was found. This will usually be the same as <code>final_commit_id</code>, except when <code>GIT_BLAME_TRACK_COPIES_ANY_COMMIT_COPIES</code> has been specified. - <code>orig_path</code> is the path to the file where this hunk originated, as of the commit specified by <code>orig_commit_id</code>. - <code>orig_start_line_number</code> is the 1-based line number where this hunk begins in the file named by <code>orig_path</code> in the commit specified by <code>orig_commit_id</code>. - <code>boundary</code> is 1 iff the hunk has been tracked to a boundary commit (the root, or the commit specified in git_blame_options.oldest_commit)</li>\n</ul>\n","fields":[{"type":"size_t","name":"lines_in_hunk","comments":""},{"type":"git_oid","name":"final_commit_id","comments":""},{"type":"size_t","name":"final_start_line_number","comments":""},{"type":"git_signature *","name":"final_signature","comments":""},{"type":"git_oid","name":"orig_commit_id","comments":""},{"type":"const char *","name":"orig_path","comments":""},{"type":"size_t","name":"orig_start_line_number","comments":""},{"type":"git_signature *","name":"orig_signature","comments":""},{"type":"char","name":"boundary","comments":""}],"used":{"returns":["git_blame_get_hunk_byindex","git_blame_get_hunk_byline"],"needs":[]}}],["git_blame_options",{"decl":["unsigned int version","uint32_t flags","uint16_t min_match_characters","git_oid newest_commit","git_oid oldest_commit","size_t min_line","size_t max_line"],"type":"struct","value":"git_blame_options","file":"git2/blame.h","line":70,"lineto":79,"block":"unsigned int version\nuint32_t flags\nuint16_t min_match_characters\ngit_oid newest_commit\ngit_oid oldest_commit\nsize_t min_line\nsize_t max_line","tdef":"typedef","description":" Blame options structure","comments":"<p>Use zeros to indicate default settings. It's easiest to use the <code>GIT_BLAME_OPTIONS_INIT</code> macro: git_blame_options opts = GIT_BLAME_OPTIONS_INIT;</p>\n\n<ul>\n<li><code>flags</code> is a combination of the <code>git_blame_flag_t</code> values above. - <code>min_match_characters</code> is the lower bound on the number of alphanumeric characters that must be detected as moving/copying within a file for it to associate those lines with the parent commit. The default value is 20. This value only takes effect if any of the <code>GIT_BLAME_TRACK_COPIES_*</code> flags are specified. - <code>newest_commit</code> is the id of the newest commit to consider. The default is HEAD. - <code>oldest_commit</code> is the id of the oldest commit to consider. The default is the first commit encountered with a NULL parent. - <code>min_line</code> is the first line in the file to blame. The default is 1 (line numbers start with 1). - <code>max_line</code> is the last line in the file to blame. The default is the last line of the file.</li>\n</ul>\n","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"uint32_t","name":"flags","comments":""},{"type":"uint16_t","name":"min_match_characters","comments":""},{"type":"git_oid","name":"newest_commit","comments":""},{"type":"git_oid","name":"oldest_commit","comments":""},{"type":"size_t","name":"min_line","comments":""},{"type":"size_t","name":"max_line","comments":""}],"used":{"returns":[],"needs":["git_blame_file","git_blame_init_options"]}}],["git_blob",{"decl":"git_blob","type":"struct","value":"git_blob","file":"git2/types.h","line":120,"lineto":120,"tdef":"typedef","description":" In-memory representation of a blob object. ","comments":"","used":{"returns":[],"needs":["git_blob_dup","git_blob_filtered_content","git_blob_free","git_blob_id","git_blob_is_binary","git_blob_lookup","git_blob_lookup_prefix","git_blob_owner","git_blob_rawcontent","git_blob_rawsize","git_diff_blob_to_buffer","git_diff_blobs","git_filter_list_apply_to_blob","git_filter_list_load","git_filter_list_stream_blob","git_patch_from_blob_and_buffer","git_patch_from_blobs"]}}],["git_branch_iterator",{"decl":"git_branch_iterator","type":"struct","value":"git_branch_iterator","file":"git2/branch.h","line":88,"lineto":88,"tdef":"typedef","description":" Iterator type for branches ","comments":"","used":{"returns":[],"needs":["git_branch_iterator_free","git_branch_iterator_new","git_branch_next"]}}],["git_branch_t",{"decl":["GIT_BRANCH_LOCAL","GIT_BRANCH_REMOTE","GIT_BRANCH_ALL"],"type":"enum","file":"git2/types.h","line":202,"lineto":206,"block":"GIT_BRANCH_LOCAL\nGIT_BRANCH_REMOTE\nGIT_BRANCH_ALL","tdef":"typedef","description":" Basic type of any Git branch. ","comments":"","fields":[{"type":"int","name":"GIT_BRANCH_LOCAL","comments":"","value":1},{"type":"int","name":"GIT_BRANCH_REMOTE","comments":"","value":2},{"type":"int","name":"GIT_BRANCH_ALL","comments":"","value":3}],"used":{"returns":[],"needs":["git_branch_iterator_new","git_branch_lookup","git_branch_next"]}}],["git_buf",{"decl":["char * ptr","size_t asize","size_t size"],"type":"struct","value":"git_buf","file":"git2/buffer.h","line":52,"lineto":55,"block":"char * ptr\nsize_t asize\nsize_t size","tdef":"typedef","description":" A data buffer for exporting data from libgit2","comments":"<p>Sometimes libgit2 wants to return an allocated data buffer to the caller and have the caller take responsibility for freeing that memory. This can be awkward if the caller does not have easy access to the same allocation functions that libgit2 is using. In those cases, libgit2 will fill in a <code>git_buf</code> and the caller can use <code>git_buf_free()</code> to release it when they are done.</p>\n\n<p>A <code>git_buf</code> may also be used for the caller to pass in a reference to a block of memory they hold. In this case, libgit2 will not resize or free the memory, but will read from it as needed.</p>\n\n<p>A <code>git_buf</code> is a public structure with three fields:</p>\n\n<ul>\n<li><p><code>ptr</code> points to the start of the allocated memory. If it is NULL, then the <code>git_buf</code> is considered empty and libgit2 will feel free to overwrite it with new data.</p></li>\n<li><p><code>size</code> holds the size (in bytes) of the data that is actually used.</p></li>\n<li><p><code>asize</code> holds the known total amount of allocated memory if the <code>ptr</code> was allocated by libgit2. It may be larger than <code>size</code>. If <code>ptr</code> was not allocated by libgit2 and should not be resized and/or freed, then <code>asize</code> will be set to zero.</p></li>\n</ul>\n\n<p>Some APIs may occasionally do something slightly unusual with a buffer, such as setting <code>ptr</code> to a value that was passed in by the user. In those cases, the behavior will be clearly documented by the API.</p>\n","fields":[{"type":"char *","name":"ptr","comments":""},{"type":"size_t","name":"asize","comments":""},{"type":"size_t","name":"size","comments":""}],"used":{"returns":[],"needs":["git_blob_filtered_content","git_buf_contains_nul","git_buf_free","git_buf_grow","git_buf_is_binary","git_buf_set","git_commit_create_buffer","git_commit_extract_signature","git_commit_header_field","git_config_find_global","git_config_find_programdata","git_config_find_system","git_config_find_xdg","git_config_get_path","git_config_get_string_buf","git_config_parse_path","git_describe_format","git_diff_commit_as_email","git_diff_format_email","git_diff_stats_to_buf","git_diff_to_buf","git_filter_list_apply_to_blob","git_filter_list_apply_to_data","git_filter_list_apply_to_file","git_filter_list_stream_data","git_message_prettify","git_object_short_id","git_patch_to_buf","git_refspec_rtransform","git_refspec_transform","git_remote_default_branch","git_repository_discover","git_repository_item_path","git_repository_message","git_submodule_resolve_url","git_treebuilder_write_with_buffer","git_worktree_is_locked"]}}],["git_cert",{"decl":["git_cert_t cert_type"],"type":"struct","value":"git_cert","file":"git2/types.h","line":318,"lineto":323,"block":"git_cert_t cert_type","tdef":"typedef","description":" Parent type for `git_cert_hostkey` and `git_cert_x509`.","comments":"","fields":[{"type":"git_cert_t","name":"cert_type","comments":" Type of certificate. A `GIT_CERT_` value."}],"used":{"returns":[],"needs":["git_transport_certificate_check_cb"]}}],["git_cert_hostkey",{"decl":["git_cert parent","git_cert_ssh_t type","unsigned char [16] hash_md5","unsigned char [20] hash_sha1"],"type":"struct","value":"git_cert_hostkey","file":"git2/transport.h","line":39,"lineto":59,"block":"git_cert parent\ngit_cert_ssh_t type\nunsigned char [16] hash_md5\nunsigned char [20] hash_sha1","tdef":"typedef","description":" Hostkey information taken from libssh2","comments":"","fields":[{"type":"git_cert","name":"parent","comments":""},{"type":"git_cert_ssh_t","name":"type","comments":" A hostkey type from libssh2, either\n `GIT_CERT_SSH_MD5` or `GIT_CERT_SSH_SHA1`"},{"type":"unsigned char [16]","name":"hash_md5","comments":" Hostkey hash. If type has `GIT_CERT_SSH_MD5` set, this will\n have the MD5 hash of the hostkey."},{"type":"unsigned char [20]","name":"hash_sha1","comments":" Hostkey hash. If type has `GIT_CERT_SSH_SHA1` set, this will\n have the SHA-1 hash of the hostkey."}],"used":{"returns":[],"needs":[]}}],["git_cert_ssh_t",{"decl":["GIT_CERT_SSH_MD5","GIT_CERT_SSH_SHA1"],"type":"enum","file":"git2/transport.h","line":29,"lineto":34,"block":"GIT_CERT_SSH_MD5\nGIT_CERT_SSH_SHA1","tdef":"typedef","description":" Type of SSH host fingerprint","comments":"","fields":[{"type":"int","name":"GIT_CERT_SSH_MD5","comments":"<p>MD5 is available </p>\n","value":1},{"type":"int","name":"GIT_CERT_SSH_SHA1","comments":"<p>SHA-1 is available </p>\n","value":2}],"used":{"returns":[],"needs":[]}}],["git_cert_t",{"decl":["GIT_CERT_NONE","GIT_CERT_X509","GIT_CERT_HOSTKEY_LIBSSH2","GIT_CERT_STRARRAY"],"type":"enum","file":"git2/types.h","line":290,"lineto":313,"block":"GIT_CERT_NONE\nGIT_CERT_X509\nGIT_CERT_HOSTKEY_LIBSSH2\nGIT_CERT_STRARRAY\nGIT_CERT_NONE\nGIT_CERT_X509\nGIT_CERT_HOSTKEY_LIBSSH2\nGIT_CERT_STRARRAY","tdef":"typedef","description":" Type of host certificate structure that is passed to the check callback","comments":"","fields":[{"type":"int","name":"GIT_CERT_NONE","comments":"<p>No information about the certificate is available. This may\n happen when using curl.</p>\n","value":0},{"type":"int","name":"GIT_CERT_X509","comments":"<p>The <code>data</code> argument to the callback will be a pointer to\n the DER-encoded data.</p>\n","value":1},{"type":"int","name":"GIT_CERT_HOSTKEY_LIBSSH2","comments":"<p>The <code>data</code> argument to the callback will be a pointer to a\n <code>git_cert_hostkey</code> structure.</p>\n","value":2},{"type":"int","name":"GIT_CERT_STRARRAY","comments":"<p>The <code>data</code> argument to the callback will be a pointer to a\n <code>git_strarray</code> with <code>name:content</code> strings containing\n information about the certificate. This is used when using\n curl.</p>\n","value":3}],"used":{"returns":[],"needs":[]}}],["git_cert_x509",{"decl":["git_cert parent","void * data","size_t len"],"type":"struct","value":"git_cert_x509","file":"git2/transport.h","line":64,"lineto":74,"block":"git_cert parent\nvoid * data\nsize_t len","tdef":"typedef","description":" X.509 certificate information","comments":"","fields":[{"type":"git_cert","name":"parent","comments":""},{"type":"void *","name":"data","comments":" Pointer to the X.509 certificate data"},{"type":"size_t","name":"len","comments":" Length of the memory block pointed to by `data`."}],"used":{"returns":[],"needs":[]}}],["git_checkout_notify_t",{"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","GIT_CHECKOUT_NOTIFY_ALL"],"type":"enum","file":"git2/checkout.h","line":205,"lineto":214,"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\nGIT_CHECKOUT_NOTIFY_ALL","tdef":"typedef","description":" Checkout notification flags","comments":"<p>Checkout will invoke an options notification callback (<code>notify_cb</code>) for certain 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 "dirty" files, i.e. those that do not need an update but no longer match the baseline. Core git displays these files when checkout runs, but won'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. The non-zero return value will be propagated back and returned by the git_checkout_... call.</p>\n\n<p>Notification callbacks are made prior to modifying any files on disk, so canceling on any notification will still happen prior to any files being modified.</p>\n","fields":[{"type":"int","name":"GIT_CHECKOUT_NOTIFY_NONE","comments":"","value":0},{"type":"int","name":"GIT_CHECKOUT_NOTIFY_CONFLICT","comments":"","value":1},{"type":"int","name":"GIT_CHECKOUT_NOTIFY_DIRTY","comments":"","value":2},{"type":"int","name":"GIT_CHECKOUT_NOTIFY_UPDATED","comments":"","value":4},{"type":"int","name":"GIT_CHECKOUT_NOTIFY_UNTRACKED","comments":"","value":8},{"type":"int","name":"GIT_CHECKOUT_NOTIFY_IGNORED","comments":"","value":16},{"type":"int","name":"GIT_CHECKOUT_NOTIFY_ALL","comments":"","value":65535}],"used":{"returns":[],"needs":["git_checkout_notify_cb"]}}],["git_checkout_options",{"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","git_index * baseline_index","const char * target_directory","const char * ancestor_label","const char * our_label","const char * their_label","git_checkout_perfdata_cb perfdata_cb","void * perfdata_payload"],"type":"struct","value":"git_checkout_options","file":"git2/checkout.h","line":251,"lineto":295,"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\ngit_index * baseline_index\nconst char * target_directory\nconst char * ancestor_label\nconst char * our_label\nconst char * their_label\ngit_checkout_perfdata_cb perfdata_cb\nvoid * perfdata_payload","tdef":"typedef","description":" Checkout options structure","comments":"<p>Zero out for defaults. Initialize with <code>GIT_CHECKOUT_OPTIONS_INIT</code> macro to correctly set the <code>version</code> field. E.g.</p>\n\n<pre><code> git_checkout_options opts = GIT_CHECKOUT_OPTIONS_INIT;\n</code></pre>\n","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"unsigned int","name":"checkout_strategy","comments":" default will be a dry run "},{"type":"int","name":"disable_filters","comments":" don't apply filters like CRLF conversion "},{"type":"unsigned int","name":"dir_mode","comments":" default is 0755 "},{"type":"unsigned int","name":"file_mode","comments":" default is 0644 or 0755 as dictated by blob "},{"type":"int","name":"file_open_flags","comments":" default is O_CREAT | O_TRUNC | O_WRONLY "},{"type":"unsigned int","name":"notify_flags","comments":" see `git_checkout_notify_t` above "},{"type":"git_checkout_notify_cb","name":"notify_cb","comments":""},{"type":"void *","name":"notify_payload","comments":""},{"type":"git_checkout_progress_cb","name":"progress_cb","comments":" Optional callback to notify the consumer of checkout progress. "},{"type":"void *","name":"progress_payload","comments":""},{"type":"git_strarray","name":"paths","comments":" When not zeroed out, array of fnmatch patterns specifying which\n paths should be taken into account, otherwise all files. Use\n GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH to treat as simple list."},{"type":"git_tree *","name":"baseline","comments":" The expected content of the working directory; defaults to HEAD.\n If the working directory does not match this baseline information,\n that will produce a checkout conflict."},{"type":"git_index *","name":"baseline_index","comments":" expected content of workdir, expressed as an index. "},{"type":"const char *","name":"target_directory","comments":" alternative checkout path to workdir "},{"type":"const char *","name":"ancestor_label","comments":" the name of the common ancestor side of conflicts "},{"type":"const char *","name":"our_label","comments":" the name of the \"our\" side of conflicts "},{"type":"const char *","name":"their_label","comments":" the name of the \"their\" side of conflicts "},{"type":"git_checkout_perfdata_cb","name":"perfdata_cb","comments":" Optional callback to notify the consumer of performance data. "},{"type":"void *","name":"perfdata_payload","comments":""}],"used":{"returns":[],"needs":["git_checkout_head","git_checkout_index","git_checkout_init_options","git_checkout_tree","git_merge","git_reset","git_reset_from_annotated"]}}],["git_checkout_strategy_t",{"decl":["GIT_CHECKOUT_NONE","GIT_CHECKOUT_SAFE","GIT_CHECKOUT_FORCE","GIT_CHECKOUT_RECREATE_MISSING","GIT_CHECKOUT_ALLOW_CONFLICTS","GIT_CHECKOUT_REMOVE_UNTRACKED","GIT_CHECKOUT_REMOVE_IGNORED","GIT_CHECKOUT_UPDATE_ONLY","GIT_CHECKOUT_DONT_UPDATE_INDEX","GIT_CHECKOUT_NO_REFRESH","GIT_CHECKOUT_SKIP_UNMERGED","GIT_CHECKOUT_USE_OURS","GIT_CHECKOUT_USE_THEIRS","GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH","GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES","GIT_CHECKOUT_DONT_OVERWRITE_IGNORED","GIT_CHECKOUT_CONFLICT_STYLE_MERGE","GIT_CHECKOUT_CONFLICT_STYLE_DIFF3","GIT_CHECKOUT_DONT_REMOVE_EXISTING","GIT_CHECKOUT_DONT_WRITE_INDEX","GIT_CHECKOUT_UPDATE_SUBMODULES","GIT_CHECKOUT_UPDATE_SUBMODULES_IF_CHANGED"],"type":"enum","file":"git2/checkout.h","line":106,"lineto":177,"block":"GIT_CHECKOUT_NONE\nGIT_CHECKOUT_SAFE\nGIT_CHECKOUT_FORCE\nGIT_CHECKOUT_RECREATE_MISSING\nGIT_CHECKOUT_ALLOW_CONFLICTS\nGIT_CHECKOUT_REMOVE_UNTRACKED\nGIT_CHECKOUT_REMOVE_IGNORED\nGIT_CHECKOUT_UPDATE_ONLY\nGIT_CHECKOUT_DONT_UPDATE_INDEX\nGIT_CHECKOUT_NO_REFRESH\nGIT_CHECKOUT_SKIP_UNMERGED\nGIT_CHECKOUT_USE_OURS\nGIT_CHECKOUT_USE_THEIRS\nGIT_CHECKOUT_DISABLE_PATHSPEC_MATCH\nGIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES\nGIT_CHECKOUT_DONT_OVERWRITE_IGNORED\nGIT_CHECKOUT_CONFLICT_STYLE_MERGE\nGIT_CHECKOUT_CONFLICT_STYLE_DIFF3\nGIT_CHECKOUT_DONT_REMOVE_EXISTING\nGIT_CHECKOUT_DONT_WRITE_INDEX\nGIT_CHECKOUT_UPDATE_SUBMODULES\nGIT_CHECKOUT_UPDATE_SUBMODULES_IF_CHANGED","tdef":"typedef","description":" Checkout behavior flags","comments":"<p>In libgit2, checkout is used to update the working directory and index to match a target tree. Unlike git checkout, it does not move the HEAD commit for you - use <code>git_repository_set_head</code> or the like to do that.</p>\n\n<p>Checkout looks at (up to) four things: the "target" tree you want to check out, the "baseline" tree of what was checked out previously, the working directory for actual files, and the index for staged changes.</p>\n\n<p>You give checkout one of three strategies for update:</p>\n\n<ul>\n<li><p><code>GIT_CHECKOUT_NONE</code> is a dry-run strategy that checks for conflicts, etc., but doesn't make any actual changes.</p></li>\n<li><p><code>GIT_CHECKOUT_FORCE</code> is at the opposite extreme, taking any action to make the working directory match the target (including potentially discarding modified files).</p></li>\n<li><p><code>GIT_CHECKOUT_SAFE</code> is between these two options, it will only make modifications that will not lose changes.</p>\n\n<pre><code> | target == baseline | target != baseline | ---------------------|-----------------------|----------------------| workdir == baseline | no action | create, update, or | | | delete file | ---------------------|-----------------------|----------------------| workdir exists and | no action | conflict (notify | is != baseline | notify dirty MODIFIED | and cancel checkout) | ---------------------|-----------------------|----------------------| workdir missing, | notify dirty DELETED | create file | baseline present | | | ---------------------|-----------------------|----------------------|\n</code></pre></li>\n</ul>\n\n<p>To emulate <code>git checkout</code>, use <code>GIT_CHECKOUT_SAFE</code> with a checkout notification callback (see below) that displays information about dirty files. The default behavior will cancel checkout on conflicts.</p>\n\n<p>To emulate <code>git checkout-index</code>, use <code>GIT_CHECKOUT_SAFE</code> with a notification callback that cancels the operation if a dirty-but-existing file is found in the working directory. This core git command isn't quite "force" but is sensitive about some types of changes.</p>\n\n<p>To emulate <code>git checkout -f</code>, use <code>GIT_CHECKOUT_FORCE</code>.</p>\n\n<p>There are some additional flags to modified the behavior of checkout:</p>\n\n<ul>\n<li><p>GIT_CHECKOUT_ALLOW_CONFLICTS makes SAFE mode apply safe file updates even if there are conflicts (instead of cancelling the checkout).</p></li>\n<li><p>GIT_CHECKOUT_REMOVE_UNTRACKED means remove untracked files (i.e. not in target, baseline, or index, and not ignored) from the working dir.</p></li>\n<li><p>GIT_CHECKOUT_REMOVE_IGNORED means remove ignored files (that are also untracked) from the working directory as well.</p></li>\n<li><p>GIT_CHECKOUT_UPDATE_ONLY means to only update the content of files that already exist. Files will not be created nor deleted. This just skips applying adds, deletes, and typechanges.</p></li>\n<li><p>GIT_CHECKOUT_DONT_UPDATE_INDEX prevents checkout from writing the updated files' information to the index.</p></li>\n<li><p>Normally, checkout will reload the index and git attributes from disk before any operations. GIT_CHECKOUT_NO_REFRESH prevents this reload.</p></li>\n<li><p>Unmerged index entries are conflicts. GIT_CHECKOUT_SKIP_UNMERGED skips files with unmerged index entries instead. GIT_CHECKOUT_USE_OURS and GIT_CHECKOUT_USE_THEIRS to proceed with the checkout using either the stage 2 ("ours") or stage 3 ("theirs") version of files in the index.</p></li>\n<li><p>GIT_CHECKOUT_DONT_OVERWRITE_IGNORED prevents ignored files from being overwritten. Normally, files that are ignored in the working directory are not considered "precious" and may be overwritten if the checkout target contains that file.</p></li>\n<li><p>GIT_CHECKOUT_DONT_REMOVE_EXISTING prevents checkout from removing files or folders that fold to the same name on case insensitive filesystems. This can cause files to retain their existing names and write through existing symbolic links.</p></li>\n</ul>\n","fields":[{"type":"int","name":"GIT_CHECKOUT_NONE","comments":"<p>default is a dry run, no actual updates </p>\n","value":0},{"type":"int","name":"GIT_CHECKOUT_SAFE","comments":"<p>Allow safe updates that cannot overwrite uncommitted data </p>\n","value":1},{"type":"int","name":"GIT_CHECKOUT_FORCE","comments":"<p>Allow all updates to force working directory to look like index </p>\n","value":2},{"type":"int","name":"GIT_CHECKOUT_RECREATE_MISSING","comments":"<p>Allow checkout to recreate missing files </p>\n","value":4},{"type":"int","name":"GIT_CHECKOUT_ALLOW_CONFLICTS","comments":"<p>Allow checkout to make safe updates even if conflicts are found </p>\n","value":16},{"type":"int","name":"GIT_CHECKOUT_REMOVE_UNTRACKED","comments":"<p>Remove untracked files not in index (that are not ignored) </p>\n","value":32},{"type":"int","name":"GIT_CHECKOUT_REMOVE_IGNORED","comments":"<p>Remove ignored files not in index </p>\n","value":64},{"type":"int","name":"GIT_CHECKOUT_UPDATE_ONLY","comments":"<p>Only update existing files, don't create new ones </p>\n","value":128},{"type":"int","name":"GIT_CHECKOUT_DONT_UPDATE_INDEX","comments":"<p>Normally checkout updates index entries as it goes; this stops that.\n Implies <code>GIT_CHECKOUT_DONT_WRITE_INDEX</code>.</p>\n","value":256},{"type":"int","name":"GIT_CHECKOUT_NO_REFRESH","comments":"<p>Don't refresh index/config/etc before doing checkout </p>\n","value":512},{"type":"int","name":"GIT_CHECKOUT_SKIP_UNMERGED","comments":"<p>Allow checkout to skip unmerged files </p>\n","value":1024},{"type":"int","name":"GIT_CHECKOUT_USE_OURS","comments":"<p>For unmerged files, checkout stage 2 from index </p>\n","value":2048},{"type":"int","name":"GIT_CHECKOUT_USE_THEIRS","comments":"<p>For unmerged files, checkout stage 3 from index </p>\n","value":4096},{"type":"int","name":"GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH","comments":"<p>Treat pathspec as simple list of exact match file paths </p>\n","value":8192},{"type":"int","name":"GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES","comments":"<p>Ignore directories in use, they will be left empty </p>\n","value":262144},{"type":"int","name":"GIT_CHECKOUT_DONT_OVERWRITE_IGNORED","comments":"<p>Don't overwrite ignored files that exist in the checkout target </p>\n","value":524288},{"type":"int","name":"GIT_CHECKOUT_CONFLICT_STYLE_MERGE","comments":"<p>Write normal merge files for conflicts </p>\n","value":1048576},{"type":"int","name":"GIT_CHECKOUT_CONFLICT_STYLE_DIFF3","comments":"<p>Include common ancestor data in diff3 format files for conflicts </p>\n","value":2097152},{"type":"int","name":"GIT_CHECKOUT_DONT_REMOVE_EXISTING","comments":"<p>Don't overwrite existing files or folders </p>\n","value":4194304},{"type":"int","name":"GIT_CHECKOUT_DONT_WRITE_INDEX","comments":"<p>Normally checkout writes the index upon completion; this prevents that. </p>\n","value":8388608},{"type":"int","name":"GIT_CHECKOUT_UPDATE_SUBMODULES","comments":"<p>Recursively checkout submodules with same options (NOT IMPLEMENTED) </p>\n","value":65536},{"type":"int","name":"GIT_CHECKOUT_UPDATE_SUBMODULES_IF_CHANGED","comments":"<p>Recursively checkout submodules if HEAD moved in super repo (NOT IMPLEMENTED) </p>\n","value":131072}],"used":{"returns":[],"needs":[]}}],["git_cherrypick_options",{"decl":["unsigned int version","unsigned int mainline","git_merge_options merge_opts","git_checkout_options checkout_opts"],"type":"struct","value":"git_cherrypick_options","file":"git2/cherrypick.h","line":26,"lineto":34,"block":"unsigned int version\nunsigned int mainline\ngit_merge_options merge_opts\ngit_checkout_options checkout_opts","tdef":"typedef","description":" Cherry-pick options","comments":"","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"unsigned int","name":"mainline","comments":" For merge commits, the \"mainline\" is treated as the parent. "},{"type":"git_merge_options","name":"merge_opts","comments":" Options for the merging "},{"type":"git_checkout_options","name":"checkout_opts","comments":" Options for the checkout "}],"used":{"returns":[],"needs":["git_cherrypick","git_cherrypick_init_options"]}}],["git_clone_local_t",{"decl":["GIT_CLONE_LOCAL_AUTO","GIT_CLONE_LOCAL","GIT_CLONE_NO_LOCAL","GIT_CLONE_LOCAL_NO_LINKS"],"type":"enum","file":"git2/clone.h","line":33,"lineto":53,"block":"GIT_CLONE_LOCAL_AUTO\nGIT_CLONE_LOCAL\nGIT_CLONE_NO_LOCAL\nGIT_CLONE_LOCAL_NO_LINKS","tdef":"typedef","description":" Options for bypassing the git-aware transport on clone. Bypassing\n it means that instead of a fetch, libgit2 will copy the object\n database directory instead of figuring out what it needs, which is\n faster. If possible, it will hardlink the files to save space.","comments":"","fields":[{"type":"int","name":"GIT_CLONE_LOCAL_AUTO","comments":"<p>Auto-detect (default), libgit2 will bypass the git-aware\n transport for local paths, but use a normal fetch for\n <code>file://</code> urls.</p>\n","value":0},{"type":"int","name":"GIT_CLONE_LOCAL","comments":"<p>Bypass the git-aware transport even for a <code>file://</code> url.</p>\n","value":1},{"type":"int","name":"GIT_CLONE_NO_LOCAL","comments":"<p>Do no bypass the git-aware transport</p>\n","value":2},{"type":"int","name":"GIT_CLONE_LOCAL_NO_LINKS","comments":"<p>Bypass the git-aware transport, but do not try to use\n hardlinks.</p>\n","value":3}],"used":{"returns":[],"needs":[]}}],["git_clone_options",{"decl":["unsigned int version","git_checkout_options checkout_opts","git_fetch_options fetch_opts","int bare","git_clone_local_t local","const char * checkout_branch","git_repository_create_cb repository_cb","void * repository_cb_payload","git_remote_create_cb remote_cb","void * remote_cb_payload"],"type":"struct","value":"git_clone_options","file":"git2/clone.h","line":103,"lineto":164,"block":"unsigned int version\ngit_checkout_options checkout_opts\ngit_fetch_options fetch_opts\nint bare\ngit_clone_local_t local\nconst char * checkout_branch\ngit_repository_create_cb repository_cb\nvoid * repository_cb_payload\ngit_remote_create_cb remote_cb\nvoid * remote_cb_payload","tdef":"typedef","description":" Clone options structure","comments":"<p>Use the GIT_CLONE_OPTIONS_INIT to get the default settings, like this:</p>\n\n<pre><code> git_clone_options opts = GIT_CLONE_OPTIONS_INIT;\n</code></pre>\n","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"git_checkout_options","name":"checkout_opts","comments":" These options are passed to the checkout step. To disable\n checkout, set the `checkout_strategy` to\n `GIT_CHECKOUT_NONE`."},{"type":"git_fetch_options","name":"fetch_opts","comments":" Options which control the fetch, including callbacks.\n\n The callbacks are used for reporting fetch progress, and for acquiring\n credentials in the event they are needed."},{"type":"int","name":"bare","comments":" Set to zero (false) to create a standard repo, or non-zero\n for a bare repo"},{"type":"git_clone_local_t","name":"local","comments":" Whether to use a fetch or copy the object database."},{"type":"const char *","name":"checkout_branch","comments":" The name of the branch to checkout. NULL means use the\n remote's default branch."},{"type":"git_repository_create_cb","name":"repository_cb","comments":" A callback used to create the new repository into which to\n clone. If NULL, the 'bare' field will be used to determine\n whether to create a bare repository."},{"type":"void *","name":"repository_cb_payload","comments":" An opaque payload to pass to the git_repository creation callback.\n This parameter is ignored unless repository_cb is non-NULL."},{"type":"git_remote_create_cb","name":"remote_cb","comments":" A callback used to create the git_remote, prior to its being\n used to perform the clone operation. See the documentation for\n git_remote_create_cb for details. This parameter may be NULL,\n indicating that git_clone should provide default behavior."},{"type":"void *","name":"remote_cb_payload","comments":" An opaque payload to pass to the git_remote creation callback.\n This parameter is ignored unless remote_cb is non-NULL."}],"used":{"returns":[],"needs":["git_clone","git_clone_init_options"]}}],["git_commit",{"decl":"git_commit","type":"struct","value":"git_commit","file":"git2/types.h","line":123,"lineto":123,"tdef":"typedef","description":" Parsed representation of a commit object. ","comments":"","used":{"returns":[],"needs":["git_branch_create","git_cherrypick","git_cherrypick_commit","git_commit_amend","git_commit_author","git_commit_body","git_commit_committer","git_commit_create","git_commit_create_buffer","git_commit_dup","git_commit_free","git_commit_header_field","git_commit_id","git_commit_lookup","git_commit_lookup_prefix","git_commit_message","git_commit_message_encoding","git_commit_message_raw","git_commit_nth_gen_ancestor","git_commit_owner","git_commit_parent","git_commit_parent_id","git_commit_parentcount","git_commit_raw_header","git_commit_summary","git_commit_time","git_commit_time_offset","git_commit_tree","git_commit_tree_id","git_diff_commit_as_email","git_merge_commits","git_note_commit_create","git_note_commit_iterator_new","git_note_commit_read","git_note_commit_remove","git_revert","git_revert_commit"]}}],["git_config",{"decl":"git_config","type":"struct","value":"git_config","file":"git2/types.h","line":141,"lineto":141,"tdef":"typedef","description":" Memory representation of a set of config files ","comments":"","used":{"returns":[],"needs":["git_config_add_file_ondisk","git_config_backend_foreach_match","git_config_delete_entry","git_config_delete_multivar","git_config_entry_free","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_foreach","git_config_get_path","git_config_get_string","git_config_get_string_buf","git_config_iterator_free","git_config_iterator_glob_new","git_config_iterator_new","git_config_lock","git_config_multivar_iterator_new","git_config_new","git_config_next","git_config_open_default","git_config_open_global","git_config_open_level","git_config_open_ondisk","git_config_set_bool","git_config_set_int32","git_config_set_int64","git_config_set_multivar","git_config_set_string","git_config_snapshot","git_repository_config","git_repository_config_snapshot"]}}],["git_config_backend",{"decl":"git_config_backend","type":"struct","value":"git_config_backend","file":"git2/types.h","line":144,"lineto":144,"block":"unsigned int version\nint readonly\nstruct git_config git_config\nstruct git_config * cfg\nint (*)(struct git_config_backend *, int, const int *) open\nint (*)(struct git_config_backend *, const char *, int **) get\nint (*)(struct git_config_backend *, const char *, const char *) set\nint (*)(struct git_config_backend *, const char *, const char *, const char *) set_multivar\nint (*)(struct git_config_backend *, const char *) del\nint (*)(struct git_config_backend *, const char *, const char *) del_multivar\nint (*)(int **, struct git_config_backend *) iterator\nint (*)(struct git_config_backend **, struct git_config_backend *) snapshot\nint (*)(struct git_config_backend *) lock\nint (*)(struct git_config_backend *, int) unlock\nvoid (*)(struct git_config_backend *) free","tdef":"typedef","description":" Interface to access a configuration file ","comments":"","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"int","name":"readonly","comments":" True if this backend is for a snapshot "},{"type":"struct git_config","name":"git_config","comments":""},{"type":"struct git_config *","name":"cfg","comments":""},{"type":"int (*)(struct git_config_backend *, int, const int *)","name":"open","comments":""},{"type":"int (*)(struct git_config_backend *, const char *, int **)","name":"get","comments":""},{"type":"int (*)(struct git_config_backend *, const char *, const char *)","name":"set","comments":""},{"type":"int (*)(struct git_config_backend *, const char *, const char *, const char *)","name":"set_multivar","comments":""},{"type":"int (*)(struct git_config_backend *, const char *)","name":"del","comments":""},{"type":"int (*)(struct git_config_backend *, const char *, const char *)","name":"del_multivar","comments":""},{"type":"int (*)(int **, struct git_config_backend *)","name":"iterator","comments":""},{"type":"int (*)(struct git_config_backend **, struct git_config_backend *)","name":"snapshot","comments":" Produce a read-only version of this backend "},{"type":"int (*)(struct git_config_backend *)","name":"lock","comments":" Lock this backend.\n\n Prevent any writes to the data store backing this\n backend. Any updates must not be visible to any other\n readers."},{"type":"int (*)(struct git_config_backend *, int)","name":"unlock","comments":" Unlock the data store backing this backend. If success is\n true, the changes should be committed, otherwise rolled\n back."},{"type":"void (*)(struct git_config_backend *)","name":"free","comments":""}],"used":{"returns":[],"needs":["git_config_backend_foreach_match"]}}],["git_config_entry",{"decl":["const char * name","const char * value","git_config_level_t level","void (*)(struct git_config_entry *) free","void * payload"],"type":"struct","value":"git_config_entry","file":"git2/config.h","line":64,"lineto":70,"block":"const char * name\nconst char * value\ngit_config_level_t level\nvoid (*)(struct git_config_entry *) free\nvoid * payload","tdef":"typedef","description":" An entry in a configuration file","comments":"","fields":[{"type":"const char *","name":"name","comments":" Name of the entry (normalised) "},{"type":"const char *","name":"value","comments":" String value of the entry "},{"type":"git_config_level_t","name":"level","comments":" Which config file this was found in "},{"type":"void (*)(struct git_config_entry *)","name":"free","comments":" Free function for this entry "},{"type":"void *","name":"payload","comments":" Opaque value for the free function. Do not read or write "}],"used":{"returns":[],"needs":["git_config_entry_free","git_config_get_entry","git_config_next"]}}],["git_config_level_t",{"decl":["GIT_CONFIG_LEVEL_PROGRAMDATA","GIT_CONFIG_LEVEL_SYSTEM","GIT_CONFIG_LEVEL_XDG","GIT_CONFIG_LEVEL_GLOBAL","GIT_CONFIG_LEVEL_LOCAL","GIT_CONFIG_LEVEL_APP","GIT_CONFIG_HIGHEST_LEVEL"],"type":"enum","file":"git2/config.h","line":31,"lineto":59,"block":"GIT_CONFIG_LEVEL_PROGRAMDATA\nGIT_CONFIG_LEVEL_SYSTEM\nGIT_CONFIG_LEVEL_XDG\nGIT_CONFIG_LEVEL_GLOBAL\nGIT_CONFIG_LEVEL_LOCAL\nGIT_CONFIG_LEVEL_APP\nGIT_CONFIG_HIGHEST_LEVEL","tdef":"typedef","description":" Priority level of a config file.\n These priority levels correspond to the natural escalation logic\n (from higher to lower) when searching for config entries in git.git.","comments":"<p>git_config_open_default() and git_repository_config() honor those priority levels as well.</p>\n","fields":[{"type":"int","name":"GIT_CONFIG_LEVEL_PROGRAMDATA","comments":"<p>System-wide on Windows, for compatibility with portable git </p>\n","value":1},{"type":"int","name":"GIT_CONFIG_LEVEL_SYSTEM","comments":"<p>System-wide configuration file; /etc/gitconfig on Linux systems </p>\n","value":2},{"type":"int","name":"GIT_CONFIG_LEVEL_XDG","comments":"<p>XDG compatible configuration file; typically ~/.config/git/config </p>\n","value":3},{"type":"int","name":"GIT_CONFIG_LEVEL_GLOBAL","comments":"<p>User-specific configuration file (also called Global configuration\n file); typically ~/.gitconfig</p>\n","value":4},{"type":"int","name":"GIT_CONFIG_LEVEL_LOCAL","comments":"<p>Repository specific configuration file; $WORK_DIR/.git/config on\n non-bare repos</p>\n","value":5},{"type":"int","name":"GIT_CONFIG_LEVEL_APP","comments":"<p>Application specific configuration file; freely defined by applications</p>\n","value":6},{"type":"int","name":"GIT_CONFIG_HIGHEST_LEVEL","comments":"<p>Represents the highest level available config file (i.e. the most\n specific config file available that actually is loaded)</p>\n","value":-1}],"used":{"returns":[],"needs":["git_config_add_file_ondisk","git_config_open_level"]}}],["git_cred_default",{"decl":"git_cred_default","type":"struct","value":"git_cred_default","file":"git2/transport.h","line":176,"lineto":176,"tdef":"typedef","description":" A key for NTLM/Kerberos \"default\" credentials ","comments":"","used":{"returns":[],"needs":[]}}],["git_cred_ssh_custom",{"decl":["git_cred parent","char * username","char * publickey","size_t publickey_len","git_cred_sign_callback sign_callback","void * payload"],"type":"struct","value":"git_cred_ssh_custom","file":"git2/transport.h","line":166,"lineto":173,"block":"git_cred parent\nchar * username\nchar * publickey\nsize_t publickey_len\ngit_cred_sign_callback sign_callback\nvoid * payload","tdef":"typedef","description":" A key with a custom signature function","comments":"","fields":[{"type":"git_cred","name":"parent","comments":""},{"type":"char *","name":"username","comments":""},{"type":"char *","name":"publickey","comments":""},{"type":"size_t","name":"publickey_len","comments":""},{"type":"git_cred_sign_callback","name":"sign_callback","comments":""},{"type":"void *","name":"payload","comments":""}],"used":{"returns":[],"needs":[]}}],["git_cred_ssh_interactive",{"decl":["git_cred parent","char * username","git_cred_ssh_interactive_callback prompt_callback","void * payload"],"type":"struct","value":"git_cred_ssh_interactive","file":"git2/transport.h","line":156,"lineto":161,"block":"git_cred parent\nchar * username\ngit_cred_ssh_interactive_callback prompt_callback\nvoid * payload","tdef":"typedef","description":" Keyboard-interactive based ssh authentication","comments":"","fields":[{"type":"git_cred","name":"parent","comments":""},{"type":"char *","name":"username","comments":""},{"type":"git_cred_ssh_interactive_callback","name":"prompt_callback","comments":""},{"type":"void *","name":"payload","comments":""}],"used":{"returns":[],"needs":["git_cred_ssh_interactive_new"]}}],["git_cred_ssh_key",{"decl":["git_cred parent","char * username","char * publickey","char * privatekey","char * passphrase"],"type":"struct","value":"git_cred_ssh_key","file":"git2/transport.h","line":145,"lineto":151,"block":"git_cred parent\nchar * username\nchar * publickey\nchar * privatekey\nchar * passphrase","tdef":"typedef","description":" A ssh key from disk","comments":"","fields":[{"type":"git_cred","name":"parent","comments":""},{"type":"char *","name":"username","comments":""},{"type":"char *","name":"publickey","comments":""},{"type":"char *","name":"privatekey","comments":""},{"type":"char *","name":"passphrase","comments":""}],"used":{"returns":[],"needs":[]}}],["git_cred_username",{"decl":["git_cred parent","char [1] username"],"type":"struct","value":"git_cred_username","file":"git2/transport.h","line":179,"lineto":182,"block":"git_cred parent\nchar [1] username","tdef":"typedef","description":" Username-only credential information ","comments":"","fields":[{"type":"git_cred","name":"parent","comments":""},{"type":"char [1]","name":"username","comments":""}],"used":{"returns":[],"needs":[]}}],["git_cred_userpass_payload",{"decl":["const char * username","const char * password"],"type":"struct","value":"git_cred_userpass_payload","file":"git2/cred_helpers.h","line":24,"lineto":27,"block":"const char * username\nconst char * password","tdef":"typedef","description":" Payload for git_cred_stock_userpass_plaintext.","comments":"","fields":[{"type":"const char *","name":"username","comments":""},{"type":"const char *","name":"password","comments":""}],"used":{"returns":[],"needs":[]}}],["git_cred_userpass_plaintext",{"decl":["git_cred parent","char * username","char * password"],"type":"struct","value":"git_cred_userpass_plaintext","file":"git2/transport.h","line":122,"lineto":126,"block":"git_cred parent\nchar * username\nchar * password","tdef":"typedef","description":" A plaintext username and password ","comments":"","fields":[{"type":"git_cred","name":"parent","comments":""},{"type":"char *","name":"username","comments":""},{"type":"char *","name":"password","comments":""}],"used":{"returns":[],"needs":[]}}],["git_credtype_t",{"decl":["GIT_CREDTYPE_USERPASS_PLAINTEXT","GIT_CREDTYPE_SSH_KEY","GIT_CREDTYPE_SSH_CUSTOM","GIT_CREDTYPE_DEFAULT","GIT_CREDTYPE_SSH_INTERACTIVE","GIT_CREDTYPE_USERNAME","GIT_CREDTYPE_SSH_MEMORY"],"type":"enum","file":"git2/transport.h","line":81,"lineto":111,"block":"GIT_CREDTYPE_USERPASS_PLAINTEXT\nGIT_CREDTYPE_SSH_KEY\nGIT_CREDTYPE_SSH_CUSTOM\nGIT_CREDTYPE_DEFAULT\nGIT_CREDTYPE_SSH_INTERACTIVE\nGIT_CREDTYPE_USERNAME\nGIT_CREDTYPE_SSH_MEMORY","tdef":"typedef","description":" Authentication type requested ","comments":"","fields":[{"type":"int","name":"GIT_CREDTYPE_USERPASS_PLAINTEXT","comments":"","value":1},{"type":"int","name":"GIT_CREDTYPE_SSH_KEY","comments":"","value":2},{"type":"int","name":"GIT_CREDTYPE_SSH_CUSTOM","comments":"","value":4},{"type":"int","name":"GIT_CREDTYPE_DEFAULT","comments":"","value":8},{"type":"int","name":"GIT_CREDTYPE_SSH_INTERACTIVE","comments":"","value":16},{"type":"int","name":"GIT_CREDTYPE_USERNAME","comments":"<p>Username-only information</p>\n\n<p>If the SSH transport does not know which username to use,\n it will ask via this credential type.</p>\n","value":32},{"type":"int","name":"GIT_CREDTYPE_SSH_MEMORY","comments":"<p>Credentials read from memory.</p>\n\n<p>Only available for libssh2+OpenSSL for now.</p>\n","value":64}],"used":{"returns":[],"needs":[]}}],["git_cvar_map",{"decl":["git_cvar_t cvar_type","const char * str_match","int map_value"],"type":"struct","value":"git_cvar_map","file":"git2/config.h","line":93,"lineto":97,"block":"git_cvar_t cvar_type\nconst char * str_match\nint map_value","tdef":"typedef","description":" Mapping from config variables to values.","comments":"","fields":[{"type":"git_cvar_t","name":"cvar_type","comments":""},{"type":"const char *","name":"str_match","comments":""},{"type":"int","name":"map_value","comments":""}],"used":{"returns":[],"needs":["git_config_get_mapped","git_config_lookup_map_value"]}}],["git_cvar_t",{"decl":["GIT_CVAR_FALSE","GIT_CVAR_TRUE","GIT_CVAR_INT32","GIT_CVAR_STRING"],"type":"enum","file":"git2/config.h","line":83,"lineto":88,"block":"GIT_CVAR_FALSE\nGIT_CVAR_TRUE\nGIT_CVAR_INT32\nGIT_CVAR_STRING","tdef":"typedef","description":" Config var type","comments":"","fields":[{"type":"int","name":"GIT_CVAR_FALSE","comments":"","value":0},{"type":"int","name":"GIT_CVAR_TRUE","comments":"","value":1},{"type":"int","name":"GIT_CVAR_INT32","comments":"","value":2},{"type":"int","name":"GIT_CVAR_STRING","comments":"","value":3}],"used":{"returns":[],"needs":[]}}],["git_delta_t",{"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","GIT_DELTA_UNREADABLE","GIT_DELTA_CONFLICTED"],"type":"enum","file":"git2/diff.h","line":252,"lineto":264,"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\nGIT_DELTA_UNREADABLE\nGIT_DELTA_CONFLICTED","tdef":"typedef","description":" What type of change is described by a git_diff_delta?","comments":"<p><code>GIT_DELTA_RENAMED</code> and <code>GIT_DELTA_COPIED</code> will only show up if you run <code>git_diff_find_similar()</code> on the diff object.</p>\n\n<p><code>GIT_DELTA_TYPECHANGE</code> only shows up given <code>GIT_DIFF_INCLUDE_TYPECHANGE</code> in the option flags (otherwise type changes will be split into ADDED / DELETED pairs).</p>\n","fields":[{"type":"int","name":"GIT_DELTA_UNMODIFIED","comments":"<p>no changes </p>\n","value":0},{"type":"int","name":"GIT_DELTA_ADDED","comments":"<p>entry does not exist in old version </p>\n","value":1},{"type":"int","name":"GIT_DELTA_DELETED","comments":"<p>entry does not exist in new version </p>\n","value":2},{"type":"int","name":"GIT_DELTA_MODIFIED","comments":"<p>entry content changed between old and new </p>\n","value":3},{"type":"int","name":"GIT_DELTA_RENAMED","comments":"<p>entry was renamed between old and new </p>\n","value":4},{"type":"int","name":"GIT_DELTA_COPIED","comments":"<p>entry was copied from another old entry </p>\n","value":5},{"type":"int","name":"GIT_DELTA_IGNORED","comments":"<p>entry is ignored item in workdir </p>\n","value":6},{"type":"int","name":"GIT_DELTA_UNTRACKED","comments":"<p>entry is untracked item in workdir </p>\n","value":7},{"type":"int","name":"GIT_DELTA_TYPECHANGE","comments":"<p>type of entry changed between old and new </p>\n","value":8},{"type":"int","name":"GIT_DELTA_UNREADABLE","comments":"<p>entry is unreadable </p>\n","value":9},{"type":"int","name":"GIT_DELTA_CONFLICTED","comments":"<p>entry in the index is conflicted </p>\n","value":10}],"used":{"returns":[],"needs":["git_diff_num_deltas_of_type","git_diff_status_char"]}}],["git_describe_format_options",{"decl":["unsigned int version","unsigned int abbreviated_size","int always_use_long_format","const char * dirty_suffix"],"type":"struct","value":"git_describe_format_options","file":"git2/describe.h","line":78,"lineto":98,"block":"unsigned int version\nunsigned int abbreviated_size\nint always_use_long_format\nconst char * dirty_suffix","tdef":"typedef","description":" Options for formatting the describe string","comments":"","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"unsigned int","name":"abbreviated_size","comments":" Size of the abbreviated commit id to use. This value is the\n lower bound for the length of the abbreviated string. The\n default is 7."},{"type":"int","name":"always_use_long_format","comments":" Set to use the long format even when a shorter name could be used."},{"type":"const char *","name":"dirty_suffix","comments":" If the workdir is dirty and this is set, this string will\n be appended to the description string."}],"used":{"returns":[],"needs":["git_describe_format"]}}],["git_describe_options",{"decl":["unsigned int version","unsigned int max_candidates_tags","unsigned int describe_strategy","const char * pattern","int only_follow_first_parent","int show_commit_oid_as_fallback"],"type":"struct","value":"git_describe_options","file":"git2/describe.h","line":44,"lineto":62,"block":"unsigned int version\nunsigned int max_candidates_tags\nunsigned int describe_strategy\nconst char * pattern\nint only_follow_first_parent\nint show_commit_oid_as_fallback","tdef":"typedef","description":" Describe options structure","comments":"<p>Initialize with <code>GIT_DESCRIBE_OPTIONS_INIT</code> macro to correctly set the <code>version</code> field. E.g.</p>\n\n<pre><code> git_describe_options opts = GIT_DESCRIBE_OPTIONS_INIT;\n</code></pre>\n","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"unsigned int","name":"max_candidates_tags","comments":" default: 10 "},{"type":"unsigned int","name":"describe_strategy","comments":" default: GIT_DESCRIBE_DEFAULT "},{"type":"const char *","name":"pattern","comments":""},{"type":"int","name":"only_follow_first_parent","comments":" When calculating the distance from the matching tag or\n reference, only walk down the first-parent ancestry."},{"type":"int","name":"show_commit_oid_as_fallback","comments":" If no matching tag or reference is found, the describe\n operation would normally fail. If this option is set, it\n will instead fall back to showing the full id of the\n commit."}],"used":{"returns":[],"needs":["git_describe_commit","git_describe_workdir"]}}],["git_describe_result",{"decl":"git_describe_result","type":"struct","value":"git_describe_result","file":"git2/describe.h","line":111,"lineto":111,"tdef":"typedef","description":" A struct that stores the result of a describe operation.","comments":"","used":{"returns":[],"needs":["git_describe_commit","git_describe_format","git_describe_result_free","git_describe_workdir"]}}],["git_describe_strategy_t",{"decl":["GIT_DESCRIBE_DEFAULT","GIT_DESCRIBE_TAGS","GIT_DESCRIBE_ALL"],"type":"enum","file":"git2/describe.h","line":30,"lineto":34,"block":"GIT_DESCRIBE_DEFAULT\nGIT_DESCRIBE_TAGS\nGIT_DESCRIBE_ALL","tdef":"typedef","description":" Reference lookup strategy","comments":"<p>These behave like the --tags and --all options to git-describe, namely they say to look for any reference in either refs/tags/ or refs/ respectively.</p>\n","fields":[{"type":"int","name":"GIT_DESCRIBE_DEFAULT","comments":"","value":0},{"type":"int","name":"GIT_DESCRIBE_TAGS","comments":"","value":1},{"type":"int","name":"GIT_DESCRIBE_ALL","comments":"","value":2}],"used":{"returns":[],"needs":[]}}],["git_diff",{"decl":"git_diff","type":"struct","value":"git_diff","file":"git2/diff.h","line":225,"lineto":225,"tdef":"typedef","description":" The diff object that contains all individual file deltas.","comments":"<p>This is an opaque structure which will be allocated by one of the diff generator functions below (such as <code>git_diff_tree_to_tree</code>). You are responsible for releasing the object memory when done, using the <code>git_diff_free()</code> function.</p>\n","used":{"returns":["git_diff_get_delta","git_patch_get_delta"],"needs":["git_checkout_notify_cb","git_diff_binary_cb","git_diff_blob_to_buffer","git_diff_blobs","git_diff_buffers","git_diff_commit_as_email","git_diff_file_cb","git_diff_find_init_options","git_diff_find_similar","git_diff_foreach","git_diff_format_email","git_diff_format_email_init_options","git_diff_free","git_diff_from_buffer","git_diff_get_delta","git_diff_get_stats","git_diff_hunk_cb","git_diff_index_to_index","git_diff_index_to_workdir","git_diff_init_options","git_diff_is_sorted_icase","git_diff_line_cb","git_diff_merge","git_diff_notify_cb","git_diff_num_deltas","git_diff_num_deltas_of_type","git_diff_patchid","git_diff_patchid_init_options","git_diff_print","git_diff_progress_cb","git_diff_stats_deletions","git_diff_stats_files_changed","git_diff_stats_free","git_diff_stats_insertions","git_diff_stats_to_buf","git_diff_to_buf","git_diff_tree_to_index","git_diff_tree_to_tree","git_diff_tree_to_workdir","git_diff_tree_to_workdir_with_index","git_patch_from_blob_and_buffer","git_patch_from_blobs","git_patch_from_buffers","git_patch_from_diff","git_patch_get_hunk","git_patch_get_line_in_hunk","git_patch_print"]}}],["git_diff_binary",{"decl":["unsigned int contains_data","git_diff_binary_file old_file","git_diff_binary_file new_file"],"type":"struct","value":"git_diff_binary","file":"git2/diff.h","line":498,"lineto":509,"block":"unsigned int contains_data\ngit_diff_binary_file old_file\ngit_diff_binary_file new_file","tdef":"typedef","description":" Structure describing the binary contents of a diff. ","comments":"","fields":[{"type":"unsigned int","name":"contains_data","comments":" Whether there is data in this binary structure or not. If this\n is `1`, then this was produced and included binary content. If\n this is `0` then this was generated knowing only that a binary\n file changed but without providing the data, probably from a patch\n that said `Binary files a/file.txt and b/file.txt differ`."},{"type":"git_diff_binary_file","name":"old_file","comments":" The contents of the old file. "},{"type":"git_diff_binary_file","name":"new_file","comments":" The contents of the new file. "}],"used":{"returns":[],"needs":["git_diff_binary_cb","git_diff_blob_to_buffer","git_diff_blobs","git_diff_buffers","git_diff_foreach"]}}],["git_diff_binary_file",{"decl":["git_diff_binary_t type","const char * data","size_t datalen","size_t inflatedlen"],"type":"struct","value":"git_diff_binary_file","file":"git2/diff.h","line":483,"lineto":495,"block":"git_diff_binary_t type\nconst char * data\nsize_t datalen\nsize_t inflatedlen","tdef":"typedef","description":" The contents of one of the files in a binary diff. ","comments":"","fields":[{"type":"git_diff_binary_t","name":"type","comments":" The type of binary data for this file. "},{"type":"const char *","name":"data","comments":" The binary data, deflated. "},{"type":"size_t","name":"datalen","comments":" The length of the binary data. "},{"type":"size_t","name":"inflatedlen","comments":" The length of the binary data after inflation. "}],"used":{"returns":[],"needs":[]}}],["git_diff_binary_t",{"decl":["GIT_DIFF_BINARY_NONE","GIT_DIFF_BINARY_LITERAL","GIT_DIFF_BINARY_DELTA"],"type":"enum","file":"git2/diff.h","line":471,"lineto":480,"block":"GIT_DIFF_BINARY_NONE\nGIT_DIFF_BINARY_LITERAL\nGIT_DIFF_BINARY_DELTA","tdef":"typedef","description":" When producing a binary diff, the binary data returned will be\n either the deflated full (\"literal\") contents of the file, or\n the deflated binary delta between the two sides (whichever is\n smaller).","comments":"","fields":[{"type":"int","name":"GIT_DIFF_BINARY_NONE","comments":"<p>There is no binary delta. </p>\n","value":0},{"type":"int","name":"GIT_DIFF_BINARY_LITERAL","comments":"<p>The binary data is the literal contents of the file. </p>\n","value":1},{"type":"int","name":"GIT_DIFF_BINARY_DELTA","comments":"<p>The binary data is the delta from one side to the other. </p>\n","value":2}],"used":{"returns":[],"needs":[]}}],["git_diff_delta",{"decl":["git_delta_t status","uint32_t flags","uint16_t similarity","uint16_t nfiles","git_diff_file old_file","git_diff_file new_file"],"type":"struct","value":"git_diff_delta","file":"git2/diff.h","line":337,"lineto":344,"block":"git_delta_t status\nuint32_t flags\nuint16_t similarity\nuint16_t nfiles\ngit_diff_file old_file\ngit_diff_file new_file","tdef":"typedef","description":" Description of changes to one entry.","comments":"<p>When iterating over a diff, this will be passed to most callbacks and you can use the contents to understand exactly what has changed.</p>\n\n<p>The <code>old_file</code> represents the "from" side of the diff and the <code>new_file</code> represents to "to" side of the diff. What those means depend on the function that was used to generate the diff and will be documented below. You 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 "old_file" and "new_file", they actually may correspond to entries that represent a file, a symbolic link, a submodule commit id, or even a tree (if you are tracking type changes or ignored/untracked directories).</p>\n\n<p>Under some circumstances, in the name of efficiency, not all fields will be filled in, but we generally try to fill in as much as possible. One example is that the "flags" field may not have either the <code>BINARY</code> or the <code>NOT_BINARY</code> flag set to avoid examining file contents if you do not pass in hunk and/or line callbacks to the diff foreach iteration function. It will just use the git attributes for those files.</p>\n\n<p>The similarity score is zero unless you call <code>git_diff_find_similar()</code> which does a similarity analysis of files in the diff. Use that function to do rename and copy detection, and to split heavily modified files in add/delete pairs. After that call, deltas with a status of GIT_DELTA_RENAMED or GIT_DELTA_COPIED will have a similarity score between 0 and 100 indicating how similar the old and new sides are.</p>\n\n<p>If you ask <code>git_diff_find_similar</code> to find heavily modified files to break, but to not <em>actually</em> break the records, then GIT_DELTA_MODIFIED records may have a non-zero similarity score if the self-similarity is below the split threshold. To display this value like core Git, invert the score (a la <code>printf("M%03d", 100 - delta->similarity)</code>).</p>\n","fields":[{"type":"git_delta_t","name":"status","comments":""},{"type":"uint32_t","name":"flags","comments":" git_diff_flag_t values "},{"type":"uint16_t","name":"similarity","comments":" for RENAMED and COPIED, value 0-100 "},{"type":"uint16_t","name":"nfiles","comments":" number of files in this delta "},{"type":"git_diff_file","name":"old_file","comments":""},{"type":"git_diff_file","name":"new_file","comments":""}],"used":{"returns":["git_diff_get_delta","git_patch_get_delta"],"needs":["git_diff_binary_cb","git_diff_file_cb","git_diff_hunk_cb","git_diff_line_cb","git_diff_notify_cb"]}}],["git_diff_file",{"decl":["git_oid id","const char * path","git_off_t size","uint32_t flags","uint16_t mode","uint16_t id_abbrev"],"type":"struct","value":"git_diff_file","file":"git2/diff.h","line":292,"lineto":299,"block":"git_oid id\nconst char * path\ngit_off_t size\nuint32_t flags\nuint16_t mode\nuint16_t id_abbrev","tdef":"typedef","description":" Description of one side of a delta.","comments":"<p>Although this is called a "file", it could represent a file, a symbolic link, a submodule commit id, or even a tree (although that only if you are tracking type changes or ignored/untracked directories).</p>\n\n<p>The <code>id</code> is the <code>git_oid</code> of the item. If the entry represents an absent side of a diff (e.g. the <code>old_file</code> of a <code>GIT_DELTA_ADDED</code> delta), then the oid will be zeroes.</p>\n\n<p><code>path</code> is the NUL-terminated path to the entry relative to the working directory 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 be restricted to one of the <code>git_filemode_t</code> values.</p>\n\n<p>The <code>id_abbrev</code> represents the known length of the <code>id</code> field, when converted to a hex string. It is generally <code>GIT_OID_HEXSZ</code>, unless this delta was created from reading a patch file, in which case it may be abbreviated to something reasonable, like 7 characters.</p>\n","fields":[{"type":"git_oid","name":"id","comments":""},{"type":"const char *","name":"path","comments":""},{"type":"git_off_t","name":"size","comments":""},{"type":"uint32_t","name":"flags","comments":""},{"type":"uint16_t","name":"mode","comments":""},{"type":"uint16_t","name":"id_abbrev","comments":""}],"used":{"returns":[],"needs":["git_checkout_notify_cb","git_diff_blob_to_buffer","git_diff_blobs","git_diff_buffers","git_diff_foreach"]}}],["git_diff_find_options",{"decl":["unsigned int version","uint32_t flags","uint16_t rename_threshold","uint16_t rename_from_rewrite_threshold","uint16_t copy_threshold","uint16_t break_rewrite_threshold","size_t rename_limit","git_diff_similarity_metric * metric"],"type":"struct","value":"git_diff_find_options","file":"git2/diff.h","line":703,"lineto":729,"block":"unsigned int version\nuint32_t flags\nuint16_t rename_threshold\nuint16_t rename_from_rewrite_threshold\nuint16_t copy_threshold\nuint16_t break_rewrite_threshold\nsize_t rename_limit\ngit_diff_similarity_metric * metric","tdef":"typedef","description":" Control behavior of rename and copy detection","comments":"<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 - <code>copy_threshold</code> is the same as the -C option with a value - <code>rename_from_rewrite_threshold</code> matches the top of the -B option - <code>break_rewrite_threshold</code> matches the bottom of the -B option - <code>rename_limit</code> is the maximum number of matches to consider for a particular file. This is a little different from the <code>-l</code> option to regular Git because we will still process up to this many matches before abandoning the search.</li>\n</ul>\n\n<p>The <code>metric</code> option allows you to plug in a custom similarity metric. Set it to NULL for the default internal metric which is based on sampling hashes of ranges of data in the file. The default metric is a pretty good similarity approximation that should work fairly well for both text and binary data, and is pretty fast with fixed memory overhead.</p>\n","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"uint32_t","name":"flags","comments":" Combination of git_diff_find_t values (default GIT_DIFF_FIND_BY_CONFIG).\n NOTE: if you don't explicitly set this, `diff.renames` could be set\n to false, resulting in `git_diff_find_similar` doing nothing."},{"type":"uint16_t","name":"rename_threshold","comments":" Similarity to consider a file renamed (default 50) "},{"type":"uint16_t","name":"rename_from_rewrite_threshold","comments":" Similarity of modified to be eligible rename source (default 50) "},{"type":"uint16_t","name":"copy_threshold","comments":" Similarity to consider a file a copy (default 50) "},{"type":"uint16_t","name":"break_rewrite_threshold","comments":" Similarity to split modify into delete/add pair (default 60) "},{"type":"size_t","name":"rename_limit","comments":" Maximum similarity sources to examine for a file (somewhat like\n git-diff's `-l` option or `diff.renameLimit` config) (default 200)"},{"type":"git_diff_similarity_metric *","name":"metric","comments":" Pluggable similarity metric; pass NULL to use internal metric "}],"used":{"returns":[],"needs":["git_diff_find_init_options","git_diff_find_similar"]}}],["git_diff_find_t",{"decl":["GIT_DIFF_FIND_BY_CONFIG","GIT_DIFF_FIND_RENAMES","GIT_DIFF_FIND_RENAMES_FROM_REWRITES","GIT_DIFF_FIND_COPIES","GIT_DIFF_FIND_COPIES_FROM_UNMODIFIED","GIT_DIFF_FIND_REWRITES","GIT_DIFF_BREAK_REWRITES","GIT_DIFF_FIND_AND_BREAK_REWRITES","GIT_DIFF_FIND_FOR_UNTRACKED","GIT_DIFF_FIND_ALL","GIT_DIFF_FIND_IGNORE_LEADING_WHITESPACE","GIT_DIFF_FIND_IGNORE_WHITESPACE","GIT_DIFF_FIND_DONT_IGNORE_WHITESPACE","GIT_DIFF_FIND_EXACT_MATCH_ONLY","GIT_DIFF_BREAK_REWRITES_FOR_RENAMES_ONLY","GIT_DIFF_FIND_REMOVE_UNMODIFIED"],"type":"enum","file":"git2/diff.h","line":597,"lineto":666,"block":"GIT_DIFF_FIND_BY_CONFIG\nGIT_DIFF_FIND_RENAMES\nGIT_DIFF_FIND_RENAMES_FROM_REWRITES\nGIT_DIFF_FIND_COPIES\nGIT_DIFF_FIND_COPIES_FROM_UNMODIFIED\nGIT_DIFF_FIND_REWRITES\nGIT_DIFF_BREAK_REWRITES\nGIT_DIFF_FIND_AND_BREAK_REWRITES\nGIT_DIFF_FIND_FOR_UNTRACKED\nGIT_DIFF_FIND_ALL\nGIT_DIFF_FIND_IGNORE_LEADING_WHITESPACE\nGIT_DIFF_FIND_IGNORE_WHITESPACE\nGIT_DIFF_FIND_DONT_IGNORE_WHITESPACE\nGIT_DIFF_FIND_EXACT_MATCH_ONLY\nGIT_DIFF_BREAK_REWRITES_FOR_RENAMES_ONLY\nGIT_DIFF_FIND_REMOVE_UNMODIFIED","tdef":"typedef","description":" Flags to control the behavior of diff rename/copy detection.","comments":"","fields":[{"type":"int","name":"GIT_DIFF_FIND_BY_CONFIG","comments":"<p>Obey <code>diff.renames</code>. Overridden by any other GIT_DIFF_FIND_... flag. </p>\n","value":0},{"type":"int","name":"GIT_DIFF_FIND_RENAMES","comments":"<p>Look for renames? (<code>--find-renames</code>) </p>\n","value":1},{"type":"int","name":"GIT_DIFF_FIND_RENAMES_FROM_REWRITES","comments":"<p>Consider old side of MODIFIED for renames? (<code>--break-rewrites=N</code>) </p>\n","value":2},{"type":"int","name":"GIT_DIFF_FIND_COPIES","comments":"<p>Look for copies? (a la <code>--find-copies</code>). </p>\n","value":4},{"type":"int","name":"GIT_DIFF_FIND_COPIES_FROM_UNMODIFIED","comments":"<p>Consider UNMODIFIED as copy sources? (<code>--find-copies-harder</code>).</p>\n\n<p>For this to work correctly, use GIT_DIFF_INCLUDE_UNMODIFIED when\n the initial <code>git_diff</code> is being generated.</p>\n","value":8},{"type":"int","name":"GIT_DIFF_FIND_REWRITES","comments":"<p>Mark significant rewrites for split (<code>--break-rewrites=/M</code>) </p>\n","value":16},{"type":"int","name":"GIT_DIFF_BREAK_REWRITES","comments":"<p>Actually split large rewrites into delete/add pairs </p>\n","value":32},{"type":"int","name":"GIT_DIFF_FIND_AND_BREAK_REWRITES","comments":"<p>Mark rewrites for split and break into delete/add pairs </p>\n","value":48},{"type":"int","name":"GIT_DIFF_FIND_FOR_UNTRACKED","comments":"<p>Find renames/copies for UNTRACKED items in working directory.</p>\n\n<p>For this to work correctly, use GIT_DIFF_INCLUDE_UNTRACKED when the\n initial <code>git_diff</code> is being generated (and obviously the diff must\n be against the working directory for this to make sense).</p>\n","value":64},{"type":"int","name":"GIT_DIFF_FIND_ALL","comments":"<p>Turn on all finding features. </p>\n","value":255},{"type":"int","name":"GIT_DIFF_FIND_IGNORE_LEADING_WHITESPACE","comments":"<p>Measure similarity ignoring leading whitespace (default) </p>\n","value":0},{"type":"int","name":"GIT_DIFF_FIND_IGNORE_WHITESPACE","comments":"<p>Measure similarity ignoring all whitespace </p>\n","value":4096},{"type":"int","name":"GIT_DIFF_FIND_DONT_IGNORE_WHITESPACE","comments":"<p>Measure similarity including all data </p>\n","value":8192},{"type":"int","name":"GIT_DIFF_FIND_EXACT_MATCH_ONLY","comments":"<p>Measure similarity only by comparing SHAs (fast and cheap) </p>\n","value":16384},{"type":"int","name":"GIT_DIFF_BREAK_REWRITES_FOR_RENAMES_ONLY","comments":"<p>Do not break rewrites unless they contribute to a rename.</p>\n\n<p>Normally, GIT_DIFF_FIND_AND_BREAK_REWRITES will measure the self-\n similarity of modified files and split the ones that have changed a\n lot into a DELETE / ADD pair. Then the sides of that pair will be\n considered candidates for rename and copy detection.</p>\n\n<p>If you add this flag in and the split pair is <em>not</em> used for an\n actual rename or copy, then the modified record will be restored to\n a regular MODIFIED record instead of being split.</p>\n","value":32768},{"type":"int","name":"GIT_DIFF_FIND_REMOVE_UNMODIFIED","comments":"<p>Remove any UNMODIFIED deltas after find_similar is done.</p>\n\n<p>Using GIT_DIFF_FIND_COPIES_FROM_UNMODIFIED to emulate the\n --find-copies-harder behavior requires building a diff with the\n GIT_DIFF_INCLUDE_UNMODIFIED flag. If you do not want UNMODIFIED\n records in the final result, pass this flag to have them removed.</p>\n","value":65536}],"used":{"returns":[],"needs":[]}}],["git_diff_flag_t",{"decl":["GIT_DIFF_FLAG_BINARY","GIT_DIFF_FLAG_NOT_BINARY","GIT_DIFF_FLAG_VALID_ID","GIT_DIFF_FLAG_EXISTS"],"type":"enum","file":"git2/diff.h","line":235,"lineto":240,"block":"GIT_DIFF_FLAG_BINARY\nGIT_DIFF_FLAG_NOT_BINARY\nGIT_DIFF_FLAG_VALID_ID\nGIT_DIFF_FLAG_EXISTS","tdef":"typedef","description":" Flags for the delta object and the file objects on each side.","comments":"<p>These flags are used for both the <code>flags</code> value of the <code>git_diff_delta</code> and the flags for the <code>git_diff_file</code> objects representing the old and new sides of the delta. Values outside of this public range should be considered reserved for internal or future use.</p>\n","fields":[{"type":"int","name":"GIT_DIFF_FLAG_BINARY","comments":"<p>file(s) treated as binary data </p>\n","value":1},{"type":"int","name":"GIT_DIFF_FLAG_NOT_BINARY","comments":"<p>file(s) treated as text data </p>\n","value":2},{"type":"int","name":"GIT_DIFF_FLAG_VALID_ID","comments":"<p><code>id</code> value is known correct </p>\n","value":4},{"type":"int","name":"GIT_DIFF_FLAG_EXISTS","comments":"<p>file exists at this side of the delta </p>\n","value":8}],"used":{"returns":[],"needs":[]}}],["git_diff_format_email_flags_t",{"decl":["GIT_DIFF_FORMAT_EMAIL_NONE","GIT_DIFF_FORMAT_EMAIL_EXCLUDE_SUBJECT_PATCH_MARKER"],"type":"enum","file":"git2/diff.h","line":1321,"lineto":1328,"block":"GIT_DIFF_FORMAT_EMAIL_NONE\nGIT_DIFF_FORMAT_EMAIL_EXCLUDE_SUBJECT_PATCH_MARKER","tdef":"typedef","description":" Formatting options for diff e-mail generation","comments":"","fields":[{"type":"int","name":"GIT_DIFF_FORMAT_EMAIL_NONE","comments":"<p>Normal patch, the default </p>\n","value":0},{"type":"int","name":"GIT_DIFF_FORMAT_EMAIL_EXCLUDE_SUBJECT_PATCH_MARKER","comments":"<p>Don't insert "[PATCH]" in the subject header</p>\n","value":1}],"used":{"returns":[],"needs":["git_diff_commit_as_email"]}}],["git_diff_format_email_options",{"decl":["unsigned int version","git_diff_format_email_flags_t flags","size_t patch_no","size_t total_patches","const git_oid * id","const char * summary","const char * body","const git_signature * author"],"type":"struct","value":"git_diff_format_email_options","file":"git2/diff.h","line":1333,"lineto":1355,"block":"unsigned int version\ngit_diff_format_email_flags_t flags\nsize_t patch_no\nsize_t total_patches\nconst git_oid * id\nconst char * summary\nconst char * body\nconst git_signature * author","tdef":"typedef","description":" Options for controlling the formatting of the generated e-mail.","comments":"","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"git_diff_format_email_flags_t","name":"flags","comments":""},{"type":"size_t","name":"patch_no","comments":" This patch number "},{"type":"size_t","name":"total_patches","comments":" Total number of patches in this series "},{"type":"const git_oid *","name":"id","comments":" id to use for the commit "},{"type":"const char *","name":"summary","comments":" Summary of the change "},{"type":"const char *","name":"body","comments":" Commit message's body "},{"type":"const git_signature *","name":"author","comments":" Author of the change "}],"used":{"returns":[],"needs":["git_diff_format_email","git_diff_format_email_init_options"]}}],["git_diff_format_t",{"decl":["GIT_DIFF_FORMAT_PATCH","GIT_DIFF_FORMAT_PATCH_HEADER","GIT_DIFF_FORMAT_RAW","GIT_DIFF_FORMAT_NAME_ONLY","GIT_DIFF_FORMAT_NAME_STATUS"],"type":"enum","file":"git2/diff.h","line":1045,"lineto":1051,"block":"GIT_DIFF_FORMAT_PATCH\nGIT_DIFF_FORMAT_PATCH_HEADER\nGIT_DIFF_FORMAT_RAW\nGIT_DIFF_FORMAT_NAME_ONLY\nGIT_DIFF_FORMAT_NAME_STATUS","tdef":"typedef","description":" Possible output formats for diff data","comments":"","fields":[{"type":"int","name":"GIT_DIFF_FORMAT_PATCH","comments":"<p>full git diff </p>\n","value":1},{"type":"int","name":"GIT_DIFF_FORMAT_PATCH_HEADER","comments":"<p>just the file headers of patch </p>\n","value":2},{"type":"int","name":"GIT_DIFF_FORMAT_RAW","comments":"<p>like git diff --raw </p>\n","value":3},{"type":"int","name":"GIT_DIFF_FORMAT_NAME_ONLY","comments":"<p>like git diff --name-only </p>\n","value":4},{"type":"int","name":"GIT_DIFF_FORMAT_NAME_STATUS","comments":"<p>like git diff --name-status </p>\n","value":5}],"used":{"returns":[],"needs":["git_diff_print","git_diff_to_buf"]}}],["git_diff_hunk",{"decl":["int old_start","int old_lines","int new_start","int new_lines","size_t header_len","char [128] header"],"type":"struct","value":"git_diff_hunk","file":"git2/diff.h","line":523,"lineto":530,"block":"int old_start\nint old_lines\nint new_start\nint new_lines\nsize_t header_len\nchar [128] header","tdef":"typedef","description":" Structure describing a hunk of a diff.","comments":"","fields":[{"type":"int","name":"old_start","comments":" Starting line number in old_file "},{"type":"int","name":"old_lines","comments":" Number of lines in old_file "},{"type":"int","name":"new_start","comments":" Starting line number in new_file "},{"type":"int","name":"new_lines","comments":" Number of lines in new_file "},{"type":"size_t","name":"header_len","comments":" Number of bytes in header text "},{"type":"char [128]","name":"header","comments":" Header text, NUL-byte terminated "}],"used":{"returns":[],"needs":["git_diff_blob_to_buffer","git_diff_blobs","git_diff_buffers","git_diff_foreach","git_diff_hunk_cb","git_diff_line_cb","git_patch_get_hunk"]}}],["git_diff_line",{"decl":["char origin","int old_lineno","int new_lineno","int num_lines","size_t content_len","git_off_t content_offset","const char * content"],"type":"struct","value":"git_diff_line","file":"git2/diff.h","line":570,"lineto":578,"block":"char origin\nint old_lineno\nint new_lineno\nint num_lines\nsize_t content_len\ngit_off_t content_offset\nconst char * content","tdef":"typedef","description":" Structure describing a line (or data span) of a diff.","comments":"","fields":[{"type":"char","name":"origin","comments":" A git_diff_line_t value "},{"type":"int","name":"old_lineno","comments":" Line number in old file or -1 for added line "},{"type":"int","name":"new_lineno","comments":" Line number in new file or -1 for deleted line "},{"type":"int","name":"num_lines","comments":" Number of newline characters in content "},{"type":"size_t","name":"content_len","comments":" Number of bytes of data "},{"type":"git_off_t","name":"content_offset","comments":" Offset in the original file to the content "},{"type":"const char *","name":"content","comments":" Pointer to diff text, not NUL-byte terminated "}],"used":{"returns":[],"needs":["git_diff_blob_to_buffer","git_diff_blobs","git_diff_buffers","git_diff_foreach","git_diff_line_cb","git_diff_print","git_patch_get_line_in_hunk","git_patch_print"]}}],["git_diff_line_t",{"decl":["GIT_DIFF_LINE_CONTEXT","GIT_DIFF_LINE_ADDITION","GIT_DIFF_LINE_DELETION","GIT_DIFF_LINE_CONTEXT_EOFNL","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":"git2/diff.h","line":549,"lineto":565,"block":"GIT_DIFF_LINE_CONTEXT\nGIT_DIFF_LINE_ADDITION\nGIT_DIFF_LINE_DELETION\nGIT_DIFF_LINE_CONTEXT_EOFNL\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","description":" Line origin constants.","comments":"<p>These values describe where a line came from and will be passed to the git_diff_line_cb when iterating over a diff. There are some special origin constants at the end that are used for the text output callbacks to demarcate lines that are actually part of the file or hunk headers.</p>\n","fields":[{"type":"int","name":"GIT_DIFF_LINE_CONTEXT","comments":"","value":32},{"type":"int","name":"GIT_DIFF_LINE_ADDITION","comments":"","value":43},{"type":"int","name":"GIT_DIFF_LINE_DELETION","comments":"","value":45},{"type":"int","name":"GIT_DIFF_LINE_CONTEXT_EOFNL","comments":"<p>Both files have no LF at end </p>\n","value":61},{"type":"int","name":"GIT_DIFF_LINE_ADD_EOFNL","comments":"<p>Old has no LF at end, new does </p>\n","value":62},{"type":"int","name":"GIT_DIFF_LINE_DEL_EOFNL","comments":"<p>Old has LF at end, new does not </p>\n","value":60},{"type":"int","name":"GIT_DIFF_LINE_FILE_HDR","comments":"","value":70},{"type":"int","name":"GIT_DIFF_LINE_HUNK_HDR","comments":"","value":72},{"type":"int","name":"GIT_DIFF_LINE_BINARY","comments":"<p>For "Binary files x and y differ" </p>\n","value":66}],"used":{"returns":[],"needs":[]}}],["git_diff_option_t",{"decl":["GIT_DIFF_NORMAL","GIT_DIFF_REVERSE","GIT_DIFF_INCLUDE_IGNORED","GIT_DIFF_RECURSE_IGNORED_DIRS","GIT_DIFF_INCLUDE_UNTRACKED","GIT_DIFF_RECURSE_UNTRACKED_DIRS","GIT_DIFF_INCLUDE_UNMODIFIED","GIT_DIFF_INCLUDE_TYPECHANGE","GIT_DIFF_INCLUDE_TYPECHANGE_TREES","GIT_DIFF_IGNORE_FILEMODE","GIT_DIFF_IGNORE_SUBMODULES","GIT_DIFF_IGNORE_CASE","GIT_DIFF_INCLUDE_CASECHANGE","GIT_DIFF_DISABLE_PATHSPEC_MATCH","GIT_DIFF_SKIP_BINARY_CHECK","GIT_DIFF_ENABLE_FAST_UNTRACKED_DIRS","GIT_DIFF_UPDATE_INDEX","GIT_DIFF_INCLUDE_UNREADABLE","GIT_DIFF_INCLUDE_UNREADABLE_AS_UNTRACKED","GIT_DIFF_FORCE_TEXT","GIT_DIFF_FORCE_BINARY","GIT_DIFF_IGNORE_WHITESPACE","GIT_DIFF_IGNORE_WHITESPACE_CHANGE","GIT_DIFF_IGNORE_WHITESPACE_EOL","GIT_DIFF_SHOW_UNTRACKED_CONTENT","GIT_DIFF_SHOW_UNMODIFIED","GIT_DIFF_PATIENCE","GIT_DIFF_MINIMAL","GIT_DIFF_SHOW_BINARY","GIT_DIFF_INDENT_HEURISTIC"],"type":"enum","file":"git2/diff.h","line":72,"lineto":215,"block":"GIT_DIFF_NORMAL\nGIT_DIFF_REVERSE\nGIT_DIFF_INCLUDE_IGNORED\nGIT_DIFF_RECURSE_IGNORED_DIRS\nGIT_DIFF_INCLUDE_UNTRACKED\nGIT_DIFF_RECURSE_UNTRACKED_DIRS\nGIT_DIFF_INCLUDE_UNMODIFIED\nGIT_DIFF_INCLUDE_TYPECHANGE\nGIT_DIFF_INCLUDE_TYPECHANGE_TREES\nGIT_DIFF_IGNORE_FILEMODE\nGIT_DIFF_IGNORE_SUBMODULES\nGIT_DIFF_IGNORE_CASE\nGIT_DIFF_INCLUDE_CASECHANGE\nGIT_DIFF_DISABLE_PATHSPEC_MATCH\nGIT_DIFF_SKIP_BINARY_CHECK\nGIT_DIFF_ENABLE_FAST_UNTRACKED_DIRS\nGIT_DIFF_UPDATE_INDEX\nGIT_DIFF_INCLUDE_UNREADABLE\nGIT_DIFF_INCLUDE_UNREADABLE_AS_UNTRACKED\nGIT_DIFF_FORCE_TEXT\nGIT_DIFF_FORCE_BINARY\nGIT_DIFF_IGNORE_WHITESPACE\nGIT_DIFF_IGNORE_WHITESPACE_CHANGE\nGIT_DIFF_IGNORE_WHITESPACE_EOL\nGIT_DIFF_SHOW_UNTRACKED_CONTENT\nGIT_DIFF_SHOW_UNMODIFIED\nGIT_DIFF_PATIENCE\nGIT_DIFF_MINIMAL\nGIT_DIFF_SHOW_BINARY\nGIT_DIFF_INDENT_HEURISTIC","tdef":"typedef","description":" Flags for diff options. A combination of these flags can be passed\n in via the `flags` value in the `git_diff_options`.","comments":"","fields":[{"type":"int","name":"GIT_DIFF_NORMAL","comments":"<p>Normal diff, the default </p>\n","value":0},{"type":"int","name":"GIT_DIFF_REVERSE","comments":"<p>Reverse the sides of the diff </p>\n","value":1},{"type":"int","name":"GIT_DIFF_INCLUDE_IGNORED","comments":"<p>Include ignored files in the diff </p>\n","value":2},{"type":"int","name":"GIT_DIFF_RECURSE_IGNORED_DIRS","comments":"<p>Even with GIT_DIFF_INCLUDE_IGNORED, an entire ignored directory\n will be marked with only a single entry in the diff; this flag\n adds all files under the directory as IGNORED entries, too.</p>\n","value":4},{"type":"int","name":"GIT_DIFF_INCLUDE_UNTRACKED","comments":"<p>Include untracked files in the diff </p>\n","value":8},{"type":"int","name":"GIT_DIFF_RECURSE_UNTRACKED_DIRS","comments":"<p>Even with GIT_DIFF_INCLUDE_UNTRACKED, an entire untracked\n directory will be marked with only a single entry in the diff\n (a la what core Git does in <code>git status</code>); this flag adds <em>all</em>\n files under untracked directories as UNTRACKED entries, too.</p>\n","value":16},{"type":"int","name":"GIT_DIFF_INCLUDE_UNMODIFIED","comments":"<p>Include unmodified files in the diff </p>\n","value":32},{"type":"int","name":"GIT_DIFF_INCLUDE_TYPECHANGE","comments":"<p>Normally, a type change between files will be converted into a\n DELETED record for the old and an ADDED record for the new; this\n options enabled the generation of TYPECHANGE delta records.</p>\n","value":64},{"type":"int","name":"GIT_DIFF_INCLUDE_TYPECHANGE_TREES","comments":"<p>Even with GIT_DIFF_INCLUDE_TYPECHANGE, blob->tree changes still\n generally show as a DELETED blob. This flag tries to correctly\n label blob->tree transitions as TYPECHANGE records with new_file's\n mode set to tree. Note: the tree SHA will not be available.</p>\n","value":128},{"type":"int","name":"GIT_DIFF_IGNORE_FILEMODE","comments":"<p>Ignore file mode changes </p>\n","value":256},{"type":"int","name":"GIT_DIFF_IGNORE_SUBMODULES","comments":"<p>Treat all submodules as unmodified </p>\n","value":512},{"type":"int","name":"GIT_DIFF_IGNORE_CASE","comments":"<p>Use case insensitive filename comparisons </p>\n","value":1024},{"type":"int","name":"GIT_DIFF_INCLUDE_CASECHANGE","comments":"<p>May be combined with <code>GIT_DIFF_IGNORE_CASE</code> to specify that a file\n that has changed case will be returned as an add/delete pair.</p>\n","value":2048},{"type":"int","name":"GIT_DIFF_DISABLE_PATHSPEC_MATCH","comments":"<p>If the pathspec is set in the diff options, this flags indicates\n that the paths will be treated as literal paths instead of\n fnmatch patterns. Each path in the list must either be a full\n path to a file or a directory. (A trailing slash indicates that\n the path will <em>only</em> match a directory). If a directory is\n specified, all children will be included.</p>\n","value":4096},{"type":"int","name":"GIT_DIFF_SKIP_BINARY_CHECK","comments":"<p>Disable updating of the <code>binary</code> flag in delta records. This is\n useful when iterating over a diff if you don't need hunk and data\n callbacks and want to avoid having to load file completely.</p>\n","value":8192},{"type":"int","name":"GIT_DIFF_ENABLE_FAST_UNTRACKED_DIRS","comments":"<p>When diff finds an untracked directory, to match the behavior of\n core Git, it scans the contents for IGNORED and UNTRACKED files.\n If <em>all</em> contents are IGNORED, then the directory is IGNORED; if\n any contents are not IGNORED, then the directory is UNTRACKED.\n This is extra work that may not matter in many cases. This flag\n turns off that scan and immediately labels an untracked directory\n as UNTRACKED (changing the behavior to not match core Git).</p>\n","value":16384},{"type":"int","name":"GIT_DIFF_UPDATE_INDEX","comments":"<p>When diff finds a file in the working directory with stat\n information different from the index, but the OID ends up being the\n same, write the correct stat information into the index. Note:\n without this flag, diff will always leave the index untouched.</p>\n","value":32768},{"type":"int","name":"GIT_DIFF_INCLUDE_UNREADABLE","comments":"<p>Include unreadable files in the diff </p>\n","value":65536},{"type":"int","name":"GIT_DIFF_INCLUDE_UNREADABLE_AS_UNTRACKED","comments":"<p>Include unreadable files in the diff </p>\n","value":131072},{"type":"int","name":"GIT_DIFF_FORCE_TEXT","comments":"<p>Treat all files as text, disabling binary attributes \n&\n detection </p>\n","value":1048576},{"type":"int","name":"GIT_DIFF_FORCE_BINARY","comments":"<p>Treat all files as binary, disabling text diffs </p>\n","value":2097152},{"type":"int","name":"GIT_DIFF_IGNORE_WHITESPACE","comments":"<p>Ignore all whitespace </p>\n","value":4194304},{"type":"int","name":"GIT_DIFF_IGNORE_WHITESPACE_CHANGE","comments":"<p>Ignore changes in amount of whitespace </p>\n","value":8388608},{"type":"int","name":"GIT_DIFF_IGNORE_WHITESPACE_EOL","comments":"<p>Ignore whitespace at end of line </p>\n","value":16777216},{"type":"int","name":"GIT_DIFF_SHOW_UNTRACKED_CONTENT","comments":"<p>When generating patch text, include the content of untracked\n files. This automatically turns on GIT_DIFF_INCLUDE_UNTRACKED but\n it does not turn on GIT_DIFF_RECURSE_UNTRACKED_DIRS. Add that\n flag if you want the content of every single UNTRACKED file.</p>\n","value":33554432},{"type":"int","name":"GIT_DIFF_SHOW_UNMODIFIED","comments":"<p>When generating output, include the names of unmodified files if\n they are included in the git_diff. Normally these are skipped in\n the formats that list files (e.g. name-only, name-status, raw).\n Even with this, these will not be included in patch format.</p>\n","value":67108864},{"type":"int","name":"GIT_DIFF_PATIENCE","comments":"<p>Use the "patience diff" algorithm </p>\n","value":268435456},{"type":"int","name":"GIT_DIFF_MINIMAL","comments":"<p>Take extra time to find minimal diff </p>\n","value":536870912},{"type":"int","name":"GIT_DIFF_SHOW_BINARY","comments":"<p>Include the necessary deflate / delta information so that <code>git-apply</code>\n can apply given diff information to binary files.</p>\n","value":1073741824},{"type":"unsigned int","name":"GIT_DIFF_INDENT_HEURISTIC","comments":"<p>Use a heuristic that takes indentation and whitespace into account\n which generally can produce better diffs when dealing with ambiguous\n diff hunks.</p>\n","value":-2147483648}],"used":{"returns":[],"needs":[]}}],["git_diff_options",{"decl":["unsigned int version","uint32_t flags","git_submodule_ignore_t ignore_submodules","git_strarray pathspec","git_diff_notify_cb notify_cb","git_diff_progress_cb progress_cb","void * payload","uint32_t context_lines","uint32_t interhunk_lines","uint16_t id_abbrev","git_off_t max_size","const char * old_prefix","const char * new_prefix"],"type":"struct","value":"git_diff_options","file":"git2/diff.h","line":408,"lineto":428,"block":"unsigned int version\nuint32_t flags\ngit_submodule_ignore_t ignore_submodules\ngit_strarray pathspec\ngit_diff_notify_cb notify_cb\ngit_diff_progress_cb progress_cb\nvoid * payload\nuint32_t context_lines\nuint32_t interhunk_lines\nuint16_t id_abbrev\ngit_off_t max_size\nconst char * old_prefix\nconst char * new_prefix","tdef":"typedef","description":" Structure describing options about how the diff should be executed.","comments":"<p>Setting all values of the structure to zero will yield the default values. Similarly, passing NULL for the options structure will give 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 - <code>context_lines</code> is the number of unchanged lines that define the boundary of a hunk (and to display before and after) - <code>interhunk_lines</code> is the maximum number of unchanged lines between hunk boundaries before the hunks will be merged into a one. - <code>old_prefix</code> is the virtual "directory" to prefix to old file names in hunk headers (default "a") - <code>new_prefix</code> is the virtual "directory" to prefix to new file names in hunk headers (default "b") - <code>pathspec</code> is an array of paths / fnmatch patterns to constrain diff - <code>max_size</code> is a file size (in bytes) above which a blob will be marked as binary automatically; pass a negative value to disable. - <code>notify_cb</code> is an optional callback function, notifying the consumer of changes to the diff as new deltas are added. - <code>progress_cb</code> is an optional callback function, notifying the consumer of which files are being examined as the diff is generated. - <code>payload</code> is the payload to pass to the callback functions. - <code>ignore_submodules</code> overrides the submodule ignore setting for all submodules in the diff.</li>\n</ul>\n","fields":[{"type":"unsigned int","name":"version","comments":" version for the struct "},{"type":"uint32_t","name":"flags","comments":" defaults to GIT_DIFF_NORMAL "},{"type":"git_submodule_ignore_t","name":"ignore_submodules","comments":" submodule ignore rule "},{"type":"git_strarray","name":"pathspec","comments":" defaults to include all paths "},{"type":"git_diff_notify_cb","name":"notify_cb","comments":""},{"type":"git_diff_progress_cb","name":"progress_cb","comments":""},{"type":"void *","name":"payload","comments":""},{"type":"uint32_t","name":"context_lines","comments":" defaults to 3 "},{"type":"uint32_t","name":"interhunk_lines","comments":" defaults to 0 "},{"type":"uint16_t","name":"id_abbrev","comments":" default 'core.abbrev' or 7 if unset "},{"type":"git_off_t","name":"max_size","comments":" defaults to 512MB "},{"type":"const char *","name":"old_prefix","comments":" defaults to \"a\" "},{"type":"const char *","name":"new_prefix","comments":" defaults to \"b\" "}],"used":{"returns":[],"needs":["git_diff_blob_to_buffer","git_diff_blobs","git_diff_buffers","git_diff_commit_as_email","git_diff_index_to_index","git_diff_index_to_workdir","git_diff_init_options","git_diff_tree_to_index","git_diff_tree_to_tree","git_diff_tree_to_workdir","git_diff_tree_to_workdir_with_index","git_patch_from_blob_and_buffer","git_patch_from_blobs","git_patch_from_buffers"]}}],["git_diff_patchid_options",{"decl":["unsigned int version"],"type":"struct","value":"git_diff_patchid_options","file":"git2/diff.h","line":1415,"lineto":1417,"block":"unsigned int version","tdef":"typedef","description":" Patch ID options structure","comments":"<p>Initialize with <code>GIT_DIFF_PATCHID_OPTIONS_INIT</code> macro to correctly set the default values and version.</p>\n","fields":[{"type":"unsigned int","name":"version","comments":""}],"used":{"returns":[],"needs":["git_diff_patchid","git_diff_patchid_init_options"]}}],["git_diff_similarity_metric",{"decl":["int (*)(void **, const git_diff_file *, const char *, void *) file_signature","int (*)(void **, const git_diff_file *, const char *, size_t, void *) buffer_signature","void (*)(void *, void *) free_signature","int (*)(int *, void *, void *, void *) similarity","void * payload"],"type":"struct","value":"git_diff_similarity_metric","file":"git2/diff.h","line":671,"lineto":681,"block":"int (*)(void **, const git_diff_file *, const char *, void *) file_signature\nint (*)(void **, const git_diff_file *, const char *, size_t, void *) buffer_signature\nvoid (*)(void *, void *) free_signature\nint (*)(int *, void *, void *, void *) similarity\nvoid * payload","tdef":"typedef","description":" Pluggable similarity metric","comments":"","fields":[{"type":"int (*)(void **, const git_diff_file *, const char *, void *)","name":"file_signature","comments":""},{"type":"int (*)(void **, const git_diff_file *, const char *, size_t, void *)","name":"buffer_signature","comments":""},{"type":"void (*)(void *, void *)","name":"free_signature","comments":""},{"type":"int (*)(int *, void *, void *, void *)","name":"similarity","comments":""},{"type":"void *","name":"payload","comments":""}],"used":{"returns":[],"needs":[]}}],["git_diff_stats",{"decl":"git_diff_stats","type":"struct","value":"git_diff_stats","file":"git2/diff.h","line":1235,"lineto":1235,"tdef":"typedef","description":" This is an opaque structure which is allocated by `git_diff_get_stats`.\n You are responsible for releasing the object memory when done, using the\n `git_diff_stats_free()` function.","comments":"","used":{"returns":[],"needs":["git_diff_get_stats","git_diff_stats_deletions","git_diff_stats_files_changed","git_diff_stats_free","git_diff_stats_insertions","git_diff_stats_to_buf"]}}],["git_diff_stats_format_t",{"decl":["GIT_DIFF_STATS_NONE","GIT_DIFF_STATS_FULL","GIT_DIFF_STATS_SHORT","GIT_DIFF_STATS_NUMBER","GIT_DIFF_STATS_INCLUDE_SUMMARY"],"type":"enum","file":"git2/diff.h","line":1240,"lineto":1255,"block":"GIT_DIFF_STATS_NONE\nGIT_DIFF_STATS_FULL\nGIT_DIFF_STATS_SHORT\nGIT_DIFF_STATS_NUMBER\nGIT_DIFF_STATS_INCLUDE_SUMMARY","tdef":"typedef","description":" Formatting options for diff stats","comments":"","fields":[{"type":"int","name":"GIT_DIFF_STATS_NONE","comments":"<p>No stats</p>\n","value":0},{"type":"int","name":"GIT_DIFF_STATS_FULL","comments":"<p>Full statistics, equivalent of <code>--stat</code> </p>\n","value":1},{"type":"int","name":"GIT_DIFF_STATS_SHORT","comments":"<p>Short statistics, equivalent of <code>--shortstat</code> </p>\n","value":2},{"type":"int","name":"GIT_DIFF_STATS_NUMBER","comments":"<p>Number statistics, equivalent of <code>--numstat</code> </p>\n","value":4},{"type":"int","name":"GIT_DIFF_STATS_INCLUDE_SUMMARY","comments":"<p>Extended header information such as creations, renames and mode changes, equivalent of <code>--summary</code> </p>\n","value":8}],"used":{"returns":[],"needs":["git_diff_stats_to_buf"]}}],["git_direction",{"decl":["GIT_DIRECTION_FETCH","GIT_DIRECTION_PUSH"],"type":"enum","file":"git2/net.h","line":31,"lineto":34,"block":"GIT_DIRECTION_FETCH\nGIT_DIRECTION_PUSH","tdef":"typedef","description":" Direction of the connection.","comments":"<p>We need this because we need to know whether we should call git-upload-pack or git-receive-pack on the remote end when get_refs gets called.</p>\n","fields":[{"type":"int","name":"GIT_DIRECTION_FETCH","comments":"","value":0},{"type":"int","name":"GIT_DIRECTION_PUSH","comments":"","value":1}],"used":{"returns":["git_refspec_direction"],"needs":["git_remote_connect"]}}],["git_error",{"decl":["char * message","int klass"],"type":"struct","value":"git_error","file":"git2/errors.h","line":66,"lineto":69,"block":"char * message\nint klass","tdef":"typedef","description":" Structure to store extra details of the last error that occurred.","comments":"<p>This is kept on a per-thread basis if GIT_THREADS was defined when the library was build, otherwise one is kept globally for the library</p>\n","fields":[{"type":"char *","name":"message","comments":""},{"type":"int","name":"klass","comments":""}],"used":{"returns":["giterr_last"],"needs":[]}}],["git_error_code",{"decl":["GIT_OK","GIT_ERROR","GIT_ENOTFOUND","GIT_EEXISTS","GIT_EAMBIGUOUS","GIT_EBUFS","GIT_EUSER","GIT_EBAREREPO","GIT_EUNBORNBRANCH","GIT_EUNMERGED","GIT_ENONFASTFORWARD","GIT_EINVALIDSPEC","GIT_ECONFLICT","GIT_ELOCKED","GIT_EMODIFIED","GIT_EAUTH","GIT_ECERTIFICATE","GIT_EAPPLIED","GIT_EPEEL","GIT_EEOF","GIT_EINVALID","GIT_EUNCOMMITTED","GIT_EDIRECTORY","GIT_EMERGECONFLICT","GIT_PASSTHROUGH","GIT_ITEROVER","GIT_RETRY","GIT_EMISMATCH"],"type":"enum","file":"git2/errors.h","line":21,"lineto":58,"block":"GIT_OK\nGIT_ERROR\nGIT_ENOTFOUND\nGIT_EEXISTS\nGIT_EAMBIGUOUS\nGIT_EBUFS\nGIT_EUSER\nGIT_EBAREREPO\nGIT_EUNBORNBRANCH\nGIT_EUNMERGED\nGIT_ENONFASTFORWARD\nGIT_EINVALIDSPEC\nGIT_ECONFLICT\nGIT_ELOCKED\nGIT_EMODIFIED\nGIT_EAUTH\nGIT_ECERTIFICATE\nGIT_EAPPLIED\nGIT_EPEEL\nGIT_EEOF\nGIT_EINVALID\nGIT_EUNCOMMITTED\nGIT_EDIRECTORY\nGIT_EMERGECONFLICT\nGIT_PASSTHROUGH\nGIT_ITEROVER\nGIT_RETRY\nGIT_EMISMATCH","tdef":"typedef","description":" Generic return codes ","comments":"","fields":[{"type":"int","name":"GIT_OK","comments":"<p>No error </p>\n","value":0},{"type":"int","name":"GIT_ERROR","comments":"<p>Generic error </p>\n","value":-1},{"type":"int","name":"GIT_ENOTFOUND","comments":"<p>Requested object could not be found </p>\n","value":-3},{"type":"int","name":"GIT_EEXISTS","comments":"<p>Object exists preventing operation </p>\n","value":-4},{"type":"int","name":"GIT_EAMBIGUOUS","comments":"<p>More than one object matches </p>\n","value":-5},{"type":"int","name":"GIT_EBUFS","comments":"<p>Output buffer too short to hold data </p>\n","value":-6},{"type":"int","name":"GIT_EUSER","comments":"","value":-7},{"type":"int","name":"GIT_EBAREREPO","comments":"<p>Operation not allowed on bare repository </p>\n","value":-8},{"type":"int","name":"GIT_EUNBORNBRANCH","comments":"<p>HEAD refers to branch with no commits </p>\n","value":-9},{"type":"int","name":"GIT_EUNMERGED","comments":"<p>Merge in progress prevented operation </p>\n","value":-10},{"type":"int","name":"GIT_ENONFASTFORWARD","comments":"<p>Reference was not fast-forwardable </p>\n","value":-11},{"type":"int","name":"GIT_EINVALIDSPEC","comments":"<p>Name/ref spec was not in a valid format </p>\n","value":-12},{"type":"int","name":"GIT_ECONFLICT","comments":"<p>Checkout conflicts prevented operation </p>\n","value":-13},{"type":"int","name":"GIT_ELOCKED","comments":"<p>Lock file prevented operation </p>\n","value":-14},{"type":"int","name":"GIT_EMODIFIED","comments":"<p>Reference value does not match expected </p>\n","value":-15},{"type":"int","name":"GIT_EAUTH","comments":"<p>Authentication error </p>\n","value":-16},{"type":"int","name":"GIT_ECERTIFICATE","comments":"<p>Server certificate is invalid </p>\n","value":-17},{"type":"int","name":"GIT_EAPPLIED","comments":"<p>Patch/merge has already been applied </p>\n","value":-18},{"type":"int","name":"GIT_EPEEL","comments":"<p>The requested peel operation is not possible </p>\n","value":-19},{"type":"int","name":"GIT_EEOF","comments":"<p>Unexpected EOF </p>\n","value":-20},{"type":"int","name":"GIT_EINVALID","comments":"<p>Invalid operation or input </p>\n","value":-21},{"type":"int","name":"GIT_EUNCOMMITTED","comments":"<p>Uncommitted changes in index prevented operation </p>\n","value":-22},{"type":"int","name":"GIT_EDIRECTORY","comments":"<p>The operation is not valid for a directory </p>\n","value":-23},{"type":"int","name":"GIT_EMERGECONFLICT","comments":"<p>A merge conflict exists and cannot continue </p>\n","value":-24},{"type":"int","name":"GIT_PASSTHROUGH","comments":"<p>Internal only </p>\n","value":-30},{"type":"int","name":"GIT_ITEROVER","comments":"<p>Signals end of iteration with iterator </p>\n","value":-31},{"type":"int","name":"GIT_RETRY","comments":"<p>Internal only </p>\n","value":-32},{"type":"int","name":"GIT_EMISMATCH","comments":"<p>Hashsum mismatch in object </p>\n","value":-33}],"used":{"returns":[],"needs":[]}}],["git_error_t",{"decl":["GITERR_NONE","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","GITERR_SSH","GITERR_FILTER","GITERR_REVERT","GITERR_CALLBACK","GITERR_CHERRYPICK","GITERR_DESCRIBE","GITERR_REBASE","GITERR_FILESYSTEM","GITERR_PATCH","GITERR_WORKTREE","GITERR_SHA1"],"type":"enum","file":"git2/errors.h","line":72,"lineto":107,"block":"GITERR_NONE\nGITERR_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\nGITERR_SSH\nGITERR_FILTER\nGITERR_REVERT\nGITERR_CALLBACK\nGITERR_CHERRYPICK\nGITERR_DESCRIBE\nGITERR_REBASE\nGITERR_FILESYSTEM\nGITERR_PATCH\nGITERR_WORKTREE\nGITERR_SHA1","tdef":"typedef","description":" Error classes ","comments":"","fields":[{"type":"int","name":"GITERR_NONE","comments":"","value":0},{"type":"int","name":"GITERR_NOMEMORY","comments":"","value":1},{"type":"int","name":"GITERR_OS","comments":"","value":2},{"type":"int","name":"GITERR_INVALID","comments":"","value":3},{"type":"int","name":"GITERR_REFERENCE","comments":"","value":4},{"type":"int","name":"GITERR_ZLIB","comments":"","value":5},{"type":"int","name":"GITERR_REPOSITORY","comments":"","value":6},{"type":"int","name":"GITERR_CONFIG","comments":"","value":7},{"type":"int","name":"GITERR_REGEX","comments":"","value":8},{"type":"int","name":"GITERR_ODB","comments":"","value":9},{"type":"int","name":"GITERR_INDEX","comments":"","value":10},{"type":"int","name":"GITERR_OBJECT","comments":"","value":11},{"type":"int","name":"GITERR_NET","comments":"","value":12},{"type":"int","name":"GITERR_TAG","comments":"","value":13},{"type":"int","name":"GITERR_TREE","comments":"","value":14},{"type":"int","name":"GITERR_INDEXER","comments":"","value":15},{"type":"int","name":"GITERR_SSL","comments":"","value":16},{"type":"int","name":"GITERR_SUBMODULE","comments":"","value":17},{"type":"int","name":"GITERR_THREAD","comments":"","value":18},{"type":"int","name":"GITERR_STASH","comments":"","value":19},{"type":"int","name":"GITERR_CHECKOUT","comments":"","value":20},{"type":"int","name":"GITERR_FETCHHEAD","comments":"","value":21},{"type":"int","name":"GITERR_MERGE","comments":"","value":22},{"type":"int","name":"GITERR_SSH","comments":"","value":23},{"type":"int","name":"GITERR_FILTER","comments":"","value":24},{"type":"int","name":"GITERR_REVERT","comments":"","value":25},{"type":"int","name":"GITERR_CALLBACK","comments":"","value":26},{"type":"int","name":"GITERR_CHERRYPICK","comments":"","value":27},{"type":"int","name":"GITERR_DESCRIBE","comments":"","value":28},{"type":"int","name":"GITERR_REBASE","comments":"","value":29},{"type":"int","name":"GITERR_FILESYSTEM","comments":"","value":30},{"type":"int","name":"GITERR_PATCH","comments":"","value":31},{"type":"int","name":"GITERR_WORKTREE","comments":"","value":32},{"type":"int","name":"GITERR_SHA1","comments":"","value":33}],"used":{"returns":[],"needs":[]}}],["git_feature_t",{"decl":["GIT_FEATURE_THREADS","GIT_FEATURE_HTTPS","GIT_FEATURE_SSH","GIT_FEATURE_NSEC"],"type":"enum","file":"git2/common.h","line":111,"lineto":134,"block":"GIT_FEATURE_THREADS\nGIT_FEATURE_HTTPS\nGIT_FEATURE_SSH\nGIT_FEATURE_NSEC","tdef":"typedef","description":" Combinations of these values describe the features with which libgit2\n was compiled","comments":"","fields":[{"type":"int","name":"GIT_FEATURE_THREADS","comments":"<p>If set, libgit2 was built thread-aware and can be safely used from multiple\n threads.</p>\n","value":1},{"type":"int","name":"GIT_FEATURE_HTTPS","comments":"<p>If set, libgit2 was built with and linked against a TLS implementation.\n Custom TLS streams may still be added by the user to support HTTPS\n regardless of this.</p>\n","value":2},{"type":"int","name":"GIT_FEATURE_SSH","comments":"<p>If set, libgit2 was built with and linked against libssh2. A custom\n transport may still be added by the user to support libssh2 regardless of\n this.</p>\n","value":4},{"type":"int","name":"GIT_FEATURE_NSEC","comments":"<p>If set, libgit2 was built with support for sub-second resolution in file\n modification times.</p>\n","value":8}],"used":{"returns":[],"needs":[]}}],["git_fetch_options",{"decl":["int version","git_remote_callbacks callbacks","git_fetch_prune_t prune","int update_fetchhead","git_remote_autotag_option_t download_tags","git_proxy_options proxy_opts","git_strarray custom_headers"],"type":"struct","value":"git_fetch_options","file":"git2/remote.h","line":555,"lineto":592,"block":"int version\ngit_remote_callbacks callbacks\ngit_fetch_prune_t prune\nint update_fetchhead\ngit_remote_autotag_option_t download_tags\ngit_proxy_options proxy_opts\ngit_strarray custom_headers","tdef":"typedef","description":" Fetch options structure.","comments":"<p>Zero out for defaults. Initialize with <code>GIT_FETCH_OPTIONS_INIT</code> macro to correctly set the <code>version</code> field. E.g.</p>\n\n<pre><code> git_fetch_options opts = GIT_FETCH_OPTIONS_INIT;\n</code></pre>\n","fields":[{"type":"int","name":"version","comments":""},{"type":"git_remote_callbacks","name":"callbacks","comments":" Callbacks to use for this fetch operation"},{"type":"git_fetch_prune_t","name":"prune","comments":" Whether to perform a prune after the fetch"},{"type":"int","name":"update_fetchhead","comments":" Whether to write the results to FETCH_HEAD. Defaults to\n on. Leave this default in order to behave like git."},{"type":"git_remote_autotag_option_t","name":"download_tags","comments":" Determines how to behave regarding tags on the remote, such\n as auto-downloading tags for objects we're downloading or\n downloading all of them.\n\n The default is to auto-follow tags."},{"type":"git_proxy_options","name":"proxy_opts","comments":" Proxy options to use, by default no proxy is used."},{"type":"git_strarray","name":"custom_headers","comments":" Extra headers for this fetch operation"}],"used":{"returns":[],"needs":["git_fetch_init_options","git_remote_download","git_remote_fetch"]}}],["git_filemode_t",{"decl":["GIT_FILEMODE_UNREADABLE","GIT_FILEMODE_TREE","GIT_FILEMODE_BLOB","GIT_FILEMODE_BLOB_EXECUTABLE","GIT_FILEMODE_LINK","GIT_FILEMODE_COMMIT"],"type":"enum","file":"git2/types.h","line":209,"lineto":216,"block":"GIT_FILEMODE_UNREADABLE\nGIT_FILEMODE_TREE\nGIT_FILEMODE_BLOB\nGIT_FILEMODE_BLOB_EXECUTABLE\nGIT_FILEMODE_LINK\nGIT_FILEMODE_COMMIT","tdef":"typedef","description":" Valid modes for index and tree entries. ","comments":"","fields":[{"type":"int","name":"GIT_FILEMODE_UNREADABLE","comments":"","value":0},{"type":"int","name":"GIT_FILEMODE_TREE","comments":"","value":16384},{"type":"int","name":"GIT_FILEMODE_BLOB","comments":"","value":33188},{"type":"int","name":"GIT_FILEMODE_BLOB_EXECUTABLE","comments":"","value":33261},{"type":"int","name":"GIT_FILEMODE_LINK","comments":"","value":40960},{"type":"int","name":"GIT_FILEMODE_COMMIT","comments":"","value":57344}],"used":{"returns":["git_tree_entry_filemode","git_tree_entry_filemode_raw"],"needs":["git_treebuilder_insert"]}}],["git_filter",{"decl":["unsigned int version","const char * attributes","git_filter_init_fn initialize","git_filter_shutdown_fn shutdown","git_filter_check_fn check","git_filter_apply_fn apply","git_filter_stream_fn stream","git_filter_cleanup_fn cleanup"],"type":"struct","value":"git_filter","file":"git2/sys/filter.h","line":226,"lineto":271,"tdef":null,"description":" Filter structure used to register custom filters.","comments":"<p>To associate extra data with a filter, allocate extra data and put the <code>git_filter</code> struct at the start of your data buffer, then cast the <code>self</code> pointer to your larger structure when your callback is invoked.</p>\n","block":"unsigned int version\nconst char * attributes\ngit_filter_init_fn initialize\ngit_filter_shutdown_fn shutdown\ngit_filter_check_fn check\ngit_filter_apply_fn apply\ngit_filter_stream_fn stream\ngit_filter_cleanup_fn cleanup","fields":[{"type":"unsigned int","name":"version","comments":" The `version` field should be set to `GIT_FILTER_VERSION`. "},{"type":"const char *","name":"attributes","comments":" A whitespace-separated list of attribute names to check for this\n filter (e.g. \"eol crlf text\"). If the attribute name is bare, it\n will be simply loaded and passed to the `check` callback. If it\n has a value (i.e. \"name=value\"), the attribute must match that\n value for the filter to be applied. The value may be a wildcard\n (eg, \"name=*\"), in which case the filter will be invoked for any\n value for the given attribute name. See the attribute parameter\n of the `check` callback for the attribute value that was specified."},{"type":"git_filter_init_fn","name":"initialize","comments":" Called when the filter is first used for any file. "},{"type":"git_filter_shutdown_fn","name":"shutdown","comments":" Called when the filter is removed or unregistered from the system. "},{"type":"git_filter_check_fn","name":"check","comments":" Called to determine whether the filter should be invoked for a\n given file. If this function returns `GIT_PASSTHROUGH` then the\n `apply` function will not be invoked and the contents will be passed\n through unmodified."},{"type":"git_filter_apply_fn","name":"apply","comments":" Called to actually apply the filter to file contents. If this\n function returns `GIT_PASSTHROUGH` then the contents will be passed\n through unmodified."},{"type":"git_filter_stream_fn","name":"stream","comments":" Called to apply the filter in a streaming manner. If this is not\n specified then the system will call `apply` with the whole buffer."},{"type":"git_filter_cleanup_fn","name":"cleanup","comments":" Called when the system is done filtering for a file. "}],"used":{"returns":[],"needs":["git_filter_apply_fn","git_filter_check_fn","git_filter_list_apply_to_blob","git_filter_list_apply_to_data","git_filter_list_apply_to_file","git_filter_list_contains","git_filter_list_free","git_filter_list_load","git_filter_list_stream_blob","git_filter_list_stream_data","git_filter_list_stream_file"]}}],["git_filter_flag_t",{"decl":["GIT_FILTER_DEFAULT","GIT_FILTER_ALLOW_UNSAFE"],"type":"enum","file":"git2/filter.h","line":41,"lineto":44,"block":"GIT_FILTER_DEFAULT\nGIT_FILTER_ALLOW_UNSAFE","tdef":"typedef","description":" Filter option flags.","comments":"","fields":[{"type":"int","name":"GIT_FILTER_DEFAULT","comments":"","value":0},{"type":"int","name":"GIT_FILTER_ALLOW_UNSAFE","comments":"","value":1}],"used":{"returns":[],"needs":[]}}],["git_filter_list",{"decl":"git_filter_list","type":"struct","value":"git_filter_list","file":"git2/filter.h","line":73,"lineto":73,"tdef":"typedef","description":" List of filters to be applied","comments":"<p>This represents a list of filters to be applied to a file / blob. You can build the list with one call, apply it with another, and dispose it with a third. In typical usage, there are not many occasions where a git_filter_list is needed directly since the library will generally handle conversions for you, but it can be convenient to be able to build and apply the list sometimes.</p>\n","used":{"returns":[],"needs":["git_filter_list_apply_to_blob","git_filter_list_apply_to_data","git_filter_list_apply_to_file","git_filter_list_contains","git_filter_list_free","git_filter_list_load","git_filter_list_stream_blob","git_filter_list_stream_data","git_filter_list_stream_file"]}}],["git_filter_mode_t",{"decl":["GIT_FILTER_TO_WORKTREE","GIT_FILTER_SMUDGE","GIT_FILTER_TO_ODB","GIT_FILTER_CLEAN"],"type":"enum","file":"git2/filter.h","line":31,"lineto":36,"block":"GIT_FILTER_TO_WORKTREE\nGIT_FILTER_SMUDGE\nGIT_FILTER_TO_ODB\nGIT_FILTER_CLEAN","tdef":"typedef","description":" Filters are applied in one of two directions: smudging - which is\n exporting a file from the Git object database to the working directory,\n and cleaning - which is importing a file from the working directory to\n the Git object database. These values control which direction of\n change is being applied.","comments":"","fields":[{"type":"int","name":"GIT_FILTER_TO_WORKTREE","comments":"","value":0},{"type":"int","name":"GIT_FILTER_SMUDGE","comments":"","value":0},{"type":"int","name":"GIT_FILTER_TO_ODB","comments":"","value":1},{"type":"int","name":"GIT_FILTER_CLEAN","comments":"","value":1}],"used":{"returns":[],"needs":["git_filter_list_load"]}}],["git_filter_source",{"decl":"git_filter_source","type":"struct","value":"git_filter_source","file":"git2/sys/filter.h","line":95,"lineto":95,"tdef":"typedef","description":" A filter source represents a file/blob to be processed","comments":"","used":{"returns":[],"needs":["git_filter_apply_fn","git_filter_check_fn"]}}],["git_hashsig_option_t",{"decl":["GIT_HASHSIG_NORMAL","GIT_HASHSIG_IGNORE_WHITESPACE","GIT_HASHSIG_SMART_WHITESPACE","GIT_HASHSIG_ALLOW_SMALL_FILES"],"type":"enum","file":"git2/sys/hashsig.h","line":25,"lineto":45,"block":"GIT_HASHSIG_NORMAL\nGIT_HASHSIG_IGNORE_WHITESPACE\nGIT_HASHSIG_SMART_WHITESPACE\nGIT_HASHSIG_ALLOW_SMALL_FILES","tdef":"typedef","description":" Options for hashsig computation","comments":"<p>The options GIT_HASHSIG_NORMAL, GIT_HASHSIG_IGNORE_WHITESPACE, GIT_HASHSIG_SMART_WHITESPACE are exclusive and should not be combined.</p>\n","fields":[{"type":"int","name":"GIT_HASHSIG_NORMAL","comments":"<p>Use all data</p>\n","value":0},{"type":"int","name":"GIT_HASHSIG_IGNORE_WHITESPACE","comments":"<p>Ignore whitespace</p>\n","value":1},{"type":"int","name":"GIT_HASHSIG_SMART_WHITESPACE","comments":"<p>Ignore </p>\n\n<p>and all space after </p>\n","value":2},{"type":"int","name":"GIT_HASHSIG_ALLOW_SMALL_FILES","comments":"<p>Allow hashing of small files</p>\n","value":4}],"used":{"returns":[],"needs":[]}}],["git_idxentry_extended_flag_t",{"decl":["GIT_IDXENTRY_INTENT_TO_ADD","GIT_IDXENTRY_SKIP_WORKTREE","GIT_IDXENTRY_EXTENDED2","GIT_IDXENTRY_EXTENDED_FLAGS","GIT_IDXENTRY_UPDATE","GIT_IDXENTRY_REMOVE","GIT_IDXENTRY_UPTODATE","GIT_IDXENTRY_ADDED","GIT_IDXENTRY_HASHED","GIT_IDXENTRY_UNHASHED","GIT_IDXENTRY_WT_REMOVE","GIT_IDXENTRY_CONFLICTED","GIT_IDXENTRY_UNPACKED","GIT_IDXENTRY_NEW_SKIP_WORKTREE"],"type":"enum","file":"git2/index.h","line":115,"lineto":135,"block":"GIT_IDXENTRY_INTENT_TO_ADD\nGIT_IDXENTRY_SKIP_WORKTREE\nGIT_IDXENTRY_EXTENDED2\nGIT_IDXENTRY_EXTENDED_FLAGS\nGIT_IDXENTRY_UPDATE\nGIT_IDXENTRY_REMOVE\nGIT_IDXENTRY_UPTODATE\nGIT_IDXENTRY_ADDED\nGIT_IDXENTRY_HASHED\nGIT_IDXENTRY_UNHASHED\nGIT_IDXENTRY_WT_REMOVE\nGIT_IDXENTRY_CONFLICTED\nGIT_IDXENTRY_UNPACKED\nGIT_IDXENTRY_NEW_SKIP_WORKTREE","tdef":"typedef","description":" Bitmasks for on-disk fields of `git_index_entry`'s `flags_extended`","comments":"<p>In memory, the <code>flags_extended</code> fields are divided into two parts: the fields that are read from and written to disk, and other fields that in-memory only and used by libgit2. Only the flags in <code>GIT_IDXENTRY_EXTENDED_FLAGS</code> will get saved on-disk.</p>\n\n<p>Thee first three bitmasks match the three fields in the <code>git_index_entry</code> <code>flags_extended</code> value that belong on disk. You can use them to interpret the data in the <code>flags_extended</code>.</p>\n\n<p>The rest of the bitmasks match the other fields in the <code>git_index_entry</code> <code>flags_extended</code> value that are only used in-memory by libgit2. You can use them to interpret the data in the <code>flags_extended</code>.</p>\n","fields":[{"type":"int","name":"GIT_IDXENTRY_INTENT_TO_ADD","comments":"","value":8192},{"type":"int","name":"GIT_IDXENTRY_SKIP_WORKTREE","comments":"","value":16384},{"type":"int","name":"GIT_IDXENTRY_EXTENDED2","comments":"<p>Reserved for future extension </p>\n","value":32768},{"type":"int","name":"GIT_IDXENTRY_EXTENDED_FLAGS","comments":"<p>Reserved for future extension </p>\n","value":24576},{"type":"int","name":"GIT_IDXENTRY_UPDATE","comments":"<p>Reserved for future extension </p>\n","value":1},{"type":"int","name":"GIT_IDXENTRY_REMOVE","comments":"<p>Reserved for future extension </p>\n","value":2},{"type":"int","name":"GIT_IDXENTRY_UPTODATE","comments":"<p>Reserved for future extension </p>\n","value":4},{"type":"int","name":"GIT_IDXENTRY_ADDED","comments":"<p>Reserved for future extension </p>\n","value":8},{"type":"int","name":"GIT_IDXENTRY_HASHED","comments":"<p>Reserved for future extension </p>\n","value":16},{"type":"int","name":"GIT_IDXENTRY_UNHASHED","comments":"<p>Reserved for future extension </p>\n","value":32},{"type":"int","name":"GIT_IDXENTRY_WT_REMOVE","comments":"<p>remove in work directory </p>\n","value":64},{"type":"int","name":"GIT_IDXENTRY_CONFLICTED","comments":"","value":128},{"type":"int","name":"GIT_IDXENTRY_UNPACKED","comments":"","value":256},{"type":"int","name":"GIT_IDXENTRY_NEW_SKIP_WORKTREE","comments":"","value":512}],"used":{"returns":[],"needs":[]}}],["git_index",{"decl":"git_index","type":"struct","value":"git_index","file":"git2/types.h","line":135,"lineto":135,"tdef":"typedef","description":" Memory representation of an index file. ","comments":"","used":{"returns":["git_index_get_byindex","git_index_get_bypath"],"needs":["git_checkout_index","git_cherrypick_commit","git_diff_index_to_index","git_diff_index_to_workdir","git_diff_tree_to_index","git_index_add","git_index_add_all","git_index_add_bypath","git_index_add_frombuffer","git_index_caps","git_index_checksum","git_index_clear","git_index_conflict_add","git_index_conflict_cleanup","git_index_conflict_get","git_index_conflict_iterator_free","git_index_conflict_iterator_new","git_index_conflict_next","git_index_conflict_remove","git_index_entry_is_conflict","git_index_entry_stage","git_index_entrycount","git_index_find","git_index_find_prefix","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_path","git_index_read","git_index_read_tree","git_index_remove","git_index_remove_all","git_index_remove_bypath","git_index_remove_directory","git_index_set_caps","git_index_set_version","git_index_update_all","git_index_version","git_index_write","git_index_write_tree","git_index_write_tree_to","git_indexer_append","git_indexer_commit","git_indexer_free","git_indexer_hash","git_indexer_new","git_merge_commits","git_merge_file_from_index","git_merge_trees","git_rebase_inmemory_index","git_repository_index","git_revert_commit"]}}],["git_index_add_option_t",{"decl":["GIT_INDEX_ADD_DEFAULT","GIT_INDEX_ADD_FORCE","GIT_INDEX_ADD_DISABLE_PATHSPEC_MATCH","GIT_INDEX_ADD_CHECK_PATHSPEC"],"type":"enum","file":"git2/index.h","line":150,"lineto":155,"block":"GIT_INDEX_ADD_DEFAULT\nGIT_INDEX_ADD_FORCE\nGIT_INDEX_ADD_DISABLE_PATHSPEC_MATCH\nGIT_INDEX_ADD_CHECK_PATHSPEC","tdef":"typedef","description":" Flags for APIs that add files matching pathspec ","comments":"","fields":[{"type":"int","name":"GIT_INDEX_ADD_DEFAULT","comments":"","value":0},{"type":"int","name":"GIT_INDEX_ADD_FORCE","comments":"","value":1},{"type":"int","name":"GIT_INDEX_ADD_DISABLE_PATHSPEC_MATCH","comments":"","value":2},{"type":"int","name":"GIT_INDEX_ADD_CHECK_PATHSPEC","comments":"","value":4}],"used":{"returns":[],"needs":[]}}],["git_index_conflict_iterator",{"decl":"git_index_conflict_iterator","type":"struct","value":"git_index_conflict_iterator","file":"git2/types.h","line":138,"lineto":138,"tdef":"typedef","description":" An iterator for conflicts in the index. ","comments":"","used":{"returns":[],"needs":["git_index_conflict_iterator_free","git_index_conflict_iterator_new","git_index_conflict_next"]}}],["git_index_entry",{"decl":["git_index_time ctime","git_index_time mtime","uint32_t dev","uint32_t ino","uint32_t mode","uint32_t uid","uint32_t gid","uint32_t file_size","git_oid id","uint16_t flags","uint16_t flags_extended","const char * path"],"type":"struct","value":"git_index_entry","file":"git2/index.h","line":53,"lineto":70,"block":"git_index_time ctime\ngit_index_time mtime\nuint32_t dev\nuint32_t ino\nuint32_t mode\nuint32_t uid\nuint32_t gid\nuint32_t file_size\ngit_oid id\nuint16_t flags\nuint16_t flags_extended\nconst char * path","tdef":"typedef","description":" In-memory representation of a file entry in the index.","comments":"<p>This is a public structure that represents a file entry in the index. The meaning of the fields corresponds to core Git's documentation (in "Documentation/technical/index-format.txt").</p>\n\n<p>The <code>flags</code> field consists of a number of bit fields which can be accessed via the first set of <code>GIT_IDXENTRY_...</code> bitmasks below. These flags are all read from and persisted to disk.</p>\n\n<p>The <code>flags_extended</code> field also has a number of bit fields which can be accessed via the later <code>GIT_IDXENTRY_...</code> bitmasks below. Some of these flags are read from and written to disk, but some are set aside for in-memory only reference.</p>\n\n<p>Note that the time and size fields are truncated to 32 bits. This is enough to detect changes, which is enough for the index to function as a cache, but it should not be taken as an authoritative source for that data.</p>\n","fields":[{"type":"git_index_time","name":"ctime","comments":""},{"type":"git_index_time","name":"mtime","comments":""},{"type":"uint32_t","name":"dev","comments":""},{"type":"uint32_t","name":"ino","comments":""},{"type":"uint32_t","name":"mode","comments":""},{"type":"uint32_t","name":"uid","comments":""},{"type":"uint32_t","name":"gid","comments":""},{"type":"uint32_t","name":"file_size","comments":""},{"type":"git_oid","name":"id","comments":""},{"type":"uint16_t","name":"flags","comments":""},{"type":"uint16_t","name":"flags_extended","comments":""},{"type":"const char *","name":"path","comments":""}],"used":{"returns":["git_index_get_byindex","git_index_get_bypath"],"needs":["git_index_add","git_index_add_frombuffer","git_index_conflict_add","git_index_conflict_get","git_index_conflict_next","git_index_entry_is_conflict","git_index_entry_stage","git_merge_file_from_index"]}}],["git_index_time",{"decl":["int32_t seconds","uint32_t nanoseconds"],"type":"struct","value":"git_index_time","file":"git2/index.h","line":26,"lineto":30,"block":"int32_t seconds\nuint32_t nanoseconds","tdef":"typedef","description":" Time structure used in a git index entry ","comments":"","fields":[{"type":"int32_t","name":"seconds","comments":""},{"type":"uint32_t","name":"nanoseconds","comments":""}],"used":{"returns":[],"needs":[]}}],["git_indexcap_t",{"decl":["GIT_INDEXCAP_IGNORE_CASE","GIT_INDEXCAP_NO_FILEMODE","GIT_INDEXCAP_NO_SYMLINKS","GIT_INDEXCAP_FROM_OWNER"],"type":"enum","file":"git2/index.h","line":138,"lineto":143,"block":"GIT_INDEXCAP_IGNORE_CASE\nGIT_INDEXCAP_NO_FILEMODE\nGIT_INDEXCAP_NO_SYMLINKS\nGIT_INDEXCAP_FROM_OWNER","tdef":"typedef","description":" Capabilities of system that affect index actions. ","comments":"","fields":[{"type":"int","name":"GIT_INDEXCAP_IGNORE_CASE","comments":"","value":1},{"type":"int","name":"GIT_INDEXCAP_NO_FILEMODE","comments":"","value":2},{"type":"int","name":"GIT_INDEXCAP_NO_SYMLINKS","comments":"","value":4},{"type":"int","name":"GIT_INDEXCAP_FROM_OWNER","comments":"","value":-1}],"used":{"returns":[],"needs":[]}}],["git_indxentry_flag_t",{"decl":["GIT_IDXENTRY_EXTENDED","GIT_IDXENTRY_VALID"],"type":"enum","file":"git2/index.h","line":86,"lineto":89,"block":"GIT_IDXENTRY_EXTENDED\nGIT_IDXENTRY_VALID","tdef":"typedef","description":" Flags for index entries","comments":"","fields":[{"type":"int","name":"GIT_IDXENTRY_EXTENDED","comments":"","value":16384},{"type":"int","name":"GIT_IDXENTRY_VALID","comments":"","value":32768}],"used":{"returns":[],"needs":[]}}],["git_libgit2_opt_t",{"decl":["GIT_OPT_GET_MWINDOW_SIZE","GIT_OPT_SET_MWINDOW_SIZE","GIT_OPT_GET_MWINDOW_MAPPED_LIMIT","GIT_OPT_SET_MWINDOW_MAPPED_LIMIT","GIT_OPT_GET_SEARCH_PATH","GIT_OPT_SET_SEARCH_PATH","GIT_OPT_SET_CACHE_OBJECT_LIMIT","GIT_OPT_SET_CACHE_MAX_SIZE","GIT_OPT_ENABLE_CACHING","GIT_OPT_GET_CACHED_MEMORY","GIT_OPT_GET_TEMPLATE_PATH","GIT_OPT_SET_TEMPLATE_PATH","GIT_OPT_SET_SSL_CERT_LOCATIONS","GIT_OPT_SET_USER_AGENT","GIT_OPT_ENABLE_STRICT_OBJECT_CREATION","GIT_OPT_ENABLE_STRICT_SYMBOLIC_REF_CREATION","GIT_OPT_SET_SSL_CIPHERS","GIT_OPT_GET_USER_AGENT","GIT_OPT_ENABLE_OFS_DELTA","GIT_OPT_ENABLE_FSYNC_GITDIR","GIT_OPT_GET_WINDOWS_SHAREMODE","GIT_OPT_SET_WINDOWS_SHAREMODE","GIT_OPT_ENABLE_STRICT_HASH_VERIFICATION"],"type":"enum","file":"git2/common.h","line":162,"lineto":186,"block":"GIT_OPT_GET_MWINDOW_SIZE\nGIT_OPT_SET_MWINDOW_SIZE\nGIT_OPT_GET_MWINDOW_MAPPED_LIMIT\nGIT_OPT_SET_MWINDOW_MAPPED_LIMIT\nGIT_OPT_GET_SEARCH_PATH\nGIT_OPT_SET_SEARCH_PATH\nGIT_OPT_SET_CACHE_OBJECT_LIMIT\nGIT_OPT_SET_CACHE_MAX_SIZE\nGIT_OPT_ENABLE_CACHING\nGIT_OPT_GET_CACHED_MEMORY\nGIT_OPT_GET_TEMPLATE_PATH\nGIT_OPT_SET_TEMPLATE_PATH\nGIT_OPT_SET_SSL_CERT_LOCATIONS\nGIT_OPT_SET_USER_AGENT\nGIT_OPT_ENABLE_STRICT_OBJECT_CREATION\nGIT_OPT_ENABLE_STRICT_SYMBOLIC_REF_CREATION\nGIT_OPT_SET_SSL_CIPHERS\nGIT_OPT_GET_USER_AGENT\nGIT_OPT_ENABLE_OFS_DELTA\nGIT_OPT_ENABLE_FSYNC_GITDIR\nGIT_OPT_GET_WINDOWS_SHAREMODE\nGIT_OPT_SET_WINDOWS_SHAREMODE\nGIT_OPT_ENABLE_STRICT_HASH_VERIFICATION","tdef":"typedef","description":" Global library options","comments":"<p>These are used to select which global option to set or get and are used in <code>git_libgit2_opts()</code>.</p>\n","fields":[{"type":"int","name":"GIT_OPT_GET_MWINDOW_SIZE","comments":"","value":0},{"type":"int","name":"GIT_OPT_SET_MWINDOW_SIZE","comments":"","value":1},{"type":"int","name":"GIT_OPT_GET_MWINDOW_MAPPED_LIMIT","comments":"","value":2},{"type":"int","name":"GIT_OPT_SET_MWINDOW_MAPPED_LIMIT","comments":"","value":3},{"type":"int","name":"GIT_OPT_GET_SEARCH_PATH","comments":"","value":4},{"type":"int","name":"GIT_OPT_SET_SEARCH_PATH","comments":"","value":5},{"type":"int","name":"GIT_OPT_SET_CACHE_OBJECT_LIMIT","comments":"","value":6},{"type":"int","name":"GIT_OPT_SET_CACHE_MAX_SIZE","comments":"","value":7},{"type":"int","name":"GIT_OPT_ENABLE_CACHING","comments":"","value":8},{"type":"int","name":"GIT_OPT_GET_CACHED_MEMORY","comments":"","value":9},{"type":"int","name":"GIT_OPT_GET_TEMPLATE_PATH","comments":"","value":10},{"type":"int","name":"GIT_OPT_SET_TEMPLATE_PATH","comments":"","value":11},{"type":"int","name":"GIT_OPT_SET_SSL_CERT_LOCATIONS","comments":"","value":12},{"type":"int","name":"GIT_OPT_SET_USER_AGENT","comments":"","value":13},{"type":"int","name":"GIT_OPT_ENABLE_STRICT_OBJECT_CREATION","comments":"","value":14},{"type":"int","name":"GIT_OPT_ENABLE_STRICT_SYMBOLIC_REF_CREATION","comments":"","value":15},{"type":"int","name":"GIT_OPT_SET_SSL_CIPHERS","comments":"","value":16},{"type":"int","name":"GIT_OPT_GET_USER_AGENT","comments":"","value":17},{"type":"int","name":"GIT_OPT_ENABLE_OFS_DELTA","comments":"","value":18},{"type":"int","name":"GIT_OPT_ENABLE_FSYNC_GITDIR","comments":"","value":19},{"type":"int","name":"GIT_OPT_GET_WINDOWS_SHAREMODE","comments":"","value":20},{"type":"int","name":"GIT_OPT_SET_WINDOWS_SHAREMODE","comments":"","value":21},{"type":"int","name":"GIT_OPT_ENABLE_STRICT_HASH_VERIFICATION","comments":"","value":22}],"used":{"returns":[],"needs":[]}}],["git_merge_analysis_t",{"decl":["GIT_MERGE_ANALYSIS_NONE","GIT_MERGE_ANALYSIS_NORMAL","GIT_MERGE_ANALYSIS_UP_TO_DATE","GIT_MERGE_ANALYSIS_FASTFORWARD","GIT_MERGE_ANALYSIS_UNBORN"],"type":"enum","file":"git2/merge.h","line":318,"lineto":347,"block":"GIT_MERGE_ANALYSIS_NONE\nGIT_MERGE_ANALYSIS_NORMAL\nGIT_MERGE_ANALYSIS_UP_TO_DATE\nGIT_MERGE_ANALYSIS_FASTFORWARD\nGIT_MERGE_ANALYSIS_UNBORN","tdef":"typedef","description":" The results of `git_merge_analysis` indicate the merge opportunities.","comments":"","fields":[{"type":"int","name":"GIT_MERGE_ANALYSIS_NONE","comments":"<p>No merge is possible. (Unused.) </p>\n","value":0},{"type":"int","name":"GIT_MERGE_ANALYSIS_NORMAL","comments":"<p>A "normal" merge; both HEAD and the given merge input have diverged\n from their common ancestor. The divergent commits must be merged.</p>\n","value":1},{"type":"int","name":"GIT_MERGE_ANALYSIS_UP_TO_DATE","comments":"<p>All given merge inputs are reachable from HEAD, meaning the\n repository is up-to-date and no merge needs to be performed.</p>\n","value":2},{"type":"int","name":"GIT_MERGE_ANALYSIS_FASTFORWARD","comments":"<p>The given merge input is a fast-forward from HEAD and no merge\n needs to be performed. Instead, the client can check out the\n given merge input.</p>\n","value":4},{"type":"int","name":"GIT_MERGE_ANALYSIS_UNBORN","comments":"<p>The HEAD of the current repository is "unborn" and does not point to\n a valid commit. No merge can be performed, but the caller may wish\n to simply set HEAD to the target commit(s).</p>\n","value":8}],"used":{"returns":[],"needs":["git_merge_analysis"]}}],["git_merge_driver",{"decl":["unsigned int version","git_merge_driver_init_fn initialize","git_merge_driver_shutdown_fn shutdown","git_merge_driver_apply_fn apply"],"type":"struct","value":"git_merge_driver","file":"git2/sys/merge.h","line":118,"lineto":135,"block":"unsigned int version\ngit_merge_driver_init_fn initialize\ngit_merge_driver_shutdown_fn shutdown\ngit_merge_driver_apply_fn apply","tdef":null,"description":" Merge driver structure used to register custom merge drivers.","comments":"<p>To associate extra data with a driver, allocate extra data and put the <code>git_merge_driver</code> struct at the start of your data buffer, then cast the <code>self</code> pointer to your larger structure when your callback is invoked.</p>\n","fields":[{"type":"unsigned int","name":"version","comments":" The `version` should be set to `GIT_MERGE_DRIVER_VERSION`. "},{"type":"git_merge_driver_init_fn","name":"initialize","comments":" Called when the merge driver is first used for any file. "},{"type":"git_merge_driver_shutdown_fn","name":"shutdown","comments":" Called when the merge driver is unregistered from the system. "},{"type":"git_merge_driver_apply_fn","name":"apply","comments":" Called to merge the contents of a conflict. If this function\n returns `GIT_PASSTHROUGH` then the default (`text`) merge driver\n will instead be invoked. If this function returns\n `GIT_EMERGECONFLICT` then the file will remain conflicted."}],"used":{"returns":[],"needs":["git_merge_driver_apply_fn"]}}],["git_merge_driver_source",{"decl":"git_merge_driver_source","type":"struct","value":"git_merge_driver_source","file":"git2/sys/merge.h","line":36,"lineto":36,"tdef":"typedef","description":" A merge driver source represents the file to be merged","comments":"","used":{"returns":[],"needs":["git_merge_driver_apply_fn"]}}],["git_merge_file_favor_t",{"decl":["GIT_MERGE_FILE_FAVOR_NORMAL","GIT_MERGE_FILE_FAVOR_OURS","GIT_MERGE_FILE_FAVOR_THEIRS","GIT_MERGE_FILE_FAVOR_UNION"],"type":"enum","file":"git2/merge.h","line":101,"lineto":131,"block":"GIT_MERGE_FILE_FAVOR_NORMAL\nGIT_MERGE_FILE_FAVOR_OURS\nGIT_MERGE_FILE_FAVOR_THEIRS\nGIT_MERGE_FILE_FAVOR_UNION","tdef":"typedef","description":" Merge file favor options for `git_merge_options` instruct the file-level\n merging functionality how to deal with conflicting regions of the files.","comments":"","fields":[{"type":"int","name":"GIT_MERGE_FILE_FAVOR_NORMAL","comments":"<p>When a region of a file is changed in both branches, a conflict\n will be recorded in the index so that <code>git_checkout</code> can produce\n a merge file with conflict markers in the working directory.\n This is the default.</p>\n","value":0},{"type":"int","name":"GIT_MERGE_FILE_FAVOR_OURS","comments":"<p>When a region of a file is changed in both branches, the file\n created in the index will contain the "ours" side of any conflicting\n region. The index will not record a conflict.</p>\n","value":1},{"type":"int","name":"GIT_MERGE_FILE_FAVOR_THEIRS","comments":"<p>When a region of a file is changed in both branches, the file\n created in the index will contain the "theirs" side of any conflicting\n region. The index will not record a conflict.</p>\n","value":2},{"type":"int","name":"GIT_MERGE_FILE_FAVOR_UNION","comments":"<p>When a region of a file is changed in both branches, the file\n created in the index will contain each unique line from each side,\n which has the result of combining both files. The index will not\n record a conflict.</p>\n","value":3}],"used":{"returns":[],"needs":[]}}],["git_merge_file_flag_t",{"decl":["GIT_MERGE_FILE_DEFAULT","GIT_MERGE_FILE_STYLE_MERGE","GIT_MERGE_FILE_STYLE_DIFF3","GIT_MERGE_FILE_SIMPLIFY_ALNUM","GIT_MERGE_FILE_IGNORE_WHITESPACE","GIT_MERGE_FILE_IGNORE_WHITESPACE_CHANGE","GIT_MERGE_FILE_IGNORE_WHITESPACE_EOL","GIT_MERGE_FILE_DIFF_PATIENCE","GIT_MERGE_FILE_DIFF_MINIMAL"],"type":"enum","file":"git2/merge.h","line":136,"lineto":163,"block":"GIT_MERGE_FILE_DEFAULT\nGIT_MERGE_FILE_STYLE_MERGE\nGIT_MERGE_FILE_STYLE_DIFF3\nGIT_MERGE_FILE_SIMPLIFY_ALNUM\nGIT_MERGE_FILE_IGNORE_WHITESPACE\nGIT_MERGE_FILE_IGNORE_WHITESPACE_CHANGE\nGIT_MERGE_FILE_IGNORE_WHITESPACE_EOL\nGIT_MERGE_FILE_DIFF_PATIENCE\nGIT_MERGE_FILE_DIFF_MINIMAL","tdef":"typedef","description":" File merging flags","comments":"","fields":[{"type":"int","name":"GIT_MERGE_FILE_DEFAULT","comments":"<p>Defaults </p>\n","value":0},{"type":"int","name":"GIT_MERGE_FILE_STYLE_MERGE","comments":"<p>Create standard conflicted merge files </p>\n","value":1},{"type":"int","name":"GIT_MERGE_FILE_STYLE_DIFF3","comments":"<p>Create diff3-style files </p>\n","value":2},{"type":"int","name":"GIT_MERGE_FILE_SIMPLIFY_ALNUM","comments":"<p>Condense non-alphanumeric regions for simplified diff file </p>\n","value":4},{"type":"int","name":"GIT_MERGE_FILE_IGNORE_WHITESPACE","comments":"<p>Ignore all whitespace </p>\n","value":8},{"type":"int","name":"GIT_MERGE_FILE_IGNORE_WHITESPACE_CHANGE","comments":"<p>Ignore changes in amount of whitespace </p>\n","value":16},{"type":"int","name":"GIT_MERGE_FILE_IGNORE_WHITESPACE_EOL","comments":"<p>Ignore whitespace at end of line </p>\n","value":32},{"type":"int","name":"GIT_MERGE_FILE_DIFF_PATIENCE","comments":"<p>Use the "patience diff" algorithm </p>\n","value":64},{"type":"int","name":"GIT_MERGE_FILE_DIFF_MINIMAL","comments":"<p>Take extra time to find minimal diff </p>\n","value":128}],"used":{"returns":[],"needs":[]}}],["git_merge_file_input",{"decl":["unsigned int version","const char * ptr","size_t size","const char * path","unsigned int mode"],"type":"struct","value":"git_merge_file_input","file":"git2/merge.h","line":32,"lineto":46,"block":"unsigned int version\nconst char * ptr\nsize_t size\nconst char * path\nunsigned int mode","tdef":"typedef","description":" The file inputs to `git_merge_file`. Callers should populate the\n `git_merge_file_input` structure with descriptions of the files in\n each side of the conflict for use in producing the merge file.","comments":"","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"const char *","name":"ptr","comments":" Pointer to the contents of the file. "},{"type":"size_t","name":"size","comments":" Size of the contents pointed to in `ptr`. "},{"type":"const char *","name":"path","comments":" File name of the conflicted file, or `NULL` to not merge the path. "},{"type":"unsigned int","name":"mode","comments":" File mode of the conflicted file, or `0` to not merge the mode. "}],"used":{"returns":[],"needs":["git_merge_file","git_merge_file_init_input"]}}],["git_merge_file_options",{"decl":["unsigned int version","const char * ancestor_label","const char * our_label","const char * their_label","git_merge_file_favor_t favor","git_merge_file_flag_t flags","unsigned short marker_size"],"type":"struct","value":"git_merge_file_options","file":"git2/merge.h","line":170,"lineto":200,"block":"unsigned int version\nconst char * ancestor_label\nconst char * our_label\nconst char * their_label\ngit_merge_file_favor_t favor\ngit_merge_file_flag_t flags\nunsigned short marker_size","tdef":"typedef","description":" Options for merging a file","comments":"","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"const char *","name":"ancestor_label","comments":" Label for the ancestor file side of the conflict which will be prepended\n to labels in diff3-format merge files."},{"type":"const char *","name":"our_label","comments":" Label for our file side of the conflict which will be prepended\n to labels in merge files."},{"type":"const char *","name":"their_label","comments":" Label for their file side of the conflict which will be prepended\n to labels in merge files."},{"type":"git_merge_file_favor_t","name":"favor","comments":" The file to favor in region conflicts. "},{"type":"git_merge_file_flag_t","name":"flags","comments":" see `git_merge_file_flag_t` above "},{"type":"unsigned short","name":"marker_size","comments":" The size of conflict markers (eg, \"\n<\n<\n<\n<\n<\n<\n<\n\"). Default is\n GIT_MERGE_CONFLICT_MARKER_SIZE. "}],"used":{"returns":[],"needs":["git_merge_file","git_merge_file_from_index","git_merge_file_init_options"]}}],["git_merge_file_result",{"decl":["unsigned int automergeable","const char * path","unsigned int mode","const char * ptr","size_t len"],"type":"struct","value":"git_merge_file_result","file":"git2/merge.h","line":221,"lineto":242,"block":"unsigned int automergeable\nconst char * path\nunsigned int mode\nconst char * ptr\nsize_t len","tdef":"typedef","description":" Information about file-level merging","comments":"","fields":[{"type":"unsigned int","name":"automergeable","comments":" True if the output was automerged, false if the output contains\n conflict markers."},{"type":"const char *","name":"path","comments":" The path that the resultant merge file should use, or NULL if a\n filename conflict would occur."},{"type":"unsigned int","name":"mode","comments":" The mode that the resultant merge file should use. "},{"type":"const char *","name":"ptr","comments":" The contents of the merge. "},{"type":"size_t","name":"len","comments":" The length of the merge contents. "}],"used":{"returns":[],"needs":["git_merge_file","git_merge_file_from_index","git_merge_file_result_free"]}}],["git_merge_flag_t",{"decl":["GIT_MERGE_FIND_RENAMES","GIT_MERGE_FAIL_ON_CONFLICT","GIT_MERGE_SKIP_REUC","GIT_MERGE_NO_RECURSIVE"],"type":"enum","file":"git2/merge.h","line":68,"lineto":95,"block":"GIT_MERGE_FIND_RENAMES\nGIT_MERGE_FAIL_ON_CONFLICT\nGIT_MERGE_SKIP_REUC\nGIT_MERGE_NO_RECURSIVE","tdef":"typedef","description":" Flags for `git_merge` options. A combination of these flags can be\n passed in via the `flags` value in the `git_merge_options`.","comments":"","fields":[{"type":"int","name":"GIT_MERGE_FIND_RENAMES","comments":"<p>Detect renames that occur between the common ancestor and the "ours"\n side or the common ancestor and the "theirs" side. This will enable\n the ability to merge between a modified and renamed file.</p>\n","value":1},{"type":"int","name":"GIT_MERGE_FAIL_ON_CONFLICT","comments":"<p>If a conflict occurs, exit immediately instead of attempting to\n continue resolving conflicts. The merge operation will fail with\n GIT_EMERGECONFLICT and no index will be returned.</p>\n","value":2},{"type":"int","name":"GIT_MERGE_SKIP_REUC","comments":"<p>Do not write the REUC extension on the generated index</p>\n","value":4},{"type":"int","name":"GIT_MERGE_NO_RECURSIVE","comments":"<p>If the commits being merged have multiple merge bases, do not build\n a recursive merge base (by merging the multiple merge bases),\n instead simply use the first base. This flag provides a similar\n merge base to <code>git-merge-resolve</code>.</p>\n","value":8}],"used":{"returns":[],"needs":[]}}],["git_merge_options",{"decl":["unsigned int version","git_merge_flag_t flags","unsigned int rename_threshold","unsigned int target_limit","git_diff_similarity_metric * metric","unsigned int recursion_limit","const char * default_driver","git_merge_file_favor_t file_favor","git_merge_file_flag_t file_flags"],"type":"struct","value":"git_merge_options","file":"git2/merge.h","line":247,"lineto":296,"block":"unsigned int version\ngit_merge_flag_t flags\nunsigned int rename_threshold\nunsigned int target_limit\ngit_diff_similarity_metric * metric\nunsigned int recursion_limit\nconst char * default_driver\ngit_merge_file_favor_t file_favor\ngit_merge_file_flag_t file_flags","tdef":"typedef","description":" Merging options","comments":"","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"git_merge_flag_t","name":"flags","comments":" See `git_merge_flag_t` above "},{"type":"unsigned int","name":"rename_threshold","comments":" Similarity to consider a file renamed (default 50). If\n `GIT_MERGE_FIND_RENAMES` is enabled, added files will be compared\n with deleted files to determine their similarity. Files that are\n more similar than the rename threshold (percentage-wise) will be\n treated as a rename."},{"type":"unsigned int","name":"target_limit","comments":" Maximum similarity sources to examine for renames (default 200).\n If the number of rename candidates (add / delete pairs) is greater\n than this value, inexact rename detection is aborted.\n\n This setting overrides the `merge.renameLimit` configuration value."},{"type":"git_diff_similarity_metric *","name":"metric","comments":" Pluggable similarity metric; pass NULL to use internal metric "},{"type":"unsigned int","name":"recursion_limit","comments":" Maximum number of times to merge common ancestors to build a\n virtual merge base when faced with criss-cross merges. When this\n limit is reached, the next ancestor will simply be used instead of\n attempting to merge it. The default is unlimited."},{"type":"const char *","name":"default_driver","comments":" Default merge driver to be used when both sides of a merge have\n changed. The default is the `text` driver."},{"type":"git_merge_file_favor_t","name":"file_favor","comments":" Flags for handling conflicting content, to be used with the standard\n (`text`) merge driver."},{"type":"git_merge_file_flag_t","name":"file_flags","comments":" see `git_merge_file_flag_t` above "}],"used":{"returns":[],"needs":["git_cherrypick_commit","git_merge","git_merge_commits","git_merge_init_options","git_merge_trees","git_revert_commit"]}}],["git_merge_preference_t",{"decl":["GIT_MERGE_PREFERENCE_NONE","GIT_MERGE_PREFERENCE_NO_FASTFORWARD","GIT_MERGE_PREFERENCE_FASTFORWARD_ONLY"],"type":"enum","file":"git2/merge.h","line":352,"lineto":370,"block":"GIT_MERGE_PREFERENCE_NONE\nGIT_MERGE_PREFERENCE_NO_FASTFORWARD\nGIT_MERGE_PREFERENCE_FASTFORWARD_ONLY","tdef":"typedef","description":" The user's stated preference for merges.","comments":"","fields":[{"type":"int","name":"GIT_MERGE_PREFERENCE_NONE","comments":"<p>No configuration was found that suggests a preferred behavior for\n merge.</p>\n","value":0},{"type":"int","name":"GIT_MERGE_PREFERENCE_NO_FASTFORWARD","comments":"<p>There is a <code>merge.ff=false</code> configuration setting, suggesting that\n the user does not want to allow a fast-forward merge.</p>\n","value":1},{"type":"int","name":"GIT_MERGE_PREFERENCE_FASTFORWARD_ONLY","comments":"<p>There is a <code>merge.ff=only</code> configuration setting, suggesting that\n the user only wants fast-forward merges.</p>\n","value":2}],"used":{"returns":[],"needs":["git_merge_analysis"]}}],["git_merge_result",{"decl":"git_merge_result","type":"struct","value":"git_merge_result","file":"git2/types.h","line":185,"lineto":185,"tdef":"typedef","description":" Merge result ","comments":"","used":{"returns":[],"needs":[]}}],["git_message_trailer",{"decl":["const char * key","const char * value"],"type":"struct","value":"git_message_trailer","file":"git2/message.h","line":43,"lineto":46,"block":"const char * key\nconst char * value","tdef":"typedef","description":" Represents a single git message trailer.","comments":"","fields":[{"type":"const char *","name":"key","comments":""},{"type":"const char *","name":"value","comments":""}],"used":{"returns":[],"needs":["git_message_trailer_array_free","git_message_trailers"]}}],["git_message_trailer_array",{"decl":["git_message_trailer * trailers","size_t count","char * _trailer_block"],"type":"struct","value":"git_message_trailer_array","file":"git2/message.h","line":54,"lineto":60,"block":"git_message_trailer * trailers\nsize_t count\nchar * _trailer_block","tdef":"typedef","description":" Represents an array of git message trailers.","comments":"<p>Struct members under the private comment are private, subject to change and should not be used by callers.</p>\n","fields":[{"type":"git_message_trailer *","name":"trailers","comments":""},{"type":"size_t","name":"count","comments":""},{"type":"char *","name":"_trailer_block","comments":""}],"used":{"returns":[],"needs":["git_message_trailer_array_free","git_message_trailers"]}}],["git_note",{"decl":"git_note","type":"struct","value":"git_note","file":"git2/types.h","line":153,"lineto":153,"tdef":"typedef","description":" Representation of a git note ","comments":"","used":{"returns":[],"needs":["git_note_author","git_note_commit_iterator_new","git_note_commit_read","git_note_committer","git_note_foreach","git_note_free","git_note_id","git_note_iterator_free","git_note_iterator_new","git_note_message","git_note_next","git_note_read"]}}],["git_note_iterator",{"decl":"git_note_iterator","type":"struct","value":"git_note_iterator","file":"git2/notes.h","line":35,"lineto":35,"tdef":"typedef","description":" note iterator","comments":"","used":{"returns":[],"needs":["git_note_commit_iterator_new","git_note_iterator_free","git_note_iterator_new","git_note_next"]}}],["git_object",{"decl":"git_object","type":"struct","value":"git_object","file":"git2/types.h","line":111,"lineto":111,"tdef":"typedef","description":" Representation of a generic object in a repository ","comments":"","used":{"returns":[],"needs":["git_checkout_tree","git_describe_commit","git_object_dup","git_object_free","git_object_id","git_object_lookup","git_object_lookup_bypath","git_object_lookup_prefix","git_object_owner","git_object_peel","git_object_short_id","git_object_type","git_reference_peel","git_reset","git_reset_default","git_revparse_ext","git_revparse_single","git_tag_annotation_create","git_tag_create","git_tag_create_lightweight","git_tag_peel","git_tag_target","git_tree_entry_to_object"]}}],["git_odb",{"decl":"git_odb","type":"struct","value":"git_odb","file":"git2/types.h","line":81,"lineto":81,"tdef":"typedef","description":" An open object database handle. ","comments":"","used":{"returns":[],"needs":["git_indexer_new","git_odb_add_alternate","git_odb_add_backend","git_odb_add_disk_alternate","git_odb_backend_loose","git_odb_backend_one_pack","git_odb_backend_pack","git_odb_exists","git_odb_exists_prefix","git_odb_expand_ids","git_odb_foreach","git_odb_free","git_odb_get_backend","git_odb_new","git_odb_num_backends","git_odb_object_data","git_odb_object_dup","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_stream_finalize_write","git_odb_stream_free","git_odb_stream_read","git_odb_stream_write","git_odb_write","git_odb_write_pack","git_repository_odb","git_repository_wrap_odb"]}}],["git_odb_backend",{"decl":"git_odb_backend","type":"struct","value":"git_odb_backend","file":"git2/types.h","line":84,"lineto":84,"tdef":"typedef","description":" A custom backend in an ODB ","comments":"","used":{"returns":[],"needs":["git_odb_add_alternate","git_odb_add_backend","git_odb_backend_loose","git_odb_backend_one_pack","git_odb_backend_pack","git_odb_get_backend"]}}],["git_odb_expand_id",{"decl":["git_oid id","unsigned short length","git_otype type"],"type":"struct","value":"git_odb_expand_id","file":"git2/odb.h","line":180,"lineto":195,"block":"git_oid id\nunsigned short length\ngit_otype type","tdef":"typedef","description":" The information about object IDs to query in `git_odb_expand_ids`,\n which will be populated upon return.","comments":"","fields":[{"type":"git_oid","name":"id","comments":" The object ID to expand "},{"type":"unsigned short","name":"length","comments":" The length of the object ID (in nibbles, or packets of 4 bits; the\n number of hex characters)"},{"type":"git_otype","name":"type","comments":" The (optional) type of the object to search for; leave as `0` or set\n to `GIT_OBJ_ANY` to query for any object matching the ID."}],"used":{"returns":[],"needs":["git_odb_expand_ids"]}}],["git_odb_object",{"decl":"git_odb_object","type":"struct","value":"git_odb_object","file":"git2/types.h","line":87,"lineto":87,"tdef":"typedef","description":" An object read from the ODB ","comments":"","used":{"returns":[],"needs":["git_odb_object_data","git_odb_object_dup","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":"git_odb_stream","type":"struct","value":"git_odb_stream","file":"git2/types.h","line":90,"lineto":90,"block":"git_odb_backend * backend\nunsigned int mode\nvoid * hash_ctx\ngit_off_t declared_size\ngit_off_t received_bytes\nint (*)(git_odb_stream *, char *, size_t) read\nint (*)(git_odb_stream *, const char *, size_t) write\nint (*)(git_odb_stream *, const int *) finalize_write\nvoid (*)(git_odb_stream *) free","tdef":"typedef","description":" A stream to read/write from the ODB ","comments":"","fields":[{"type":"git_odb_backend *","name":"backend","comments":""},{"type":"unsigned int","name":"mode","comments":""},{"type":"void *","name":"hash_ctx","comments":""},{"type":"git_off_t","name":"declared_size","comments":""},{"type":"git_off_t","name":"received_bytes","comments":""},{"type":"int (*)(git_odb_stream *, char *, size_t)","name":"read","comments":" Write at most `len` bytes into `buffer` and advance the stream."},{"type":"int (*)(git_odb_stream *, const char *, size_t)","name":"write","comments":" Write `len` bytes from `buffer` into the stream."},{"type":"int (*)(git_odb_stream *, const int *)","name":"finalize_write","comments":" Store the contents of the stream as an object with the id\n specified in `oid`.\n\n This method might not be invoked if:\n - an error occurs earlier with the `write` callback,\n - the object referred to by `oid` already exists in any backend, or\n - the final number of received bytes differs from the size declared\n with `git_odb_open_wstream()`"},{"type":"void (*)(git_odb_stream *)","name":"free","comments":" Free the stream's memory.\n\n This method might be called without a call to `finalize_write` if\n an error occurs or if the object is already present in the ODB."}],"used":{"returns":[],"needs":["git_odb_open_rstream","git_odb_open_wstream","git_odb_stream_finalize_write","git_odb_stream_free","git_odb_stream_read","git_odb_stream_write"]}}],["git_odb_stream_t",{"decl":["GIT_STREAM_RDONLY","GIT_STREAM_WRONLY","GIT_STREAM_RW"],"type":"enum","file":"git2/odb_backend.h","line":70,"lineto":74,"block":"GIT_STREAM_RDONLY\nGIT_STREAM_WRONLY\nGIT_STREAM_RW","tdef":"typedef","description":" Streaming mode ","comments":"","fields":[{"type":"int","name":"GIT_STREAM_RDONLY","comments":"","value":2},{"type":"int","name":"GIT_STREAM_WRONLY","comments":"","value":4},{"type":"int","name":"GIT_STREAM_RW","comments":"","value":6}],"used":{"returns":[],"needs":[]}}],["git_odb_writepack",{"decl":"git_odb_writepack","type":"struct","value":"git_odb_writepack","file":"git2/types.h","line":93,"lineto":93,"block":"git_odb_backend * backend\nint (*)(git_odb_writepack *, const void *, size_t, git_transfer_progress *) append\nint (*)(git_odb_writepack *, git_transfer_progress *) commit\nvoid (*)(git_odb_writepack *) free","tdef":"typedef","description":" A stream to write a packfile to the ODB ","comments":"","fields":[{"type":"git_odb_backend *","name":"backend","comments":""},{"type":"int (*)(git_odb_writepack *, const void *, size_t, git_transfer_progress *)","name":"append","comments":""},{"type":"int (*)(git_odb_writepack *, git_transfer_progress *)","name":"commit","comments":""},{"type":"void (*)(git_odb_writepack *)","name":"free","comments":""}],"used":{"returns":[],"needs":["git_odb_write_pack"]}}],["git_oid",{"decl":["unsigned char [20] id"],"type":"struct","value":"git_oid","file":"git2/oid.h","line":33,"lineto":36,"block":"unsigned char [20] id","tdef":"typedef","description":" Unique identity of any object (commit, tree, blob, tag). ","comments":"","fields":[{"type":"unsigned char [20]","name":"id","comments":" raw binary formatted id "}],"used":{"returns":["git_annotated_commit_id","git_blob_id","git_commit_id","git_commit_parent_id","git_commit_tree_id","git_index_checksum","git_indexer_hash","git_note_id","git_object_id","git_odb_object_id","git_oid_shorten_new","git_packbuilder_hash","git_reference_target","git_reference_target_peel","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_annotated_commit_from_fetchhead","git_annotated_commit_lookup","git_blob_create_frombuffer","git_blob_create_fromdisk","git_blob_create_fromstream_commit","git_blob_create_fromworkdir","git_blob_lookup","git_blob_lookup_prefix","git_commit_amend","git_commit_create","git_commit_create_v","git_commit_create_with_signature","git_commit_extract_signature","git_commit_lookup","git_commit_lookup_prefix","git_diff_patchid","git_graph_ahead_behind","git_graph_descendant_of","git_index_write_tree","git_index_write_tree_to","git_merge_base","git_merge_base_many","git_merge_base_octopus","git_merge_bases","git_merge_bases_many","git_note_commit_create","git_note_commit_read","git_note_commit_remove","git_note_create","git_note_foreach_cb","git_note_next","git_note_read","git_note_remove","git_object_lookup","git_object_lookup_prefix","git_odb_exists","git_odb_exists_prefix","git_odb_foreach_cb","git_odb_hash","git_odb_hashfile","git_odb_open_rstream","git_odb_read","git_odb_read_header","git_odb_read_prefix","git_odb_stream_finalize_write","git_odb_write","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_nfmt","git_oid_pathfmt","git_oid_shorten_add","git_oid_shorten_free","git_oid_strcmp","git_oid_streq","git_oid_tostr","git_oid_tostr_s","git_oidarray_free","git_packbuilder_insert","git_packbuilder_insert_commit","git_packbuilder_insert_recur","git_packbuilder_insert_tree","git_rebase_commit","git_reference_create","git_reference_create_matching","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_hide_cb","git_revwalk_next","git_revwalk_push","git_tag_annotation_create","git_tag_create","git_tag_create_frombuffer","git_tag_create_lightweight","git_tag_lookup","git_tag_lookup_prefix","git_tree_create_updated","git_tree_entry_byid","git_tree_lookup","git_tree_lookup_prefix","git_treebuilder_insert","git_treebuilder_write","git_treebuilder_write_with_buffer"]}}],["git_oid_shorten",{"decl":"git_oid_shorten","type":"struct","value":"git_oid_shorten","file":"git2/oid.h","line":215,"lineto":215,"tdef":"typedef","description":" OID Shortener object","comments":"","used":{"returns":["git_oid_shorten_new"],"needs":["git_oid_shorten_add","git_oid_shorten_free"]}}],["git_oidarray",{"decl":["git_oid * ids","size_t count"],"type":"struct","value":"git_oidarray","file":"git2/oidarray.h","line":16,"lineto":19,"block":"git_oid * ids\nsize_t count","tdef":"typedef","description":" Array of object ids ","comments":"","fields":[{"type":"git_oid *","name":"ids","comments":""},{"type":"size_t","name":"count","comments":""}],"used":{"returns":[],"needs":["git_merge_bases","git_merge_bases_many","git_oidarray_free"]}}],["git_otype",{"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":"git2/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","description":" Basic type (loose or packed) of any Git object. ","comments":"","fields":[{"type":"int","name":"GIT_OBJ_ANY","comments":"<p>Object can be any of the following </p>\n","value":-2},{"type":"int","name":"GIT_OBJ_BAD","comments":"<p>Object is invalid. </p>\n","value":-1},{"type":"int","name":"GIT_OBJ__EXT1","comments":"<p>Reserved for future use. </p>\n","value":0},{"type":"int","name":"GIT_OBJ_COMMIT","comments":"<p>A commit object. </p>\n","value":1},{"type":"int","name":"GIT_OBJ_TREE","comments":"<p>A tree (directory listing) object. </p>\n","value":2},{"type":"int","name":"GIT_OBJ_BLOB","comments":"<p>A file revision object. </p>\n","value":3},{"type":"int","name":"GIT_OBJ_TAG","comments":"<p>An annotated tag object. </p>\n","value":4},{"type":"int","name":"GIT_OBJ__EXT2","comments":"<p>Reserved for future use. </p>\n","value":5},{"type":"int","name":"GIT_OBJ_OFS_DELTA","comments":"<p>A delta, base is given by an offset. </p>\n","value":6},{"type":"int","name":"GIT_OBJ_REF_DELTA","comments":"<p>A delta, base is given by object id. </p>\n","value":7}],"used":{"returns":["git_object_string2type","git_object_type","git_odb_object_type","git_tag_target_type","git_tree_entry_type"],"needs":["git_object__size","git_object_lookup","git_object_lookup_bypath","git_object_lookup_prefix","git_object_peel","git_object_type2string","git_object_typeisloose","git_odb_hash","git_odb_hashfile","git_odb_open_rstream","git_odb_open_wstream","git_odb_read_header","git_odb_write","git_reference_peel","git_repository_hashfile"]}}],["git_packbuilder",{"decl":"git_packbuilder","type":"struct","value":"git_packbuilder","file":"git2/types.h","line":156,"lineto":156,"tdef":"typedef","description":" Representation of a git packbuilder ","comments":"","used":{"returns":[],"needs":["git_packbuilder_foreach","git_packbuilder_free","git_packbuilder_hash","git_packbuilder_insert","git_packbuilder_insert_commit","git_packbuilder_insert_recur","git_packbuilder_insert_tree","git_packbuilder_insert_walk","git_packbuilder_new","git_packbuilder_object_count","git_packbuilder_set_callbacks","git_packbuilder_set_threads","git_packbuilder_write","git_packbuilder_written"]}}],["git_packbuilder_stage_t",{"decl":["GIT_PACKBUILDER_ADDING_OBJECTS","GIT_PACKBUILDER_DELTAFICATION"],"type":"enum","file":"git2/pack.h","line":51,"lineto":54,"block":"GIT_PACKBUILDER_ADDING_OBJECTS\nGIT_PACKBUILDER_DELTAFICATION","tdef":"typedef","description":" Stages that are reported by the packbuilder progress callback.","comments":"","fields":[{"type":"int","name":"GIT_PACKBUILDER_ADDING_OBJECTS","comments":"","value":0},{"type":"int","name":"GIT_PACKBUILDER_DELTAFICATION","comments":"","value":1}],"used":{"returns":[],"needs":[]}}],["git_patch",{"decl":"git_patch","type":"struct","value":"git_patch","file":"git2/patch.h","line":29,"lineto":29,"tdef":"typedef","description":" The diff patch is used to store all the text diffs for a delta.","comments":"<p>You can easily loop over the content of patches and get information about them.</p>\n","used":{"returns":[],"needs":["git_patch_free","git_patch_from_blob_and_buffer","git_patch_from_blobs","git_patch_from_buffers","git_patch_from_diff","git_patch_get_delta","git_patch_get_hunk","git_patch_get_line_in_hunk","git_patch_line_stats","git_patch_num_hunks","git_patch_num_lines_in_hunk","git_patch_print","git_patch_size","git_patch_to_buf"]}}],["git_proxy_options",{"decl":["unsigned int version","git_proxy_t type","const char * url","git_cred_acquire_cb credentials","git_transport_certificate_check_cb certificate_check","void * payload"],"type":"struct","value":"git_proxy_options","file":"git2/proxy.h","line":42,"lineto":77,"block":"unsigned int version\ngit_proxy_t type\nconst char * url\ngit_cred_acquire_cb credentials\ngit_transport_certificate_check_cb certificate_check\nvoid * payload","tdef":"typedef","description":" Options for connecting through a proxy","comments":"<p>Note that not all types may be supported, depending on the platform and compilation options.</p>\n","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"git_proxy_t","name":"type","comments":" The type of proxy to use, by URL, auto-detect."},{"type":"const char *","name":"url","comments":" The URL of the proxy."},{"type":"git_cred_acquire_cb","name":"credentials","comments":" This will be called if the remote host requires\n authentication in order to connect to it.\n\n Returning GIT_PASSTHROUGH will make libgit2 behave as\n though this field isn't set."},{"type":"git_transport_certificate_check_cb","name":"certificate_check","comments":" If cert verification fails, this will be called to let the\n user make the final decision of whether to allow the\n connection to proceed. Returns 1 to allow the connection, 0\n to disallow it or a negative value to indicate an error."},{"type":"void *","name":"payload","comments":" Payload to be provided to the credentials and certificate\n check callbacks."}],"used":{"returns":[],"needs":["git_proxy_init_options","git_remote_connect"]}}],["git_proxy_t",{"decl":["GIT_PROXY_NONE","GIT_PROXY_AUTO","GIT_PROXY_SPECIFIED"],"type":"enum","file":"git2/proxy.h","line":18,"lineto":34,"block":"GIT_PROXY_NONE\nGIT_PROXY_AUTO\nGIT_PROXY_SPECIFIED","tdef":"typedef","description":" The type of proxy to use.","comments":"","fields":[{"type":"int","name":"GIT_PROXY_NONE","comments":"<p>Do not attempt to connect through a proxy</p>\n\n<p>If built against libcurl, it itself may attempt to connect\n to a proxy if the environment variables specify it.</p>\n","value":0},{"type":"int","name":"GIT_PROXY_AUTO","comments":"<p>Try to auto-detect the proxy from the git configuration.</p>\n","value":1},{"type":"int","name":"GIT_PROXY_SPECIFIED","comments":"<p>Connect via the URL given in the options</p>\n","value":2}],"used":{"returns":[],"needs":[]}}],["git_push",{"decl":"git_push","type":"struct","value":"git_push","file":"git2/types.h","line":240,"lineto":240,"tdef":"typedef","description":" Preparation for a push operation. Can be used to configure what to\n push and the level of parallelism of the packfile builder.","comments":"","used":{"returns":[],"needs":["git_push_init_options","git_push_negotiation","git_remote_push","git_remote_upload"]}}],["git_push_options",{"decl":["unsigned int version","unsigned int pb_parallelism","git_remote_callbacks callbacks","git_proxy_options proxy_opts","git_strarray custom_headers"],"type":"struct","value":"git_push_options","file":"git2/remote.h","line":615,"lineto":642,"block":"unsigned int version\nunsigned int pb_parallelism\ngit_remote_callbacks callbacks\ngit_proxy_options proxy_opts\ngit_strarray custom_headers","tdef":"typedef","description":" Controls the behavior of a git_push object.","comments":"","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"unsigned int","name":"pb_parallelism","comments":" If the transport being used to push to the remote requires the creation\n of a pack file, this controls the number of worker threads used by\n the packbuilder when creating that pack file to be sent to the remote.\n\n If set to 0, the packbuilder will auto-detect the number of threads\n to create. The default value is 1."},{"type":"git_remote_callbacks","name":"callbacks","comments":" Callbacks to use for this push operation"},{"type":"git_proxy_options","name":"proxy_opts","comments":" Proxy options to use, by default no proxy is used."},{"type":"git_strarray","name":"custom_headers","comments":" Extra headers for this push operation"}],"used":{"returns":[],"needs":["git_push_init_options","git_remote_push","git_remote_upload"]}}],["git_push_update",{"decl":["char * src_refname","char * dst_refname","git_oid src","git_oid dst"],"type":"struct","value":"git_push_update","file":"git2/remote.h","line":359,"lineto":376,"block":"char * src_refname\nchar * dst_refname\ngit_oid src\ngit_oid dst","tdef":"typedef","description":" Represents an update which will be performed on the remote during push","comments":"","fields":[{"type":"char *","name":"src_refname","comments":" The source name of the reference"},{"type":"char *","name":"dst_refname","comments":" The name of the reference to update on the server"},{"type":"git_oid","name":"src","comments":" The current target of the reference"},{"type":"git_oid","name":"dst","comments":" The new target for the reference"}],"used":{"returns":[],"needs":["git_push_negotiation"]}}],["git_rebase",{"decl":"git_rebase","type":"struct","value":"git_rebase","file":"git2/types.h","line":191,"lineto":191,"tdef":"typedef","description":" Representation of a rebase ","comments":"","used":{"returns":["git_rebase_operation_byindex"],"needs":["git_rebase_abort","git_rebase_commit","git_rebase_finish","git_rebase_free","git_rebase_init","git_rebase_init_options","git_rebase_inmemory_index","git_rebase_next","git_rebase_open","git_rebase_operation_byindex","git_rebase_operation_current","git_rebase_operation_entrycount"]}}],["git_rebase_operation",{"decl":["git_rebase_operation_t type","const git_oid id","const char * exec"],"type":"struct","value":"git_rebase_operation","file":"git2/rebase.h","line":130,"lineto":145,"block":"git_rebase_operation_t type\nconst git_oid id\nconst char * exec","tdef":"typedef","description":" A rebase operation","comments":"<p>Describes a single instruction/operation to be performed during the rebase.</p>\n","fields":[{"type":"git_rebase_operation_t","name":"type","comments":" The type of rebase operation. "},{"type":"const git_oid","name":"id","comments":" The commit ID being cherry-picked. This will be populated for\n all operations except those of type `GIT_REBASE_OPERATION_EXEC`."},{"type":"const char *","name":"exec","comments":" The executable the user has requested be run. This will only\n be populated for operations of type `GIT_REBASE_OPERATION_EXEC`."}],"used":{"returns":["git_rebase_operation_byindex"],"needs":["git_rebase_next"]}}],["git_rebase_operation_t",{"decl":["GIT_REBASE_OPERATION_PICK","GIT_REBASE_OPERATION_REWORD","GIT_REBASE_OPERATION_EDIT","GIT_REBASE_OPERATION_SQUASH","GIT_REBASE_OPERATION_FIXUP","GIT_REBASE_OPERATION_EXEC"],"type":"enum","file":"git2/rebase.h","line":78,"lineto":114,"block":"GIT_REBASE_OPERATION_PICK\nGIT_REBASE_OPERATION_REWORD\nGIT_REBASE_OPERATION_EDIT\nGIT_REBASE_OPERATION_SQUASH\nGIT_REBASE_OPERATION_FIXUP\nGIT_REBASE_OPERATION_EXEC","tdef":"typedef","description":" Type of rebase operation in-progress after calling `git_rebase_next`.","comments":"","fields":[{"type":"int","name":"GIT_REBASE_OPERATION_PICK","comments":"<p>The given commit is to be cherry-picked. The client should commit\n the changes and continue if there are no conflicts.</p>\n","value":0},{"type":"int","name":"GIT_REBASE_OPERATION_REWORD","comments":"<p>The given commit is to be cherry-picked, but the client should prompt\n the user to provide an updated commit message.</p>\n","value":1},{"type":"int","name":"GIT_REBASE_OPERATION_EDIT","comments":"<p>The given commit is to be cherry-picked, but the client should stop\n to allow the user to edit the changes before committing them.</p>\n","value":2},{"type":"int","name":"GIT_REBASE_OPERATION_SQUASH","comments":"<p>The given commit is to be squashed into the previous commit. The\n commit message will be merged with the previous message.</p>\n","value":3},{"type":"int","name":"GIT_REBASE_OPERATION_FIXUP","comments":"<p>The given commit is to be squashed into the previous commit. The\n commit message from this commit will be discarded.</p>\n","value":4},{"type":"int","name":"GIT_REBASE_OPERATION_EXEC","comments":"<p>No commit will be cherry-picked. The client should run the given\n command and (if successful) continue.</p>\n","value":5}],"used":{"returns":[],"needs":[]}}],["git_ref_t",{"decl":["GIT_REF_INVALID","GIT_REF_OID","GIT_REF_SYMBOLIC","GIT_REF_LISTALL"],"type":"enum","file":"git2/types.h","line":194,"lineto":199,"block":"GIT_REF_INVALID\nGIT_REF_OID\nGIT_REF_SYMBOLIC\nGIT_REF_LISTALL","tdef":"typedef","description":" Basic type of any Git reference. ","comments":"","fields":[{"type":"int","name":"GIT_REF_INVALID","comments":"<p>Invalid reference </p>\n","value":0},{"type":"int","name":"GIT_REF_OID","comments":"<p>A reference which points at an object id </p>\n","value":1},{"type":"int","name":"GIT_REF_SYMBOLIC","comments":"<p>A reference which points at another reference </p>\n","value":2},{"type":"int","name":"GIT_REF_LISTALL","comments":"","value":3}],"used":{"returns":["git_reference_type"],"needs":[]}}],["git_refdb",{"decl":"git_refdb","type":"struct","value":"git_refdb","file":"git2/types.h","line":96,"lineto":96,"tdef":"typedef","description":" An open refs database handle. ","comments":"","used":{"returns":[],"needs":["git_refdb_compress","git_refdb_free","git_refdb_new","git_refdb_open","git_repository_refdb"]}}],["git_refdb_backend",{"decl":"git_refdb_backend","type":"struct","value":"git_refdb_backend","file":"git2/types.h","line":99,"lineto":99,"block":"unsigned int version\nint (*)(int *, struct git_refdb_backend *, const char *) exists\nint (*)(int **, struct git_refdb_backend *, const char *) lookup\nint (*)(int **, struct git_refdb_backend *, const char *) iterator\nint (*)(struct git_refdb_backend *, const int *, int, const int *, const char *, const int *, const char *) write\nint (*)(int **, struct git_refdb_backend *, const char *, const char *, int, const int *, const char *) rename\nint (*)(struct git_refdb_backend *, const char *, const int *, const char *) del\nint (*)(struct git_refdb_backend *) compress\nint (*)(struct git_refdb_backend *, const char *) has_log\nint (*)(struct git_refdb_backend *, const char *) ensure_log\nvoid (*)(struct git_refdb_backend *) free\nint (*)(int **, struct git_refdb_backend *, const char *) reflog_read\nint (*)(struct git_refdb_backend *, int *) reflog_write\nint (*)(struct git_refdb_backend *, const char *, const char *) reflog_rename\nint (*)(struct git_refdb_backend *, const char *) reflog_delete\nint (*)(void **, struct git_refdb_backend *, const char *) lock\nint (*)(struct git_refdb_backend *, void *, int, int, const int *, const int *, const char *) unlock","tdef":"typedef","description":" A custom backend for refs ","comments":"","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"int (*)(int *, struct git_refdb_backend *, const char *)","name":"exists","comments":" Queries the refdb backend to determine if the given ref_name\n exists. A refdb implementation must provide this function."},{"type":"int (*)(int **, struct git_refdb_backend *, const char *)","name":"lookup","comments":" Queries the refdb backend for a given reference. A refdb\n implementation must provide this function."},{"type":"int (*)(int **, struct git_refdb_backend *, const char *)","name":"iterator","comments":" Allocate an iterator object for the backend.\n\n A refdb implementation must provide this function."},{"type":"int (*)(struct git_refdb_backend *, const int *, int, const int *, const char *, const int *, const char *)","name":"write","comments":""},{"type":"int (*)(int **, struct git_refdb_backend *, const char *, const char *, int, const int *, const char *)","name":"rename","comments":""},{"type":"int (*)(struct git_refdb_backend *, const char *, const int *, const char *)","name":"del","comments":" Deletes the given reference (and if necessary its reflog)\n from the refdb. A refdb implementation must provide this\n function."},{"type":"int (*)(struct git_refdb_backend *)","name":"compress","comments":" Suggests that the given refdb compress or optimize its references.\n This mechanism is implementation specific. (For on-disk reference\n databases, this may pack all loose references.) A refdb\n implementation may provide this function; if it is not provided,\n nothing will be done."},{"type":"int (*)(struct git_refdb_backend *, const char *)","name":"has_log","comments":" Query whether a particular reference has a log (may be empty)"},{"type":"int (*)(struct git_refdb_backend *, const char *)","name":"ensure_log","comments":" Make sure a particular reference will have a reflog which\n will be appended to on writes."},{"type":"void (*)(struct git_refdb_backend *)","name":"free","comments":" Frees any resources held by the refdb (including the `git_refdb_backend`\n itself). A refdb backend implementation must provide this function."},{"type":"int (*)(int **, struct git_refdb_backend *, const char *)","name":"reflog_read","comments":" Read the reflog for the given reference name."},{"type":"int (*)(struct git_refdb_backend *, int *)","name":"reflog_write","comments":" Write a reflog to disk."},{"type":"int (*)(struct git_refdb_backend *, const char *, const char *)","name":"reflog_rename","comments":" Rename a reflog"},{"type":"int (*)(struct git_refdb_backend *, const char *)","name":"reflog_delete","comments":" Remove a reflog."},{"type":"int (*)(void **, struct git_refdb_backend *, const char *)","name":"lock","comments":" Lock a reference. The opaque parameter will be passed to the unlock function"},{"type":"int (*)(struct git_refdb_backend *, void *, int, int, const int *, const int *, const char *)","name":"unlock","comments":" Unlock a reference. Only one of target or symbolic_target\n will be set. success indicates whether to update the\n reference or discard the lock (if it's false)"}],"used":{"returns":[],"needs":[]}}],["git_reference",{"decl":"git_reference","type":"struct","value":"git_reference","file":"git2/types.h","line":173,"lineto":173,"tdef":"typedef","description":" In-memory representation of a reference. ","comments":"","used":{"returns":[],"needs":["git_annotated_commit_from_ref","git_branch_create","git_branch_create_from_annotated","git_branch_delete","git_branch_is_checked_out","git_branch_is_head","git_branch_lookup","git_branch_move","git_branch_name","git_branch_next","git_branch_set_upstream","git_branch_upstream","git_reference_cmp","git_reference_create","git_reference_create_matching","git_reference_delete","git_reference_dup","git_reference_dwim","git_reference_foreach","git_reference_foreach_glob","git_reference_foreach_name","git_reference_free","git_reference_is_branch","git_reference_is_note","git_reference_is_remote","git_reference_is_tag","git_reference_iterator_free","git_reference_iterator_glob_new","git_reference_iterator_new","git_reference_lookup","git_reference_name","git_reference_next","git_reference_next_name","git_reference_owner","git_reference_peel","git_reference_rename","git_reference_resolve","git_reference_set_target","git_reference_shorthand","git_reference_symbolic_create","git_reference_symbolic_create_matching","git_reference_symbolic_set_target","git_reference_symbolic_target","git_reference_target","git_reference_target_peel","git_reference_type","git_repository_head","git_repository_head_for_worktree","git_revparse_ext"]}}],["git_reference_iterator",{"decl":"git_reference_iterator","type":"struct","value":"git_reference_iterator","file":"git2/types.h","line":176,"lineto":176,"tdef":"typedef","description":" Iterator for references ","comments":"","used":{"returns":[],"needs":["git_reference_iterator_free","git_reference_iterator_glob_new","git_reference_iterator_new","git_reference_next","git_reference_next_name"]}}],["git_reference_normalize_t",{"decl":["GIT_REF_FORMAT_NORMAL","GIT_REF_FORMAT_ALLOW_ONELEVEL","GIT_REF_FORMAT_REFSPEC_PATTERN","GIT_REF_FORMAT_REFSPEC_SHORTHAND"],"type":"enum","file":"git2/refs.h","line":639,"lineto":668,"block":"GIT_REF_FORMAT_NORMAL\nGIT_REF_FORMAT_ALLOW_ONELEVEL\nGIT_REF_FORMAT_REFSPEC_PATTERN\nGIT_REF_FORMAT_REFSPEC_SHORTHAND","tdef":"typedef","description":" Normalization options for reference lookup","comments":"","fields":[{"type":"int","name":"GIT_REF_FORMAT_NORMAL","comments":"<p>No particular normalization.</p>\n","value":0},{"type":"int","name":"GIT_REF_FORMAT_ALLOW_ONELEVEL","comments":"<p>Control whether one-level refnames are accepted\n (i.e., refnames that do not contain multiple /-separated\n components). Those are expected to be written only using\n uppercase letters and underscore (FETCH_HEAD, ...)</p>\n","value":1},{"type":"int","name":"GIT_REF_FORMAT_REFSPEC_PATTERN","comments":"<p>Interpret the provided name as a reference pattern for a\n refspec (as used with remote repositories). If this option\n is enabled, the name is allowed to contain a single * (\n<star</p>\n\n<blockquote>\n<p>)\n in place of a one full pathname component\n (e.g., foo/\n<star\n/bar but not foo/bar\n<star\n).</p>\n</blockquote>\n","value":2},{"type":"int","name":"GIT_REF_FORMAT_REFSPEC_SHORTHAND","comments":"<p>Interpret the name as part of a refspec in shorthand form\n so the <code>ONELEVEL</code> naming rules aren't enforced and 'master'\n becomes a valid name.</p>\n","value":4}],"used":{"returns":[],"needs":[]}}],["git_reflog",{"decl":"git_reflog","type":"struct","value":"git_reflog","file":"git2/types.h","line":150,"lineto":150,"tdef":"typedef","description":" Representation of a reference log ","comments":"","used":{"returns":["git_reflog_entry_byindex"],"needs":["git_reflog_append","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_write"]}}],["git_reflog_entry",{"decl":"git_reflog_entry","type":"struct","value":"git_reflog_entry","file":"git2/types.h","line":147,"lineto":147,"tdef":"typedef","description":" Representation of a reference log entry ","comments":"","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",{"decl":"git_remote","type":"struct","value":"git_remote","file":"git2/types.h","line":228,"lineto":228,"tdef":"typedef","description":" Git's idea of a remote repository. A remote can be anonymous (in\n which case it does not have backing configuration entires).","comments":"","used":{"returns":["git_remote_autotag"],"needs":["git_headlist_cb","git_remote_autotag","git_remote_connect","git_remote_connected","git_remote_create","git_remote_create_anonymous","git_remote_create_cb","git_remote_create_detached","git_remote_create_with_fetchspec","git_remote_default_branch","git_remote_disconnect","git_remote_download","git_remote_dup","git_remote_fetch","git_remote_free","git_remote_get_fetch_refspecs","git_remote_get_push_refspecs","git_remote_get_refspec","git_remote_init_callbacks","git_remote_lookup","git_remote_ls","git_remote_name","git_remote_owner","git_remote_prune","git_remote_prune_refs","git_remote_push","git_remote_pushurl","git_remote_refspec_count","git_remote_set_autotag","git_remote_stats","git_remote_stop","git_remote_update_tips","git_remote_upload","git_remote_url","git_transport_cb"]}}],["git_remote_autotag_option_t",{"decl":["GIT_REMOTE_DOWNLOAD_TAGS_UNSPECIFIED","GIT_REMOTE_DOWNLOAD_TAGS_AUTO","GIT_REMOTE_DOWNLOAD_TAGS_NONE","GIT_REMOTE_DOWNLOAD_TAGS_ALL"],"type":"enum","file":"git2/remote.h","line":527,"lineto":545,"block":"GIT_REMOTE_DOWNLOAD_TAGS_UNSPECIFIED\nGIT_REMOTE_DOWNLOAD_TAGS_AUTO\nGIT_REMOTE_DOWNLOAD_TAGS_NONE\nGIT_REMOTE_DOWNLOAD_TAGS_ALL","tdef":"typedef","description":" Automatic tag following option","comments":"<p>Lets us select the --tags option to use.</p>\n","fields":[{"type":"int","name":"GIT_REMOTE_DOWNLOAD_TAGS_UNSPECIFIED","comments":"<p>Use the setting from the configuration.</p>\n","value":0},{"type":"int","name":"GIT_REMOTE_DOWNLOAD_TAGS_AUTO","comments":"<p>Ask the server for tags pointing to objects we're already\n downloading.</p>\n","value":1},{"type":"int","name":"GIT_REMOTE_DOWNLOAD_TAGS_NONE","comments":"<p>Don't ask for any tags beyond the refspecs.</p>\n","value":2},{"type":"int","name":"GIT_REMOTE_DOWNLOAD_TAGS_ALL","comments":"<p>Ask for the all the tags.</p>\n","value":3}],"used":{"returns":["git_remote_autotag"],"needs":["git_remote_set_autotag","git_remote_update_tips"]}}],["git_remote_callbacks",{"decl":["unsigned int version","git_transport_message_cb sideband_progress","int (*)(git_remote_completion_type, void *) completion","git_cred_acquire_cb credentials","git_transport_certificate_check_cb certificate_check","git_transfer_progress_cb transfer_progress","int (*)(const char *, const git_oid *, const git_oid *, void *) update_tips","git_packbuilder_progress pack_progress","git_push_transfer_progress push_transfer_progress","git_push_update_reference_cb push_update_reference","git_push_negotiation push_negotiation","git_transport_cb transport","void * payload"],"type":"struct","value":"git_remote_callbacks","file":"git2/remote.h","line":408,"lineto":490,"block":"unsigned int version\ngit_transport_message_cb sideband_progress\nint (*)(git_remote_completion_type, void *) completion\ngit_cred_acquire_cb credentials\ngit_transport_certificate_check_cb certificate_check\ngit_transfer_progress_cb transfer_progress\nint (*)(const char *, const git_oid *, const git_oid *, void *) update_tips\ngit_packbuilder_progress pack_progress\ngit_push_transfer_progress push_transfer_progress\ngit_push_update_reference_cb push_update_reference\ngit_push_negotiation push_negotiation\ngit_transport_cb transport\nvoid * payload","tdef":null,"description":" The callback settings structure","comments":"<p>Set the callbacks to be called by the remote when informing the user about the progress of the network operations.</p>\n","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"git_transport_message_cb","name":"sideband_progress","comments":" Textual progress from the remote. Text send over the\n progress side-band will be passed to this function (this is\n the 'counting objects' output)."},{"type":"int (*)(git_remote_completion_type, void *)","name":"completion","comments":" Completion is called when different parts of the download\n process are done (currently unused)."},{"type":"git_cred_acquire_cb","name":"credentials","comments":" This will be called if the remote host requires\n authentication in order to connect to it.\n\n Returning GIT_PASSTHROUGH will make libgit2 behave as\n though this field isn't set."},{"type":"git_transport_certificate_check_cb","name":"certificate_check","comments":" If cert verification fails, this will be called to let the\n user make the final decision of whether to allow the\n connection to proceed. Returns 1 to allow the connection, 0\n to disallow it or a negative value to indicate an error."},{"type":"git_transfer_progress_cb","name":"transfer_progress","comments":" During the download of new data, this will be regularly\n called with the current count of progress done by the\n indexer."},{"type":"int (*)(const char *, const git_oid *, const git_oid *, void *)","name":"update_tips","comments":" Each time a reference is updated locally, this function\n will be called with information about it."},{"type":"git_packbuilder_progress","name":"pack_progress","comments":" Function to call with progress information during pack\n building. Be aware that this is called inline with pack\n building operations, so performance may be affected."},{"type":"git_push_transfer_progress","name":"push_transfer_progress","comments":" Function to call with progress information during the\n upload portion of a push. Be aware that this is called\n inline with pack building operations, so performance may be\n affected."},{"type":"git_push_update_reference_cb","name":"push_update_reference","comments":" See documentation of git_push_update_reference_cb"},{"type":"git_push_negotiation","name":"push_negotiation","comments":" Called once between the negotiation step and the upload. It\n provides information about what updates will be performed."},{"type":"git_transport_cb","name":"transport","comments":" Create the transport to use for this operation. Leave NULL\n to auto-detect."},{"type":"void *","name":"payload","comments":" This will be passed to each of the callbacks in this struct\n as the last parameter."}],"used":{"returns":[],"needs":["git_remote_connect","git_remote_init_callbacks","git_remote_prune","git_remote_update_tips"]}}],["git_remote_completion_type",{"decl":["GIT_REMOTE_COMPLETION_DOWNLOAD","GIT_REMOTE_COMPLETION_INDEXING","GIT_REMOTE_COMPLETION_ERROR"],"type":"enum","file":"git2/remote.h","line":344,"lineto":348,"block":"GIT_REMOTE_COMPLETION_DOWNLOAD\nGIT_REMOTE_COMPLETION_INDEXING\nGIT_REMOTE_COMPLETION_ERROR\nGIT_REMOTE_COMPLETION_DOWNLOAD\nGIT_REMOTE_COMPLETION_INDEXING\nGIT_REMOTE_COMPLETION_ERROR","tdef":"typedef","description":" Argument to the completion callback which tells it which operation\n finished.","comments":"","fields":[{"type":"int","name":"GIT_REMOTE_COMPLETION_DOWNLOAD","comments":"","value":0},{"type":"int","name":"GIT_REMOTE_COMPLETION_INDEXING","comments":"","value":1},{"type":"int","name":"GIT_REMOTE_COMPLETION_ERROR","comments":"","value":2}],"used":{"returns":[],"needs":[]}}],["git_remote_head",{"decl":["int local","git_oid oid","git_oid loid","char * name","char * symref_target"],"type":"struct","value":"git_remote_head","file":"git2/net.h","line":40,"lineto":50,"block":"int local\ngit_oid oid\ngit_oid loid\nchar * name\nchar * symref_target","tdef":null,"description":" Description of a reference advertised by a remote server, given out\n on `ls` calls.","comments":"","fields":[{"type":"int","name":"local","comments":""},{"type":"git_oid","name":"oid","comments":""},{"type":"git_oid","name":"loid","comments":""},{"type":"char *","name":"name","comments":""},{"type":"char *","name":"symref_target","comments":" If the server send a symref mapping for this ref, this will\n point to the target."}],"used":{"returns":[],"needs":["git_headlist_cb","git_remote_ls"]}}],["git_repository",{"decl":"git_repository","type":"struct","value":"git_repository","file":"git2/types.h","line":105,"lineto":105,"tdef":"typedef","description":" Representation of an existing git repository,\n including all its object contents","comments":"","used":{"returns":["git_blob_owner","git_commit_owner","git_index_owner","git_object_owner","git_reference_owner","git_remote_owner","git_revwalk_repository","git_submodule_owner","git_tag_owner","git_tree_owner"],"needs":["git_annotated_commit_from_fetchhead","git_annotated_commit_from_ref","git_annotated_commit_from_revspec","git_annotated_commit_lookup","git_attr_add_macro","git_attr_cache_flush","git_attr_foreach","git_attr_get","git_attr_get_many","git_blame_file","git_blob_create_frombuffer","git_blob_create_fromdisk","git_blob_create_fromstream","git_blob_create_fromworkdir","git_blob_lookup","git_blob_lookup_prefix","git_branch_create","git_branch_create_from_annotated","git_branch_iterator_new","git_branch_lookup","git_checkout_head","git_checkout_index","git_checkout_tree","git_cherrypick","git_cherrypick_commit","git_clone","git_commit_create","git_commit_create_buffer","git_commit_create_v","git_commit_create_with_signature","git_commit_extract_signature","git_commit_lookup","git_commit_lookup_prefix","git_config_add_file_ondisk","git_describe_workdir","git_diff_commit_as_email","git_diff_index_to_index","git_diff_index_to_workdir","git_diff_tree_to_index","git_diff_tree_to_tree","git_diff_tree_to_workdir","git_diff_tree_to_workdir_with_index","git_filter_list_apply_to_file","git_filter_list_load","git_filter_list_stream_file","git_graph_ahead_behind","git_graph_descendant_of","git_ignore_add_rule","git_ignore_clear_internal_rules","git_ignore_path_is_ignored","git_index_write_tree_to","git_merge","git_merge_analysis","git_merge_base","git_merge_base_many","git_merge_base_octopus","git_merge_bases","git_merge_bases_many","git_merge_commits","git_merge_file_from_index","git_merge_trees","git_note_commit_create","git_note_commit_read","git_note_commit_remove","git_note_create","git_note_foreach","git_note_iterator_new","git_note_read","git_note_remove","git_object_lookup","git_object_lookup_prefix","git_packbuilder_new","git_rebase_init","git_rebase_open","git_refdb_new","git_refdb_open","git_reference_create","git_reference_create_matching","git_reference_dwim","git_reference_ensure_log","git_reference_foreach","git_reference_foreach_glob","git_reference_foreach_name","git_reference_has_log","git_reference_iterator_glob_new","git_reference_iterator_new","git_reference_list","git_reference_lookup","git_reference_name_to_id","git_reference_remove","git_reference_symbolic_create","git_reference_symbolic_create_matching","git_reflog_delete","git_reflog_read","git_reflog_rename","git_remote_add_fetch","git_remote_add_push","git_remote_create","git_remote_create_anonymous","git_remote_create_cb","git_remote_create_with_fetchspec","git_remote_delete","git_remote_list","git_remote_lookup","git_remote_rename","git_remote_set_autotag","git_remote_set_pushurl","git_remote_set_url","git_repository_commondir","git_repository_config","git_repository_config_snapshot","git_repository_create_cb","git_repository_detach_head","git_repository_fetchhead_foreach","git_repository_free","git_repository_get_namespace","git_repository_hashfile","git_repository_head","git_repository_head_detached","git_repository_head_for_worktree","git_repository_head_unborn","git_repository_ident","git_repository_index","git_repository_init","git_repository_init_ext","git_repository_init_init_options","git_repository_is_bare","git_repository_is_empty","git_repository_is_shallow","git_repository_is_worktree","git_repository_item_path","git_repository_mergehead_foreach","git_repository_message","git_repository_message_remove","git_repository_odb","git_repository_open","git_repository_open_bare","git_repository_open_ext","git_repository_open_from_worktree","git_repository_path","git_repository_refdb","git_repository_set_head","git_repository_set_head_detached","git_repository_set_head_detached_from_annotated","git_repository_set_ident","git_repository_set_namespace","git_repository_set_workdir","git_repository_state","git_repository_state_cleanup","git_repository_workdir","git_repository_wrap_odb","git_reset","git_reset_default","git_reset_from_annotated","git_revert","git_revert_commit","git_revparse","git_revparse_ext","git_revparse_single","git_revwalk_new","git_signature_default","git_stash_apply","git_stash_drop","git_stash_foreach","git_stash_pop","git_status_file","git_status_foreach","git_status_foreach_ext","git_status_list_new","git_status_should_ignore","git_submodule_add_setup","git_submodule_foreach","git_submodule_lookup","git_submodule_open","git_submodule_repo_init","git_submodule_resolve_url","git_submodule_set_branch","git_submodule_set_fetch_recurse_submodules","git_submodule_set_ignore","git_submodule_set_update","git_submodule_set_url","git_submodule_status","git_tag_annotation_create","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_create_updated","git_tree_entry_to_object","git_tree_lookup","git_tree_lookup_prefix","git_treebuilder_new","git_worktree_add","git_worktree_list","git_worktree_lookup","git_worktree_open_from_repository"]}}],["git_repository_init_flag_t",{"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","GIT_REPOSITORY_INIT_RELATIVE_GITLINK"],"type":"enum","file":"git2/repository.h","line":232,"lineto":240,"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\nGIT_REPOSITORY_INIT_RELATIVE_GITLINK","tdef":"typedef","description":" Option flags for `git_repository_init_ext`.","comments":"<p>These flags configure extra behaviors to <code>git_repository_init_ext</code>. In every case, the default behavior is the zero value (i.e. flag is not set). Just OR the flag values together for the <code>flags</code> parameter when initializing a new repo. Details of individual values are:</p>\n\n<ul>\n<li>BARE - Create a bare repository with no working directory. * NO_REINIT - Return an GIT_EEXISTS error if the repo_path appears to already be an git repository. * NO_DOTGIT_DIR - Normally a "/.git/" will be appended to the repo path for non-bare repos (if it is not already there), but passing this flag prevents that behavior. * MKDIR - Make the repo_path (and workdir_path) as needed. Init is always willing to create the ".git" directory even without this flag. This flag tells init to create the trailing component of the repo and workdir paths as needed. * MKPATH - Recursively make all components of the repo and workdir paths as necessary. * EXTERNAL_TEMPLATE - libgit2 normally uses internal templates to initialize a new repo. This flags enables external templates, looking the "template_path" from the options if set, or the <code>init.templatedir</code> global config if not, or falling back on "/usr/share/git-core/templates" if it exists. * GIT_REPOSITORY_INIT_RELATIVE_GITLINK - If an alternate workdir is specified, use relative paths for the gitdir and core.worktree.</li>\n</ul>\n","fields":[{"type":"int","name":"GIT_REPOSITORY_INIT_BARE","comments":"","value":1},{"type":"int","name":"GIT_REPOSITORY_INIT_NO_REINIT","comments":"","value":2},{"type":"int","name":"GIT_REPOSITORY_INIT_NO_DOTGIT_DIR","comments":"","value":4},{"type":"int","name":"GIT_REPOSITORY_INIT_MKDIR","comments":"","value":8},{"type":"int","name":"GIT_REPOSITORY_INIT_MKPATH","comments":"","value":16},{"type":"int","name":"GIT_REPOSITORY_INIT_EXTERNAL_TEMPLATE","comments":"","value":32},{"type":"int","name":"GIT_REPOSITORY_INIT_RELATIVE_GITLINK","comments":"","value":64}],"used":{"returns":[],"needs":[]}}],["git_repository_init_mode_t",{"decl":["GIT_REPOSITORY_INIT_SHARED_UMASK","GIT_REPOSITORY_INIT_SHARED_GROUP","GIT_REPOSITORY_INIT_SHARED_ALL"],"type":"enum","file":"git2/repository.h","line":255,"lineto":259,"block":"GIT_REPOSITORY_INIT_SHARED_UMASK\nGIT_REPOSITORY_INIT_SHARED_GROUP\nGIT_REPOSITORY_INIT_SHARED_ALL","tdef":"typedef","description":" Mode options for `git_repository_init_ext`.","comments":"<p>Set the mode field of the <code>git_repository_init_options</code> structure either to the custom mode that you would like, or to one of the following modes:</p>\n\n<ul>\n<li>SHARED_UMASK - Use permissions configured by umask - the default. * SHARED_GROUP - Use "--shared=group" behavior, chmod'ing the new repo to be group writable and "g+sx" for sticky group assignment. * SHARED_ALL - Use "--shared=all" behavior, adding world readability. * Anything else - Set to custom value.</li>\n</ul>\n","fields":[{"type":"int","name":"GIT_REPOSITORY_INIT_SHARED_UMASK","comments":"","value":0},{"type":"int","name":"GIT_REPOSITORY_INIT_SHARED_GROUP","comments":"","value":1533},{"type":"int","name":"GIT_REPOSITORY_INIT_SHARED_ALL","comments":"","value":1535}],"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":"git2/repository.h","line":289,"lineto":298,"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","description":" Extended options structure for `git_repository_init_ext`.","comments":"<p>This contains extra options for <code>git_repository_init_ext</code> that enable additional initialization features. The fields are:</p>\n\n<ul>\n<li>flags - Combination of GIT_REPOSITORY_INIT flags above. * mode - Set to one of the standard GIT_REPOSITORY_INIT_SHARED_... constants above, or to a custom value that you would like. * workdir_path - The path to the working dir or NULL for default (i.e. repo_path parent on non-bare repos). IF THIS IS RELATIVE PATH, IT WILL BE EVALUATED RELATIVE TO THE REPO_PATH. If this is not the "natural" working directory, a .git gitlink file will be created here linking to the repo_path. * description - If set, this will be used to initialize the "description" file in the repository, instead of using the template content. * template_path - When GIT_REPOSITORY_INIT_EXTERNAL_TEMPLATE is set, this contains the path to use for the template directory. If this is NULL, the config or default directory options will be used instead. * initial_head - The name of the head to point HEAD at. If NULL, then this will be treated as "master" and the HEAD ref will be set to "refs/heads/master". If this begins with "refs/" it will be used verbatim; otherwise "refs/heads/" will be prefixed. * origin_url - If this is non-NULL, then after the rest of the repository initialization is completed, an "origin" remote will be added pointing to this URL.</li>\n</ul>\n","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"uint32_t","name":"flags","comments":""},{"type":"uint32_t","name":"mode","comments":""},{"type":"const char *","name":"workdir_path","comments":""},{"type":"const char *","name":"description","comments":""},{"type":"const char *","name":"template_path","comments":""},{"type":"const char *","name":"initial_head","comments":""},{"type":"const char *","name":"origin_url","comments":""}],"used":{"returns":[],"needs":["git_repository_init_ext","git_repository_init_init_options"]}}],["git_repository_item_t",{"decl":["GIT_REPOSITORY_ITEM_GITDIR","GIT_REPOSITORY_ITEM_WORKDIR","GIT_REPOSITORY_ITEM_COMMONDIR","GIT_REPOSITORY_ITEM_INDEX","GIT_REPOSITORY_ITEM_OBJECTS","GIT_REPOSITORY_ITEM_REFS","GIT_REPOSITORY_ITEM_PACKED_REFS","GIT_REPOSITORY_ITEM_REMOTES","GIT_REPOSITORY_ITEM_CONFIG","GIT_REPOSITORY_ITEM_INFO","GIT_REPOSITORY_ITEM_HOOKS","GIT_REPOSITORY_ITEM_LOGS","GIT_REPOSITORY_ITEM_MODULES","GIT_REPOSITORY_ITEM_WORKTREES"],"type":"enum","file":"git2/repository.h","line":412,"lineto":427,"block":"GIT_REPOSITORY_ITEM_GITDIR\nGIT_REPOSITORY_ITEM_WORKDIR\nGIT_REPOSITORY_ITEM_COMMONDIR\nGIT_REPOSITORY_ITEM_INDEX\nGIT_REPOSITORY_ITEM_OBJECTS\nGIT_REPOSITORY_ITEM_REFS\nGIT_REPOSITORY_ITEM_PACKED_REFS\nGIT_REPOSITORY_ITEM_REMOTES\nGIT_REPOSITORY_ITEM_CONFIG\nGIT_REPOSITORY_ITEM_INFO\nGIT_REPOSITORY_ITEM_HOOKS\nGIT_REPOSITORY_ITEM_LOGS\nGIT_REPOSITORY_ITEM_MODULES\nGIT_REPOSITORY_ITEM_WORKTREES","tdef":"typedef","description":" List of items which belong to the git repository layout","comments":"","fields":[{"type":"int","name":"GIT_REPOSITORY_ITEM_GITDIR","comments":"","value":0},{"type":"int","name":"GIT_REPOSITORY_ITEM_WORKDIR","comments":"","value":1},{"type":"int","name":"GIT_REPOSITORY_ITEM_COMMONDIR","comments":"","value":2},{"type":"int","name":"GIT_REPOSITORY_ITEM_INDEX","comments":"","value":3},{"type":"int","name":"GIT_REPOSITORY_ITEM_OBJECTS","comments":"","value":4},{"type":"int","name":"GIT_REPOSITORY_ITEM_REFS","comments":"","value":5},{"type":"int","name":"GIT_REPOSITORY_ITEM_PACKED_REFS","comments":"","value":6},{"type":"int","name":"GIT_REPOSITORY_ITEM_REMOTES","comments":"","value":7},{"type":"int","name":"GIT_REPOSITORY_ITEM_CONFIG","comments":"","value":8},{"type":"int","name":"GIT_REPOSITORY_ITEM_INFO","comments":"","value":9},{"type":"int","name":"GIT_REPOSITORY_ITEM_HOOKS","comments":"","value":10},{"type":"int","name":"GIT_REPOSITORY_ITEM_LOGS","comments":"","value":11},{"type":"int","name":"GIT_REPOSITORY_ITEM_MODULES","comments":"","value":12},{"type":"int","name":"GIT_REPOSITORY_ITEM_WORKTREES","comments":"","value":13}],"used":{"returns":[],"needs":["git_repository_item_path"]}}],["git_repository_open_flag_t",{"decl":["GIT_REPOSITORY_OPEN_NO_SEARCH","GIT_REPOSITORY_OPEN_CROSS_FS","GIT_REPOSITORY_OPEN_BARE","GIT_REPOSITORY_OPEN_NO_DOTGIT","GIT_REPOSITORY_OPEN_FROM_ENV"],"type":"enum","file":"git2/repository.h","line":126,"lineto":132,"block":"GIT_REPOSITORY_OPEN_NO_SEARCH\nGIT_REPOSITORY_OPEN_CROSS_FS\nGIT_REPOSITORY_OPEN_BARE\nGIT_REPOSITORY_OPEN_NO_DOTGIT\nGIT_REPOSITORY_OPEN_FROM_ENV","tdef":"typedef","description":" Option flags for `git_repository_open_ext`.","comments":"<ul>\n<li>GIT_REPOSITORY_OPEN_NO_SEARCH - Only open the repository if it can be immediately found in the start_path. Do not walk up from the start_path looking at parent directories. * GIT_REPOSITORY_OPEN_CROSS_FS - Unless this flag is set, open will not continue searching across filesystem boundaries (i.e. when <code>st_dev</code> changes from the <code>stat</code> system call). (E.g. Searching in a user's home directory "/home/user/source/" will not return "/.git/" as the found repo if "/" is a different filesystem than "/home".) * GIT_REPOSITORY_OPEN_BARE - Open repository as a bare repo regardless of core.bare config, and defer loading config file for faster setup. Unlike <code>git_repository_open_bare</code>, this can follow gitlinks. * GIT_REPOSITORY_OPEN_NO_DOTGIT - Do not check for a repository by appending /.git to the start_path; only open the repository if start_path itself points to the git directory. * GIT_REPOSITORY_OPEN_FROM_ENV - Find and open a git repository, respecting the environment variables used by the git command-line tools. If set, <code>git_repository_open_ext</code> will ignore the other flags and the <code>ceiling_dirs</code> argument, and will allow a NULL <code>path</code> to use <code>GIT_DIR</code> or search from the current directory. The search for a repository will respect $GIT_CEILING_DIRECTORIES and $GIT_DISCOVERY_ACROSS_FILESYSTEM. The opened repository will respect $GIT_INDEX_FILE, $GIT_NAMESPACE, $GIT_OBJECT_DIRECTORY, and $GIT_ALTERNATE_OBJECT_DIRECTORIES. In the future, this flag will also cause <code>git_repository_open_ext</code> to respect $GIT_WORK_TREE and $GIT_COMMON_DIR; currently, <code>git_repository_open_ext</code> with this flag will error out if either $GIT_WORK_TREE or $GIT_COMMON_DIR is set.</li>\n</ul>\n","fields":[{"type":"int","name":"GIT_REPOSITORY_OPEN_NO_SEARCH","comments":"","value":1},{"type":"int","name":"GIT_REPOSITORY_OPEN_CROSS_FS","comments":"","value":2},{"type":"int","name":"GIT_REPOSITORY_OPEN_BARE","comments":"","value":4},{"type":"int","name":"GIT_REPOSITORY_OPEN_NO_DOTGIT","comments":"","value":8},{"type":"int","name":"GIT_REPOSITORY_OPEN_FROM_ENV","comments":"","value":16}],"used":{"returns":[],"needs":[]}}],["git_repository_state_t",{"decl":["GIT_REPOSITORY_STATE_NONE","GIT_REPOSITORY_STATE_MERGE","GIT_REPOSITORY_STATE_REVERT","GIT_REPOSITORY_STATE_REVERT_SEQUENCE","GIT_REPOSITORY_STATE_CHERRYPICK","GIT_REPOSITORY_STATE_CHERRYPICK_SEQUENCE","GIT_REPOSITORY_STATE_BISECT","GIT_REPOSITORY_STATE_REBASE","GIT_REPOSITORY_STATE_REBASE_INTERACTIVE","GIT_REPOSITORY_STATE_REBASE_MERGE","GIT_REPOSITORY_STATE_APPLY_MAILBOX","GIT_REPOSITORY_STATE_APPLY_MAILBOX_OR_REBASE"],"type":"enum","file":"git2/repository.h","line":784,"lineto":797,"block":"GIT_REPOSITORY_STATE_NONE\nGIT_REPOSITORY_STATE_MERGE\nGIT_REPOSITORY_STATE_REVERT\nGIT_REPOSITORY_STATE_REVERT_SEQUENCE\nGIT_REPOSITORY_STATE_CHERRYPICK\nGIT_REPOSITORY_STATE_CHERRYPICK_SEQUENCE\nGIT_REPOSITORY_STATE_BISECT\nGIT_REPOSITORY_STATE_REBASE\nGIT_REPOSITORY_STATE_REBASE_INTERACTIVE\nGIT_REPOSITORY_STATE_REBASE_MERGE\nGIT_REPOSITORY_STATE_APPLY_MAILBOX\nGIT_REPOSITORY_STATE_APPLY_MAILBOX_OR_REBASE","tdef":"typedef","description":" Repository state","comments":"<p>These values represent possible states for the repository to be in, based on the current operation which is ongoing.</p>\n","fields":[{"type":"int","name":"GIT_REPOSITORY_STATE_NONE","comments":"","value":0},{"type":"int","name":"GIT_REPOSITORY_STATE_MERGE","comments":"","value":1},{"type":"int","name":"GIT_REPOSITORY_STATE_REVERT","comments":"","value":2},{"type":"int","name":"GIT_REPOSITORY_STATE_REVERT_SEQUENCE","comments":"","value":3},{"type":"int","name":"GIT_REPOSITORY_STATE_CHERRYPICK","comments":"","value":4},{"type":"int","name":"GIT_REPOSITORY_STATE_CHERRYPICK_SEQUENCE","comments":"","value":5},{"type":"int","name":"GIT_REPOSITORY_STATE_BISECT","comments":"","value":6},{"type":"int","name":"GIT_REPOSITORY_STATE_REBASE","comments":"","value":7},{"type":"int","name":"GIT_REPOSITORY_STATE_REBASE_INTERACTIVE","comments":"","value":8},{"type":"int","name":"GIT_REPOSITORY_STATE_REBASE_MERGE","comments":"","value":9},{"type":"int","name":"GIT_REPOSITORY_STATE_APPLY_MAILBOX","comments":"","value":10},{"type":"int","name":"GIT_REPOSITORY_STATE_APPLY_MAILBOX_OR_REBASE","comments":"","value":11}],"used":{"returns":[],"needs":[]}}],["git_reset_t",{"decl":["GIT_RESET_SOFT","GIT_RESET_MIXED","GIT_RESET_HARD"],"type":"enum","file":"git2/reset.h","line":26,"lineto":30,"block":"GIT_RESET_SOFT\nGIT_RESET_MIXED\nGIT_RESET_HARD","tdef":"typedef","description":" Kinds of reset operation","comments":"","fields":[{"type":"int","name":"GIT_RESET_SOFT","comments":"<p>Move the head to the given commit </p>\n","value":1},{"type":"int","name":"GIT_RESET_MIXED","comments":"<p>SOFT plus reset index to the commit </p>\n","value":2},{"type":"int","name":"GIT_RESET_HARD","comments":"<p>MIXED plus changes in working tree discarded </p>\n","value":3}],"used":{"returns":[],"needs":["git_reset","git_reset_from_annotated"]}}],["git_revert_options",{"decl":["unsigned int version","unsigned int mainline","git_merge_options merge_opts","git_checkout_options checkout_opts"],"type":"struct","value":"git_revert_options","file":"git2/revert.h","line":26,"lineto":34,"block":"unsigned int version\nunsigned int mainline\ngit_merge_options merge_opts\ngit_checkout_options checkout_opts","tdef":"typedef","description":" Options for revert","comments":"","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"unsigned int","name":"mainline","comments":" For merge commits, the \"mainline\" is treated as the parent. "},{"type":"git_merge_options","name":"merge_opts","comments":" Options for the merging "},{"type":"git_checkout_options","name":"checkout_opts","comments":" Options for the checkout "}],"used":{"returns":[],"needs":["git_revert","git_revert_init_options"]}}],["git_revparse_mode_t",{"decl":["GIT_REVPARSE_SINGLE","GIT_REVPARSE_RANGE","GIT_REVPARSE_MERGE_BASE"],"type":"enum","file":"git2/revparse.h","line":71,"lineto":78,"block":"GIT_REVPARSE_SINGLE\nGIT_REVPARSE_RANGE\nGIT_REVPARSE_MERGE_BASE","tdef":"typedef","description":" Revparse flags. These indicate the intended behavior of the spec passed to\n git_revparse.","comments":"","fields":[{"type":"int","name":"GIT_REVPARSE_SINGLE","comments":"<p>The spec targeted a single object. </p>\n","value":1},{"type":"int","name":"GIT_REVPARSE_RANGE","comments":"<p>The spec targeted a range of commits. </p>\n","value":2},{"type":"int","name":"GIT_REVPARSE_MERGE_BASE","comments":"<p>The spec used the '...' operator, which invokes special semantics. </p>\n","value":4}],"used":{"returns":[],"needs":[]}}],["git_revspec",{"decl":["git_object * from","git_object * to","unsigned int flags"],"type":"struct","value":"git_revspec","file":"git2/revparse.h","line":83,"lineto":90,"block":"git_object * from\ngit_object * to\nunsigned int flags","tdef":"typedef","description":" Git Revision Spec: output of a `git_revparse` operation","comments":"","fields":[{"type":"git_object *","name":"from","comments":" The left element of the revspec; must be freed by the user "},{"type":"git_object *","name":"to","comments":" The right element of the revspec; must be freed by the user "},{"type":"unsigned int","name":"flags","comments":" The intent of the revspec (i.e. `git_revparse_mode_t` flags) "}],"used":{"returns":[],"needs":["git_revparse"]}}],["git_revwalk",{"decl":"git_revwalk","type":"struct","value":"git_revwalk","file":"git2/types.h","line":114,"lineto":114,"tdef":"typedef","description":" Representation of an in-progress walk through the commits in a repo ","comments":"","used":{"returns":[],"needs":["git_packbuilder_insert_walk","git_revwalk_add_hide_cb","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_simplify_first_parent","git_revwalk_sorting"]}}],["git_signature",{"decl":["char * name","char * email","git_time when"],"type":"struct","value":"git_signature","file":"git2/types.h","line":166,"lineto":170,"block":"char * name\nchar * email\ngit_time when","tdef":"typedef","description":" An action signature (e.g. for committers, taggers, etc) ","comments":"","fields":[{"type":"char *","name":"name","comments":" full name of the author "},{"type":"char *","name":"email","comments":" email of the author "},{"type":"git_time","name":"when","comments":" time when the action happened "}],"used":{"returns":["git_commit_author","git_commit_committer","git_note_author","git_note_committer","git_reflog_entry_committer","git_tag_tagger"],"needs":["git_commit_amend","git_commit_create","git_commit_create_buffer","git_commit_create_v","git_note_commit_create","git_note_commit_remove","git_note_create","git_note_remove","git_rebase_commit","git_rebase_finish","git_reflog_append","git_signature_default","git_signature_dup","git_signature_free","git_signature_from_buffer","git_signature_new","git_signature_now","git_tag_annotation_create","git_tag_create"]}}],["git_smart_subtransport_definition",{"decl":["git_smart_subtransport_cb callback","unsigned int rpc","void * param"],"type":"struct","value":"git_smart_subtransport_definition","file":"git2/sys/transport.h","line":336,"lineto":349,"block":"git_smart_subtransport_cb callback\nunsigned int rpc\nvoid * param","tdef":"typedef","description":" Definition for a \"subtransport\"","comments":"<p>This is used to let the smart protocol code know about the protocol which you are implementing.</p>\n","fields":[{"type":"git_smart_subtransport_cb","name":"callback","comments":" The function to use to create the git_smart_subtransport "},{"type":"unsigned int","name":"rpc","comments":" True if the protocol is stateless; false otherwise. For example,\n http:// is stateless, but git:// is not."},{"type":"void *","name":"param","comments":" Param of the callback"}],"used":{"returns":[],"needs":[]}}],["git_sort_t",{"decl":["GIT_SORT_NONE","GIT_SORT_TOPOLOGICAL","GIT_SORT_TIME","GIT_SORT_REVERSE"],"type":"enum","file":"git2/revwalk.h","line":26,"lineto":53,"block":"GIT_SORT_NONE\nGIT_SORT_TOPOLOGICAL\nGIT_SORT_TIME\nGIT_SORT_REVERSE","tdef":"typedef","description":" Flags to specify the sorting which a revwalk should perform.","comments":"","fields":[{"type":"int","name":"GIT_SORT_NONE","comments":"<p>Sort the output with the same default time-order method from git.\n This is the default sorting for new walkers.</p>\n","value":0},{"type":"int","name":"GIT_SORT_TOPOLOGICAL","comments":"<p>Sort the repository contents in topological order (parents before\n children); this sorting mode can be combined with time sorting to\n produce git's "time-order".</p>\n","value":1},{"type":"int","name":"GIT_SORT_TIME","comments":"<p>Sort the repository contents by commit time;\n this sorting mode can be combined with\n topological sorting.</p>\n","value":2},{"type":"int","name":"GIT_SORT_REVERSE","comments":"<p>Iterate through the repository contents in reverse\n order; this sorting mode can be combined with\n any of the above.</p>\n","value":4}],"used":{"returns":[],"needs":[]}}],["git_stash_apply_flags",{"decl":["GIT_STASH_APPLY_DEFAULT","GIT_STASH_APPLY_REINSTATE_INDEX"],"type":"enum","file":"git2/stash.h","line":74,"lineto":81,"block":"GIT_STASH_APPLY_DEFAULT\nGIT_STASH_APPLY_REINSTATE_INDEX","tdef":"typedef","description":" Stash application flags. ","comments":"","fields":[{"type":"int","name":"GIT_STASH_APPLY_DEFAULT","comments":"","value":0},{"type":"int","name":"GIT_STASH_APPLY_REINSTATE_INDEX","comments":"","value":1}],"used":{"returns":[],"needs":[]}}],["git_stash_flags",{"decl":["GIT_STASH_DEFAULT","GIT_STASH_KEEP_INDEX","GIT_STASH_INCLUDE_UNTRACKED","GIT_STASH_INCLUDE_IGNORED"],"type":"enum","file":"git2/stash.h","line":24,"lineto":47,"block":"GIT_STASH_DEFAULT\nGIT_STASH_KEEP_INDEX\nGIT_STASH_INCLUDE_UNTRACKED\nGIT_STASH_INCLUDE_IGNORED","tdef":"typedef","description":" Stash flags","comments":"","fields":[{"type":"int","name":"GIT_STASH_DEFAULT","comments":"<p>No option, default</p>\n","value":0},{"type":"int","name":"GIT_STASH_KEEP_INDEX","comments":"<p>All changes already added to the index are left intact in\n the working directory</p>\n","value":1},{"type":"int","name":"GIT_STASH_INCLUDE_UNTRACKED","comments":"<p>All untracked files are also stashed and then cleaned up\n from the working directory</p>\n","value":2},{"type":"int","name":"GIT_STASH_INCLUDE_IGNORED","comments":"<p>All ignored files are also stashed and then cleaned up from\n the working directory</p>\n","value":4}],"used":{"returns":[],"needs":[]}}],["git_status_list",{"decl":"git_status_list","type":"struct","value":"git_status_list","file":"git2/types.h","line":188,"lineto":188,"tdef":"typedef","description":" Representation of a status collection ","comments":"","used":{"returns":[],"needs":["git_status_byindex","git_status_list_entrycount","git_status_list_free","git_status_list_new"]}}],["git_status_opt_t",{"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","GIT_STATUS_OPT_RENAMES_HEAD_TO_INDEX","GIT_STATUS_OPT_RENAMES_INDEX_TO_WORKDIR","GIT_STATUS_OPT_SORT_CASE_SENSITIVELY","GIT_STATUS_OPT_SORT_CASE_INSENSITIVELY","GIT_STATUS_OPT_RENAMES_FROM_REWRITES","GIT_STATUS_OPT_NO_REFRESH","GIT_STATUS_OPT_UPDATE_INDEX","GIT_STATUS_OPT_INCLUDE_UNREADABLE","GIT_STATUS_OPT_INCLUDE_UNREADABLE_AS_UNTRACKED"],"type":"enum","file":"git2/status.h","line":137,"lineto":154,"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\nGIT_STATUS_OPT_RENAMES_HEAD_TO_INDEX\nGIT_STATUS_OPT_RENAMES_INDEX_TO_WORKDIR\nGIT_STATUS_OPT_SORT_CASE_SENSITIVELY\nGIT_STATUS_OPT_SORT_CASE_INSENSITIVELY\nGIT_STATUS_OPT_RENAMES_FROM_REWRITES\nGIT_STATUS_OPT_NO_REFRESH\nGIT_STATUS_OPT_UPDATE_INDEX\nGIT_STATUS_OPT_INCLUDE_UNREADABLE\nGIT_STATUS_OPT_INCLUDE_UNREADABLE_AS_UNTRACKED","tdef":"typedef","description":" Flags to control status callbacks","comments":"<ul>\n<li>GIT_STATUS_OPT_INCLUDE_UNTRACKED says that callbacks should be made on untracked files. These will only be made if the workdir files are included in the status "show" option. - GIT_STATUS_OPT_INCLUDE_IGNORED says that ignored files get callbacks. Again, these callbacks will only be made if the workdir files are included in the status "show" option. - GIT_STATUS_OPT_INCLUDE_UNMODIFIED indicates that callback should be made even on unmodified files. - GIT_STATUS_OPT_EXCLUDE_SUBMODULES indicates that submodules should be skipped. This only applies if there are no pending typechanges to the submodule (either from or to another type). - GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS indicates that all files in untracked directories should be included. Normally if an entire directory is new, then just the top-level directory is included (with a trailing slash on the entry name). This flag says to include all of the individual files in the directory instead. - GIT_STATUS_OPT_DISABLE_PATHSPEC_MATCH indicates that the given path should be treated as a literal path, and not as a pathspec pattern. - GIT_STATUS_OPT_RECURSE_IGNORED_DIRS indicates that the contents of ignored directories should be included in the status. This is like doing <code>git ls-files -o -i --exclude-standard</code> with core git. - GIT_STATUS_OPT_RENAMES_HEAD_TO_INDEX indicates that rename detection should be processed between the head and the index and enables the GIT_STATUS_INDEX_RENAMED as a possible status flag. - GIT_STATUS_OPT_RENAMES_INDEX_TO_WORKDIR indicates that rename detection should be run between the index and the working directory and enabled GIT_STATUS_WT_RENAMED as a possible status flag. - GIT_STATUS_OPT_SORT_CASE_SENSITIVELY overrides the native case sensitivity for the file system and forces the output to be in case-sensitive order - GIT_STATUS_OPT_SORT_CASE_INSENSITIVELY overrides the native case sensitivity for the file system and forces the output to be in case-insensitive order - GIT_STATUS_OPT_RENAMES_FROM_REWRITES indicates that rename detection should include rewritten files - GIT_STATUS_OPT_NO_REFRESH bypasses the default status behavior of doing a "soft" index reload (i.e. reloading the index data if the file on disk has been modified outside libgit2). - GIT_STATUS_OPT_UPDATE_INDEX tells libgit2 to refresh the stat cache in the index for files that are unchanged but have out of date stat information in the index. It will result in less work being done on subsequent calls to get status. This is mutually exclusive with the NO_REFRESH option.</li>\n</ul>\n\n<p>Calling <code>git_status_foreach()</code> is like calling the extended version with: GIT_STATUS_OPT_INCLUDE_IGNORED, GIT_STATUS_OPT_INCLUDE_UNTRACKED, and GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS. Those options are bundled together as <code>GIT_STATUS_OPT_DEFAULTS</code> if you want them as a baseline.</p>\n","fields":[{"type":"int","name":"GIT_STATUS_OPT_INCLUDE_UNTRACKED","comments":"","value":1},{"type":"int","name":"GIT_STATUS_OPT_INCLUDE_IGNORED","comments":"","value":2},{"type":"int","name":"GIT_STATUS_OPT_INCLUDE_UNMODIFIED","comments":"","value":4},{"type":"int","name":"GIT_STATUS_OPT_EXCLUDE_SUBMODULES","comments":"","value":8},{"type":"int","name":"GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS","comments":"","value":16},{"type":"int","name":"GIT_STATUS_OPT_DISABLE_PATHSPEC_MATCH","comments":"","value":32},{"type":"int","name":"GIT_STATUS_OPT_RECURSE_IGNORED_DIRS","comments":"","value":64},{"type":"int","name":"GIT_STATUS_OPT_RENAMES_HEAD_TO_INDEX","comments":"","value":128},{"type":"int","name":"GIT_STATUS_OPT_RENAMES_INDEX_TO_WORKDIR","comments":"","value":256},{"type":"int","name":"GIT_STATUS_OPT_SORT_CASE_SENSITIVELY","comments":"","value":512},{"type":"int","name":"GIT_STATUS_OPT_SORT_CASE_INSENSITIVELY","comments":"","value":1024},{"type":"int","name":"GIT_STATUS_OPT_RENAMES_FROM_REWRITES","comments":"","value":2048},{"type":"int","name":"GIT_STATUS_OPT_NO_REFRESH","comments":"","value":4096},{"type":"int","name":"GIT_STATUS_OPT_UPDATE_INDEX","comments":"","value":8192},{"type":"int","name":"GIT_STATUS_OPT_INCLUDE_UNREADABLE","comments":"","value":16384},{"type":"int","name":"GIT_STATUS_OPT_INCLUDE_UNREADABLE_AS_UNTRACKED","comments":"","value":32768}],"used":{"returns":[],"needs":[]}}],["git_status_show_t",{"decl":["GIT_STATUS_SHOW_INDEX_AND_WORKDIR","GIT_STATUS_SHOW_INDEX_ONLY","GIT_STATUS_SHOW_WORKDIR_ONLY"],"type":"enum","file":"git2/status.h","line":79,"lineto":83,"block":"GIT_STATUS_SHOW_INDEX_AND_WORKDIR\nGIT_STATUS_SHOW_INDEX_ONLY\nGIT_STATUS_SHOW_WORKDIR_ONLY","tdef":"typedef","description":" Select the files on which to report status.","comments":"<p>With <code>git_status_foreach_ext</code>, this will control which changes get callbacks. With <code>git_status_list_new</code>, these will control which changes are included in the list.</p>\n\n<ul>\n<li>GIT_STATUS_SHOW_INDEX_AND_WORKDIR is the default. This roughly matches <code>git status --porcelain</code> regarding which files are included and in what order. - GIT_STATUS_SHOW_INDEX_ONLY only gives status based on HEAD to index comparison, not looking at working directory changes. - GIT_STATUS_SHOW_WORKDIR_ONLY only gives status based on index to working directory comparison, not comparing the index to the HEAD.</li>\n</ul>\n","fields":[{"type":"int","name":"GIT_STATUS_SHOW_INDEX_AND_WORKDIR","comments":"","value":0},{"type":"int","name":"GIT_STATUS_SHOW_INDEX_ONLY","comments":"","value":1},{"type":"int","name":"GIT_STATUS_SHOW_WORKDIR_ONLY","comments":"","value":2}],"used":{"returns":[],"needs":[]}}],["git_status_t",{"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_WT_RENAMED","GIT_STATUS_WT_UNREADABLE","GIT_STATUS_IGNORED","GIT_STATUS_CONFLICTED"],"type":"enum","file":"git2/status.h","line":32,"lineto":50,"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_WT_RENAMED\nGIT_STATUS_WT_UNREADABLE\nGIT_STATUS_IGNORED\nGIT_STATUS_CONFLICTED","tdef":"typedef","description":" Status flags for a single file.","comments":"<p>A combination of these values will be returned to indicate the status of a file. Status compares the working directory, the index, and the current HEAD of the repository. The <code>GIT_STATUS_INDEX</code> set of flags represents the status of file in the index relative to the HEAD, and the <code>GIT_STATUS_WT</code> set of flags represent the status of the file in the working directory relative to the index.</p>\n","fields":[{"type":"int","name":"GIT_STATUS_CURRENT","comments":"","value":0},{"type":"int","name":"GIT_STATUS_INDEX_NEW","comments":"","value":1},{"type":"int","name":"GIT_STATUS_INDEX_MODIFIED","comments":"","value":2},{"type":"int","name":"GIT_STATUS_INDEX_DELETED","comments":"","value":4},{"type":"int","name":"GIT_STATUS_INDEX_RENAMED","comments":"","value":8},{"type":"int","name":"GIT_STATUS_INDEX_TYPECHANGE","comments":"","value":16},{"type":"int","name":"GIT_STATUS_WT_NEW","comments":"","value":128},{"type":"int","name":"GIT_STATUS_WT_MODIFIED","comments":"","value":256},{"type":"int","name":"GIT_STATUS_WT_DELETED","comments":"","value":512},{"type":"int","name":"GIT_STATUS_WT_TYPECHANGE","comments":"","value":1024},{"type":"int","name":"GIT_STATUS_WT_RENAMED","comments":"","value":2048},{"type":"int","name":"GIT_STATUS_WT_UNREADABLE","comments":"","value":4096},{"type":"int","name":"GIT_STATUS_IGNORED","comments":"","value":16384},{"type":"int","name":"GIT_STATUS_CONFLICTED","comments":"","value":32768}],"used":{"returns":[],"needs":[]}}],["git_strarray",{"decl":["char ** strings","size_t count"],"type":"struct","value":"git_strarray","file":"git2/strarray.h","line":22,"lineto":25,"block":"char ** strings\nsize_t count","tdef":"typedef","description":" Array of strings ","comments":"","fields":[{"type":"char **","name":"strings","comments":""},{"type":"size_t","name":"count","comments":""}],"used":{"returns":[],"needs":["git_index_add_all","git_index_remove_all","git_index_update_all","git_reference_list","git_remote_connect","git_remote_download","git_remote_fetch","git_remote_get_fetch_refspecs","git_remote_get_push_refspecs","git_remote_list","git_remote_push","git_remote_rename","git_remote_upload","git_reset_default","git_strarray_copy","git_strarray_free","git_tag_list","git_tag_list_match","git_worktree_list"]}}],["git_submodule",{"decl":"git_submodule","type":"struct","value":"git_submodule","file":"git2/types.h","line":339,"lineto":339,"tdef":"typedef","description":" Opaque structure representing a submodule.","comments":"","used":{"returns":["git_submodule_fetch_recurse_submodules","git_submodule_ignore","git_submodule_update_strategy"],"needs":["git_submodule_add_finalize","git_submodule_add_setup","git_submodule_add_to_index","git_submodule_branch","git_submodule_cb","git_submodule_fetch_recurse_submodules","git_submodule_foreach","git_submodule_free","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_repo_init","git_submodule_set_fetch_recurse_submodules","git_submodule_set_ignore","git_submodule_set_update","git_submodule_status","git_submodule_sync","git_submodule_update","git_submodule_update_init_options","git_submodule_update_strategy","git_submodule_url","git_submodule_wd_id"]}}],["git_submodule_ignore_t",{"decl":["GIT_SUBMODULE_IGNORE_UNSPECIFIED","GIT_SUBMODULE_IGNORE_NONE","GIT_SUBMODULE_IGNORE_UNTRACKED","GIT_SUBMODULE_IGNORE_DIRTY","GIT_SUBMODULE_IGNORE_ALL"],"type":"enum","file":"git2/types.h","line":403,"lineto":410,"block":"GIT_SUBMODULE_IGNORE_UNSPECIFIED\nGIT_SUBMODULE_IGNORE_NONE\nGIT_SUBMODULE_IGNORE_UNTRACKED\nGIT_SUBMODULE_IGNORE_DIRTY\nGIT_SUBMODULE_IGNORE_ALL","tdef":"typedef","description":" Submodule ignore values","comments":"<p>These values represent settings for the <code>submodule.$name.ignore</code> configuration value which says how deeply to look at the working directory when getting submodule status.</p>\n\n<p>You can override this value in memory on a per-submodule basis with <code>git_submodule_set_ignore()</code> and can write the changed value to disk with <code>git_submodule_save()</code>. If you have overwritten the value, you can revert to the on disk value by using <code>GIT_SUBMODULE_IGNORE_RESET</code>.</p>\n\n<p>The values are:</p>\n\n<ul>\n<li>GIT_SUBMODULE_IGNORE_UNSPECIFIED: use the submodule's configuration - GIT_SUBMODULE_IGNORE_NONE: don't ignore any change - i.e. even an untracked file, will mark the submodule as dirty. Ignored files are still ignored, of course. - GIT_SUBMODULE_IGNORE_UNTRACKED: ignore untracked files; only changes to tracked files, or the index or the HEAD commit will matter. - GIT_SUBMODULE_IGNORE_DIRTY: ignore changes in the working directory, only considering changes if the HEAD of submodule has moved from the value in the superproject. - GIT_SUBMODULE_IGNORE_ALL: never check if the submodule is dirty - GIT_SUBMODULE_IGNORE_DEFAULT: not used except as static initializer when we don't want any particular ignore rule to be specified.</li>\n</ul>\n","fields":[{"type":"int","name":"GIT_SUBMODULE_IGNORE_UNSPECIFIED","comments":"<p>use the submodule's configuration </p>\n","value":-1},{"type":"int","name":"GIT_SUBMODULE_IGNORE_NONE","comments":"<p>any change or untracked == dirty </p>\n","value":1},{"type":"int","name":"GIT_SUBMODULE_IGNORE_UNTRACKED","comments":"<p>dirty if tracked files change </p>\n","value":2},{"type":"int","name":"GIT_SUBMODULE_IGNORE_DIRTY","comments":"<p>only dirty if HEAD moved </p>\n","value":3},{"type":"int","name":"GIT_SUBMODULE_IGNORE_ALL","comments":"<p>never dirty </p>\n","value":4}],"used":{"returns":["git_submodule_ignore"],"needs":["git_submodule_set_ignore","git_submodule_status"]}}],["git_submodule_recurse_t",{"decl":["GIT_SUBMODULE_RECURSE_NO","GIT_SUBMODULE_RECURSE_YES","GIT_SUBMODULE_RECURSE_ONDEMAND"],"type":"enum","file":"git2/types.h","line":422,"lineto":426,"block":"GIT_SUBMODULE_RECURSE_NO\nGIT_SUBMODULE_RECURSE_YES\nGIT_SUBMODULE_RECURSE_ONDEMAND","tdef":"typedef","description":" Options for submodule recurse.","comments":"<p>Represent the value of <code>submodule.$name.fetchRecurseSubmodules</code></p>\n\n<ul>\n<li>GIT_SUBMODULE_RECURSE_NO - do no recurse into submodules * GIT_SUBMODULE_RECURSE_YES - recurse into submodules * GIT_SUBMODULE_RECURSE_ONDEMAND - recurse into submodules only when commit not already in local clone</li>\n</ul>\n","fields":[{"type":"int","name":"GIT_SUBMODULE_RECURSE_NO","comments":"","value":0},{"type":"int","name":"GIT_SUBMODULE_RECURSE_YES","comments":"","value":1},{"type":"int","name":"GIT_SUBMODULE_RECURSE_ONDEMAND","comments":"","value":2}],"used":{"returns":["git_submodule_fetch_recurse_submodules"],"needs":["git_submodule_set_fetch_recurse_submodules"]}}],["git_submodule_status_t",{"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":"git2/submodule.h","line":74,"lineto":89,"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","description":" Return codes for submodule status.","comments":"<p>A combination of these flags will be returned to describe the status of a submodule. Depending on the "ignore" property of the submodule, some of the flags may never be returned because they indicate changes that are supposed to be ignored.</p>\n\n<p>Submodule info is contained in 4 places: the HEAD tree, the index, config files (both .git/config and .gitmodules), and the working directory. Any or all of those places might be missing information about the submodule depending on what state the repo is in. We consider all four places to build the combination of status flags.</p>\n\n<p>There are four values that are not really status, but give basic info about what sources of submodule data are available. These will be returned even if ignore is set to "ALL".</p>\n\n<ul>\n<li>IN_HEAD - superproject head contains submodule * IN_INDEX - superproject index contains submodule * IN_CONFIG - superproject gitmodules has submodule * IN_WD - superproject workdir has submodule</li>\n</ul>\n\n<p>The following values will be returned so long as ignore is not "ALL".</p>\n\n<ul>\n<li>INDEX_ADDED - in index, not in head * INDEX_DELETED - in head, not in index * INDEX_MODIFIED - index and head don't match * WD_UNINITIALIZED - workdir contains empty directory * WD_ADDED - in workdir, not index * WD_DELETED - in index, not workdir * WD_MODIFIED - index and workdir head don't match</li>\n</ul>\n\n<p>The following can only be returned if ignore is "NONE" or "UNTRACKED".</p>\n\n<ul>\n<li>WD_INDEX_MODIFIED - submodule workdir index is dirty * WD_WD_MODIFIED - submodule workdir has modified files</li>\n</ul>\n\n<p>Lastly, the following will only be returned for ignore "NONE".</p>\n\n<ul>\n<li>WD_UNTRACKED - wd contains untracked files</li>\n</ul>\n","fields":[{"type":"int","name":"GIT_SUBMODULE_STATUS_IN_HEAD","comments":"","value":1},{"type":"int","name":"GIT_SUBMODULE_STATUS_IN_INDEX","comments":"","value":2},{"type":"int","name":"GIT_SUBMODULE_STATUS_IN_CONFIG","comments":"","value":4},{"type":"int","name":"GIT_SUBMODULE_STATUS_IN_WD","comments":"","value":8},{"type":"int","name":"GIT_SUBMODULE_STATUS_INDEX_ADDED","comments":"","value":16},{"type":"int","name":"GIT_SUBMODULE_STATUS_INDEX_DELETED","comments":"","value":32},{"type":"int","name":"GIT_SUBMODULE_STATUS_INDEX_MODIFIED","comments":"","value":64},{"type":"int","name":"GIT_SUBMODULE_STATUS_WD_UNINITIALIZED","comments":"","value":128},{"type":"int","name":"GIT_SUBMODULE_STATUS_WD_ADDED","comments":"","value":256},{"type":"int","name":"GIT_SUBMODULE_STATUS_WD_DELETED","comments":"","value":512},{"type":"int","name":"GIT_SUBMODULE_STATUS_WD_MODIFIED","comments":"","value":1024},{"type":"int","name":"GIT_SUBMODULE_STATUS_WD_INDEX_MODIFIED","comments":"","value":2048},{"type":"int","name":"GIT_SUBMODULE_STATUS_WD_WD_MODIFIED","comments":"","value":4096},{"type":"int","name":"GIT_SUBMODULE_STATUS_WD_UNTRACKED","comments":"","value":8192}],"used":{"returns":[],"needs":[]}}],["git_submodule_update_options",{"decl":["unsigned int version","git_checkout_options checkout_opts","git_fetch_options fetch_opts","int allow_fetch"],"type":"struct","value":"git_submodule_update_options","file":"git2/submodule.h","line":129,"lineto":154,"block":"unsigned int version\ngit_checkout_options checkout_opts\ngit_fetch_options fetch_opts\nint allow_fetch","tdef":"typedef","description":" Submodule update options structure","comments":"<p>Use the GIT_SUBMODULE_UPDATE_OPTIONS_INIT to get the default settings, like this:</p>\n\n<p>git_submodule_update_options opts = GIT_SUBMODULE_UPDATE_OPTIONS_INIT;</p>\n","fields":[{"type":"unsigned int","name":"version","comments":""},{"type":"git_checkout_options","name":"checkout_opts","comments":" These options are passed to the checkout step. To disable\n checkout, set the `checkout_strategy` to\n `GIT_CHECKOUT_NONE`. Generally you will want the use\n GIT_CHECKOUT_SAFE to update files in the working\n directory. "},{"type":"git_fetch_options","name":"fetch_opts","comments":" Options which control the fetch, including callbacks.\n\n The callbacks to use for reporting fetch progress, and for acquiring\n credentials in the event they are needed."},{"type":"int","name":"allow_fetch","comments":" Allow fetching from the submodule's default remote if the target\n commit isn't found. Enabled by default."}],"used":{"returns":[],"needs":["git_submodule_update","git_submodule_update_init_options"]}}],["git_submodule_update_t",{"decl":["GIT_SUBMODULE_UPDATE_CHECKOUT","GIT_SUBMODULE_UPDATE_REBASE","GIT_SUBMODULE_UPDATE_MERGE","GIT_SUBMODULE_UPDATE_NONE","GIT_SUBMODULE_UPDATE_DEFAULT"],"type":"enum","file":"git2/types.h","line":367,"lineto":374,"block":"GIT_SUBMODULE_UPDATE_CHECKOUT\nGIT_SUBMODULE_UPDATE_REBASE\nGIT_SUBMODULE_UPDATE_MERGE\nGIT_SUBMODULE_UPDATE_NONE\nGIT_SUBMODULE_UPDATE_DEFAULT","tdef":"typedef","description":" Submodule update values","comments":"<p>These values represent settings for the <code>submodule.$name.update</code> configuration value which says how to handle <code>git submodule update</code> for this submodule. The value is usually set in the ".gitmodules" file and copied to ".git/config" when the submodule is initialized.</p>\n\n<p>You can override this setting on a per-submodule basis with <code>git_submodule_set_update()</code> and write the changed value to disk using <code>git_submodule_save()</code>. If you have overwritten the value, you can revert it by passing <code>GIT_SUBMODULE_UPDATE_RESET</code> to the set function.</p>\n\n<p>The values are:</p>\n\n<ul>\n<li>GIT_SUBMODULE_UPDATE_CHECKOUT: the default; when a submodule is updated, checkout the new detached HEAD to the submodule directory. - GIT_SUBMODULE_UPDATE_REBASE: update by rebasing the current checked out branch onto the commit from the superproject. - GIT_SUBMODULE_UPDATE_MERGE: update by merging the commit in the superproject into the current checkout out branch of the submodule. - GIT_SUBMODULE_UPDATE_NONE: do not update this submodule even when the commit in the superproject is updated. - GIT_SUBMODULE_UPDATE_DEFAULT: not used except as static initializer when we don't want any particular update rule to be specified.</li>\n</ul>\n","fields":[{"type":"int","name":"GIT_SUBMODULE_UPDATE_CHECKOUT","comments":"","value":1},{"type":"int","name":"GIT_SUBMODULE_UPDATE_REBASE","comments":"","value":2},{"type":"int","name":"GIT_SUBMODULE_UPDATE_MERGE","comments":"","value":3},{"type":"int","name":"GIT_SUBMODULE_UPDATE_NONE","comments":"","value":4},{"type":"int","name":"GIT_SUBMODULE_UPDATE_DEFAULT","comments":"","value":0}],"used":{"returns":["git_submodule_update_strategy"],"needs":["git_submodule_set_update"]}}],["git_tag",{"decl":"git_tag","type":"struct","value":"git_tag","file":"git2/types.h","line":117,"lineto":117,"tdef":"typedef","description":" Parsed representation of a tag object. ","comments":"","used":{"returns":[],"needs":["git_tag_dup","git_tag_foreach","git_tag_free","git_tag_id","git_tag_lookup","git_tag_lookup_prefix","git_tag_message","git_tag_name","git_tag_owner","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","char sign"],"type":"struct","value":"git_time","file":"git2/types.h","line":159,"lineto":163,"block":"git_time_t time\nint offset\nchar sign","tdef":"typedef","description":" Time in a signature ","comments":"","fields":[{"type":"git_time_t","name":"time","comments":" time in seconds from epoch "},{"type":"int","name":"offset","comments":" timezone offset, in minutes "},{"type":"char","name":"sign","comments":" indicator for questionable '-0000' offsets in signature "}],"used":{"returns":["git_commit_time"],"needs":["git_signature_new"]}}],["git_trace_level_t",{"decl":["GIT_TRACE_NONE","GIT_TRACE_FATAL","GIT_TRACE_ERROR","GIT_TRACE_WARN","GIT_TRACE_INFO","GIT_TRACE_DEBUG","GIT_TRACE_TRACE"],"type":"enum","file":"git2/trace.h","line":26,"lineto":47,"block":"GIT_TRACE_NONE\nGIT_TRACE_FATAL\nGIT_TRACE_ERROR\nGIT_TRACE_WARN\nGIT_TRACE_INFO\nGIT_TRACE_DEBUG\nGIT_TRACE_TRACE","tdef":"typedef","description":" Available tracing levels. When tracing is set to a particular level,\n callers will be provided tracing at the given level and all lower levels.","comments":"","fields":[{"type":"int","name":"GIT_TRACE_NONE","comments":"<p>No tracing will be performed. </p>\n","value":0},{"type":"int","name":"GIT_TRACE_FATAL","comments":"<p>Severe errors that may impact the program's execution </p>\n","value":1},{"type":"int","name":"GIT_TRACE_ERROR","comments":"<p>Errors that do not impact the program's execution </p>\n","value":2},{"type":"int","name":"GIT_TRACE_WARN","comments":"<p>Warnings that suggest abnormal data </p>\n","value":3},{"type":"int","name":"GIT_TRACE_INFO","comments":"<p>Informational messages about program execution </p>\n","value":4},{"type":"int","name":"GIT_TRACE_DEBUG","comments":"<p>Detailed data that allows for debugging </p>\n","value":5},{"type":"int","name":"GIT_TRACE_TRACE","comments":"<p>Exceptionally detailed debugging data </p>\n","value":6}],"used":{"returns":[],"needs":["git_trace_callback","git_trace_set"]}}],["git_transaction",{"decl":"git_transaction","type":"struct","value":"git_transaction","file":"git2/types.h","line":179,"lineto":179,"tdef":"typedef","description":" Transactional interface to references ","comments":"","used":{"returns":[],"needs":["git_config_lock"]}}],["git_transfer_progress",{"decl":["unsigned int total_objects","unsigned int indexed_objects","unsigned int received_objects","unsigned int local_objects","unsigned int total_deltas","unsigned int indexed_deltas","size_t received_bytes"],"type":"struct","value":"git_transfer_progress","file":"git2/types.h","line":257,"lineto":265,"block":"unsigned int total_objects\nunsigned int indexed_objects\nunsigned int received_objects\nunsigned int local_objects\nunsigned int total_deltas\nunsigned int indexed_deltas\nsize_t received_bytes","tdef":"typedef","description":" This is passed as the first argument to the callback to allow the\n user to see the progress.","comments":"<ul>\n<li>total_objects: number of objects in the packfile being downloaded - indexed_objects: received objects that have been hashed - received_objects: objects which have been downloaded - local_objects: locally-available objects that have been injected in order to fix a thin pack. - received-bytes: size of the packfile received up to now</li>\n</ul>\n","fields":[{"type":"unsigned int","name":"total_objects","comments":""},{"type":"unsigned int","name":"indexed_objects","comments":""},{"type":"unsigned int","name":"received_objects","comments":""},{"type":"unsigned int","name":"local_objects","comments":""},{"type":"unsigned int","name":"total_deltas","comments":""},{"type":"unsigned int","name":"indexed_deltas","comments":""},{"type":"size_t","name":"received_bytes","comments":""}],"used":{"returns":["git_remote_stats"],"needs":["git_indexer_append","git_indexer_commit","git_indexer_new","git_odb_write_pack","git_packbuilder_write","git_transfer_progress_cb"]}}],["git_transport",{"decl":"git_transport","type":"struct","value":"git_transport","file":"git2/types.h","line":234,"lineto":234,"tdef":"typedef","description":" Interface which represents a transport to communicate with a\n remote.","comments":"","used":{"returns":[],"needs":["git_transport_cb"]}}],["git_tree",{"decl":"git_tree","type":"struct","value":"git_tree","file":"git2/types.h","line":129,"lineto":129,"tdef":"typedef","description":" Representation of a tree object. ","comments":"","used":{"returns":["git_tree_entry_byid","git_tree_entry_byindex","git_tree_entry_byname","git_treebuilder_get"],"needs":["git_commit_amend","git_commit_create","git_commit_create_buffer","git_commit_create_v","git_commit_tree","git_diff_tree_to_index","git_diff_tree_to_tree","git_diff_tree_to_workdir","git_diff_tree_to_workdir_with_index","git_index_read_tree","git_merge_trees","git_tree_create_updated","git_tree_dup","git_tree_entry_byid","git_tree_entry_byindex","git_tree_entry_byname","git_tree_entry_bypath","git_tree_entry_cmp","git_tree_entry_dup","git_tree_entry_filemode","git_tree_entry_filemode_raw","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","git_treebuilder_clear","git_treebuilder_entrycount","git_treebuilder_filter","git_treebuilder_filter_cb","git_treebuilder_free","git_treebuilder_get","git_treebuilder_insert","git_treebuilder_new","git_treebuilder_remove","git_treebuilder_write","git_treebuilder_write_with_buffer","git_treewalk_cb"]}}],["git_tree_entry",{"decl":"git_tree_entry","type":"struct","value":"git_tree_entry","file":"git2/types.h","line":126,"lineto":126,"tdef":"typedef","description":" Representation of each one of the entries in a tree object. ","comments":"","used":{"returns":["git_tree_entry_byid","git_tree_entry_byindex","git_tree_entry_byname","git_treebuilder_get"],"needs":["git_tree_entry_bypath","git_tree_entry_cmp","git_tree_entry_dup","git_tree_entry_filemode","git_tree_entry_filemode_raw","git_tree_entry_free","git_tree_entry_id","git_tree_entry_name","git_tree_entry_to_object","git_tree_entry_type","git_treebuilder_filter_cb","git_treebuilder_insert","git_treewalk_cb"]}}],["git_tree_update",{"decl":["git_tree_update_t action","git_oid id","git_filemode_t filemode","const char * path"],"type":"struct","value":"git_tree_update","file":"git2/tree.h","line":448,"lineto":457,"block":"git_tree_update_t action\ngit_oid id\ngit_filemode_t filemode\nconst char * path","tdef":"typedef","description":" An action to perform during the update of a tree","comments":"","fields":[{"type":"git_tree_update_t","name":"action","comments":" Update action. If it's an removal, only the path is looked at "},{"type":"git_oid","name":"id","comments":" The entry's id "},{"type":"git_filemode_t","name":"filemode","comments":" The filemode/kind of object "},{"type":"const char *","name":"path","comments":" The full path from the root tree "}],"used":{"returns":[],"needs":["git_tree_create_updated"]}}],["git_tree_update_t",{"decl":["GIT_TREE_UPDATE_UPSERT","GIT_TREE_UPDATE_REMOVE"],"type":"enum","file":"git2/tree.h","line":438,"lineto":443,"block":"GIT_TREE_UPDATE_UPSERT\nGIT_TREE_UPDATE_REMOVE","tdef":"typedef","description":" The kind of update to perform","comments":"","fields":[{"type":"int","name":"GIT_TREE_UPDATE_UPSERT","comments":"<p>Update or insert an entry at the specified path </p>\n","value":0},{"type":"int","name":"GIT_TREE_UPDATE_REMOVE","comments":"<p>Remove an entry from the specified path </p>\n","value":1}],"used":{"returns":[],"needs":[]}}],["git_treebuilder",{"decl":"git_treebuilder","type":"struct","value":"git_treebuilder","file":"git2/types.h","line":132,"lineto":132,"tdef":"typedef","description":" Constructor for in-memory trees ","comments":"","used":{"returns":[],"needs":["git_treebuilder_clear","git_treebuilder_entrycount","git_treebuilder_filter","git_treebuilder_free","git_treebuilder_get","git_treebuilder_insert","git_treebuilder_new","git_treebuilder_remove","git_treebuilder_write","git_treebuilder_write_with_buffer"]}}],["git_treewalk_mode",{"decl":["GIT_TREEWALK_PRE","GIT_TREEWALK_POST"],"type":"enum","file":"git2/tree.h","line":398,"lineto":401,"block":"GIT_TREEWALK_PRE\nGIT_TREEWALK_POST","tdef":"typedef","description":" Tree traversal modes ","comments":"","fields":[{"type":"int","name":"GIT_TREEWALK_PRE","comments":"","value":0},{"type":"int","name":"GIT_TREEWALK_POST","comments":"","value":1}],"used":{"returns":[],"needs":["git_tree_walk"]}}],["git_worktree",{"decl":"git_worktree","type":"struct","value":"git_worktree","file":"git2/types.h","line":108,"lineto":108,"tdef":"typedef","description":" Representation of a working tree ","comments":"","used":{"returns":[],"needs":["git_repository_open_from_worktree","git_worktree_add","git_worktree_add_init_options","git_worktree_free","git_worktree_is_locked","git_worktree_is_prunable","git_worktree_lock","git_worktree_lookup","git_worktree_open_from_repository","git_worktree_prune","git_worktree_prune_init_options","git_worktree_unlock","git_worktree_validate"]}}],["git_worktree_prune_t",{"decl":["GIT_WORKTREE_PRUNE_VALID","GIT_WORKTREE_PRUNE_LOCKED","GIT_WORKTREE_PRUNE_WORKING_TREE"],"type":"enum","file":"git2/worktree.h","line":155,"lineto":162,"block":"GIT_WORKTREE_PRUNE_VALID\nGIT_WORKTREE_PRUNE_LOCKED\nGIT_WORKTREE_PRUNE_WORKING_TREE","tdef":"typedef","description":" Flags which can be passed to git_worktree_prune to alter its\n behavior.","comments":"","fields":[{"type":"int","name":"GIT_WORKTREE_PRUNE_VALID","comments":"","value":1},{"type":"int","name":"GIT_WORKTREE_PRUNE_LOCKED","comments":"","value":2},{"type":"int","name":"GIT_WORKTREE_PRUNE_WORKING_TREE","comments":"","value":4}],"used":{"returns":[],"needs":[]}}],["git_writestream",{"decl":"git_writestream","type":"struct","value":"git_writestream","file":"git2/types.h","line":429,"lineto":429,"tdef":"typedef","description":" A type to write in a streaming fashion, for example, for filters. ","comments":"","used":{"returns":[],"needs":["git_blob_create_fromstream","git_blob_create_fromstream_commit","git_filter_list_stream_blob","git_filter_list_stream_data","git_filter_list_stream_file"]}}]],"prefix":"include","groups":[["annotated",["git_annotated_commit_free","git_annotated_commit_from_fetchhead","git_annotated_commit_from_ref","git_annotated_commit_from_revspec","git_annotated_commit_id","git_annotated_commit_lookup"]],["attr",["git_attr_add_macro","git_attr_cache_flush","git_attr_foreach","git_attr_get","git_attr_get_many","git_attr_value"]],["blame",["git_blame_buffer","git_blame_file","git_blame_free","git_blame_get_hunk_byindex","git_blame_get_hunk_byline","git_blame_get_hunk_count","git_blame_init_options"]],["blob",["git_blob_create_frombuffer","git_blob_create_fromdisk","git_blob_create_fromstream","git_blob_create_fromstream_commit","git_blob_create_fromworkdir","git_blob_dup","git_blob_filtered_content","git_blob_free","git_blob_id","git_blob_is_binary","git_blob_lookup","git_blob_lookup_prefix","git_blob_owner","git_blob_rawcontent","git_blob_rawsize"]],["branch",["git_branch_create","git_branch_create_from_annotated","git_branch_delete","git_branch_is_checked_out","git_branch_is_head","git_branch_iterator_free","git_branch_iterator_new","git_branch_lookup","git_branch_move","git_branch_name","git_branch_next","git_branch_set_upstream","git_branch_upstream"]],["buf",["git_buf_contains_nul","git_buf_free","git_buf_grow","git_buf_is_binary","git_buf_set"]],["checkout",["git_checkout_head","git_checkout_index","git_checkout_init_options","git_checkout_tree"]],["cherrypick",["git_cherrypick","git_cherrypick_commit","git_cherrypick_init_options"]],["clone",["git_clone","git_clone_init_options"]],["commit",["git_commit_amend","git_commit_author","git_commit_body","git_commit_committer","git_commit_create","git_commit_create_buffer","git_commit_create_v","git_commit_create_with_signature","git_commit_dup","git_commit_extract_signature","git_commit_free","git_commit_header_field","git_commit_id","git_commit_lookup","git_commit_lookup_prefix","git_commit_message","git_commit_message_encoding","git_commit_message_raw","git_commit_nth_gen_ancestor","git_commit_owner","git_commit_parent","git_commit_parent_id","git_commit_parentcount","git_commit_raw_header","git_commit_summary","git_commit_time","git_commit_time_offset","git_commit_tree","git_commit_tree_id"]],["config",["git_config_add_file_ondisk","git_config_backend_foreach_match","git_config_delete_entry","git_config_delete_multivar","git_config_entry_free","git_config_find_global","git_config_find_programdata","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_foreach","git_config_get_path","git_config_get_string","git_config_get_string_buf","git_config_iterator_free","git_config_iterator_glob_new","git_config_iterator_new","git_config_lock","git_config_lookup_map_value","git_config_multivar_iterator_new","git_config_new","git_config_next","git_config_open_default","git_config_open_global","git_config_open_level","git_config_open_ondisk","git_config_parse_bool","git_config_parse_int32","git_config_parse_int64","git_config_parse_path","git_config_set_bool","git_config_set_int32","git_config_set_int64","git_config_set_multivar","git_config_set_string","git_config_snapshot"]],["cred",["git_cred_default_new","git_cred_free","git_cred_has_username","git_cred_ssh_custom_new","git_cred_ssh_interactive_new","git_cred_ssh_key_from_agent","git_cred_ssh_key_memory_new","git_cred_ssh_key_new","git_cred_username_new","git_cred_userpass","git_cred_userpass_plaintext_new"]],["describe",["git_describe_commit","git_describe_format","git_describe_result_free","git_describe_workdir"]],["diff",["git_diff_blob_to_buffer","git_diff_blobs","git_diff_buffers","git_diff_commit_as_email","git_diff_find_init_options","git_diff_find_similar","git_diff_foreach","git_diff_format_email","git_diff_format_email_init_options","git_diff_free","git_diff_from_buffer","git_diff_get_delta","git_diff_get_stats","git_diff_index_to_index","git_diff_index_to_workdir","git_diff_init_options","git_diff_is_sorted_icase","git_diff_merge","git_diff_num_deltas","git_diff_num_deltas_of_type","git_diff_patchid","git_diff_patchid_init_options","git_diff_print","git_diff_stats_deletions","git_diff_stats_files_changed","git_diff_stats_free","git_diff_stats_insertions","git_diff_stats_to_buf","git_diff_status_char","git_diff_to_buf","git_diff_tree_to_index","git_diff_tree_to_tree","git_diff_tree_to_workdir","git_diff_tree_to_workdir_with_index"]],["fetch",["git_fetch_init_options"]],["filter",["git_filter_list_apply_to_blob","git_filter_list_apply_to_data","git_filter_list_apply_to_file","git_filter_list_contains","git_filter_list_free","git_filter_list_load","git_filter_list_stream_blob","git_filter_list_stream_data","git_filter_list_stream_file"]],["giterr",["giterr_clear","giterr_last","giterr_set_oom","giterr_set_str"]],["graph",["git_graph_ahead_behind","git_graph_descendant_of"]],["ignore",["git_ignore_add_rule","git_ignore_clear_internal_rules","git_ignore_path_is_ignored"]],["index",["git_index_add","git_index_add_all","git_index_add_bypath","git_index_add_frombuffer","git_index_caps","git_index_checksum","git_index_clear","git_index_conflict_add","git_index_conflict_cleanup","git_index_conflict_get","git_index_conflict_iterator_free","git_index_conflict_iterator_new","git_index_conflict_next","git_index_conflict_remove","git_index_entry_is_conflict","git_index_entry_stage","git_index_entrycount","git_index_find","git_index_find_prefix","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_path","git_index_read","git_index_read_tree","git_index_remove","git_index_remove_all","git_index_remove_bypath","git_index_remove_directory","git_index_set_caps","git_index_set_version","git_index_update_all","git_index_version","git_index_write","git_index_write_tree","git_index_write_tree_to"]],["indexer",["git_indexer_append","git_indexer_commit","git_indexer_free","git_indexer_hash","git_indexer_new"]],["libgit2",["git_libgit2_features","git_libgit2_init","git_libgit2_opts","git_libgit2_shutdown","git_libgit2_version"]],["merge",["git_merge","git_merge_analysis","git_merge_base","git_merge_base_many","git_merge_base_octopus","git_merge_bases","git_merge_bases_many","git_merge_commits","git_merge_file","git_merge_file_from_index","git_merge_file_init_input","git_merge_file_init_options","git_merge_file_result_free","git_merge_init_options","git_merge_trees"]],["message",["git_message_prettify","git_message_trailer_array_free","git_message_trailers"]],["note",["git_note_author","git_note_commit_create","git_note_commit_iterator_new","git_note_commit_read","git_note_commit_remove","git_note_committer","git_note_create","git_note_foreach","git_note_free","git_note_id","git_note_iterator_free","git_note_iterator_new","git_note_message","git_note_next","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_bypath","git_object_lookup_prefix","git_object_owner","git_object_peel","git_object_short_id","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_loose","git_odb_backend_one_pack","git_odb_backend_pack","git_odb_exists","git_odb_exists_prefix","git_odb_expand_ids","git_odb_foreach","git_odb_free","git_odb_get_backend","git_odb_hash","git_odb_hashfile","git_odb_new","git_odb_num_backends","git_odb_object_data","git_odb_object_dup","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_stream_finalize_write","git_odb_stream_free","git_odb_stream_read","git_odb_stream_write","git_odb_write","git_odb_write_pack"]],["oid",["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_nfmt","git_oid_pathfmt","git_oid_shorten_add","git_oid_shorten_free","git_oid_shorten_new","git_oid_strcmp","git_oid_streq","git_oid_tostr","git_oid_tostr_s"]],["oidarray",["git_oidarray_free"]],["packbuilder",["git_packbuilder_foreach","git_packbuilder_free","git_packbuilder_hash","git_packbuilder_insert","git_packbuilder_insert_commit","git_packbuilder_insert_recur","git_packbuilder_insert_tree","git_packbuilder_insert_walk","git_packbuilder_new","git_packbuilder_object_count","git_packbuilder_set_callbacks","git_packbuilder_set_threads","git_packbuilder_write","git_packbuilder_written"]],["patch",["git_patch_free","git_patch_from_blob_and_buffer","git_patch_from_blobs","git_patch_from_buffers","git_patch_from_diff","git_patch_get_delta","git_patch_get_hunk","git_patch_get_line_in_hunk","git_patch_line_stats","git_patch_num_hunks","git_patch_num_lines_in_hunk","git_patch_print","git_patch_size","git_patch_to_buf"]],["proxy",["git_proxy_init_options"]],["push",["git_push_init_options"]],["rebase",["git_rebase_abort","git_rebase_commit","git_rebase_finish","git_rebase_free","git_rebase_init","git_rebase_init_options","git_rebase_inmemory_index","git_rebase_next","git_rebase_open","git_rebase_operation_byindex","git_rebase_operation_current","git_rebase_operation_entrycount"]],["refdb",["git_refdb_compress","git_refdb_free","git_refdb_new","git_refdb_open"]],["reference",["git_reference_cmp","git_reference_create","git_reference_create_matching","git_reference_delete","git_reference_dup","git_reference_dwim","git_reference_ensure_log","git_reference_foreach","git_reference_foreach_glob","git_reference_foreach_name","git_reference_free","git_reference_has_log","git_reference_is_branch","git_reference_is_note","git_reference_is_remote","git_reference_is_tag","git_reference_is_valid_name","git_reference_iterator_free","git_reference_iterator_glob_new","git_reference_iterator_new","git_reference_list","git_reference_lookup","git_reference_name","git_reference_name_to_id","git_reference_next","git_reference_next_name","git_reference_normalize_name","git_reference_owner","git_reference_peel","git_reference_remove","git_reference_rename","git_reference_resolve","git_reference_set_target","git_reference_shorthand","git_reference_symbolic_create","git_reference_symbolic_create_matching","git_reference_symbolic_set_target","git_reference_symbolic_target","git_reference_target","git_reference_target_peel","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_direction","git_refspec_dst","git_refspec_dst_matches","git_refspec_force","git_refspec_rtransform","git_refspec_src","git_refspec_src_matches","git_refspec_string","git_refspec_transform"]],["remote",["git_remote_add_fetch","git_remote_add_push","git_remote_autotag","git_remote_connect","git_remote_connected","git_remote_create","git_remote_create_anonymous","git_remote_create_detached","git_remote_create_with_fetchspec","git_remote_default_branch","git_remote_delete","git_remote_disconnect","git_remote_download","git_remote_dup","git_remote_fetch","git_remote_free","git_remote_get_fetch_refspecs","git_remote_get_push_refspecs","git_remote_get_refspec","git_remote_init_callbacks","git_remote_is_valid_name","git_remote_list","git_remote_lookup","git_remote_ls","git_remote_name","git_remote_owner","git_remote_prune","git_remote_prune_refs","git_remote_push","git_remote_pushurl","git_remote_refspec_count","git_remote_rename","git_remote_set_autotag","git_remote_set_pushurl","git_remote_set_url","git_remote_stats","git_remote_stop","git_remote_update_tips","git_remote_upload","git_remote_url"]],["repository",["git_repository_commondir","git_repository_config","git_repository_config_snapshot","git_repository_detach_head","git_repository_discover","git_repository_fetchhead_foreach","git_repository_free","git_repository_get_namespace","git_repository_hashfile","git_repository_head","git_repository_head_detached","git_repository_head_for_worktree","git_repository_head_unborn","git_repository_ident","git_repository_index","git_repository_init","git_repository_init_ext","git_repository_init_init_options","git_repository_is_bare","git_repository_is_empty","git_repository_is_shallow","git_repository_is_worktree","git_repository_item_path","git_repository_mergehead_foreach","git_repository_message","git_repository_message_remove","git_repository_odb","git_repository_open","git_repository_open_bare","git_repository_open_ext","git_repository_open_from_worktree","git_repository_path","git_repository_refdb","git_repository_set_head","git_repository_set_head_detached","git_repository_set_head_detached_from_annotated","git_repository_set_ident","git_repository_set_namespace","git_repository_set_workdir","git_repository_state","git_repository_state_cleanup","git_repository_workdir","git_repository_wrap_odb"]],["reset",["git_reset","git_reset_default","git_reset_from_annotated"]],["revert",["git_revert","git_revert_commit","git_revert_init_options"]],["revparse",["git_revparse","git_revparse_ext","git_revparse_single"]],["revwalk",["git_revwalk_add_hide_cb","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_simplify_first_parent","git_revwalk_sorting"]],["signature",["git_signature_default","git_signature_dup","git_signature_free","git_signature_from_buffer","git_signature_new","git_signature_now"]],["stash",["git_stash_apply","git_stash_apply_init_options","git_stash_drop","git_stash_foreach","git_stash_pop"]],["status",["git_status_byindex","git_status_file","git_status_foreach","git_status_foreach_ext","git_status_init_options","git_status_list_entrycount","git_status_list_free","git_status_list_new","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_branch","git_submodule_fetch_recurse_submodules","git_submodule_foreach","git_submodule_free","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_repo_init","git_submodule_resolve_url","git_submodule_set_branch","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_update_init_options","git_submodule_update_strategy","git_submodule_url","git_submodule_wd_id"]],["tag",["git_tag_annotation_create","git_tag_create","git_tag_create_frombuffer","git_tag_create_lightweight","git_tag_delete","git_tag_dup","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_owner","git_tag_peel","git_tag_tagger","git_tag_target","git_tag_target_id","git_tag_target_type"]],["trace",["git_trace_set"]],["tree",["git_tree_create_updated","git_tree_dup","git_tree_entry_byid","git_tree_entry_byindex","git_tree_entry_byname","git_tree_entry_bypath","git_tree_entry_cmp","git_tree_entry_dup","git_tree_entry_filemode","git_tree_entry_filemode_raw","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_entrycount","git_treebuilder_filter","git_treebuilder_free","git_treebuilder_get","git_treebuilder_insert","git_treebuilder_new","git_treebuilder_remove","git_treebuilder_write","git_treebuilder_write_with_buffer"]],["worktree",["git_worktree_add","git_worktree_add_init_options","git_worktree_free","git_worktree_is_locked","git_worktree_is_prunable","git_worktree_list","git_worktree_lock","git_worktree_lookup","git_worktree_open_from_repository","git_worktree_prune","git_worktree_prune_init_options","git_worktree_unlock","git_worktree_validate"]]],"examples":[["add.c","ex/v0.27.1/add.html"],["blame.c","ex/v0.27.1/blame.html"],["cat-file.c","ex/v0.27.1/cat-file.html"],["common.c","ex/v0.27.1/common.html"],["describe.c","ex/v0.27.1/describe.html"],["diff.c","ex/v0.27.1/diff.html"],["for-each-ref.c","ex/v0.27.1/for-each-ref.html"],["general.c","ex/v0.27.1/general.html"],["init.c","ex/v0.27.1/init.html"],["log.c","ex/v0.27.1/log.html"],["merge.c","ex/v0.27.1/merge.html"],["network/clone.c","ex/v0.27.1/network/clone.html"],["network/common.c","ex/v0.27.1/network/common.html"],["network/fetch.c","ex/v0.27.1/network/fetch.html"],["network/git2.c","ex/v0.27.1/network/git2.html"],["network/index-pack.c","ex/v0.27.1/network/index-pack.html"],["network/ls-remote.c","ex/v0.27.1/network/ls-remote.html"],["remote.c","ex/v0.27.1/remote.html"],["rev-list.c","ex/v0.27.1/rev-list.html"],["rev-parse.c","ex/v0.27.1/rev-parse.html"],["showindex.c","ex/v0.27.1/showindex.html"],["status.c","ex/v0.27.1/status.html"],["tag.c","ex/v0.27.1/tag.html"]]}
|
