Basic Documentation

This section contains explaination on Luagit2 API.

• 1. Annotated
  • 1.1. annotated_commit_from_ref
  • 1.2. annotated_commit_from_revspec
  • 1.3. annotated_commit_lookup
  • 1.4. annotated_commit_from_fetchhead
  • 1.5. annotated_commit_id
  • 1.6. annotated_commit_free
• 2. Blame
  • 2.1. blame_file
  • 2.2. blame_get_hunk_byindex
  • 2.3. blame_get_hunk_byline
  • 2.4. blame_get_hunk_count
  • 2.5. blame_free
• 3. Blob
  • 3.1. blob_create_fromdisk
  • 3.2. blob_create_fromworkdir
  • 3.3. blob_filtered_content
  • 3.4. blob_id
  • 3.5. blob_is_binary
  • 3.6. blob_lookup
  • 3.7. blob_lookup_prefix
  • 3.8. blob_owner
  • 3.9. blob_rawsize
  • 3.10. blob_free
• 4. Branch
  • 4.1. branch_create
  • 4.2. branch_create_from_annotated
  • 4.3. branch_delete
  • 4.4. branch_is_checked_out
  • 4.5. branch_is_head
  • 4.6. branch_iterator_new
  • 4.7. branch_lookup
  • 4.8. branch_move
  • 4.9. branch_name
  • 4.10. branch_next
  • 4.11. branch_set_upstream
  • 4.12. branch_upstream
• 5. Buf
  • 5.1. buf_set_str
  • 5.2. buf_free
• 6. Checkout
  • 6.1. checkout_init_options
  • 6.2. checkout_head
  • 6.3. checkout_index
  • 6.4. checkout_tree
• 7. Clone
  • 7.1. clone_public
• 8. Commit
  • 8.1. commit_author
  • 8.2. commit_body
  • 8.3. commit_committer
  • 8.4. commit_extract_signature
  • 8.5. commit_header_field
  • 8.6. commit_lookup
  • 8.7. commit_lookup_prefix
  • 8.8. commit_message
  • 8.9. commit_message_encoding
  • 8.10. commit_message_raw
  • 8.11. commit_nth_gen_ancestor
  • 8.12. commit_parent
  • 8.13. commit_parent_id
  • 8.14. commit_parentcount
  • 8.15. commit_raw_header
  • 8.16. commit_summary
  • 8.17. commit_time
  • 8.18. commit_tree
  • 8.19. commit_tree_id
  • 8.20. commit_free
  • 8.21. commit_id
  • 8.22. commit_create_update_head
  • 8.23. commit_create_update_none
  • 8.24. commit_create_with_signature
  • 8.25. commit_create_initial
• 9. Config
  • 9.1. config_delete_entry
  • 9.2. config_delete_multivar
  • 9.3. config_find_global
  • 9.4. config_find_programdata
  • 9.5. config_find_system
  • 9.6. config_find_xdg
  • 9.7. config_get_int32
  • 9.8. config_get_int64
  • 9.9. config_get_bool
  • 9.10. config_get_path
  • 9.11. config_get_string
  • 9.12. config_get_string_buf
  • 9.13. config_open_default
  • 9.14. config_open_global
  • 9.15. config_open_level
  • 9.16. config_open_ondisk
  • 9.17. config_parse_bool
  • 9.18. config_parse_int32
  • 9.19. config_parse_int64
  • 9.20. config_parse_path
  • 9.21. config_set_bool
  • 9.22. config_set_int32
  • 9.23. config_set_int64
  • 9.24. config_set_multivar
  • 9.25. config_set_string
  • 9.26. config_snapshot
  • 9.27. config_free
  • 9.28. config_add_file_ondisk
  • 9.29. config_new
  • 9.30. config_iterator_new
  • 9.31. config_entry_free
  • 9.32. config_get_entry
  • 9.33. config_next
  • 9.34. config_iterator_free
• 10. Cred
  • 10.1. cred_default_new
  • 10.2. cred_ssh_key_from_agent
  • 10.3. cred_ssh_key_memory_new
  • 10.4. cred_ssh_key_new
  • 10.5. cred_username_new
  • 10.6. cred_userpass_plaintext_new
  • 10.7. cred_free
• 11. Describe
  • 11.1. describe_commit
  • 11.2. describe_workdir
  • 11.3. describe_format
  • 11.4. describe_result_free
• 12. Diff
  • 12.1. diff_init_options
  • 12.2. diff_get_stats
  • 12.3. diff_index_to_index
  • 12.4. diff_index_to_workdir
  • 12.5. diff_is_sorted_icase
  • 12.6. diff_merge
  • 12.7. diff_num_deltas
  • 12.8. diff_stats_deletions
  • 12.9. diff_stats_files_changed
  • 12.10. diff_stats_insertions
  • 12.11. diff_stats_to_buf
  • 12.12. diff_to_buf
  • 12.13. diff_tree_to_index
  • 12.14. diff_tree_to_tree
  • 12.15. diff_tree_to_workdir
  • 12.16. diff_tree_to_workdir_with_index
• 13. Graph
  • 13.1. graph_ahead_behind
  • 13.2. graph_descendant_of
• 14. Ignore
  • 14.1. ignore_add_rule
  • 14.2. ignore_clear_internal_rules
  • 14.3. ignore_path_is_ignored
• 15. Index
  • 15.1. index_add
  • 15.2. index_add_bypath
  • 15.3. index_caps
  • 15.4. index_checksum
  • 15.5. index_conflict_add
  • 15.6. index_conflict_cleanup
  • 15.7. index_entry_is_conflict
  • 15.8. index_entry_stage
  • 15.9. index_entrycount
  • 15.10. index_find
  • 15.11. index_find_prefix
  • 15.12. index_get_byindex
  • 15.13. index_get_bypath
  • 15.14. index_has_conflicts
  • 15.15. index_open
  • 15.16. index_owner
  • 15.17. index_path
  • 15.18. index_read
  • 15.19. index_read_tree
  • 15.20. index_remove
  • 15.21. index_remove_bypath
  • 15.22. index_remove_directory
  • 15.23. index_set_caps
  • 15.24. index_set_version
  • 15.25. index_version
  • 15.26. index_write
  • 15.27. index_write_tree
  • 15.28. index_write_tree_to
  • 15.29. index_free
• 16. Libgit
  • 16.1. init
  • 16.2. shutdown
  • 16.3. libgit2_features
  • 16.4. get_mwindow_size
  • 16.5. set_mwindow_size
  • 16.6. get_mwindow_mapped_limit
  • 16.7. set_mwindow_mapped_limit
  • 16.8. get_search_path
  • 16.9. set_search_path
  • 16.10. get_cached_memory
  • 16.11. set_cache_object_limit
  • 16.12. set_cache_max_size
  • 16.13. enable_caching
  • 16.14. get_template_path
  • 16.15. set_template_path
  • 16.16. set_user_agent
  • 16.17. get_windows_sharemode
  • 16.18. set_windows_sharemode
  • 16.19. enable_strict_object_creation
  • 16.20. enable_strict_symbolic_ref_creation
  • 16.21. enable_ofs_delta
  • 16.22. set_ssl_ciphers
  • 16.23. enable_fsync_gitdir
  • 16.24. enable_strict_hash_verification
• 17. Note
  • 17.1. note_author
  • 17.2. note_committer
  • 17.3. note_commit_create
  • 17.4. note_create
  • 17.5. note_free
  • 17.6. note_message
  • 17.7. note_id
  • 17.8. note_commit_remove
  • 17.9. note_remove
  • 17.10. note_read
  • 17.11. note_commit_read
• 18. Object
  • 18.1. object__size
  • 18.2. object_free
  • 18.3. object_id
  • 18.4. object_lookup
  • 18.5. object_lookup_bypath
  • 18.6. object_lookup_prefix
  • 18.7. object_owner
  • 18.8. object_short_id
  • 18.9. object_string2type
  • 18.10. object_type
  • 18.11. object_type2string
  • 18.12. object_typeisloose
• 19. Object Database (ODB)
  • 19.1. odb_exists
  • 19.2. odb_free
  • 19.3. odb_hash
  • 19.4. odb_hashfile
  • 19.5. odb_object_free
  • 19.6. odb_object_id
  • 19.7. odb_object_size
  • 19.8. odb_object_type
  • 19.9. odb_open
  • 19.10. odb_read
  • 19.11. odb_refresh
  • 19.12. odb_write
• 20. Reference
  • 20.1. reference_create
  • 20.2. reference_create_matching
  • 20.3. reference_dup
  • 20.4. reference_dwim
  • 20.5. reference_ensure_log
  • 20.6. reference_has_log
  • 20.7. reference_is_branch
  • 20.8. reference_is_note
  • 20.9. reference_is_remote
  • 20.10. reference_is_tag
  • 20.11. reference_is_valid_name
  • 20.12. reference_iterator_glob_new
  • 20.13. reference_iterator_new
  • 20.14. reference_list
  • 20.15. reference_lookup
  • 20.16. reference_name
  • 20.17. reference_name_to_id
  • 20.18. reference_next
  • 20.19. reference_next_name
  • 20.20. reference_owner
  • 20.21. reference_peel
  • 20.22. reference_remove
  • 20.23. reference_rename
  • 20.24. reference_resolve
  • 20.25. reference_set_target
  • 20.26. reference_symbolic_create
  • 20.27. reference_symbolic_create_matching
  • 20.28. reference_symbolic_set_target
  • 20.29. reference_symbolic_target
  • 20.30. reference_target
  • 20.31. reference_target_peel
  • 20.32. reference_type
  • 20.33. reference_free
  • 20.34. reference_iterator_free
• 21. Reflog
  • 21.1. reflog_read
  • 21.2. reflog_entrycount
  • 21.3. reflog_free
  • 21.4. reflog_entry_byindex
  • 21.5. reflog_entry_committer
  • 21.6. reflog_entry_message
  • 21.7. reflog_entry_id_new
  • 21.8. reflog_entry_id_old
  • 21.9. reflog_delete
  • 21.10. reflog_drop
  • 21.11. reflog_append
• 22. Repository
  • 22.1. repository_commondir
  • 22.2. repository_config
  • 22.3. repository_config_snapshot
  • 22.4. repository_detach_head
  • 22.5. repository_get_namespace
  • 22.6. repository_head
  • 22.7. repository_head_detached
  • 22.8. repository_head_for_worktree
  • 22.9. repository_head_unborn
  • 22.10. repository_ident
  • 22.11. repository_index
  • 22.12. repository_init
  • 22.13. repository_is_bare
  • 22.14. repository_is_empty
  • 22.15. repository_is_shallow
  • 22.16. repository_is_worktree
  • 22.17. repository_message
  • 22.18. repository_message_remove
  • 22.19. repository_odb
  • 22.20. repository_open
  • 22.21. repository_open_bare
  • 22.22. repository_open_from_worktree
  • 22.23. repository_path
  • 22.24. repository_refdb
  • 22.25. repository_set_head
  • 22.26. repository_set_head_detached
  • 22.27. repository_set_ident
  • 22.28. repository_set_namespace
  • 22.29. repository_set_workdir
  • 22.30. repository_state
  • 22.31. repository_state_cleanup
  • 22.32. repository_workdir
  • 22.33. repository_free
  • 22.34. repository_submodule_cache_all
  • 22.35. repository_submodule_cache_clear
  • 22.36. repository_set_index
  • 22.37. repository_set_bare
  • 22.38. repository_set_config
  • 22.39. repository_set_odb
  • 22.40. repository__cleanup
• 23. Reset
  • 23.1. reset
• 24. Revert
  • 24.1. revert
• 25. Revparse
  • 25.1. revparse
  • 25.2. revparse_single
• 26. Revwalk
  • 26.1. revwalk_new
  • 26.2. revwalk_next
  • 26.3. revwalk_push
  • 26.4. revwalk_push_ref
  • 26.5. revwalk_free
  • 26.6. revwalk_reset
  • 26.7. revwalk_push_head
  • 26.8. revwalk_repository
• 27. Signature
  • 27.1. signature_default
  • 27.2. signature_dup
  • 27.3. signature_from_buffer
  • 27.4. signature_now
  • 27.5. signature_free
• 28. Status
  • 28.1. status_list_new
  • 28.2. status_list_free
  • 28.3. status_list_entrycount
  • 28.4. status_byindex
• 29. Tag
  • 29.1. tag_annotation_create
  • 29.2. tag_create
  • 29.3. tag_create_frombuffer
  • 29.4. tag_create_lightweight
  • 29.5. tag_delete
  • 29.6. tag_free
  • 29.7. tag_id
  • 29.8. tag_list
  • 29.9. tag_list_match
  • 29.10. tag_lookup
  • 29.11. tag_owner
  • 29.12. tag_tagger
  • 29.13. tag_target
  • 29.14. tag_target_id
  • 29.15. tag_target_type
  • 29.16. tag_message
  • 29.17. tag_name
• 30. Tree
  • 30.1. tree_entry_byid
  • 30.2. tree_entry_byindex
  • 30.3. tree_entry_byname
  • 30.4. tree_entry_bypath
  • 30.5. tree_entry_cmp
  • 30.6. tree_entry_filemode
  • 30.7. tree_entry_filemode_raw
  • 30.8. tree_entry_id
  • 30.9. tree_entry_name
  • 30.10. tree_entry_to_object
  • 30.11. tree_entry_type
  • 30.12. tree_entrycount
  • 30.13. tree_id
  • 30.14. tree_lookup
  • 30.15. tree_lookup_prefix
  • 30.16. tree_owner
  • 30.17. tree_entry_free
  • 30.18. tree_free