diff --git a/docs/api/main.json b/docs/api/main.json index 1abfa50fb5..0ab185f116 100644 --- a/docs/api/main.json +++ b/docs/api/main.json @@ -1,7 +1,6 @@ { "info": { - "version": "main", - "commit": "c6111ec06cc0b0126cd67bdab78f8091e4cfaa10" + "commit": "4f0def867e4df60a19e54ece3ed1e5dc45dd6ce8" }, "groups": { "sys/alloc": { @@ -25316,7 +25315,7 @@ "name": "git_merge_bases_many", "location": { "file": "merge.h", - "line": 480, + "line": 511, "column": 17 }, "returns": { @@ -25350,7 +25349,13 @@ } ], "comment": [ - "Find all merge bases given a list of commits" + "Find all merge bases given a list of commits", + "This behaves similar to [`git merge-base`](https://git-scm.com/docs/git-merge-base#_discussion).", + "Given three commits `a`, `b`, and `c`, `merge_base_many`\n will compute a hypothetical commit `m`, which is a merge between `b`\n and `c`.", + "For example, with the following topology:\n ```text\n o---o---o---o---C\n /\n / o---o---o---B\n / /\n ---2---1---o---o---o---A\n ```", + "the result of `merge_base_many` given `a`, `b`, and `c` is 1. This is\n because the equivalent topology with the imaginary merge commit `m`\n between `b` and `c` is:\n ```text\n o---o---o---o---o\n / \n\\\n / o---o---o---o---M\n / /\n ---2---1---o---o---o---A\n ```", + "and the result of `merge_base_many` given `a` and `m` is 1.", + "If you're looking to recieve the common ancestor between all the\n given commits, use `merge_base_octopus`." ], "group": "merge" }, @@ -25359,7 +25364,7 @@ "name": "git_merge_base_octopus", "location": { "file": "merge.h", - "line": 495, + "line": 526, "column": 17 }, "returns": { @@ -25402,7 +25407,7 @@ "name": "git_merge_file", "location": { "file": "merge.h", - "line": 517, + "line": 548, "column": 17 }, "returns": { @@ -25452,7 +25457,7 @@ "name": "git_merge_file_from_index", "location": { "file": "merge.h", - "line": 538, + "line": 569, "column": 17 }, "returns": { @@ -25507,7 +25512,7 @@ "name": "git_merge_file_result_free", "location": { "file": "merge.h", - "line": 551, + "line": 582, "column": 18 }, "returns": { @@ -25531,7 +25536,7 @@ "name": "git_merge_trees", "location": { "file": "merge.h", - "line": 569, + "line": 600, "column": 17 }, "returns": { @@ -25587,7 +25592,7 @@ "name": "git_merge_commits", "location": { "file": "merge.h", - "line": 592, + "line": 623, "column": 17 }, "returns": { @@ -25637,7 +25642,7 @@ "name": "git_merge", "location": { "file": "merge.h", - "line": 617, + "line": 648, "column": 17 }, "returns": { diff --git a/docs/reference/index.html b/docs/reference/index.html index a4151707eb..8f119d6c69 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -923,913 +923,3 @@
Initialize git_apply_options structure
+ +Initialize a git_apply_options
with default values. Equivalent to creating
+an instance with GIT_APPLY_OPTIONS_INIT.
The struct version; pass GIT_APPLY_OPTIONS_VERSION
0 on success or -1 on failure.
+Initialize git_blame_options structure
+ +Initializes a git_blame_options
with default values. Equivalent to creating
+an instance with GIT_BLAME_OPTIONS_INIT.
The struct version; pass GIT_BLAME_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_blob_filter_options structure
+ +Initializes a git_blob_filter_options
with default values. Equivalent
+to creating an instance with GIT_BLOB_FILTER_OPTIONS_INIT
.
The struct version; pass GIT_BLOB_FILTER_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_checkout_options structure
+ +Initializes a git_checkout_options
with default values. Equivalent to creating
+an instance with GIT_CHECKOUT_OPTIONS_INIT.
The struct version; pass GIT_CHECKOUT_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_cherrypick_options structure
+ +Initializes a git_cherrypick_options
with default values. Equivalent to creating
+an instance with GIT_CHERRYPICK_OPTIONS_INIT.
The struct version; pass GIT_CHERRYPICK_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_clone_options structure
+ +Initializes a git_clone_options
with default values. Equivalent to creating
+an instance with GIT_CLONE_OPTIONS_INIT.
The struct version; pass GIT_CLONE_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_diff_format_email_options structure
+ +Initializes a git_diff_format_email_options
with default values. Equivalent
+to creating an instance with GIT_DIFF_FORMAT_EMAIL_OPTIONS_INIT.
The struct version; pass GIT_DIFF_FORMAT_EMAIL_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_describe_format_options structure
+ +Initializes a git_describe_format_options
with default values. Equivalent to creating
+an instance with GIT_DESCRIBE_FORMAT_OPTIONS_INIT.
The struct version; pass GIT_DESCRIBE_FORMAT_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_describe_options structure
+ +Initializes a git_describe_options
with default values. Equivalent to creating
+an instance with GIT_DESCRIBE_OPTIONS_INIT.
The struct version; pass GIT_DESCRIBE_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_diff_find_options structure
+ +Initializes a git_diff_find_options
with default values. Equivalent to creating
+an instance with GIT_DIFF_FIND_OPTIONS_INIT.
The struct version; pass GIT_DIFF_FIND_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_diff_options structure
+ +Initializes a git_diff_options
with default values. Equivalent to creating
+an instance with GIT_DIFF_OPTIONS_INIT.
The struct version; pass GIT_DIFF_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_diff_patchid_options structure
+ +Initializes a git_diff_patchid_options
with default values. Equivalent to
+creating an instance with GIT_DIFF_PATCHID_OPTIONS_INIT
.
The struct version; pass GIT_DIFF_PATCHID_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Return the stage number from a git index entry
+ +This entry is calculated from the entry's flag attribute like this:
+ +(entry->flags +& +GIT_INDEX_ENTRY_STAGEMASK) >> GIT_INDEX_ENTRY_STAGESHIFT
+ +the stage number
+Initializes a git_indexer_options
with default values. Equivalent to
+creating an instance with GIT_INDEXER_OPTIONS_INIT.
Version of struct; pass GIT_INDEXER_OPTIONS_VERSION
Zero on success; -1 on failure.
+Find all merge bases given a list of commits
+This behaves similar to git merge-base
.
Given three commits a
, b
, and c
, merge_base_many
+will compute a hypothetical commit m
, which is a merge between b
+and c
.
For example, with the following topology:
+ o---o---o---o---C
+ /
+ / o---o---o---B
+ / /
+---2---1---o---o---o---A
+
+
+ the result of merge_base_many
given a
, b
, and c
is 1. This is
+because the equivalent topology with the imaginary merge commit m
+between b
and c
is:
o---o---o---o---o
+ /
+\
+ / o---o---o---o---M
+ / /
+---2---1---o---o---o---A
+
+
+ and the result of merge_base_many
given a
and m
is 1.
If you're looking to recieve the common ancestor between all the
+given commits, use merge_base_octopus
.
Initializes a git_merge_file_input
with default values. Equivalent to
+creating an instance with GIT_MERGE_FILE_INPUT_INIT.
the version of the struct; you should pass GIT_MERGE_FILE_INPUT_VERSION
here.
Zero on success; -1 on failure.
+Initialize git_merge_file_options structure
+ +Initializes a git_merge_file_options
with default values. Equivalent to
+creating an instance with GIT_MERGE_FILE_OPTIONS_INIT
.
The struct version; pass GIT_MERGE_FILE_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_merge_options structure
+ +Initializes a git_merge_options
with default values. Equivalent to
+creating an instance with GIT_MERGE_OPTIONS_INIT
.
The struct version; pass GIT_MERGE_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_proxy_options structure
+ +Initializes a git_proxy_options
with default values. Equivalent to
+creating an instance with GIT_PROXY_OPTIONS_INIT
.
The struct version; pass GIT_PROXY_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_rebase_options structure
+ +Initializes a git_rebase_options
with default values. Equivalent to
+creating an instance with GIT_REBASE_OPTIONS_INIT
.
The struct version; pass GIT_REBASE_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_fetch_options structure
+ +Initializes a git_fetch_options
with default values. Equivalent to
+creating an instance with GIT_FETCH_OPTIONS_INIT
.
The struct version; pass GIT_FETCH_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_push_options structure
+ +Initializes a git_push_options
with default values. Equivalent to
+creating an instance with GIT_PUSH_OPTIONS_INIT
.
The struct version; pass GIT_PUSH_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_remote_connect_options structure.
+ +Initializes a git_remote_connect_options
with default values.
+Equivalent to creating an instance with
+GIT_REMOTE_CONNECT_OPTIONS_INIT
.
The struct version; pass GIT_REMOTE_CONNECT_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_remote_create_options structure
+ +Initializes a git_remote_create_options
with default values. Equivalent to
+creating an instance with GIT_REMOTE_CREATE_OPTIONS_INIT
.
The struct version; pass GIT_REMOTE_CREATE_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_repository_init_options structure
+ +Initializes a git_repository_init_options
with default values. Equivalent to
+creating an instance with GIT_REPOSITORY_INIT_OPTIONS_INIT
.
The struct version; pass GIT_REPOSITORY_INIT_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_revert_options structure
+ +Initializes a git_revert_options
with default values. Equivalent to
+creating an instance with GIT_REVERT_OPTIONS_INIT
.
The struct version; pass GIT_REVERT_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_stash_apply_options structure
+ +Initializes a git_stash_apply_options
with default values. Equivalent to
+creating an instance with GIT_STASH_APPLY_OPTIONS_INIT
.
The struct version; pass GIT_STASH_APPLY_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_stash_save_options structure
+ +Initializes a git_stash_save_options
with default values. Equivalent to
+creating an instance with GIT_STASH_SAVE_OPTIONS_INIT
.
The struct version; pass GIT_STASH_SAVE_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_status_options structure
+ +Initializes a git_status_options
with default values. Equivalent to
+creating an instance with GIT_STATUS_OPTIONS_INIT
.
The struct version; pass GIT_STATUS_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_submodule_update_options structure
+ +Initializes a git_submodule_update_options
with default values. Equivalent to
+creating an instance with GIT_SUBMODULE_UPDATE_OPTIONS_INIT
.
The struct version; pass GIT_SUBMODULE_UPDATE_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_commit_graph_writer_options structure
+ +Initializes a git_commit_graph_writer_options
with default values. Equivalent to
+creating an instance with GIT_COMMIT_GRAPH_WRITER_OPTIONS_INIT
.
The struct version; pass GIT_COMMIT_GRAPH_WRITER_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initializes a git_filter
with default values. Equivalent to
+creating an instance with GIT_FILTER_INIT.
Zero on success; -1 on failure.
+Initializes a git_transport
with default values. Equivalent to
+creating an instance with GIT_TRANSPORT_INIT.
Zero on success; -1 on failure.
+Initialize git_worktree_add_options structure
+ +Initializes a git_worktree_add_options
with default values. Equivalent to
+creating an instance with GIT_WORKTREE_ADD_OPTIONS_INIT
.
The struct version; pass GIT_WORKTREE_ADD_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+Initialize git_worktree_prune_options structure
+ +Initializes a git_worktree_prune_options
with default values. Equivalent to
+creating an instance with GIT_WORKTREE_PRUNE_OPTIONS_INIT
.
The struct version; pass GIT_WORKTREE_PRUNE_OPTIONS_VERSION
.
Zero on success; -1 on failure.
+