Look up a list of git attributes for path.
\n", + "comments": "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 git_attr_get() multiple times.
For example, you might write:
\n\n const char *attrs[] = { "crlf", "diff", "foo" }; const char **values[3]; git_attr_get_many(values, repo, 0, "my/fun/file.c", 3, attrs);\nThen you could loop through the 3 values to get the settings for the three attributes you asked about.
\n", + "group": "attr" + }, "git_attr_foreach": { "type": "function", "file": "attr.h", @@ -720,11 +760,11 @@ "comment": "the blame structure to query" }, { "name": "lineno", - "type": "uint32_t", + "type": "size_t", "comment": "the (1-based) line number to find a hunk for" }], - "argline": "git_blame *blame, uint32_t lineno", - "sig": "git_blame *::uint32_t", + "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" @@ -733,7 +773,7 @@ "comments": "", "group": "blame", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_blame_get_hunk_byline-1"] + "blame.c": ["ex/v0.24.1/blame.html#git_blame_get_hunk_byline-1"] } }, "git_blame_file": { @@ -768,9 +808,41 @@ "comments": "", "group": "blame", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_blame_file-2"] + "blame.c": ["ex/v0.24.1/blame.html#git_blame_file-2"] } }, + "git_blame_buffer": { + "type": "function", + "file": "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": "Get blame data for a file that has been modified in memory. The reference\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.
Lines that differ between the buffer and the committed version are marked as having a zero OID for their final_commit_id.
\n", + "group": "blame" + }, "git_blame_free": { "type": "function", "file": "blame.h", @@ -791,7 +863,7 @@ "comments": "", "group": "blame", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_blame_free-3"] + "blame.c": ["ex/v0.24.1/blame.html#git_blame_free-3"] } }, "git_blob_lookup": { @@ -822,10 +894,42 @@ "comments": "", "group": "blob", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_blob_lookup-4"], - "general.c": ["ex/v0.23.0/general.html#git_blob_lookup-1"] + "blame.c": ["ex/v0.24.1/blame.html#git_blob_lookup-4"], + "general.c": ["ex/v0.24.1/general.html#git_blob_lookup-1"] } }, + "git_blob_lookup_prefix": { + "type": "function", + "file": "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": "Lookup a blob object from a repository,\n given a prefix of its identifier (short id).
\n", + "comments": "", + "group": "blob" + }, "git_blob_free": { "type": "function", "file": "blob.h", @@ -846,7 +950,7 @@ "comments": "This is a wrapper around git_object_free()
\n\nIMPORTANT: It is necessary to call this method when you stop using a blob. Failure to do so will cause a memory leak.
\n", "group": "blob", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_blob_free-5"] + "blame.c": ["ex/v0.24.1/blame.html#git_blob_free-5"] } }, "git_blob_id": { @@ -909,9 +1013,9 @@ "comments": "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.
\n", "group": "blob", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_blob_rawcontent-6"], - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_blob_rawcontent-1"], - "general.c": ["ex/v0.23.0/general.html#git_blob_rawcontent-2"] + "blame.c": ["ex/v0.24.1/blame.html#git_blob_rawcontent-6"], + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_blob_rawcontent-1"], + "general.c": ["ex/v0.24.1/general.html#git_blob_rawcontent-2"] } }, "git_blob_rawsize": { @@ -934,9 +1038,9 @@ "comments": "", "group": "blob", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_blob_rawsize-7"], - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_blob_rawsize-2"], - "general.c": ["ex/v0.23.0/general.html#git_blob_rawsize-3", "ex/v0.23.0/general.html#git_blob_rawsize-4"] + "blame.c": ["ex/v0.24.1/blame.html#git_blob_rawsize-7"], + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_blob_rawsize-2"], + "general.c": ["ex/v0.24.1/general.html#git_blob_rawsize-3", "ex/v0.24.1/general.html#git_blob_rawsize-4"] } }, "git_blob_filtered_content": { @@ -1060,7 +1164,39 @@ "comment": " 0 or error code (from either libgit2 or callback function)" }, "description": "Write a loose blob to the Object Database from a\n provider of chunks of data.
\n", - "comments": "If the hintpath 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.
The implementation of the callback MUST respect the following rules:
\n\ncontent must be filled by the callback. The maximum number of bytes that the buffer can accept per call is defined by the max_length parameter. Allocation and freeing of the buffer will be taken care of by libgit2.
The callback must return the number of bytes that have been written to the content buffer.
When there is no more data to stream, callback should return 0. This will prevent it from being invoked anymore.
If an error occurs, the callback should return a negative value. This value will be returned to the caller.
If the hintpath 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.
The implementation of the callback MUST respect the following rules:
\n\ncontent must be filled by the callback. The maximum number of bytes that the buffer can accept per call is defined by the max_length parameter. Allocation and freeing of the buffer will be taken care of by libgit2.
The callback must return the number of bytes that have been written to the content buffer.
When there is no more data to stream, callback should return 0. This will prevent it from being invoked anymore.
If an error occurs, the callback should return a negative value. This value will be returned to the caller.
Write an in-memory buffer to the ODB as a blob
\n", + "comments": "", "group": "blob" }, "git_blob_is_binary": { @@ -1427,11 +1563,63 @@ "comments": "Note that this does not free the git_buf itself, just the memory pointed to by buffer->ptr. 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.
Resize the buffer allocation to make more space.
\n", + "comments": "This will attempt to grow the buffer to accommodate the target size.
\n\nIf the buffer refers to memory that was not allocated by libgit2 (i.e. the asize field is zero), then ptr 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 target_size as 0 and the memory is not allocated by libgit2, this will allocate a new buffer of size size and copy the external data into it.
Currently, this will never shrink a buffer, only expand it.
\n\nIf the allocation fails, this will return an error and the buffer will be marked as invalid for future operations, invaliding the contents.
\n", + "group": "buf" + }, + "git_buf_set": { + "type": "function", + "file": "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": "Set buffer to a copy of some raw data.
\n", + "comments": "", + "group": "buf" + }, "git_buf_is_binary": { "type": "function", "file": "buffer.h", @@ -1724,7 +1912,7 @@ "comments": "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.
\n", "group": "clone", "examples": { - "network/clone.c": ["ex/v0.23.0/network/clone.html#git_clone-1"] + "network/clone.c": ["ex/v0.24.1/network/clone.html#git_clone-1"] } }, "git_commit_lookup": { @@ -1755,10 +1943,42 @@ "comments": "The returned object should be released with git_commit_free when no longer needed.
Lookup a commit object from a repository, given a prefix of its\n identifier (short id).
\n", + "comments": "The returned object should be released with git_commit_free when no longer needed.
This is a wrapper around git_object_free()
\n\nIMPORTANT: It is necessary to call this method when you stop using a commit. Failure to do so will cause a memory leak.
\n", "group": "commit", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_commit_free-8", "ex/v0.23.0/general.html#git_commit_free-9", "ex/v0.23.0/general.html#git_commit_free-10", "ex/v0.23.0/general.html#git_commit_free-11"], - "log.c": ["ex/v0.23.0/log.html#git_commit_free-2", "ex/v0.23.0/log.html#git_commit_free-3", "ex/v0.23.0/log.html#git_commit_free-4", "ex/v0.23.0/log.html#git_commit_free-5"] + "general.c": ["ex/v0.24.1/general.html#git_commit_free-8", "ex/v0.24.1/general.html#git_commit_free-9", "ex/v0.24.1/general.html#git_commit_free-10", "ex/v0.24.1/general.html#git_commit_free-11"], + "log.c": ["ex/v0.24.1/log.html#git_commit_free-2", "ex/v0.24.1/log.html#git_commit_free-3", "ex/v0.24.1/log.html#git_commit_free-4", "ex/v0.24.1/log.html#git_commit_free-5"] } }, "git_commit_id": { @@ -1803,8 +2023,8 @@ "comments": "", "group": "commit", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_commit_id-12"], - "log.c": ["ex/v0.23.0/log.html#git_commit_id-6"] + "general.c": ["ex/v0.24.1/general.html#git_commit_id-12"], + "log.c": ["ex/v0.24.1/log.html#git_commit_id-6"] } }, "git_commit_owner": { @@ -1827,7 +2047,7 @@ "comments": "", "group": "commit", "examples": { - "log.c": ["ex/v0.23.0/log.html#git_commit_owner-7", "ex/v0.23.0/log.html#git_commit_owner-8"] + "log.c": ["ex/v0.24.1/log.html#git_commit_owner-7", "ex/v0.24.1/log.html#git_commit_owner-8"] } }, "git_commit_message_encoding": { @@ -1870,10 +2090,10 @@ "comments": "The returned message will be slightly prettified by removing any potential leading newlines.
\n", "group": "commit", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_commit_message-3", "ex/v0.23.0/cat-file.html#git_commit_message-4"], - "general.c": ["ex/v0.23.0/general.html#git_commit_message-13", "ex/v0.23.0/general.html#git_commit_message-14", "ex/v0.23.0/general.html#git_commit_message-15"], - "log.c": ["ex/v0.23.0/log.html#git_commit_message-9", "ex/v0.23.0/log.html#git_commit_message-10"], - "tag.c": ["ex/v0.23.0/tag.html#git_commit_message-2"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_commit_message-3", "ex/v0.24.1/cat-file.html#git_commit_message-4"], + "general.c": ["ex/v0.24.1/general.html#git_commit_message-13", "ex/v0.24.1/general.html#git_commit_message-14", "ex/v0.24.1/general.html#git_commit_message-15"], + "log.c": ["ex/v0.24.1/log.html#git_commit_message-9", "ex/v0.24.1/log.html#git_commit_message-10"], + "tag.c": ["ex/v0.24.1/tag.html#git_commit_message-2"] } }, "git_commit_message_raw": { @@ -1916,11 +2136,31 @@ "comments": "The returned message is the summary of the commit, comprising the first paragraph of the message with whitespace trimmed and squashed.
\n", "group": "commit" }, + "git_commit_body": { + "type": "function", + "file": "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": "Get the long "body" of the git commit message.
\n", + "comments": "The returned message is the body of the commit, comprising everything but the first paragraph of the message. Leading and trailing whitespaces are trimmed.
\n", + "group": "commit" + }, "git_commit_time": { "type": "function", "file": "commit.h", - "line": 136, - "lineto": 136, + "line": 149, + "lineto": 149, "args": [{ "name": "commit", "type": "const git_commit *", @@ -1936,14 +2176,14 @@ "comments": "", "group": "commit", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_commit_time-16", "ex/v0.23.0/general.html#git_commit_time-17"] + "general.c": ["ex/v0.24.1/general.html#git_commit_time-16", "ex/v0.24.1/general.html#git_commit_time-17"] } }, "git_commit_time_offset": { "type": "function", "file": "commit.h", - "line": 144, - "lineto": 144, + "line": 157, + "lineto": 157, "args": [{ "name": "commit", "type": "const git_commit *", @@ -1962,8 +2202,8 @@ "git_commit_committer": { "type": "function", "file": "commit.h", - "line": 152, - "lineto": 152, + "line": 165, + "lineto": 165, "args": [{ "name": "commit", "type": "const git_commit *", @@ -1979,16 +2219,16 @@ "comments": "", "group": "commit", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_commit_committer-5"], - "general.c": ["ex/v0.23.0/general.html#git_commit_committer-18"], - "log.c": ["ex/v0.23.0/log.html#git_commit_committer-11"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_commit_committer-5"], + "general.c": ["ex/v0.24.1/general.html#git_commit_committer-18"], + "log.c": ["ex/v0.24.1/log.html#git_commit_committer-11"] } }, "git_commit_author": { "type": "function", "file": "commit.h", - "line": 160, - "lineto": 160, + "line": 173, + "lineto": 173, "args": [{ "name": "commit", "type": "const git_commit *", @@ -2004,16 +2244,16 @@ "comments": "", "group": "commit", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_commit_author-6"], - "general.c": ["ex/v0.23.0/general.html#git_commit_author-19", "ex/v0.23.0/general.html#git_commit_author-20"], - "log.c": ["ex/v0.23.0/log.html#git_commit_author-12", "ex/v0.23.0/log.html#git_commit_author-13"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_commit_author-6"], + "general.c": ["ex/v0.24.1/general.html#git_commit_author-19", "ex/v0.24.1/general.html#git_commit_author-20"], + "log.c": ["ex/v0.24.1/log.html#git_commit_author-12", "ex/v0.24.1/log.html#git_commit_author-13"] } }, "git_commit_raw_header": { "type": "function", "file": "commit.h", - "line": 168, - "lineto": 168, + "line": 181, + "lineto": 181, "args": [{ "name": "commit", "type": "const git_commit *", @@ -2032,8 +2272,8 @@ "git_commit_tree": { "type": "function", "file": "commit.h", - "line": 177, - "lineto": 177, + "line": 190, + "lineto": 190, "args": [{ "name": "tree_out", "type": "git_tree **", @@ -2053,14 +2293,14 @@ "comments": "", "group": "commit", "examples": { - "log.c": ["ex/v0.23.0/log.html#git_commit_tree-14", "ex/v0.23.0/log.html#git_commit_tree-15", "ex/v0.23.0/log.html#git_commit_tree-16", "ex/v0.23.0/log.html#git_commit_tree-17", "ex/v0.23.0/log.html#git_commit_tree-18"] + "log.c": ["ex/v0.24.1/log.html#git_commit_tree-14", "ex/v0.24.1/log.html#git_commit_tree-15", "ex/v0.24.1/log.html#git_commit_tree-16", "ex/v0.24.1/log.html#git_commit_tree-17", "ex/v0.24.1/log.html#git_commit_tree-18"] } }, "git_commit_tree_id": { "type": "function", "file": "commit.h", - "line": 187, - "lineto": 187, + "line": 200, + "lineto": 200, "args": [{ "name": "commit", "type": "const git_commit *", @@ -2076,14 +2316,14 @@ "comments": "", "group": "commit", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_commit_tree_id-7"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_commit_tree_id-7"] } }, "git_commit_parentcount": { "type": "function", "file": "commit.h", - "line": 195, - "lineto": 195, + "line": 208, + "lineto": 208, "args": [{ "name": "commit", "type": "const git_commit *", @@ -2099,16 +2339,16 @@ "comments": "", "group": "commit", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_commit_parentcount-8"], - "general.c": ["ex/v0.23.0/general.html#git_commit_parentcount-21"], - "log.c": ["ex/v0.23.0/log.html#git_commit_parentcount-19", "ex/v0.23.0/log.html#git_commit_parentcount-20"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_commit_parentcount-8"], + "general.c": ["ex/v0.24.1/general.html#git_commit_parentcount-21"], + "log.c": ["ex/v0.24.1/log.html#git_commit_parentcount-19", "ex/v0.24.1/log.html#git_commit_parentcount-20"] } }, "git_commit_parent": { "type": "function", "file": "commit.h", - "line": 205, - "lineto": 208, + "line": 218, + "lineto": 221, "args": [{ "name": "out", "type": "git_commit **", @@ -2132,15 +2372,15 @@ "comments": "", "group": "commit", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_commit_parent-22"], - "log.c": ["ex/v0.23.0/log.html#git_commit_parent-21", "ex/v0.23.0/log.html#git_commit_parent-22"] + "general.c": ["ex/v0.24.1/general.html#git_commit_parent-22"], + "log.c": ["ex/v0.24.1/log.html#git_commit_parent-21", "ex/v0.24.1/log.html#git_commit_parent-22"] } }, "git_commit_parent_id": { "type": "function", "file": "commit.h", - "line": 219, - "lineto": 221, + "line": 232, + "lineto": 234, "args": [{ "name": "commit", "type": "const git_commit *", @@ -2160,15 +2400,15 @@ "comments": "", "group": "commit", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_commit_parent_id-9"], - "log.c": ["ex/v0.23.0/log.html#git_commit_parent_id-23"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_commit_parent_id-9"], + "log.c": ["ex/v0.24.1/log.html#git_commit_parent_id-23"] } }, "git_commit_nth_gen_ancestor": { "type": "function", "file": "commit.h", - "line": 237, - "lineto": 240, + "line": 250, + "lineto": 253, "args": [{ "name": "ancestor", "type": "git_commit **", @@ -2195,8 +2435,8 @@ "git_commit_header_field": { "type": "function", "file": "commit.h", - "line": 251, - "lineto": 251, + "line": 264, + "lineto": 264, "args": [{ "name": "out", "type": "git_buf *", @@ -2220,45 +2460,193 @@ "comments": "", "group": "commit" }, - "git_commit_amend": { + "git_commit_extract_signature": { "type": "function", "file": "commit.h", - "line": 356, - "lineto": 364, + "line": 282, + "lineto": 282, + "args": [{ + "name": "signature", + "type": "git_buf *", + "comment": "the signature block" + }, { + "name": "signed_data", + "type": "git_buf *", + "comment": "signed data; this is the commit contents minus the signature block" + }, { + "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": "Extract the signature from a commit
\n", + "comments": "If the id is not for a commit, the error class will be GITERR_INVALID. If the commit does not have a signature, the error class will be GITERR_OBJECT.
Create new commit in the repository from a list of git_object pointers
The message will not be cleaned up automatically. You can do that with the git_message_prettify() function.
Create new commit in the repository using a variable argument list.
\n", + "comments": "The message will not be cleaned up automatically. You can do that with the git_message_prettify() function.
The parents for the commit are specified as a variable list of pointers to const git_commit *. Note that this is a convenience method which may not be safe to export for certain languages or compilers
All other parameters remain the same as git_commit_create().
Set or query a library global option
\n", - "comments": "Available options:
\n\n* 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`, or > `GIT_CONFIG_LEVEL_XDG`. 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, > or GIT_CONFIG_LEVEL_XDG.\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.\nAvailable options:
\n\n* 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_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 disabled. * 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.\nIf /etc/gitconfig doesn't exist, it will look for %PROGRAMFILES%.
\n", "group": "config" }, + "git_config_find_programdata": { + "type": "function", + "file": "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": "Locate the path to the configuration file in ProgramData
\n", + "comments": "Look for the file in %PROGRAMDATA% used by portable git.
\n", + "group": "config" + }, "git_config_open_default": { "type": "function", "file": "config.h", - "line": 154, - "lineto": 154, + "line": 168, + "lineto": 168, "args": [{ "name": "out", "type": "git_config **", @@ -2435,8 +2843,8 @@ "git_config_new": { "type": "function", "file": "config.h", - "line": 165, - "lineto": 165, + "line": 179, + "lineto": 179, "args": [{ "name": "out", "type": "git_config **", @@ -2455,8 +2863,8 @@ "git_config_add_file_ondisk": { "type": "function", "file": "config.h", - "line": 189, - "lineto": 193, + "line": 206, + "lineto": 210, "args": [{ "name": "cfg", "type": "git_config *", @@ -2481,14 +2889,14 @@ "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": "Add an on-disk config file instance to an existing config
\n", - "comments": "The on-disk file pointed at by path 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).
Note that the configuration object will free the file automatically.
\n\nFurther 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).
\n", + "comments": "The on-disk file pointed at by path 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).
If the file does not exist, the file will still be added and it will be created the first time we write to it.
\n\nNote that the configuration object will free the file automatically.
\n\nFurther 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).
\n", "group": "config" }, "git_config_open_ondisk": { "type": "function", "file": "config.h", - "line": 208, - "lineto": 208, + "line": 224, + "lineto": 224, "args": [{ "name": "out", "type": "git_config **", @@ -2502,20 +2910,20 @@ "sig": "git_config **::const char *", "return": { "type": "int", - "comment": " 0 on success, GIT_ENOTFOUND when the file doesn't exist\n or an error code" + "comment": " 0 on success, or an error code" }, "description": "Create a new config instance containing a single on-disk file
\n", "comments": "This method is a simple utility wrapper for the following sequence of calls: - git_config_new - git_config_add_file_ondisk
\n", "group": "config", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_config_open_ondisk-23"] + "general.c": ["ex/v0.24.1/general.html#git_config_open_ondisk-24"] } }, "git_config_open_level": { "type": "function", "file": "config.h", - "line": 226, - "lineto": 229, + "line": 242, + "lineto": 245, "args": [{ "name": "out", "type": "git_config **", @@ -2542,8 +2950,8 @@ "git_config_open_global": { "type": "function", "file": "config.h", - "line": 243, - "lineto": 243, + "line": 259, + "lineto": 259, "args": [{ "name": "out", "type": "git_config **", @@ -2566,8 +2974,8 @@ "git_config_snapshot": { "type": "function", "file": "config.h", - "line": 259, - "lineto": 259, + "line": 275, + "lineto": 275, "args": [{ "name": "out", "type": "git_config **", @@ -2590,8 +2998,8 @@ "git_config_free": { "type": "function", "file": "config.h", - "line": 266, - "lineto": 266, + "line": 282, + "lineto": 282, "args": [{ "name": "cfg", "type": "git_config *", @@ -2610,8 +3018,8 @@ "git_config_get_entry": { "type": "function", "file": "config.h", - "line": 278, - "lineto": 281, + "line": 294, + "lineto": 297, "args": [{ "name": "out", "type": "git_config_entry **", @@ -2638,8 +3046,8 @@ "git_config_get_int32": { "type": "function", "file": "config.h", - "line": 295, - "lineto": 295, + "line": 311, + "lineto": 311, "args": [{ "name": "out", "type": "int32_t *", @@ -2663,14 +3071,14 @@ "comments": "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.
\n", "group": "config", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_config_get_int32-24"] + "general.c": ["ex/v0.24.1/general.html#git_config_get_int32-25"] } }, "git_config_get_int64": { "type": "function", "file": "config.h", - "line": 309, - "lineto": 309, + "line": 325, + "lineto": 325, "args": [{ "name": "out", "type": "int64_t *", @@ -2697,8 +3105,8 @@ "git_config_get_bool": { "type": "function", "file": "config.h", - "line": 326, - "lineto": 326, + "line": 342, + "lineto": 342, "args": [{ "name": "out", "type": "int *", @@ -2725,8 +3133,8 @@ "git_config_get_path": { "type": "function", "file": "config.h", - "line": 344, - "lineto": 344, + "line": 360, + "lineto": 360, "args": [{ "name": "out", "type": "git_buf *", @@ -2753,8 +3161,8 @@ "git_config_get_string": { "type": "function", "file": "config.h", - "line": 362, - "lineto": 362, + "line": 378, + "lineto": 378, "args": [{ "name": "out", "type": "const char **", @@ -2778,14 +3186,14 @@ "comments": "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.
\n\nAll 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.
\n", "group": "config", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_config_get_string-25"] + "general.c": ["ex/v0.24.1/general.html#git_config_get_string-26"] } }, "git_config_get_string_buf": { "type": "function", "file": "config.h", - "line": 378, - "lineto": 378, + "line": 394, + "lineto": 394, "args": [{ "name": "out", "type": "git_buf *", @@ -2812,8 +3220,8 @@ "git_config_get_multivar_foreach": { "type": "function", "file": "config.h", - "line": 392, - "lineto": 392, + "line": 408, + "lineto": 408, "args": [{ "name": "cfg", "type": "const git_config *", @@ -2848,8 +3256,8 @@ "git_config_multivar_iterator_new": { "type": "function", "file": "config.h", - "line": 403, - "lineto": 403, + "line": 419, + "lineto": 419, "args": [{ "name": "out", "type": "git_config_iterator **", @@ -2880,8 +3288,8 @@ "git_config_next": { "type": "function", "file": "config.h", - "line": 415, - "lineto": 415, + "line": 431, + "lineto": 431, "args": [{ "name": "entry", "type": "git_config_entry **", @@ -2904,8 +3312,8 @@ "git_config_iterator_free": { "type": "function", "file": "config.h", - "line": 422, - "lineto": 422, + "line": 438, + "lineto": 438, "args": [{ "name": "iter", "type": "git_config_iterator *", @@ -2924,8 +3332,8 @@ "git_config_set_int32": { "type": "function", "file": "config.h", - "line": 433, - "lineto": 433, + "line": 449, + "lineto": 449, "args": [{ "name": "cfg", "type": "git_config *", @@ -2952,8 +3360,8 @@ "git_config_set_int64": { "type": "function", "file": "config.h", - "line": 444, - "lineto": 444, + "line": 460, + "lineto": 460, "args": [{ "name": "cfg", "type": "git_config *", @@ -2980,8 +3388,8 @@ "git_config_set_bool": { "type": "function", "file": "config.h", - "line": 455, - "lineto": 455, + "line": 471, + "lineto": 471, "args": [{ "name": "cfg", "type": "git_config *", @@ -3008,8 +3416,8 @@ "git_config_set_string": { "type": "function", "file": "config.h", - "line": 469, - "lineto": 469, + "line": 485, + "lineto": 485, "args": [{ "name": "cfg", "type": "git_config *", @@ -3036,8 +3444,8 @@ "git_config_set_multivar": { "type": "function", "file": "config.h", - "line": 479, - "lineto": 479, + "line": 495, + "lineto": 495, "args": [{ "name": "cfg", "type": "git_config *", @@ -3068,8 +3476,8 @@ "git_config_delete_entry": { "type": "function", "file": "config.h", - "line": 488, - "lineto": 488, + "line": 504, + "lineto": 504, "args": [{ "name": "cfg", "type": "git_config *", @@ -3092,8 +3500,8 @@ "git_config_delete_multivar": { "type": "function", "file": "config.h", - "line": 499, - "lineto": 499, + "line": 515, + "lineto": 515, "args": [{ "name": "cfg", "type": "git_config *", @@ -3120,8 +3528,8 @@ "git_config_foreach": { "type": "function", "file": "config.h", - "line": 517, - "lineto": 520, + "line": 533, + "lineto": 536, "args": [{ "name": "cfg", "type": "const git_config *", @@ -3148,8 +3556,8 @@ "git_config_iterator_new": { "type": "function", "file": "config.h", - "line": 531, - "lineto": 531, + "line": 547, + "lineto": 547, "args": [{ "name": "out", "type": "git_config_iterator **", @@ -3172,8 +3580,8 @@ "git_config_iterator_glob_new": { "type": "function", "file": "config.h", - "line": 543, - "lineto": 543, + "line": 559, + "lineto": 559, "args": [{ "name": "out", "type": "git_config_iterator **", @@ -3200,8 +3608,8 @@ "git_config_foreach_match": { "type": "function", "file": "config.h", - "line": 561, - "lineto": 565, + "line": 577, + "lineto": 581, "args": [{ "name": "cfg", "type": "const git_config *", @@ -3229,11 +3637,79 @@ "comments": "This behaviors like git_config_foreach with an additional filter of a regular expression that filters which config keys are passed to the callback.
The pointers passed to the callback are only valid as long as the iteration is ongoing.
\n", "group": "config" }, - "git_config_parse_bool": { + "git_config_get_mapped": { + "type": "function", + "file": "config.h", + "line": 617, + "lineto": 622, + "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": "Query the value of a config variable and return it mapped to\n an integer constant.
\n", + "comments": "This is a helper method to easily map different possible values to a variable to integer constants that easily identify them.
\n\nA mapping array looks as follows:
\n\ngit_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}};\nOn any "false" value for the variable (e.g. "false", "FALSE", "no"), the mapping will store GIT_AUTO_CRLF_FALSE in the out parameter.
The same thing applies for any "true" value such as "true", "yes" or "1", storing the GIT_AUTO_CRLF_TRUE variable.
Otherwise, if the value matches the string "input" (with case insensitive comparison), the given constant will be stored in out, and likewise for "default".
If not a single match can be made to store in out, an error code will be returned.
Maps a string value to an integer constant
\n", + "comments": "", + "group": "config" + }, + "git_config_parse_bool": { + "type": "function", + "file": "config.h", + "line": 648, + "lineto": 648, "args": [{ "name": "out", "type": "int *", @@ -3256,8 +3732,8 @@ "git_config_parse_int32": { "type": "function", "file": "config.h", - "line": 644, - "lineto": 644, + "line": 660, + "lineto": 660, "args": [{ "name": "out", "type": "int32_t *", @@ -3280,8 +3756,8 @@ "git_config_parse_int64": { "type": "function", "file": "config.h", - "line": 656, - "lineto": 656, + "line": 672, + "lineto": 672, "args": [{ "name": "out", "type": "int64_t *", @@ -3304,8 +3780,8 @@ "git_config_parse_path": { "type": "function", "file": "config.h", - "line": 671, - "lineto": 671, + "line": 687, + "lineto": 687, "args": [{ "name": "out", "type": "git_buf *", @@ -3328,8 +3804,8 @@ "git_config_backend_foreach_match": { "type": "function", "file": "config.h", - "line": 685, - "lineto": 689, + "line": 701, + "lineto": 705, "args": [{ "name": "backend", "type": "git_config_backend *", @@ -3357,6 +3833,30 @@ "comments": "This behaviors like git_config_foreach_match except instead of all config entries it just enumerates through the given backend entry.
Lock the backend with the highest priority
\n", + "comments": "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.
\n\nYou can apply the changes by calling git_transaction_commit() before freeing the transaction. Either of these actions will unlock the config.
Perform the describe operation on the given committish object.
\n", "group": "describe", "examples": { - "describe.c": ["ex/v0.23.0/describe.html#git_describe_commit-1"] + "describe.c": ["ex/v0.24.1/describe.html#git_describe_commit-1"] } }, "git_describe_workdir": { @@ -3452,7 +3952,7 @@ "comments": "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.
\n", "group": "describe", "examples": { - "describe.c": ["ex/v0.23.0/describe.html#git_describe_workdir-2"] + "describe.c": ["ex/v0.24.1/describe.html#git_describe_workdir-2"] } }, "git_describe_format": { @@ -3483,7 +3983,7 @@ "comments": "", "group": "describe", "examples": { - "describe.c": ["ex/v0.23.0/describe.html#git_describe_format-3"] + "describe.c": ["ex/v0.24.1/describe.html#git_describe_format-3"] } }, "git_describe_result_free": { @@ -3509,8 +4009,8 @@ "git_diff_init_options": { "type": "function", "file": "diff.h", - "line": 412, - "lineto": 414, + "line": 435, + "lineto": 437, "args": [{ "name": "opts", "type": "git_diff_options *", @@ -3533,8 +4033,8 @@ "git_diff_find_init_options": { "type": "function", "file": "diff.h", - "line": 697, - "lineto": 699, + "line": 720, + "lineto": 722, "args": [{ "name": "opts", "type": "git_diff_find_options *", @@ -3557,8 +4057,8 @@ "git_diff_free": { "type": "function", "file": "diff.h", - "line": 713, - "lineto": 713, + "line": 736, + "lineto": 736, "args": [{ "name": "diff", "type": "git_diff *", @@ -3574,15 +4074,15 @@ "comments": "", "group": "diff", "examples": { - "diff.c": ["ex/v0.23.0/diff.html#git_diff_free-2"], - "log.c": ["ex/v0.23.0/log.html#git_diff_free-24", "ex/v0.23.0/log.html#git_diff_free-25"] + "diff.c": ["ex/v0.24.1/diff.html#git_diff_free-2"], + "log.c": ["ex/v0.24.1/log.html#git_diff_free-24", "ex/v0.24.1/log.html#git_diff_free-25"] } }, "git_diff_tree_to_tree": { "type": "function", "file": "diff.h", - "line": 731, - "lineto": 736, + "line": 754, + "lineto": 759, "args": [{ "name": "diff", "type": "git_diff **", @@ -3614,15 +4114,15 @@ "comments": "This is equivalent to git diff <old-tree> <new-tree>
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 old_tree and new_tree.
This is equivalent to git diff --cached <treeish> or if you pass the HEAD tree, then like git diff --cached.
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.
\n\nIf you pass NULL for the index, then the existing index of the repo will be used. In this case, the index will be refreshed from disk (if it has changed) before the diff is generated.
This matches the git diff command. See the note below on git_diff_tree_to_workdir for a discussion of the difference between git diff and git diff HEAD and how to emulate a git diff <treeish> using libgit2.
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.
\n\nIf you pass NULL for the index, then the existing index of the repo will be used. In this case, the index will be refreshed from disk (if it has changed) before the diff is generated.
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.
\n\nThis is not the same as git diff <treeish> or git diff-index <treeish>. 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 git_diff_tree_to_workdir_with_index to emulate those commands.
To see difference between this and git_diff_tree_to_workdir_with_index, 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 git diff would show status 'deleted' since there is a staged delete.
This emulates git diff <tree> 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.
Create a diff with the difference between two index objects.
\n", + "comments": "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.
\n", + "group": "diff" + }, + "git_diff_merge": { + "type": "function", + "file": "diff.h", + "line": 893, + "lineto": 895, + "args": [{ + "name": "onto", + "type": "git_diff *", "comment": "Diff to merge into." }, { "name": "from", @@ -3789,8 +4325,8 @@ "git_diff_find_similar": { "type": "function", "file": "diff.h", - "line": 867, - "lineto": 869, + "line": 909, + "lineto": 911, "args": [{ "name": "diff", "type": "git_diff *", @@ -3810,14 +4346,85 @@ "comments": "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.
\n", "group": "diff", "examples": { - "diff.c": ["ex/v0.23.0/diff.html#git_diff_find_similar-8"] + "diff.c": ["ex/v0.24.1/diff.html#git_diff_find_similar-8"] } }, - "git_diff_is_sorted_icase": { + "git_diff_num_deltas": { "type": "function", "file": "diff.h", "line": 929, "lineto": 929, + "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": "Query how many diff records are there in a diff.
\n", + "comments": "", + "group": "diff", + "examples": { + "log.c": ["ex/v0.24.1/log.html#git_diff_num_deltas-28"] + } + }, + "git_diff_num_deltas_of_type": { + "type": "function", + "file": "diff.h", + "line": 942, + "lineto": 943, + "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": "Query how many diff deltas are there in a diff filtered by type.
\n", + "comments": "This works just like git_diff_entrycount() with an extra parameter that is a git_delta_t and returns just the count of how many deltas match that particular type.
Return the diff delta for an entry in the diff list.
\n", + "comments": "The git_diff_delta 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 * git_diff (or any associated git_patch) goes away.
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 git_diff_foreach or create a git_patch.
Returning a non-zero value from the callbacks will terminate the iteration and return the non-zero value to the caller.
\n", "group": "diff", "examples": { - "diff.c": ["ex/v0.23.0/diff.html#git_diff_print-9"], - "log.c": ["ex/v0.23.0/log.html#git_diff_print-28"] + "diff.c": ["ex/v0.24.1/diff.html#git_diff_print-9"], + "log.c": ["ex/v0.24.1/log.html#git_diff_print-29"] } }, "git_diff_blobs": { "type": "function", "file": "diff.h", - "line": 1042, - "lineto": 1052, + "line": 1084, + "lineto": 1094, "args": [{ "name": "old_blob", "type": "const git_blob *", @@ -3985,11 +4592,135 @@ "comments": "Compared to a file, a blob lacks some contextual information. As such, the git_diff_file given to the callback will have some fake data; i.e. mode will be 0 and path will be NULL.
NULL is allowed for either old_blob or new_blob and will be treated as an empty blob, with the oid set to NULL in the git_diff_file data. Passing NULL for both blobs is a noop; no callbacks will be made at all.
We do run a binary content check on the blob content and if either blob looks like binary data, the git_diff_delta binary attribute will be set to 1 and no call to the hunk_cb nor line_cb will be made (unless you pass GIT_DIFF_FORCE_TEXT of course).
Directly run a diff between a blob and a buffer.
\n", + "comments": "As with git_diff_blobs, comparing a blob and buffer lacks some context, so the git_diff_file parameters to the callbacks will be faked a la the rules for git_diff_blobs().
Passing NULL for old_blob will be treated as an empty blob (i.e. the file_cb 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.
Directly run a diff between two buffers.
\n", + "comments": "Even more than with git_diff_blobs, comparing two buffer lacks context, so the git_diff_file parameters to the callbacks will be faked a la the rules for git_diff_blobs().
Accumlate diff statistics for all patches.
\n", + "description": "Accumulate diff statistics for all patches.
\n", "comments": "", "group": "diff", "examples": { - "diff.c": ["ex/v0.23.0/diff.html#git_diff_get_stats-10"] + "diff.c": ["ex/v0.24.1/diff.html#git_diff_get_stats-10"] } }, - "git_diff_stats_free": { + "git_diff_stats_files_changed": { "type": "function", "file": "diff.h", "line": 1213, - "lineto": 1213, + "lineto": 1214, + "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": "Get the total number of files changed in a diff
\n", + "comments": "", + "group": "diff" + }, + "git_diff_stats_insertions": { + "type": "function", + "file": "diff.h", + "line": 1222, + "lineto": 1223, + "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": "Get the total number of insertions in a diff
\n", + "comments": "", + "group": "diff" + }, + "git_diff_stats_deletions": { + "type": "function", + "file": "diff.h", + "line": 1231, + "lineto": 1232, + "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": "Get the total number of deletions in a diff
\n", + "comments": "", + "group": "diff" + }, + "git_diff_stats_to_buf": { + "type": "function", + "file": "diff.h", + "line": 1243, + "lineto": 1247, + "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": "Print diff statistics to a git_buf.
Create an e-mail ready patch for a commit.
\n", + "comments": "Does not support creating patches for merge commits (yet).
\n", + "group": "diff" + }, "git_diff_format_email_init_options": { "type": "function", "file": "diff.h", - "line": 1299, - "lineto": 1301, + "line": 1344, + "lineto": 1346, "args": [{ "name": "opts", "type": "git_diff_format_email_options *", @@ -4090,8 +4960,8 @@ "giterr_last": { "type": "function", "file": "errors.h", - "line": 108, - "lineto": 108, + "line": 110, + "lineto": 110, "args": [], "argline": "", "sig": "", @@ -4103,16 +4973,16 @@ "comments": "", "group": "giterr", "examples": { - "general.c": ["ex/v0.23.0/general.html#giterr_last-26"], - "network/clone.c": ["ex/v0.23.0/network/clone.html#giterr_last-2"], - "network/git2.c": ["ex/v0.23.0/network/git2.html#giterr_last-1", "ex/v0.23.0/network/git2.html#giterr_last-2"] + "general.c": ["ex/v0.24.1/general.html#giterr_last-27"], + "network/clone.c": ["ex/v0.24.1/network/clone.html#giterr_last-2"], + "network/git2.c": ["ex/v0.24.1/network/git2.html#giterr_last-1", "ex/v0.24.1/network/git2.html#giterr_last-2"] } }, "giterr_clear": { "type": "function", "file": "errors.h", - "line": 113, - "lineto": 113, + "line": 115, + "lineto": 115, "args": [], "argline": "", "sig": "", @@ -4124,31 +4994,11 @@ "comments": "", "group": "giterr" }, - "giterr_detach": { - "type": "function", - "file": "errors.h", - "line": 125, - "lineto": 125, - "args": [{ - "name": "cpy", - "type": "git_error *", - "comment": null - }], - "argline": "git_error *cpy", - "sig": "git_error *", - "return": { - "type": "int", - "comment": null - }, - "description": "Get the last error data and clear it.
\n", - "comments": "This copies the last error into the given git_error struct and returns 0 if the copy was successful, leaving the error cleared as if giterr_clear had been called.
If there was no existing error in the library, -1 will be returned and the contents of cpy will be left unmodified.
Set the error message string for this thread.
\n", - "comments": "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.
\n\nThis error message is stored in thread-local storage and only applies to the particular thread that this libgit2 call is made from.
\n\nNOTE: Passing the error_class as GITERR_OS has a special behavior: we attempt to append the system default error message for the last OS error that occurred and then clear the last error. The specific implementation of looking up and clearing this last OS error will vary by platform.
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.
\n\nThis error message is stored in thread-local storage and only applies to the particular thread that this libgit2 call is made from.
\n", "group": "giterr" }, "giterr_set_oom": { "type": "function", "file": "errors.h", - "line": 159, - "lineto": 159, + "line": 144, + "lineto": 144, "args": [], "argline": "", "sig": "", @@ -4460,18 +5310,18 @@ "comments": "This function must the called before any other libgit2 function in order to set up global state and threading.
\n\nThis 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.
\n", "group": "libgit2", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_libgit2_init-8"], - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_libgit2_init-10"], - "describe.c": ["ex/v0.23.0/describe.html#git_libgit2_init-4"], - "diff.c": ["ex/v0.23.0/diff.html#git_libgit2_init-12"], - "general.c": ["ex/v0.23.0/general.html#git_libgit2_init-27"], - "init.c": ["ex/v0.23.0/init.html#git_libgit2_init-1"], - "log.c": ["ex/v0.23.0/log.html#git_libgit2_init-29"], - "network/git2.c": ["ex/v0.23.0/network/git2.html#git_libgit2_init-3"], - "remote.c": ["ex/v0.23.0/remote.html#git_libgit2_init-2"], - "rev-parse.c": ["ex/v0.23.0/rev-parse.html#git_libgit2_init-1"], - "status.c": ["ex/v0.23.0/status.html#git_libgit2_init-1"], - "tag.c": ["ex/v0.23.0/tag.html#git_libgit2_init-3"] + "blame.c": ["ex/v0.24.1/blame.html#git_libgit2_init-8"], + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_libgit2_init-10"], + "describe.c": ["ex/v0.24.1/describe.html#git_libgit2_init-4"], + "diff.c": ["ex/v0.24.1/diff.html#git_libgit2_init-13"], + "general.c": ["ex/v0.24.1/general.html#git_libgit2_init-28"], + "init.c": ["ex/v0.24.1/init.html#git_libgit2_init-2"], + "log.c": ["ex/v0.24.1/log.html#git_libgit2_init-30"], + "network/git2.c": ["ex/v0.24.1/network/git2.html#git_libgit2_init-3"], + "remote.c": ["ex/v0.24.1/remote.html#git_libgit2_init-2"], + "rev-parse.c": ["ex/v0.24.1/rev-parse.html#git_libgit2_init-1"], + "status.c": ["ex/v0.24.1/status.html#git_libgit2_init-1"], + "tag.c": ["ex/v0.24.1/tag.html#git_libgit2_init-3"] } }, "git_libgit2_shutdown": { @@ -4490,19 +5340,55 @@ "comments": "Clean up the global state and threading context after calling it as many times as git_libgit2_init() was called - it will return the number of remainining initializations that have not been shutdown (after this one).
Count the number of unique commits between two commit objects
\n", + "comments": "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 ahead and behind values will be what git would report for the branches.
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.
\n\nThe index instance cannot be bare, and needs to be associated to an existing repository.
\n\nThe index must not contain any file in conflict.
\n", "group": "index", "examples": { - "init.c": ["ex/v0.23.0/init.html#git_index_write_tree-4"] + "init.c": ["ex/v0.24.1/init.html#git_index_write_tree-5"] } }, "git_index_write_tree_to": { "type": "function", "file": "index.h", - "line": 335, - "lineto": 335, + "line": 349, + "lineto": 349, "args": [{ "name": "out", "type": "git_oid *", @@ -4898,11 +5784,34 @@ "comments": "This method will do the same as git_index_write_tree, but letting the user choose the repository where the tree will be written.
The index must not contain any file in conflict.
\n", "group": "index" }, + "git_index_entrycount": { + "type": "function", + "file": "index.h", + "line": 368, + "lineto": 368, + "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": "Get the count of entries currently in the index
\n", + "comments": "", + "group": "index", + "examples": { + "general.c": ["ex/v0.24.1/general.html#git_index_entrycount-30"] + } + }, "git_index_clear": { "type": "function", "file": "index.h", - "line": 365, - "lineto": 365, + "line": 379, + "lineto": 379, "args": [{ "name": "index", "type": "git_index *", @@ -4918,11 +5827,38 @@ "comments": "This clears the index object in memory; changes must be explicitly written to disk for them to take effect persistently.
\n", "group": "index" }, + "git_index_get_byindex": { + "type": "function", + "file": "index.h", + "line": 392, + "lineto": 393, + "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": "Get a pointer to one of the entries in the index
\n", + "comments": "The entry is not modifiable and should not be freed. Because the git_index_entry struct is a publicly defined struct, you should be able to make your own permanent copy of the data if necessary.
The file path must be relative to the repository's working folder and must be readable.
This method will fail in bare index instances.
\n\nThis 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.
\n\nIf 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.
\n", "group": "index" }, + "git_index_add_frombuffer": { + "type": "function", + "file": "index.h", + "line": 526, + "lineto": 529, + "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": "Add or update an index entry from a buffer in memory
\n", + "comments": "This method will create a blob in the repository that owns the index and then add the index entry to the index. The path of the entry represents the position of the blob relative to the repository's root folder.
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 id and the file_size of the 'entry' are updated with the real value of the blob.
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.
\n\nIf 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.
\n", + "group": "index" + }, "git_index_remove_bypath": { "type": "function", "file": "index.h", - "line": 531, - "lineto": 531, + "line": 545, + "lineto": 545, "args": [{ "name": "index", "type": "git_index *", @@ -5117,8 +6085,8 @@ "git_index_add_all": { "type": "function", "file": "index.h", - "line": 578, - "lineto": 583, + "line": 592, + "lineto": 597, "args": [{ "name": "index", "type": "git_index *", @@ -5153,8 +6121,8 @@ "git_index_remove_all": { "type": "function", "file": "index.h", - "line": 600, - "lineto": 604, + "line": 614, + "lineto": 618, "args": [{ "name": "index", "type": "git_index *", @@ -5185,8 +6153,8 @@ "git_index_update_all": { "type": "function", "file": "index.h", - "line": 629, - "lineto": 633, + "line": 643, + "lineto": 647, "args": [{ "name": "index", "type": "git_index *", @@ -5200,25 +6168,81 @@ "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" + "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": "Update all index entries to match the working directory
\n", + "comments": "This method will fail in bare index instances.
\n\nThis 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).
\n\nIf you provide a callback function, it will be invoked on each matching item in the index immediately before 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.
\n", + "group": "index" + }, + "git_index_find": { + "type": "function", + "file": "index.h", + "line": 658, + "lineto": 658, + "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": "Find the first position of any entries which point to given\n path in the Git index.
\n", + "comments": "", + "group": "index" + }, + "git_index_find_prefix": { + "type": "function", + "file": "index.h", + "line": 669, + "lineto": 669, + "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": "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 *", + "argline": "size_t *at_pos, git_index *index, const char *prefix", + "sig": "size_t *::git_index *::const char *", "return": { "type": "int", - "comment": " 0 on success, negative callback return value, or error code" + "comment": " 0 with valid value in at_pos; an error code otherwise" }, - "description": "Update all index entries to match the working directory
\n", - "comments": "This method will fail in bare index instances.
\n\nThis 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).
\n\nIf you provide a callback function, it will be invoked on each matching item in the index immediately before 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.
\n", + "description": "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 '/'.
\n", + "comments": "", "group": "index" }, "git_index_conflict_add": { "type": "function", "file": "index.h", - "line": 669, - "lineto": 673, + "line": 694, + "lineto": 698, "args": [{ "name": "index", "type": "git_index *", @@ -5249,8 +6273,8 @@ "git_index_conflict_get": { "type": "function", "file": "index.h", - "line": 689, - "lineto": 694, + "line": 714, + "lineto": 719, "args": [{ "name": "ancestor_out", "type": "const git_index_entry **", @@ -5285,8 +6309,8 @@ "git_index_conflict_remove": { "type": "function", "file": "index.h", - "line": 703, - "lineto": 703, + "line": 728, + "lineto": 728, "args": [{ "name": "index", "type": "git_index *", @@ -5309,8 +6333,8 @@ "git_index_conflict_cleanup": { "type": "function", "file": "index.h", - "line": 711, - "lineto": 711, + "line": 736, + "lineto": 736, "args": [{ "name": "index", "type": "git_index *", @@ -5329,8 +6353,8 @@ "git_index_has_conflicts": { "type": "function", "file": "index.h", - "line": 718, - "lineto": 718, + "line": 743, + "lineto": 743, "args": [{ "name": "index", "type": "const git_index *", @@ -5349,8 +6373,8 @@ "git_index_conflict_iterator_new": { "type": "function", "file": "index.h", - "line": 729, - "lineto": 731, + "line": 754, + "lineto": 756, "args": [{ "name": "iterator_out", "type": "git_index_conflict_iterator **", @@ -5373,8 +6397,8 @@ "git_index_conflict_next": { "type": "function", "file": "index.h", - "line": 743, - "lineto": 747, + "line": 768, + "lineto": 772, "args": [{ "name": "ancestor_out", "type": "const git_index_entry **", @@ -5405,8 +6429,8 @@ "git_index_conflict_iterator_free": { "type": "function", "file": "index.h", - "line": 754, - "lineto": 755, + "line": 779, + "lineto": 780, "args": [{ "name": "iterator", "type": "git_index_conflict_iterator *", @@ -5462,7 +6486,42 @@ "comments": "", "group": "indexer", "examples": { - "network/index-pack.c": ["ex/v0.23.0/network/index-pack.html#git_indexer_new-1"] + "network/index-pack.c": ["ex/v0.24.1/network/index-pack.html#git_indexer_new-1"] + } + }, + "git_indexer_append": { + "type": "function", + "file": "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": "Add data to the indexer
\n", + "comments": "", + "group": "indexer", + "examples": { + "network/index-pack.c": ["ex/v0.24.1/network/index-pack.html#git_indexer_append-2"] } }, "git_indexer_commit": { @@ -5489,7 +6548,7 @@ "comments": "Resolve any pending deltas and write out the index file
\n", "group": "indexer", "examples": { - "network/index-pack.c": ["ex/v0.23.0/network/index-pack.html#git_indexer_commit-2"] + "network/index-pack.c": ["ex/v0.24.1/network/index-pack.html#git_indexer_commit-3"] } }, "git_indexer_hash": { @@ -5512,7 +6571,7 @@ "comments": "A packfile's name is derived from the sorted hashing of all object names. This is only correct after the index has been finalized.
\n", "group": "indexer", "examples": { - "network/index-pack.c": ["ex/v0.23.0/network/index-pack.html#git_indexer_hash-3"] + "network/index-pack.c": ["ex/v0.24.1/network/index-pack.html#git_indexer_hash-4"] } }, "git_indexer_free": { @@ -5535,7 +6594,7 @@ "comments": "", "group": "indexer", "examples": { - "network/index-pack.c": ["ex/v0.23.0/network/index-pack.html#git_indexer_free-4"] + "network/index-pack.c": ["ex/v0.24.1/network/index-pack.html#git_indexer_free-5"] } }, "git_merge_file_init_input": { @@ -5565,8 +6624,8 @@ "git_merge_file_init_options": { "type": "function", "file": "merge.h", - "line": 188, - "lineto": 190, + "line": 208, + "lineto": 210, "args": [{ "name": "opts", "type": "git_merge_file_options *", @@ -5589,8 +6648,8 @@ "git_merge_init_options": { "type": "function", "file": "merge.h", - "line": 265, - "lineto": 267, + "line": 295, + "lineto": 297, "args": [{ "name": "opts", "type": "git_merge_options *", @@ -5610,11 +6669,47 @@ "comments": "", "group": "merge" }, + "git_merge_analysis": { + "type": "function", + "file": "merge.h", + "line": 366, + "lineto": 371, + "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": "Analyzes the given branch(es) and determines the opportunities for\n merging them into the HEAD of the repository.
\n", + "comments": "", + "group": "merge" + }, "git_merge_base": { "type": "function", "file": "merge.h", - "line": 352, - "lineto": 356, + "line": 382, + "lineto": 386, "args": [{ "name": "out", "type": "git_oid *", @@ -5642,15 +6737,15 @@ "comments": "", "group": "merge", "examples": { - "log.c": ["ex/v0.23.0/log.html#git_merge_base-31"], - "rev-parse.c": ["ex/v0.23.0/rev-parse.html#git_merge_base-3"] + "log.c": ["ex/v0.24.1/log.html#git_merge_base-32"], + "rev-parse.c": ["ex/v0.24.1/rev-parse.html#git_merge_base-3"] } }, "git_merge_bases": { "type": "function", "file": "merge.h", - "line": 367, - "lineto": 371, + "line": 397, + "lineto": 401, "args": [{ "name": "out", "type": "git_oidarray *", @@ -5678,11 +6773,107 @@ "comments": "", "group": "merge" }, + "git_merge_base_many": { + "type": "function", + "file": "merge.h", + "line": 412, + "lineto": 416, + "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": "Find a merge base given a list of commits
\n", + "comments": "", + "group": "merge" + }, + "git_merge_bases_many": { + "type": "function", + "file": "merge.h", + "line": 427, + "lineto": 431, + "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": "Find all merge bases given a list of commits
\n", + "comments": "", + "group": "merge" + }, + "git_merge_base_octopus": { + "type": "function", + "file": "merge.h", + "line": 442, + "lineto": 446, + "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": "Find a merge base in preparation for an octopus merge
\n", + "comments": "", + "group": "merge" + }, "git_merge_file": { "type": "function", "file": "merge.h", - "line": 434, - "lineto": 439, + "line": 464, + "lineto": 469, "args": [{ "name": "out", "type": "git_merge_file_result *", @@ -5717,8 +6908,8 @@ "git_merge_file_from_index": { "type": "function", "file": "merge.h", - "line": 455, - "lineto": 461, + "line": 485, + "lineto": 491, "args": [{ "name": "out", "type": "git_merge_file_result *", @@ -5757,8 +6948,8 @@ "git_merge_file_result_free": { "type": "function", "file": "merge.h", - "line": 468, - "lineto": 468, + "line": 498, + "lineto": 498, "args": [{ "name": "result", "type": "git_merge_file_result *", @@ -5777,8 +6968,8 @@ "git_merge_trees": { "type": "function", "file": "merge.h", - "line": 486, - "lineto": 492, + "line": 516, + "lineto": 522, "args": [{ "name": "out", "type": "git_index **", @@ -5817,8 +7008,8 @@ "git_merge_commits": { "type": "function", "file": "merge.h", - "line": 513, - "lineto": 518, + "line": 539, + "lineto": 544, "args": [{ "name": "out", "type": "git_index **", @@ -5847,7 +7038,43 @@ "comment": " 0 on success or error code" }, "description": "Merge two commits, producing a git_index 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.
The merge performed uses the first common ancestor, unlike the git-merge-recursive strategy, which may produce an artificial common ancestor tree when there are multiple ancestors.
The returned index must be freed explicitly with git_index_free.
The returned index must be freed explicitly with git_index_free.
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.
\n", + "comments": "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 git_repository_state_cleanup().
The generated reference is owned by the repository and should be closed with the git_object_free method instead of free'd manually.
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.
\n", "group": "object", "examples": { - "log.c": ["ex/v0.23.0/log.html#git_object_lookup-32"] + "log.c": ["ex/v0.24.1/log.html#git_object_lookup-33"] } }, + "git_object_lookup_prefix": { + "type": "function", + "file": "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": "Lookup a reference to one of the objects in a repository,\n given a prefix of its identifier (short id).
\n", + "comments": "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.
\n\nThe generated reference is owned by the repository and should be closed with the git_object_free method instead of free'd manually.
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.
\n", + "group": "object" + }, "git_object_lookup_bypath": { "type": "function", "file": "object.h", @@ -6293,10 +7556,10 @@ "comments": "", "group": "object", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_object_id-10", "ex/v0.23.0/blame.html#git_object_id-11", "ex/v0.23.0/blame.html#git_object_id-12", "ex/v0.23.0/blame.html#git_object_id-13"], - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_object_id-12", "ex/v0.23.0/cat-file.html#git_object_id-13"], - "log.c": ["ex/v0.23.0/log.html#git_object_id-33", "ex/v0.23.0/log.html#git_object_id-34", "ex/v0.23.0/log.html#git_object_id-35", "ex/v0.23.0/log.html#git_object_id-36"], - "rev-parse.c": ["ex/v0.23.0/rev-parse.html#git_object_id-4", "ex/v0.23.0/rev-parse.html#git_object_id-5", "ex/v0.23.0/rev-parse.html#git_object_id-6", "ex/v0.23.0/rev-parse.html#git_object_id-7", "ex/v0.23.0/rev-parse.html#git_object_id-8"] + "blame.c": ["ex/v0.24.1/blame.html#git_object_id-10", "ex/v0.24.1/blame.html#git_object_id-11", "ex/v0.24.1/blame.html#git_object_id-12", "ex/v0.24.1/blame.html#git_object_id-13"], + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_object_id-12", "ex/v0.24.1/cat-file.html#git_object_id-13"], + "log.c": ["ex/v0.24.1/log.html#git_object_id-34", "ex/v0.24.1/log.html#git_object_id-35", "ex/v0.24.1/log.html#git_object_id-36", "ex/v0.24.1/log.html#git_object_id-37"], + "rev-parse.c": ["ex/v0.24.1/rev-parse.html#git_object_id-4", "ex/v0.24.1/rev-parse.html#git_object_id-5", "ex/v0.24.1/rev-parse.html#git_object_id-6", "ex/v0.24.1/rev-parse.html#git_object_id-7", "ex/v0.24.1/rev-parse.html#git_object_id-8"] } }, "git_object_short_id": { @@ -6323,7 +7586,7 @@ "comments": "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).
\n", "group": "object", "examples": { - "tag.c": ["ex/v0.23.0/tag.html#git_object_short_id-5"] + "tag.c": ["ex/v0.24.1/tag.html#git_object_short_id-5"] } }, "git_object_type": { @@ -6346,8 +7609,8 @@ "comments": "", "group": "object", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_object_type-14", "ex/v0.23.0/cat-file.html#git_object_type-15", "ex/v0.23.0/cat-file.html#git_object_type-16"], - "tag.c": ["ex/v0.23.0/tag.html#git_object_type-6"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_object_type-14", "ex/v0.24.1/cat-file.html#git_object_type-15", "ex/v0.24.1/cat-file.html#git_object_type-16"], + "tag.c": ["ex/v0.24.1/tag.html#git_object_type-6"] } }, "git_object_owner": { @@ -6390,12 +7653,12 @@ "comments": "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.
\n\nIMPORTANT: It is necessary to call this method when you stop using an object. Failure to do so will cause a memory leak.
\n", "group": "object", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_object_free-14", "ex/v0.23.0/blame.html#git_object_free-15", "ex/v0.23.0/blame.html#git_object_free-16", "ex/v0.23.0/blame.html#git_object_free-17"], - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_object_free-17"], - "general.c": ["ex/v0.23.0/general.html#git_object_free-29"], - "log.c": ["ex/v0.23.0/log.html#git_object_free-37"], - "rev-parse.c": ["ex/v0.23.0/rev-parse.html#git_object_free-9", "ex/v0.23.0/rev-parse.html#git_object_free-10", "ex/v0.23.0/rev-parse.html#git_object_free-11"], - "tag.c": ["ex/v0.23.0/tag.html#git_object_free-7", "ex/v0.23.0/tag.html#git_object_free-8", "ex/v0.23.0/tag.html#git_object_free-9", "ex/v0.23.0/tag.html#git_object_free-10"] + "blame.c": ["ex/v0.24.1/blame.html#git_object_free-14", "ex/v0.24.1/blame.html#git_object_free-15", "ex/v0.24.1/blame.html#git_object_free-16", "ex/v0.24.1/blame.html#git_object_free-17"], + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_object_free-17"], + "general.c": ["ex/v0.24.1/general.html#git_object_free-32"], + "log.c": ["ex/v0.24.1/log.html#git_object_free-38"], + "rev-parse.c": ["ex/v0.24.1/rev-parse.html#git_object_free-9", "ex/v0.24.1/rev-parse.html#git_object_free-10", "ex/v0.24.1/rev-parse.html#git_object_free-11"], + "tag.c": ["ex/v0.24.1/tag.html#git_object_free-7", "ex/v0.24.1/tag.html#git_object_free-8", "ex/v0.24.1/tag.html#git_object_free-9", "ex/v0.24.1/tag.html#git_object_free-10"] } }, "git_object_type2string": { @@ -6418,8 +7681,8 @@ "comments": "The result is a pointer to a string in static memory and should not be free()'ed.
\n", "group": "object", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_object_type2string-18", "ex/v0.23.0/cat-file.html#git_object_type2string-19", "ex/v0.23.0/cat-file.html#git_object_type2string-20", "ex/v0.23.0/cat-file.html#git_object_type2string-21"], - "general.c": ["ex/v0.23.0/general.html#git_object_type2string-30"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_object_type2string-18", "ex/v0.24.1/cat-file.html#git_object_type2string-19", "ex/v0.24.1/cat-file.html#git_object_type2string-20", "ex/v0.24.1/cat-file.html#git_object_type2string-21"], + "general.c": ["ex/v0.24.1/general.html#git_object_type2string-33"] } }, "git_object_string2type": { @@ -6462,6 +7725,26 @@ "comments": "", "group": "object" }, + "git_object__size": { + "type": "function", + "file": "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": "Get the size in bytes for the structure which\n acts as an in-memory representation of any given\n object type.
\n", + "comments": "For all the core types, this would the equivalent of calling sizeof(git_commit) if the core types were not opaque on the external API.
Close an open object database.
\n", - "comments": "", - "group": "odb", - "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_odb_free-22"] - } + "description": "Close an open object database.
\n", + "comments": "", + "group": "odb", + "examples": { + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_odb_free-22"] + } + }, + "git_odb_read": { + "type": "function", + "file": "odb.h", + "line": 99, + "lineto": 99, + "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": "Read an object from the database.
\n", + "comments": "This method queries all available ODB backends trying to read the given OID.
\n\nThe returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use.
\n", + "group": "odb", + "examples": { + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_odb_read-23"], + "general.c": ["ex/v0.24.1/general.html#git_odb_read-34"] + } + }, + "git_odb_read_prefix": { + "type": "function", + "file": "odb.h", + "line": 128, + "lineto": 128, + "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": "Read an object from the database, given a prefix\n of its identifier.
\n", + "comments": "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.
\n\nThe returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use.
\n", + "group": "odb" }, - "git_odb_read": { + "git_odb_read_header": { "type": "function", "file": "odb.h", - "line": 99, - "lineto": 99, + "line": 148, + "lineto": 148, "args": [{ - "name": "out", - "type": "git_odb_object **", - "comment": "pointer where to store the read object" + "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 *", @@ -6623,19 +7974,15 @@ "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 *", + "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": "Read an object from the database.
\n", - "comments": "This method queries all available ODB backends trying to read the given OID.
\n\nThe returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use.
\n", - "group": "odb", - "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_odb_read-23"], - "general.c": ["ex/v0.23.0/general.html#git_odb_read-31"] - } + "description": "Read the header of an object from the database, without\n reading its full contents.
\n", + "comments": "The header includes the length and the type of an object.
\n\nNote 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.
\n", + "group": "odb" }, "git_odb_exists": { "type": "function", @@ -6661,6 +8008,38 @@ "comments": "", "group": "odb" }, + "git_odb_exists_prefix": { + "type": "function", + "file": "odb.h", + "line": 171, + "lineto": 172, + "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": "Determine if objects can be found in the object database from a short OID.
\n", + "comments": "", + "group": "odb" + }, "git_odb_refresh": { "type": "function", "file": "odb.h", @@ -6709,6 +8088,45 @@ "comments": "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.
\n", "group": "odb" }, + "git_odb_write": { + "type": "function", + "file": "odb.h", + "line": 227, + "lineto": 227, + "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": "Write an object directly into the ODB
\n", + "comments": "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.
\n\nThis method is provided for compatibility with custom backends which are not able to support streaming writes
\n", + "group": "odb", + "examples": { + "general.c": ["ex/v0.24.1/general.html#git_odb_write-35"] + } + }, "git_odb_open_wstream": { "type": "function", "file": "odb.h", @@ -6741,6 +8159,34 @@ "comments": "The type and final length of the object must be specified when opening the stream.
\n\nThe returned stream will be of type GIT_STREAM_WRONLY, and it won't be effective until git_odb_stream_finalize_write is called and returns without an error
The stream must always be freed when done with git_odb_stream_free or will leak memory.
Write to an odb stream
\n", + "comments": "This method will fail if the total number of received bytes exceeds the size declared with git_odb_open_wstream()
The object will take its final name and will be available to the odb.
\n\nThis method will fail if the total number of received bytes differs from the size declared with git_odb_open_wstream()
Read from an odb stream
\n", + "comments": "Most backends don't implement streaming reads
\n", + "group": "odb" + }, "git_odb_stream_free": { "type": "function", "file": "odb.h", @@ -6845,6 +8319,38 @@ "comments": "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.
\n", "group": "odb" }, + "git_odb_hash": { + "type": "function", + "file": "odb.h", + "line": 356, + "lineto": 356, + "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": "Determine the object-ID (sha1 hash) of a data buffer
\n", + "comments": "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.
\n", + "group": "odb" + }, "git_odb_hashfile": { "type": "function", "file": "odb.h", @@ -6917,8 +8423,8 @@ "comments": "This method must always be called once a git_odb_object is no longer needed, otherwise memory will leak.
This is the uncompressed, raw data as read from the ODB, without the leading header.
\n\nThis pointer is owned by the object and shall not be free'd.
\n", "group": "odb", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_odb_object_data-33"] + "general.c": ["ex/v0.24.1/general.html#git_odb_object_data-37"] + } + }, + "git_odb_object_size": { + "type": "function", + "file": "odb.h", + "line": 429, + "lineto": 429, + "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": "Return the size of an ODB object
\n", + "comments": "This is the real size of the data buffer, not the actual size of the object.
Alternate backends are always checked for objects after all the main backends have been exhausted.
\n\nThe backends are checked in relative ordering, based on the value of the priority parameter.
Writing is disabled on alternate backends.
\n\nRead
Get the number of ODB backend objects
\n", + "comments": "", + "group": "odb" + }, + "git_odb_get_backend": { + "type": "function", + "file": "odb.h", + "line": 491, + "lineto": 491, + "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": "Lookup an ODB backend object by index
\n", + "comments": "", + "group": "odb" + }, "git_odb_backend_pack": { "type": "function", "file": "odb_backend.h", @@ -7155,7 +8733,7 @@ "comments": "", "group": "oid", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_oid_fromstr-35", "ex/v0.23.0/general.html#git_oid_fromstr-36", "ex/v0.23.0/general.html#git_oid_fromstr-37", "ex/v0.23.0/general.html#git_oid_fromstr-38", "ex/v0.23.0/general.html#git_oid_fromstr-39", "ex/v0.23.0/general.html#git_oid_fromstr-40", "ex/v0.23.0/general.html#git_oid_fromstr-41", "ex/v0.23.0/general.html#git_oid_fromstr-42"] + "general.c": ["ex/v0.24.1/general.html#git_oid_fromstr-40", "ex/v0.24.1/general.html#git_oid_fromstr-41", "ex/v0.24.1/general.html#git_oid_fromstr-42", "ex/v0.24.1/general.html#git_oid_fromstr-43", "ex/v0.24.1/general.html#git_oid_fromstr-44", "ex/v0.24.1/general.html#git_oid_fromstr-45", "ex/v0.24.1/general.html#git_oid_fromstr-46", "ex/v0.24.1/general.html#git_oid_fromstr-47"] } }, "git_oid_fromstrp": { @@ -7182,6 +8760,34 @@ "comments": "", "group": "oid" }, + "git_oid_fromstrn": { + "type": "function", + "file": "oid.h", + "line": 70, + "lineto": 70, + "args": [{ + "name": "out", + "type": "git_oid *", + "comment": "oid structure the result is written into." + }, { + "name": "str", + "type": "const char *", + "comment": "input hex string of at least size `length`" + }, { + "name": "length", + "type": "size_t", + "comment": "length of the input string" + }], + "argline": "git_oid *out, const char *str, size_t length", + "sig": "git_oid *::const char *::size_t", + "return": { + "type": "int", + "comment": " 0 or an error code" + }, + "description": "Parse N characters of a hex formatted object id into a git_oid
\n", + "comments": "If N is odd, N-1 characters will be parsed instead. The remaining space in the git_oid will be set to zero.
\n", + "group": "oid" + }, "git_oid_fromraw": { "type": "function", "file": "oid.h", @@ -7230,12 +8836,40 @@ "comments": "", "group": "oid", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_oid_fmt-43", "ex/v0.23.0/general.html#git_oid_fmt-44", "ex/v0.23.0/general.html#git_oid_fmt-45", "ex/v0.23.0/general.html#git_oid_fmt-46", "ex/v0.23.0/general.html#git_oid_fmt-47"], - "network/fetch.c": ["ex/v0.23.0/network/fetch.html#git_oid_fmt-1", "ex/v0.23.0/network/fetch.html#git_oid_fmt-2"], - "network/index-pack.c": ["ex/v0.23.0/network/index-pack.html#git_oid_fmt-5"], - "network/ls-remote.c": ["ex/v0.23.0/network/ls-remote.html#git_oid_fmt-1"] + "general.c": ["ex/v0.24.1/general.html#git_oid_fmt-48", "ex/v0.24.1/general.html#git_oid_fmt-49", "ex/v0.24.1/general.html#git_oid_fmt-50", "ex/v0.24.1/general.html#git_oid_fmt-51", "ex/v0.24.1/general.html#git_oid_fmt-52"], + "network/fetch.c": ["ex/v0.24.1/network/fetch.html#git_oid_fmt-1", "ex/v0.24.1/network/fetch.html#git_oid_fmt-2"], + "network/index-pack.c": ["ex/v0.24.1/network/index-pack.html#git_oid_fmt-6"], + "network/ls-remote.c": ["ex/v0.24.1/network/ls-remote.html#git_oid_fmt-1"] } }, + "git_oid_nfmt": { + "type": "function", + "file": "oid.h", + "line": 101, + "lineto": 101, + "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": "Format a git_oid into a partial hex string.
\n", + "comments": "", + "group": "oid" + }, "git_oid_pathfmt": { "type": "function", "file": "oid.h", @@ -7280,6 +8914,40 @@ "comments": "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.
\n", "group": "oid" }, + "git_oid_tostr": { + "type": "function", + "file": "oid.h", + "line": 148, + "lineto": 148, + "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": "Format a git_oid into a buffer as a hex format c-string.
\n", + "comments": "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).
\n\nIf 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.
\n", + "group": "oid", + "examples": { + "blame.c": ["ex/v0.24.1/blame.html#git_oid_tostr-18", "ex/v0.24.1/blame.html#git_oid_tostr-19"], + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_oid_tostr-26", "ex/v0.24.1/cat-file.html#git_oid_tostr-27", "ex/v0.24.1/cat-file.html#git_oid_tostr-28", "ex/v0.24.1/cat-file.html#git_oid_tostr-29", "ex/v0.24.1/cat-file.html#git_oid_tostr-30"], + "log.c": ["ex/v0.24.1/log.html#git_oid_tostr-39", "ex/v0.24.1/log.html#git_oid_tostr-40"], + "rev-parse.c": ["ex/v0.24.1/rev-parse.html#git_oid_tostr-12", "ex/v0.24.1/rev-parse.html#git_oid_tostr-13", "ex/v0.24.1/rev-parse.html#git_oid_tostr-14", "ex/v0.24.1/rev-parse.html#git_oid_tostr-15"] + } + }, "git_oid_cpy": { "type": "function", "file": "oid.h", @@ -7304,7 +8972,7 @@ "comments": "", "group": "oid", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_oid_cpy-18", "ex/v0.23.0/blame.html#git_oid_cpy-19", "ex/v0.23.0/blame.html#git_oid_cpy-20"] + "blame.c": ["ex/v0.24.1/blame.html#git_oid_cpy-20", "ex/v0.24.1/blame.html#git_oid_cpy-21", "ex/v0.24.1/blame.html#git_oid_cpy-22"] } }, "git_oid_cmp": { @@ -7349,9 +9017,37 @@ "sig": "const git_oid *::const git_oid *", "return": { "type": "int", - "comment": " true if equal, false otherwise" + "comment": " true if equal, false otherwise" + }, + "description": "Compare two oid structures for equality
\n", + "comments": "", + "group": "oid" + }, + "git_oid_ncmp": { + "type": "function", + "file": "oid.h", + "line": 185, + "lineto": 185, + "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": "Compare two oid structures for equality
\n", + "description": "Compare the first 'len' hexadecimal characters (packets of 4 bits)\n of two oid structures.
\n", "comments": "", "group": "oid" }, @@ -7423,10 +9119,30 @@ "comments": "", "group": "oid", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_oid_iszero-21"], - "network/fetch.c": ["ex/v0.23.0/network/fetch.html#git_oid_iszero-3"] + "blame.c": ["ex/v0.24.1/blame.html#git_oid_iszero-23"], + "network/fetch.c": ["ex/v0.24.1/network/fetch.html#git_oid_iszero-3"] } }, + "git_oid_shorten_new": { + "type": "function", + "file": "oid.h", + "line": 232, + "lineto": 232, + "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": "Create a new OID shortener.
\n", + "comments": "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.
\n\nE.g. look at the result of git log --abbrev.
Return a patch for an entry in the diff list.
\n", + "comments": "The git_patch is a newly created object contains the text diffs for the delta. You have to call git_patch_free() 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.
For an unchanged file or a binary file, no git_patch will be created, the output will be set to NULL, and the binary flag will be set true in the git_diff_delta structure.
It is okay to pass NULL for either of the output parameters; if you pass NULL for the git_patch, then the text diff will not be calculated.
This is just like git_diff_blobs() except it generates a patch object for the difference instead of directly making callbacks. You can use the standard git_patch accessor functions to read the patch data, and you must call git_patch_free() on the patch when done.
Directly generate a patch from the difference between a blob and a buffer.
\n", + "comments": "This is just like git_diff_blob_to_buffer() except it generates a patch object for the difference instead of directly making callbacks. You can use the standard git_patch accessor functions to read the patch data, and you must call git_patch_free() on the patch when done.
Directly generate a patch from the difference between two buffers.
\n", + "comments": "This is just like git_diff_buffers() except it generates a patch object for the difference instead of directly making callbacks. You can use the standard git_patch accessor functions to read the patch data, and you must call git_patch_free() on the patch when done.
Get the number of hunks in a patch
\n", + "comments": "", + "group": "patch" + }, + "git_patch_line_stats": { + "type": "function", + "file": "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": "Get line counts of each type in a patch.
\n", + "comments": "This helps imitate a diff --numstat type of output. For that purpose, you only need the total_additions and total_deletions values, but we include the total_context line count in case you want the total number of lines of diff output that will be generated.
All outputs are optional. Pass NULL if you don't need a particular count.
\n", + "group": "patch" + }, + "git_patch_get_hunk": { + "type": "function", + "file": "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": "Get the information about a hunk in a patch
\n", + "comments": "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.
\n", + "group": "patch" + }, + "git_patch_num_lines_in_hunk": { + "type": "function", + "file": "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 -1 if invalid hunk index" + }, + "description": "Get the number of lines in a hunk.
\n", + "comments": "", + "group": "patch" + }, + "git_patch_get_line_in_hunk": { + "type": "function", + "file": "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": "Get data about a line in a hunk of a patch.
\n", + "comments": "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.
\n", + "group": "patch" + }, + "git_patch_size": { + "type": "function", + "file": "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": "Look up size of patch diff data in bytes
\n", + "comments": "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.
\n\nIf you pass include_context 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 context_lines was 0).
This matches the pathspec against the files in the given tree.
\n\nIf out is not NULL, this returns a git_patchspec_match_list. That contains the list of all matched filenames (unless you pass the GIT_PATHSPEC_FAILURES_ONLY flag) and may also contain the list of pathspecs with no match (if you used the GIT_PATHSPEC_FIND_FAILURES flag). You must call git_pathspec_match_list_free() on this object.
Free memory associates with a git_pathspec_match_list
\n", + "comments": "", + "group": "pathspec" + }, + "git_pathspec_match_list_entrycount": { + "type": "function", + "file": "pathspec.h", + "line": 209, + "lineto": 210, + "args": [{ + "name": "m", + "type": "const git_pathspec_match_list *", + "comment": "The git_pathspec_match_list object" + }], + "argline": "const git_pathspec_match_list *m", + "sig": "const git_pathspec_match_list *", + "return": { + "type": "size_t", + "comment": " Number of items in match list" + }, + "description": "Get the number of items in a match list.
\n", + "comments": "", + "group": "pathspec" + }, + "git_pathspec_match_list_entry": { + "type": "function", + "file": "pathspec.h", + "line": 222, + "lineto": 223, + "args": [{ + "name": "m", + "type": "const git_pathspec_match_list *", + "comment": "The git_pathspec_match_list object" + }, { + "name": "pos", + "type": "size_t", + "comment": "The index into the list" + }], + "argline": "const git_pathspec_match_list *m, size_t pos", + "sig": "const git_pathspec_match_list *::size_t", + "return": { + "type": "const char *", + "comment": " The filename of the match" + }, + "description": "Get a matching filename by position.
\n", + "comments": "This routine cannot be used if the match list was generated by git_pathspec_match_diff. If so, it will always return NULL.
Get a matching diff delta by position.
\n", + "comments": "This routine can only be used if the match list was generated by git_pathspec_match_diff. Otherwise it will always return NULL.
Get the number of pathspec items that did not match.
\n", + "comments": "This will be zero unless you passed GIT_PATHSPEC_FIND_FAILURES when generating the git_pathspec_match_list.
\n", + "group": "pathspec" + }, + "git_pathspec_match_list_failed_entry": { + "type": "function", + "file": "pathspec.h", + "line": 259, + "lineto": 260, + "args": [{ + "name": "m", + "type": "const git_pathspec_match_list *", + "comment": "The git_pathspec_match_list object" + }, { + "name": "pos", + "type": "size_t", + "comment": "The index into the failed items" + }], + "argline": "const git_pathspec_match_list *m, size_t pos", + "sig": "const git_pathspec_match_list *::size_t", + "return": { + "type": "const char *", + "comment": " The pathspec pattern that didn't match anything" }, - "description": "Free memory associates with a git_pathspec_match_list
\n", - "comments": "", + "description": "Get an original pathspec string that had no matches.
\n", + "comments": "This will be return NULL for positions out of range.
\n", "group": "pathspec" }, "git_rebase_init_options": { "type": "function", "file": "rebase.h", - "line": 141, - "lineto": 143, + "line": 156, + "lineto": 158, "args": [{ "name": "opts", "type": "git_rebase_options *", @@ -8227,8 +10347,8 @@ "git_rebase_init": { "type": "function", "file": "rebase.h", - "line": 162, - "lineto": 168, + "line": 177, + "lineto": 183, "args": [{ "name": "out", "type": "git_rebase **", @@ -8267,8 +10387,8 @@ "git_rebase_open": { "type": "function", "file": "rebase.h", - "line": 179, - "lineto": 182, + "line": 194, + "lineto": 197, "args": [{ "name": "out", "type": "git_rebase **", @@ -8292,11 +10412,75 @@ "comments": "", "group": "rebase" }, - "git_rebase_next": { + "git_rebase_operation_entrycount": { + "type": "function", + "file": "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": "Gets the count of rebase operations that are to be applied.
\n", + "comments": "", + "group": "rebase" + }, + "git_rebase_operation_current": { + "type": "function", + "file": "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": "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 init but not yet next) then this returns\n GIT_REBASE_NO_OPERATION.
Gets the rebase operation specified by the given index.
\n", + "comments": "", + "group": "rebase" + }, + "git_rebase_next": { + "type": "function", + "file": "rebase.h", + "line": 240, + "lineto": 242, "args": [{ "name": "operation", "type": "git_rebase_operation **", @@ -8316,11 +10500,35 @@ "comments": "", "group": "rebase" }, - "git_rebase_commit": { + "git_rebase_inmemory_index": { "type": "function", "file": "rebase.h", - "line": 251, + "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": "Gets the index produced by the last operation, which is the result\n of git_rebase_next and which will be committed by the next\n invocation of git_rebase_commit. This is useful for resolving\n conflicts in an in-memory rebase before committing them. You must\n call git_index_free when you are finished with this.
This is only applicable for in-memory rebases; for rebases within a working directory, the changes were applied to the repository's index.
\n", + "group": "rebase" + }, + "git_rebase_commit": { + "type": "function", + "file": "rebase.h", + "line": 281, + "lineto": 287, "args": [{ "name": "id", "type": "git_oid *", @@ -8359,8 +10567,8 @@ "git_rebase_abort": { "type": "function", "file": "rebase.h", - "line": 267, - "lineto": 267, + "line": 297, + "lineto": 297, "args": [{ "name": "rebase", "type": "git_rebase *", @@ -8379,8 +10587,8 @@ "git_rebase_finish": { "type": "function", "file": "rebase.h", - "line": 277, - "lineto": 279, + "line": 307, + "lineto": 309, "args": [{ "name": "rebase", "type": "git_rebase *", @@ -8403,8 +10611,8 @@ "git_rebase_free": { "type": "function", "file": "rebase.h", - "line": 286, - "lineto": 286, + "line": 316, + "lineto": 316, "args": [{ "name": "rebase", "type": "git_rebase *", @@ -8640,6 +10848,78 @@ "comments": "", "group": "reflog" }, + "git_reflog_entrycount": { + "type": "function", + "file": "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": "Get the number of log entries in a reflog
\n", + "comments": "", + "group": "reflog" + }, + "git_reflog_entry_byindex": { + "type": "function", + "file": "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": "Lookup an entry by its index
\n", + "comments": "Requesting the reflog entry with an index of 0 (zero) will return the most recently created entry.
\n", + "group": "reflog" + }, + "git_reflog_drop": { + "type": "function", + "file": "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": "Remove an entry from the reflog by its index
\n", + "comments": "To ensure there's no gap in the log history, set rewrite_previous_entry param value to 1. When deleting entry n, member old_oid of entry n-1 (if any) will be updated with the value of member new_oid of entry n+1.
The returned reference must be freed by the user.
\n\nThe name will be checked for validity. See git_reference_symbolic_create() for rules about valid names.
Only available if the reference is direct (i.e. an object id reference, not a symbolic one).
\n\nTo find the OID of a symbolic ref, call git_reference_resolve() and then this function (or maybe use git_reference_name_to_id() to directly resolve a reference name all the way through to an OID).
Only available if the reference is symbolic.
\n", "group": "reference", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_reference_symbolic_target-50"] + "general.c": ["ex/v0.24.1/general.html#git_reference_symbolic_target-55"] } }, "git_reference_type": { @@ -9081,7 +11361,7 @@ "comments": "Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC)
\n", "group": "reference", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_reference_type-51"] + "general.c": ["ex/v0.24.1/general.html#git_reference_type-56"] } }, "git_reference_name": { @@ -9316,7 +11596,7 @@ "comments": "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 git_strarray_free().
Normalize reference name and check validity.
\n", + "comments": "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.
\n\nOnce normalized, if the reference name is valid, it will be returned in the user allocated buffer.
\n\nSee git_reference_symbolic_create() for rules about valid names.
This will transform the reference name into a name "human-readable" version. If no shortname is appropriate, it will return the full name.
\n\nThe memory is owned by the reference and must not be freed.
\n", "group": "reference", "examples": { - "status.c": ["ex/v0.23.0/status.html#git_reference_shorthand-4"] + "status.c": ["ex/v0.24.1/status.html#git_reference_shorthand-4"] } }, "git_refspec_src": { @@ -10009,7 +12321,7 @@ "comments": "", "group": "remote", "examples": { - "remote.c": ["ex/v0.23.0/remote.html#git_remote_create-4"] + "remote.c": ["ex/v0.24.1/remote.html#git_remote_create-4"] } }, "git_remote_create_with_fetchspec": { @@ -10076,8 +12388,8 @@ "comments": "Create a remote with the given url in-memory. You can use this when you have a URL instead of a remote's name.
\n", "group": "remote", "examples": { - "network/fetch.c": ["ex/v0.23.0/network/fetch.html#git_remote_create_anonymous-4"], - "network/ls-remote.c": ["ex/v0.23.0/network/ls-remote.html#git_remote_create_anonymous-2"] + "network/fetch.c": ["ex/v0.24.1/network/fetch.html#git_remote_create_anonymous-4"], + "network/ls-remote.c": ["ex/v0.24.1/network/ls-remote.html#git_remote_create_anonymous-2"] } }, "git_remote_lookup": { @@ -10108,9 +12420,9 @@ "comments": "The name will be checked for validity. See git_tag_create() for rules about valid names.
If url.*.insteadOf has been configured for this URL, it will return the modified URL.
\n", "group": "remote", "examples": { - "remote.c": ["ex/v0.23.0/remote.html#git_remote_url-6"] + "remote.c": ["ex/v0.24.1/remote.html#git_remote_url-6"] } }, "git_remote_pushurl": { @@ -10220,7 +12532,7 @@ "comments": "If url.*.pushInsteadOf has been configured for this URL, it will return the modified URL.
\n", "group": "remote", "examples": { - "remote.c": ["ex/v0.23.0/remote.html#git_remote_pushurl-7"] + "remote.c": ["ex/v0.24.1/remote.html#git_remote_pushurl-7"] } }, "git_remote_set_url": { @@ -10251,7 +12563,7 @@ "comments": "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.
\n", "group": "remote", "examples": { - "remote.c": ["ex/v0.23.0/remote.html#git_remote_set_url-8"] + "remote.c": ["ex/v0.24.1/remote.html#git_remote_set_url-8"] } }, "git_remote_set_pushurl": { @@ -10282,7 +12594,7 @@ "comments": "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.
\n", "group": "remote", "examples": { - "remote.c": ["ex/v0.23.0/remote.html#git_remote_set_pushurl-9"] + "remote.c": ["ex/v0.24.1/remote.html#git_remote_set_pushurl-9"] } }, "git_remote_add_fetch": { @@ -10389,11 +12701,55 @@ "comments": "The memory is owned by the user and should be freed with git_strarray_free.
Get the number of refspecs for a remote
\n", + "comments": "", + "group": "remote" + }, + "git_remote_get_refspec": { + "type": "function", + "file": "remote.h", + "line": 231, + "lineto": 231, + "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": "Get a refspec from the remote
\n", + "comments": "", + "group": "remote" + }, "git_remote_connect": { "type": "function", "file": "remote.h", - "line": 246, - "lineto": 246, + "line": 247, + "lineto": 247, "args": [{ "name": "remote", "type": "git_remote *", @@ -10406,9 +12762,13 @@ "name": "callbacks", "type": "const git_remote_callbacks *", "comment": "the callbacks to use for this connection" + }, { + "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", - "sig": "git_remote *::git_direction::const git_remote_callbacks *", + "argline": "git_remote *remote, git_direction direction, const git_remote_callbacks *callbacks, const git_strarray *custom_headers", + "sig": "git_remote *::git_direction::const git_remote_callbacks *::const git_strarray *", "return": { "type": "int", "comment": " 0 or an error code" @@ -10417,15 +12777,45 @@ "comments": "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.
\n", "group": "remote", "examples": { - "network/fetch.c": ["ex/v0.23.0/network/fetch.html#git_remote_connect-6"], - "network/ls-remote.c": ["ex/v0.23.0/network/ls-remote.html#git_remote_connect-4"] + "network/ls-remote.c": ["ex/v0.24.1/network/ls-remote.html#git_remote_connect-4"] + } + }, + "git_remote_ls": { + "type": "function", + "file": "remote.h", + "line": 269, + "lineto": 269, + "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": "Get the remote repository's reference advertisement list
\n", + "comments": "Get the list of references with which the server responds to a new connection.
\n\nThe 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.
\n\nThe 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.
\n", + "group": "remote", + "examples": { + "network/ls-remote.c": ["ex/v0.24.1/network/ls-remote.html#git_remote_ls-5"] } }, "git_remote_connected": { "type": "function", "file": "remote.h", - "line": 279, - "lineto": 279, + "line": 280, + "lineto": 280, "args": [{ "name": "remote", "type": "const git_remote *", @@ -10444,8 +12834,8 @@ "git_remote_stop": { "type": "function", "file": "remote.h", - "line": 289, - "lineto": 289, + "line": 290, + "lineto": 290, "args": [{ "name": "remote", "type": "git_remote *", @@ -10464,8 +12854,8 @@ "git_remote_disconnect": { "type": "function", "file": "remote.h", - "line": 298, - "lineto": 298, + "line": 299, + "lineto": 299, "args": [{ "name": "remote", "type": "git_remote *", @@ -10479,16 +12869,13 @@ }, "description": "Disconnect from the remote
\n", "comments": "Close the connection to the remote.
\n", - "group": "remote", - "examples": { - "network/fetch.c": ["ex/v0.23.0/network/fetch.html#git_remote_disconnect-7"] - } + "group": "remote" }, "git_remote_free": { "type": "function", "file": "remote.h", - "line": 308, - "lineto": 308, + "line": 309, + "lineto": 309, "args": [{ "name": "remote", "type": "git_remote *", @@ -10504,16 +12891,16 @@ "comments": "This also disconnects from the remote, if the connection has not been closed yet (using git_remote_disconnect).
\n", "group": "remote", "examples": { - "network/fetch.c": ["ex/v0.23.0/network/fetch.html#git_remote_free-8", "ex/v0.23.0/network/fetch.html#git_remote_free-9"], - "network/ls-remote.c": ["ex/v0.23.0/network/ls-remote.html#git_remote_free-5"], - "remote.c": ["ex/v0.23.0/remote.html#git_remote_free-10"] + "network/fetch.c": ["ex/v0.24.1/network/fetch.html#git_remote_free-6", "ex/v0.24.1/network/fetch.html#git_remote_free-7"], + "network/ls-remote.c": ["ex/v0.24.1/network/ls-remote.html#git_remote_free-6"], + "remote.c": ["ex/v0.24.1/remote.html#git_remote_free-10"] } }, "git_remote_list": { "type": "function", "file": "remote.h", - "line": 319, - "lineto": 319, + "line": 320, + "lineto": 320, "args": [{ "name": "out", "type": "git_strarray *", @@ -10533,14 +12920,14 @@ "comments": "The string array must be freed by the user.
\n", "group": "remote", "examples": { - "remote.c": ["ex/v0.23.0/remote.html#git_remote_list-11"] + "remote.c": ["ex/v0.24.1/remote.html#git_remote_list-11"] } }, "git_remote_init_callbacks": { "type": "function", "file": "remote.h", - "line": 470, - "lineto": 472, + "line": 471, + "lineto": 473, "args": [{ "name": "opts", "type": "git_remote_callbacks *", @@ -10563,8 +12950,8 @@ "git_fetch_init_options": { "type": "function", "file": "remote.h", - "line": 555, - "lineto": 557, + "line": 569, + "lineto": 571, "args": [{ "name": "opts", "type": "git_fetch_options *", @@ -10587,8 +12974,8 @@ "git_push_init_options": { "type": "function", "file": "remote.h", - "line": 594, - "lineto": 596, + "line": 613, + "lineto": 615, "args": [{ "name": "opts", "type": "git_push_options *", @@ -10611,8 +12998,8 @@ "git_remote_download": { "type": "function", "file": "remote.h", - "line": 614, - "lineto": 614, + "line": 633, + "lineto": 633, "args": [{ "name": "remote", "type": "git_remote *", @@ -10634,16 +13021,13 @@ }, "description": "Download and index the packfile
\n", "comments": "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.
\n\nThe .idx file will be created and both it and the packfile with be renamed to their final name.
\n", - "group": "remote", - "examples": { - "network/fetch.c": ["ex/v0.23.0/network/fetch.html#git_remote_download-10"] - } + "group": "remote" }, "git_remote_upload": { "type": "function", "file": "remote.h", - "line": 628, - "lineto": 628, + "line": 647, + "lineto": 647, "args": [{ "name": "remote", "type": "git_remote *", @@ -10670,8 +13054,8 @@ "git_remote_update_tips": { "type": "function", "file": "remote.h", - "line": 644, - "lineto": 649, + "line": 663, + "lineto": 668, "args": [{ "name": "remote", "type": "git_remote *", @@ -10701,16 +13085,13 @@ }, "description": "Update the tips to the new state
\n", "comments": "", - "group": "remote", - "examples": { - "network/fetch.c": ["ex/v0.23.0/network/fetch.html#git_remote_update_tips-11"] - } + "group": "remote" }, "git_remote_fetch": { "type": "function", "file": "remote.h", - "line": 665, - "lineto": 669, + "line": 684, + "lineto": 688, "args": [{ "name": "remote", "type": "git_remote *", @@ -10736,13 +13117,16 @@ }, "description": "Download new data and update tips
\n", "comments": "Convenience function to connect to a remote, download the data, disconnect and update the remote-tracking branches.
\n", - "group": "remote" + "group": "remote", + "examples": { + "network/fetch.c": ["ex/v0.24.1/network/fetch.html#git_remote_fetch-8"] + } }, "git_remote_prune": { "type": "function", "file": "remote.h", - "line": 678, - "lineto": 678, + "line": 697, + "lineto": 697, "args": [{ "name": "remote", "type": "git_remote *", @@ -10765,8 +13149,8 @@ "git_remote_push": { "type": "function", "file": "remote.h", - "line": 690, - "lineto": 692, + "line": 709, + "lineto": 711, "args": [{ "name": "remote", "type": "git_remote *", @@ -10792,9 +13176,9 @@ }, "git_remote_stats": { "type": "function", - "file": "remote.h", - "line": 697, - "lineto": 697, + "file": "remote.h", + "line": 716, + "lineto": 716, "args": [{ "name": "remote", "type": "git_remote *", @@ -10810,14 +13194,14 @@ "comments": "", "group": "remote", "examples": { - "network/fetch.c": ["ex/v0.23.0/network/fetch.html#git_remote_stats-12"] + "network/fetch.c": ["ex/v0.24.1/network/fetch.html#git_remote_stats-9"] } }, "git_remote_autotag": { "type": "function", "file": "remote.h", - "line": 705, - "lineto": 705, + "line": 724, + "lineto": 724, "args": [{ "name": "remote", "type": "const git_remote *", @@ -10836,8 +13220,8 @@ "git_remote_set_autotag": { "type": "function", "file": "remote.h", - "line": 717, - "lineto": 717, + "line": 736, + "lineto": 736, "args": [{ "name": "repo", "type": "git_repository *", @@ -10864,8 +13248,8 @@ "git_remote_prune_refs": { "type": "function", "file": "remote.h", - "line": 724, - "lineto": 724, + "line": 743, + "lineto": 743, "args": [{ "name": "remote", "type": "const git_remote *", @@ -10884,8 +13268,8 @@ "git_remote_rename": { "type": "function", "file": "remote.h", - "line": 746, - "lineto": 750, + "line": 765, + "lineto": 769, "args": [{ "name": "problems", "type": "git_strarray *", @@ -10897,7 +13281,7 @@ }, { "name": "name", "type": "const char *", - "comment": "the current name of the reamote" + "comment": "the current name of the remote" }, { "name": "new_name", "type": "const char *", @@ -10913,14 +13297,14 @@ "comments": "All remote-tracking branches and configuration settings for the remote are updated.
\n\nThe new name will be checked for validity. See git_tag_create() for rules about valid names.
No loaded instances of a the remote with the old name will change their name or their list of refspecs.
\n", "group": "remote", "examples": { - "remote.c": ["ex/v0.23.0/remote.html#git_remote_rename-12"] + "remote.c": ["ex/v0.24.1/remote.html#git_remote_rename-12"] } }, "git_remote_is_valid_name": { "type": "function", "file": "remote.h", - "line": 758, - "lineto": 758, + "line": 777, + "lineto": 777, "args": [{ "name": "remote_name", "type": "const char *", @@ -10939,8 +13323,8 @@ "git_remote_delete": { "type": "function", "file": "remote.h", - "line": 770, - "lineto": 770, + "line": 789, + "lineto": 789, "args": [{ "name": "repo", "type": "git_repository *", @@ -10960,14 +13344,14 @@ "comments": "All remote-tracking branches and configuration settings for the remote will be removed.
\n", "group": "remote", "examples": { - "remote.c": ["ex/v0.23.0/remote.html#git_remote_delete-13"] + "remote.c": ["ex/v0.24.1/remote.html#git_remote_delete-13"] } }, "git_remote_default_branch": { "type": "function", "file": "remote.h", - "line": 788, - "lineto": 788, + "line": 807, + "lineto": 807, "args": [{ "name": "out", "type": "git_buf *", @@ -11011,9 +13395,9 @@ "comments": "The 'path' argument must point to either a git repository folder, or an existing work dir.
\n\nThe method will automatically detect if 'path' is a normal or bare repository or fail is 'path' is neither.
\n", "group": "repository", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_repository_open-53"], - "network/git2.c": ["ex/v0.23.0/network/git2.html#git_repository_open-5"], - "remote.c": ["ex/v0.23.0/remote.html#git_repository_open-14"] + "general.c": ["ex/v0.24.1/general.html#git_repository_open-58"], + "network/git2.c": ["ex/v0.24.1/network/git2.html#git_repository_open-5"], + "remote.c": ["ex/v0.24.1/remote.html#git_repository_open-14"] } }, "git_repository_wrap_odb": { @@ -11072,7 +13456,7 @@ "comments": "The method will automatically detect if the repository is bare (if there is a repository).
\n", "group": "repository", "examples": { - "remote.c": ["ex/v0.23.0/remote.html#git_repository_discover-15"] + "remote.c": ["ex/v0.24.1/remote.html#git_repository_discover-15"] } }, "git_repository_open_ext": { @@ -11107,14 +13491,14 @@ "comments": "", "group": "repository", "examples": { - "blame.c": ["ex/v0.23.0/blame.html#git_repository_open_ext-22"], - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_repository_open_ext-25"], - "describe.c": ["ex/v0.23.0/describe.html#git_repository_open_ext-6"], - "diff.c": ["ex/v0.23.0/diff.html#git_repository_open_ext-14"], - "log.c": ["ex/v0.23.0/log.html#git_repository_open_ext-41", "ex/v0.23.0/log.html#git_repository_open_ext-42"], - "rev-parse.c": ["ex/v0.23.0/rev-parse.html#git_repository_open_ext-12"], - "status.c": ["ex/v0.23.0/status.html#git_repository_open_ext-5"], - "tag.c": ["ex/v0.23.0/tag.html#git_repository_open_ext-11"] + "blame.c": ["ex/v0.24.1/blame.html#git_repository_open_ext-24"], + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_repository_open_ext-31"], + "describe.c": ["ex/v0.24.1/describe.html#git_repository_open_ext-6"], + "diff.c": ["ex/v0.24.1/diff.html#git_repository_open_ext-15"], + "log.c": ["ex/v0.24.1/log.html#git_repository_open_ext-44", "ex/v0.24.1/log.html#git_repository_open_ext-45"], + "rev-parse.c": ["ex/v0.24.1/rev-parse.html#git_repository_open_ext-16"], + "status.c": ["ex/v0.24.1/status.html#git_repository_open_ext-5"], + "tag.c": ["ex/v0.24.1/tag.html#git_repository_open_ext-11"] } }, "git_repository_open_bare": { @@ -11161,18 +13545,18 @@ "comments": "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 git_object_free, but accessing any of the attributes of an object without a backing repository will result in undefined behavior
TODO: - Reinit the repository
\n", "group": "repository", "examples": { - "init.c": ["ex/v0.23.0/init.html#git_repository_init-6"] + "init.c": ["ex/v0.24.1/init.html#git_repository_init-7"] } }, "git_repository_init_init_options": { @@ -11258,7 +13642,7 @@ "comments": "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.
\n", "group": "repository", "examples": { - "init.c": ["ex/v0.23.0/init.html#git_repository_init_ext-7"] + "init.c": ["ex/v0.24.1/init.html#git_repository_init_ext-8"] } }, "git_repository_head": { @@ -11285,7 +13669,7 @@ "comments": "The returned git_reference will be owned by caller and git_reference_free() must be called when done with it to release the allocated memory and prevent a leak.
This is the path of the .git folder for normal repositories, or of the repository itself for bare repositories.
If the repository is bare, this function will always return NULL.
\n", "group": "repository", "examples": { - "init.c": ["ex/v0.23.0/init.html#git_repository_workdir-9"] + "init.c": ["ex/v0.24.1/init.html#git_repository_workdir-10"] } }, "git_repository_set_workdir": { @@ -11443,7 +13827,7 @@ "comments": "", "group": "repository", "examples": { - "status.c": ["ex/v0.23.0/status.html#git_repository_is_bare-9"] + "status.c": ["ex/v0.24.1/status.html#git_repository_is_bare-9"] } }, "git_repository_config": { @@ -11518,8 +13902,8 @@ "comments": "If a custom ODB has not been set, the default database for the repository will be returned (the one located in .git/objects).
The ODB must be freed once it's no longer being used by the user.
\n", "group": "repository", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_repository_odb-27"], - "general.c": ["ex/v0.23.0/general.html#git_repository_odb-55"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_repository_odb-33"], + "general.c": ["ex/v0.24.1/general.html#git_repository_odb-60"] } }, "git_repository_refdb": { @@ -11570,8 +13954,8 @@ "comments": "If a custom index has not been set, the default index for the repository will be returned (the one located in .git/index).
The index must be freed once it's no longer being used by the user.
\n", "group": "repository", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_repository_index-56"], - "init.c": ["ex/v0.23.0/init.html#git_repository_index-10"] + "general.c": ["ex/v0.24.1/general.html#git_repository_index-61"], + "init.c": ["ex/v0.24.1/init.html#git_repository_index-11"] } }, "git_repository_message": { @@ -11825,8 +14209,8 @@ "git_repository_state": { "type": "function", "file": "repository.h", - "line": 694, - "lineto": 694, + "line": 696, + "lineto": 696, "args": [{ "name": "repo", "type": "git_repository *", @@ -11845,8 +14229,8 @@ "git_repository_set_namespace": { "type": "function", "file": "repository.h", - "line": 708, - "lineto": 708, + "line": 710, + "lineto": 710, "args": [{ "name": "repo", "type": "git_repository *", @@ -11869,8 +14253,8 @@ "git_repository_get_namespace": { "type": "function", "file": "repository.h", - "line": 716, - "lineto": 716, + "line": 718, + "lineto": 718, "args": [{ "name": "repo", "type": "git_repository *", @@ -11889,8 +14273,8 @@ "git_repository_is_shallow": { "type": "function", "file": "repository.h", - "line": 725, - "lineto": 725, + "line": 727, + "lineto": 727, "args": [{ "name": "repo", "type": "git_repository *", @@ -11909,8 +14293,8 @@ "git_repository_ident": { "type": "function", "file": "repository.h", - "line": 737, - "lineto": 737, + "line": 739, + "lineto": 739, "args": [{ "name": "name", "type": "const char **", @@ -11937,8 +14321,8 @@ "git_repository_set_ident": { "type": "function", "file": "repository.h", - "line": 750, - "lineto": 750, + "line": 752, + "lineto": 752, "args": [{ "name": "repo", "type": "git_repository *", @@ -11946,11 +14330,11 @@ }, { "name": "name", "type": "const char *", - "comment": "the email to use for the reflog entries" + "comment": "the name to use for the reflog entries" }, { "name": "email", "type": "const char *", - "comment": null + "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 *", @@ -12174,11 +14558,11 @@ "comments": "See man gitrevisions, or http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for information on the syntax accepted.
The returned object should be released with git_object_free when no longer needed.
See man gitrevisions or http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for information on the syntax accepted.
This revision walker uses a custom memory pool and an internal commit cache, so it is relatively expensive to allocate.
\n\nFor maximum performance, this revision walker should be reused for different walks.
\n\nThis revision walker is not 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.
\n", "group": "revwalk", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_revwalk_new-57"], - "log.c": ["ex/v0.23.0/log.html#git_revwalk_new-46", "ex/v0.23.0/log.html#git_revwalk_new-47"] + "general.c": ["ex/v0.24.1/general.html#git_revwalk_new-62"], + "log.c": ["ex/v0.24.1/log.html#git_revwalk_new-49", "ex/v0.24.1/log.html#git_revwalk_new-50"] } }, "git_revwalk_reset": { @@ -12318,8 +14702,8 @@ "comments": "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.
\n\nAt least one commit must be pushed onto the walker before a walk can be started.
\n\nThe given id must belong to a committish on the walked repository.
\n", "group": "revwalk", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_revwalk_push-58"], - "log.c": ["ex/v0.23.0/log.html#git_revwalk_push-48"] + "general.c": ["ex/v0.24.1/general.html#git_revwalk_push-63"], + "log.c": ["ex/v0.24.1/log.html#git_revwalk_push-51"] } }, "git_revwalk_push_glob": { @@ -12366,7 +14750,7 @@ "comments": "", "group": "revwalk", "examples": { - "log.c": ["ex/v0.23.0/log.html#git_revwalk_push_head-49"] + "log.c": ["ex/v0.24.1/log.html#git_revwalk_push_head-52"] } }, "git_revwalk_hide": { @@ -12393,7 +14777,7 @@ "comments": "The given id must belong to a committish on the walked repository.
\n\nThe resolved commit and all its parents will be hidden from the output on the revision walk.
\n", "group": "revwalk", "examples": { - "log.c": ["ex/v0.23.0/log.html#git_revwalk_hide-50"] + "log.c": ["ex/v0.24.1/log.html#git_revwalk_hide-53"] } }, "git_revwalk_hide_glob": { @@ -12512,8 +14896,8 @@ "comments": "The initial call to this method is not blocking when iterating through a repo with a time-sorting mode.
\n\nIterating 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).
\n\nThe revision walker is reset when the walk is over.
\n", "group": "revwalk", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_revwalk_next-59"], - "log.c": ["ex/v0.23.0/log.html#git_revwalk_next-51"] + "general.c": ["ex/v0.24.1/general.html#git_revwalk_next-64"], + "log.c": ["ex/v0.24.1/log.html#git_revwalk_next-54"] } }, "git_revwalk_sorting": { @@ -12540,8 +14924,8 @@ "comments": "Changing the sorting mode resets the walker.
\n", "group": "revwalk", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_revwalk_sorting-60"], - "log.c": ["ex/v0.23.0/log.html#git_revwalk_sorting-52", "ex/v0.23.0/log.html#git_revwalk_sorting-53"] + "general.c": ["ex/v0.24.1/general.html#git_revwalk_sorting-65"], + "log.c": ["ex/v0.24.1/log.html#git_revwalk_sorting-55", "ex/v0.24.1/log.html#git_revwalk_sorting-56"] } }, "git_revwalk_push_range": { @@ -12608,8 +14992,8 @@ "comments": "", "group": "revwalk", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_revwalk_free-61"], - "log.c": ["ex/v0.23.0/log.html#git_revwalk_free-54"] + "general.c": ["ex/v0.24.1/general.html#git_revwalk_free-66"], + "log.c": ["ex/v0.24.1/log.html#git_revwalk_free-57"] } }, "git_revwalk_repository": { @@ -12696,7 +15080,7 @@ "comments": "Call git_signature_free() to free the data.
Note: angle brackets ('<' and '>') characters are not allowed to be used in either the name or the email parameter.
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.
\n", "group": "signature", "examples": { - "init.c": ["ex/v0.23.0/init.html#git_signature_default-11"], - "tag.c": ["ex/v0.23.0/tag.html#git_signature_default-17"] + "init.c": ["ex/v0.24.1/init.html#git_signature_default-12"], + "tag.c": ["ex/v0.24.1/tag.html#git_signature_default-17"] } }, "git_signature_dup": { @@ -12799,8 +15183,8 @@ "comments": "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.
\n", "group": "signature", "examples": { - "init.c": ["ex/v0.23.0/init.html#git_signature_free-12"], - "tag.c": ["ex/v0.23.0/tag.html#git_signature_free-18"] + "init.c": ["ex/v0.24.1/init.html#git_signature_free-13"], + "tag.c": ["ex/v0.24.1/tag.html#git_signature_free-18"] } }, "git_stash_apply_init_options": { @@ -12827,6 +15211,34 @@ "comments": "", "group": "stash" }, + "git_stash_apply": { + "type": "function", + "file": "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": "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": "Apply a single stashed state from the stash list.
\n", + "comments": "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.
\n\nIf 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.
\n\nNote that a minimum checkout strategy of GIT_CHECKOUT_SAFE is implied.
If the callback returns a non-zero value, this will stop looping.
\n", "group": "stash" }, + "git_stash_drop": { + "type": "function", + "file": "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": "Remove a single stashed state from the stash list.
\n", + "comments": "", + "group": "stash" + }, + "git_stash_pop": { + "type": "function", + "file": "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": "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": "Apply a single stashed state from the stash list and remove it from the list\n if successful.
\n", + "comments": "", + "group": "stash" + }, "git_status_init_options": { "type": "function", "file": "status.h", @@ -12907,7 +15371,7 @@ "comments": "The callback is passed the path of the file, the status (a combination of the git_status_t values above) and the payload data pointer passed into this function.
If the callback returns a non-zero value, this function will stop looping and return that value to caller.
\n", "group": "status", "examples": { - "status.c": ["ex/v0.23.0/status.html#git_status_foreach-10"] + "status.c": ["ex/v0.24.1/status.html#git_status_foreach-10"] } }, "git_status_foreach_ext": { @@ -12942,7 +15406,7 @@ "comments": "This is an extended version of the git_status_foreach() API that allows for more granular control over which paths will be processed and in what order. See the git_status_options structure for details about the additional controls that this makes available.
Note that if a pathspec is given in the git_status_options 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 pathspec so that all files can be considered.
Note that if a pathspec is given in the git_status_options 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 pathspec so that all files can be considered.
Gets the count of status entries in this list.
\n", + "comments": "If there are no changes in status (at least according the options given when the status list was created), this can return 0.
\n", + "group": "status", + "examples": { + "status.c": ["ex/v0.24.1/status.html#git_status_list_entrycount-14", "ex/v0.24.1/status.html#git_status_list_entrycount-15"] + } + }, + "git_status_byindex": { + "type": "function", + "file": "status.h", + "line": 335, + "lineto": 337, + "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": "Get a pointer to one of the entries in the status list.
\n", + "comments": "The entry is not modifiable and should not be freed.
\n", + "group": "status", + "examples": { + "status.c": ["ex/v0.24.1/status.html#git_status_byindex-16", "ex/v0.24.1/status.html#git_status_byindex-17", "ex/v0.24.1/status.html#git_status_byindex-18", "ex/v0.24.1/status.html#git_status_byindex-19", "ex/v0.24.1/status.html#git_status_byindex-20", "ex/v0.24.1/status.html#git_status_byindex-21"] } }, "git_status_list_free": { @@ -13024,7 +15538,7 @@ "comments": "", "group": "status", "examples": { - "status.c": ["ex/v0.23.0/status.html#git_status_list_free-14"] + "status.c": ["ex/v0.24.1/status.html#git_status_list_free-22"] } }, "git_status_should_ignore": { @@ -13075,9 +15589,9 @@ "comments": "This method should be called on git_strarray objects where the strings array is allocated and contains allocated strings, such as what you would get from git_strarray_copy(). Not doing so, will result in a memory leak.
This does not free the git_strarray itself, since the library will never allocate that object directly itself (it is more commonly embedded inside another struct or created on the stack).
See the note on git_submodule above. This iterates over the tracked submodules as described therein.
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.
\n", "group": "submodule", "examples": { - "status.c": ["ex/v0.23.0/status.html#git_submodule_foreach-15"] + "status.c": ["ex/v0.24.1/status.html#git_submodule_foreach-23"] } }, "git_submodule_add_setup": { "type": "function", "file": "submodule.h", - "line": 270, - "lineto": 275, + "line": 281, + "lineto": 286, "args": [{ "name": "out", "type": "git_submodule **", @@ -13274,8 +15788,8 @@ "git_submodule_add_finalize": { "type": "function", "file": "submodule.h", - "line": 287, - "lineto": 287, + "line": 298, + "lineto": 298, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13294,8 +15808,8 @@ "git_submodule_add_to_index": { "type": "function", "file": "submodule.h", - "line": 299, - "lineto": 301, + "line": 310, + "lineto": 312, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13318,8 +15832,8 @@ "git_submodule_owner": { "type": "function", "file": "submodule.h", - "line": 314, - "lineto": 314, + "line": 325, + "lineto": 325, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13338,8 +15852,8 @@ "git_submodule_name": { "type": "function", "file": "submodule.h", - "line": 322, - "lineto": 322, + "line": 333, + "lineto": 333, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13355,14 +15869,14 @@ "comments": "", "group": "submodule", "examples": { - "status.c": ["ex/v0.23.0/status.html#git_submodule_name-16"] + "status.c": ["ex/v0.24.1/status.html#git_submodule_name-24"] } }, "git_submodule_path": { "type": "function", "file": "submodule.h", - "line": 333, - "lineto": 333, + "line": 344, + "lineto": 344, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13378,14 +15892,14 @@ "comments": "The path is almost always the same as the submodule name, but the two are actually not required to match.
\n", "group": "submodule", "examples": { - "status.c": ["ex/v0.23.0/status.html#git_submodule_path-17"] + "status.c": ["ex/v0.24.1/status.html#git_submodule_path-25"] } }, "git_submodule_url": { "type": "function", "file": "submodule.h", - "line": 341, - "lineto": 341, + "line": 352, + "lineto": 352, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13404,8 +15918,8 @@ "git_submodule_resolve_url": { "type": "function", "file": "submodule.h", - "line": 351, - "lineto": 351, + "line": 362, + "lineto": 362, "args": [{ "name": "out", "type": "git_buf *", @@ -13432,8 +15946,8 @@ "git_submodule_branch": { "type": "function", "file": "submodule.h", - "line": 359, - "lineto": 359, + "line": 370, + "lineto": 370, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13452,8 +15966,8 @@ "git_submodule_set_branch": { "type": "function", "file": "submodule.h", - "line": 372, - "lineto": 372, + "line": 383, + "lineto": 383, "args": [{ "name": "repo", "type": "git_repository *", @@ -13480,8 +15994,8 @@ "git_submodule_set_url": { "type": "function", "file": "submodule.h", - "line": 386, - "lineto": 386, + "line": 397, + "lineto": 397, "args": [{ "name": "repo", "type": "git_repository *", @@ -13508,8 +16022,8 @@ "git_submodule_index_id": { "type": "function", "file": "submodule.h", - "line": 394, - "lineto": 394, + "line": 405, + "lineto": 405, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13528,8 +16042,8 @@ "git_submodule_head_id": { "type": "function", "file": "submodule.h", - "line": 402, - "lineto": 402, + "line": 413, + "lineto": 413, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13548,8 +16062,8 @@ "git_submodule_wd_id": { "type": "function", "file": "submodule.h", - "line": 415, - "lineto": 415, + "line": 426, + "lineto": 426, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13568,8 +16082,8 @@ "git_submodule_ignore": { "type": "function", "file": "submodule.h", - "line": 440, - "lineto": 441, + "line": 451, + "lineto": 452, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13588,8 +16102,8 @@ "git_submodule_set_ignore": { "type": "function", "file": "submodule.h", - "line": 453, - "lineto": 456, + "line": 464, + "lineto": 467, "args": [{ "name": "repo", "type": "git_repository *", @@ -13616,8 +16130,8 @@ "git_submodule_update_strategy": { "type": "function", "file": "submodule.h", - "line": 468, - "lineto": 469, + "line": 479, + "lineto": 480, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13636,8 +16150,8 @@ "git_submodule_set_update": { "type": "function", "file": "submodule.h", - "line": 481, - "lineto": 484, + "line": 492, + "lineto": 495, "args": [{ "name": "repo", "type": "git_repository *", @@ -13664,8 +16178,8 @@ "git_submodule_fetch_recurse_submodules": { "type": "function", "file": "submodule.h", - "line": 497, - "lineto": 498, + "line": 508, + "lineto": 509, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13684,8 +16198,8 @@ "git_submodule_set_fetch_recurse_submodules": { "type": "function", "file": "submodule.h", - "line": 510, - "lineto": 513, + "line": 521, + "lineto": 524, "args": [{ "name": "repo", "type": "git_repository *", @@ -13712,8 +16226,8 @@ "git_submodule_init": { "type": "function", "file": "submodule.h", - "line": 528, - "lineto": 528, + "line": 539, + "lineto": 539, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13736,8 +16250,8 @@ "git_submodule_repo_init": { "type": "function", "file": "submodule.h", - "line": 543, - "lineto": 546, + "line": 554, + "lineto": 557, "args": [{ "name": "out", "type": "git_repository **", @@ -13764,8 +16278,8 @@ "git_submodule_sync": { "type": "function", "file": "submodule.h", - "line": 556, - "lineto": 556, + "line": 567, + "lineto": 567, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13784,8 +16298,8 @@ "git_submodule_open": { "type": "function", "file": "submodule.h", - "line": 570, - "lineto": 572, + "line": 581, + "lineto": 583, "args": [{ "name": "repo", "type": "git_repository **", @@ -13808,8 +16322,8 @@ "git_submodule_reload": { "type": "function", "file": "submodule.h", - "line": 584, - "lineto": 584, + "line": 595, + "lineto": 595, "args": [{ "name": "submodule", "type": "git_submodule *", @@ -13832,8 +16346,8 @@ "git_submodule_status": { "type": "function", "file": "submodule.h", - "line": 600, - "lineto": 604, + "line": 611, + "lineto": 615, "args": [{ "name": "status", "type": "unsigned int *", @@ -13861,14 +16375,14 @@ "comments": "This looks at a submodule and tries to determine the status. It will return a combination of the GIT_SUBMODULE_STATUS values above. How deeply it examines the working directory to do this will depend on the git_submodule_ignore_t value for the submodule.
Clear the working directory and set core.bare to true. You may also want to call git_repository_set_index(repo, NULL) since a bare repo typically does not have an index, but this function will not do that for you.
Register a TLS stream constructor for the library to use
\n", + "comments": "If a constructor is already set, it will be overwritten. Pass NULL in order to deregister the current constructor.
Call the certificate check for this transport.
\n", + "comments": "", + "group": "transport" + }, "git_smart_subtransport_http": { "type": "function", "file": "sys/transport.h", - "line": 322, - "lineto": 325, + "line": 350, + "lineto": 353, "args": [{ "name": "out", "type": "git_smart_subtransport **", @@ -15031,8 +17597,8 @@ "git_smart_subtransport_git": { "type": "function", "file": "sys/transport.h", - "line": 334, - "lineto": 337, + "line": 362, + "lineto": 365, "args": [{ "name": "out", "type": "git_smart_subtransport **", @@ -15059,8 +17625,8 @@ "git_smart_subtransport_ssh": { "type": "function", "file": "sys/transport.h", - "line": 346, - "lineto": 349, + "line": 374, + "lineto": 377, "args": [{ "name": "out", "type": "git_smart_subtransport **", @@ -15112,9 +17678,41 @@ "comments": "", "group": "tag", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_tag_lookup-65"] + "general.c": ["ex/v0.24.1/general.html#git_tag_lookup-70"] } }, + "git_tag_lookup_prefix": { + "type": "function", + "file": "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": "Lookup a tag object from the repository,\n given a prefix of its identifier (short id).
\n", + "comments": "", + "group": "tag" + }, "git_tag_free": { "type": "function", "file": "tag.h", @@ -15199,7 +17797,7 @@ "comments": "This method performs a repository lookup for the given object and returns it
\n", "group": "tag", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_tag_target-66"] + "general.c": ["ex/v0.24.1/general.html#git_tag_target-71"] } }, "git_tag_target_id": { @@ -15222,7 +17820,7 @@ "comments": "", "group": "tag", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_tag_target_id-29"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_tag_target_id-35"] } }, "git_tag_target_type": { @@ -15245,8 +17843,8 @@ "comments": "", "group": "tag", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_tag_target_type-30"], - "general.c": ["ex/v0.23.0/general.html#git_tag_target_type-67"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_tag_target_type-36"], + "general.c": ["ex/v0.24.1/general.html#git_tag_target_type-72"] } }, "git_tag_name": { @@ -15269,9 +17867,9 @@ "comments": "", "group": "tag", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_tag_name-31"], - "general.c": ["ex/v0.23.0/general.html#git_tag_name-68"], - "tag.c": ["ex/v0.23.0/tag.html#git_tag_name-20"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_tag_name-37"], + "general.c": ["ex/v0.24.1/general.html#git_tag_name-73"], + "tag.c": ["ex/v0.24.1/tag.html#git_tag_name-20"] } }, "git_tag_tagger": { @@ -15294,7 +17892,7 @@ "comments": "", "group": "tag", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_tag_tagger-32"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_tag_tagger-38"] } }, "git_tag_message": { @@ -15317,9 +17915,9 @@ "comments": "", "group": "tag", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_tag_message-33", "ex/v0.23.0/cat-file.html#git_tag_message-34"], - "general.c": ["ex/v0.23.0/general.html#git_tag_message-69"], - "tag.c": ["ex/v0.23.0/tag.html#git_tag_message-21"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_tag_message-39", "ex/v0.24.1/cat-file.html#git_tag_message-40"], + "general.c": ["ex/v0.24.1/general.html#git_tag_message-74"], + "tag.c": ["ex/v0.24.1/tag.html#git_tag_message-21"] } }, "git_tag_create": { @@ -15366,7 +17964,7 @@ "comments": "A new reference will also be created pointing to this tag object. If force is true and a reference already exists with the given name, it'll be replaced.
The message will not be cleaned up. This can be achieved through git_message_prettify().
The tag name will be checked for validity. You must avoid the characters '~', '^', ':', '\\', '?', '[', and '*', and the sequences ".." and "@{" which have special meaning to revparse.
\n", "group": "tag", "examples": { - "tag.c": ["ex/v0.23.0/tag.html#git_tag_create-22"] + "tag.c": ["ex/v0.24.1/tag.html#git_tag_create-22"] } }, "git_tag_annotation_create": { @@ -15477,7 +18075,7 @@ "comments": "A new direct reference will be created pointing to this target object. If force is true and a reference already exists with the given name, it'll be replaced.
The tag name will be checked for validity. See git_tag_create() for rules about valid names.
The tag name will be checked for validity. See git_tag_create() for rules about valid names.
If an empty pattern is provided, all the tags will be returned.
\n\nThe 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 git_strarray_free.
Create an ssh key credential with a custom signing function.
\n", + "comments": "This lets you use your own function to sign the challenge.
\n\nThis function and its credential type is provided for completeness and wraps libssh2_userauth_publickey(), which is undocumented.
The supplied credential parameter will be internally duplicated.
\n", + "group": "cred" + }, "git_cred_default_new": { "type": "function", "file": "transport.h", - "line": 290, - "lineto": 290, + "line": 283, + "lineto": 283, "args": [{ "name": "out", "type": "git_cred **", @@ -15801,8 +18439,8 @@ "git_cred_username_new": { "type": "function", "file": "transport.h", - "line": 298, - "lineto": 298, + "line": 291, + "lineto": 291, "args": [{ "name": "cred", "type": "git_cred **", @@ -15825,8 +18463,8 @@ "git_cred_ssh_key_memory_new": { "type": "function", "file": "transport.h", - "line": 310, - "lineto": 315, + "line": 303, + "lineto": 308, "args": [{ "name": "out", "type": "git_cred **", @@ -15858,6 +18496,26 @@ "comments": "", "group": "cred" }, + "git_cred_free": { + "type": "function", + "file": "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": "Free a credential.
\n", + "comments": "This is only necessary if you own the object; that is, if you are a transport.
\n", + "group": "cred" + }, "git_tree_lookup": { "type": "function", "file": "tree.h", @@ -15886,10 +18544,42 @@ "comments": "", "group": "tree", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_tree_lookup-70", "ex/v0.23.0/general.html#git_tree_lookup-71"], - "init.c": ["ex/v0.23.0/init.html#git_tree_lookup-13"] + "general.c": ["ex/v0.24.1/general.html#git_tree_lookup-75", "ex/v0.24.1/general.html#git_tree_lookup-76"], + "init.c": ["ex/v0.24.1/init.html#git_tree_lookup-14"] } }, + "git_tree_lookup_prefix": { + "type": "function", + "file": "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": "Lookup a tree object from the repository,\n given a prefix of its identifier (short id).
\n", + "comments": "", + "group": "tree" + }, "git_tree_free": { "type": "function", "file": "tree.h", @@ -15910,9 +18600,9 @@ "comments": "You can no longer use the git_tree pointer after this call.
\n\nIMPORTANT: You MUST call this method when you stop using a tree to release memory. Failure to do so will cause a memory leak.
\n", "group": "tree", "examples": { - "diff.c": ["ex/v0.23.0/diff.html#git_tree_free-16", "ex/v0.23.0/diff.html#git_tree_free-17"], - "init.c": ["ex/v0.23.0/init.html#git_tree_free-14"], - "log.c": ["ex/v0.23.0/log.html#git_tree_free-55", "ex/v0.23.0/log.html#git_tree_free-56", "ex/v0.23.0/log.html#git_tree_free-57", "ex/v0.23.0/log.html#git_tree_free-58", "ex/v0.23.0/log.html#git_tree_free-59"] + "diff.c": ["ex/v0.24.1/diff.html#git_tree_free-17", "ex/v0.24.1/diff.html#git_tree_free-18"], + "init.c": ["ex/v0.24.1/init.html#git_tree_free-15"], + "log.c": ["ex/v0.24.1/log.html#git_tree_free-58", "ex/v0.24.1/log.html#git_tree_free-59", "ex/v0.24.1/log.html#git_tree_free-60", "ex/v0.24.1/log.html#git_tree_free-61", "ex/v0.24.1/log.html#git_tree_free-62"] } }, "git_tree_id": { @@ -15955,6 +18645,30 @@ "comments": "", "group": "tree" }, + "git_tree_entrycount": { + "type": "function", + "file": "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": "Get the number of entries listed in a tree
\n", + "comments": "", + "group": "tree", + "examples": { + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_tree_entrycount-41"], + "general.c": ["ex/v0.24.1/general.html#git_tree_entrycount-77"] + } + }, "git_tree_entry_byname": { "type": "function", "file": "tree.h", @@ -15979,7 +18693,35 @@ "comments": "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.
\n", "group": "tree", "examples": { - "general.c": ["ex/v0.23.0/general.html#git_tree_entry_byname-72"] + "general.c": ["ex/v0.24.1/general.html#git_tree_entry_byname-78"] + } + }, + "git_tree_entry_byindex": { + "type": "function", + "file": "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": "Lookup a tree entry by its position in the tree
\n", + "comments": "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.
\n", + "group": "tree", + "examples": { + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_tree_entry_byindex-42"], + "general.c": ["ex/v0.24.1/general.html#git_tree_entry_byindex-79"] } }, "git_tree_entry_byid": { @@ -16098,8 +18840,8 @@ "comments": "", "group": "tree", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_tree_entry_name-35"], - "general.c": ["ex/v0.23.0/general.html#git_tree_entry_name-73", "ex/v0.23.0/general.html#git_tree_entry_name-74"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_tree_entry_name-43"], + "general.c": ["ex/v0.24.1/general.html#git_tree_entry_name-80", "ex/v0.24.1/general.html#git_tree_entry_name-81"] } }, "git_tree_entry_id": { @@ -16122,7 +18864,7 @@ "comments": "", "group": "tree", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_tree_entry_id-36"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_tree_entry_id-44"] } }, "git_tree_entry_type": { @@ -16145,7 +18887,7 @@ "comments": "", "group": "tree", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_tree_entry_type-37"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_tree_entry_type-45"] } }, "git_tree_entry_filemode": { @@ -16168,7 +18910,7 @@ "comments": "", "group": "tree", "examples": { - "cat-file.c": ["ex/v0.23.0/cat-file.html#git_tree_entry_filemode-38"] + "cat-file.c": ["ex/v0.24.1/cat-file.html#git_tree_entry_filemode-46"] } }, "git_tree_entry_filemode_raw": { @@ -16243,7 +18985,7 @@ "comments": "You must call git_object_free() on the object when you are done with it.
Diff notification callback function.
\n", "comments": "The callback will be called for each file, just before the git_delta_t gets inserted into the diff.
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.
\n" }, + "git_diff_progress_cb": { + "type": "callback", + "file": "diff.h", + "line": 363, + "lineto": 367, + "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": "Diff progress callback.
\n", + "comments": "Called before each file comparison.
\n" + }, "git_diff_file_cb": { "type": "callback", "file": "diff.h", - "line": 423, - "lineto": 426, + "line": 446, + "lineto": 449, "args": [{ "name": "delta", "type": "const git_diff_delta *", @@ -16724,8 +19497,8 @@ "git_diff_binary_cb": { "type": "callback", "file": "diff.h", - "line": 470, - "lineto": 473, + "line": 493, + "lineto": 496, "args": [{ "name": "delta", "type": "const git_diff_delta *", @@ -16751,8 +19524,8 @@ "git_diff_hunk_cb": { "type": "callback", "file": "diff.h", - "line": 490, - "lineto": 493, + "line": 513, + "lineto": 516, "args": [{ "name": "delta", "type": "const git_diff_delta *", @@ -16778,8 +19551,8 @@ "git_diff_line_cb": { "type": "callback", "file": "diff.h", - "line": 543, - "lineto": 547, + "line": 566, + "lineto": 570, "args": [{ "name": "delta", "type": "const git_diff_delta *", @@ -16963,8 +19736,8 @@ "git_push_transfer_progress": { "type": "callback", "file": "remote.h", - "line": 332, - "lineto": 336, + "line": 333, + "lineto": 337, "args": [{ "name": "current", "type": "unsigned int", @@ -16975,15 +19748,15 @@ "comment": null }, { "name": "bytes", - "type": "int", + "type": "size_t", "comment": null }, { "name": "payload", "type": "void *", "comment": null }], - "argline": "unsigned int current, unsigned int total, int bytes, void *payload", - "sig": "unsigned int::unsigned int::int::void *", + "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 @@ -16994,23 +19767,23 @@ "git_push_negotiation": { "type": "callback", "file": "remote.h", - "line": 365, - "lineto": 365, + "line": 366, + "lineto": 366, "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": "int", + "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, int len, void *payload", - "sig": "const git_push_update **::int::void *", + "argline": "const git_push_update **updates, size_t len, void *payload", + "sig": "const git_push_update **::size_t::void *", "return": { "type": "int", "comment": null @@ -17071,7 +19844,7 @@ "lineto": 202, "args": [{ "name": "index", - "type": "int", + "type": "size_t", "comment": "The position within the stash list. 0 points to the\n most recent stashed state." }, { "name": "message", @@ -17086,8 +19859,8 @@ "type": "void *", "comment": "Extra parameter to callback function." }], - "argline": "int index, const char *message, const int *stash_id, void *payload", - "sig": "int::const char *::const int *::void *", + "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." @@ -17122,11 +19895,38 @@ "description": "Function pointer to receive status on individual files
\n", "comments": "path is the relative path to the file from the root of the repository.
status_flags is a combination of git_status_t values that apply.
payload is the value you passed to the foreach function as payload.
Function pointer to receive each submodule
\n", + "comments": "" + }, "git_filter_init_fn": { "type": "callback", "file": "sys/filter.h", - "line": 152, - "lineto": 152, + "line": 141, + "lineto": 141, "args": [{ "name": "self", "type": "git_filter *", @@ -17144,8 +19944,8 @@ "git_filter_shutdown_fn": { "type": "callback", "file": "sys/filter.h", - "line": 164, - "lineto": 164, + "line": 153, + "lineto": 153, "args": [{ "name": "self", "type": "git_filter *", @@ -17163,8 +19963,8 @@ "git_filter_check_fn": { "type": "callback", "file": "sys/filter.h", - "line": 186, - "lineto": 190, + "line": 175, + "lineto": 179, "args": [{ "name": "self", "type": "git_filter *", @@ -17194,8 +19994,8 @@ "git_filter_apply_fn": { "type": "callback", "file": "sys/filter.h", - "line": 204, - "lineto": 209, + "line": 193, + "lineto": 198, "args": [{ "name": "self", "type": "git_filter *", @@ -17229,8 +20029,8 @@ "git_filter_cleanup_fn": { "type": "callback", "file": "sys/filter.h", - "line": 226, - "lineto": 228, + "line": 215, + "lineto": 217, "args": [{ "name": "self", "type": "git_filter *", @@ -17302,8 +20102,8 @@ "git_cred_acquire_cb": { "type": "callback", "file": "transport.h", - "line": 329, - "lineto": 334, + "line": 333, + "lineto": 338, "args": [{ "name": "cred", "type": "git_cred **", @@ -17480,7 +20280,7 @@ "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_rebase_init", "git_repository_set_head_detached_from_annotated", "git_reset_from_annotated"] + "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", { @@ -17566,18 +20366,18 @@ } }], ["git_blame_hunk", { - "decl": ["uint16_t lines_in_hunk", "git_oid final_commit_id", "uint16_t final_start_line_number", "git_signature * final_signature", "git_oid orig_commit_id", "const char * orig_path", "uint16_t orig_start_line_number", "git_signature * orig_signature", "char boundary"], + "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": "blame.h", "line": 115, "lineto": 128, - "block": "uint16_t lines_in_hunk\ngit_oid final_commit_id\nuint16_t final_start_line_number\ngit_signature * final_signature\ngit_oid orig_commit_id\nconst char * orig_path\nuint16_t orig_start_line_number\ngit_signature * orig_signature\nchar boundary", + "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": "lines_in_hunk is the number of lines in this hunk - final_commit_id is the OID of the commit where this line was last changed. - final_start_line_number is the 1-based line number where this hunk begins, in the final version of the file - orig_commit_id is the OID of the commit where this hunk was found. This will usually be the same as final_commit_id, except when GIT_BLAME_TRACK_COPIES_ANY_COMMIT_COPIES has been specified. - orig_path is the path to the file where this hunk originated, as of the commit specified by orig_commit_id. - orig_start_line_number is the 1-based line number where this hunk begins in the file named by orig_path in the commit specified by orig_commit_id. - boundary is 1 iff the hunk has been tracked to a boundary commit (the root, or the commit specified in git_blame_options.oldest_commit)Use zeros to indicate default settings. It's easiest to use the GIT_BLAME_OPTIONS_INIT macro: git_blame_options opts = GIT_BLAME_OPTIONS_INIT;
flags is a combination of the git_blame_flag_t values above. - min_match_characters 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 GIT_BLAME_TRACK_COPIES_* flags are specified. - newest_commit is the id of the newest commit to consider. The default is HEAD. - oldest_commit is the id of the oldest commit to consider. The default is the first commit encountered with a NULL parent. - min_line is the first line in the file to blame. The default is 1 (line numbers start with 1). - max_line is the last line in the file to blame. The default is the last line of the file.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 git_buf and the caller can use git_buf_free() to release it when they are done.
A git_buf 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.
A git_buf is a public structure with three fields:
ptr points to the start of the allocated memory. If it is NULL, then the git_buf is considered empty and libgit2 will feel free to overwrite it with new data.
size holds the size (in bytes) of the data that is actually used.
asize holds the known total amount of allocated memory if the ptr was allocated by libgit2. It may be larger than size. If ptr was not allocated by libgit2 and should not be resized and/or freed, then asize will be set to zero.
Some APIs may occasionally do something slightly unusual with a buffer, such as setting ptr to a value that was passed in by the user. In those cases, the behavior will be clearly documented by the API.
Zero out for defaults. Initialize with GIT_CHECKOUT_OPTIONS_INIT macro to correctly set the version field. E.g.
git_checkout_options opts = GIT_CHECKOUT_OPTIONS_INIT;\nUse the GIT_CLONE_OPTIONS_INIT to get the default settings, like this:
\n\n git_clone_options opts = GIT_CLONE_OPTIONS_INIT;\ngit_config_open_default() and git_repository_config() honor those priority levels as well.
\n", "fields": [{ + "type": "int", + "name": "GIT_CONFIG_LEVEL_PROGRAMDATA", + "comments": "System-wide on Windows, for compatibility with portable git
\n", + "value": 1 + }, { "type": "int", "name": "GIT_CONFIG_LEVEL_SYSTEM", "comments": "System-wide configuration file; /etc/gitconfig on Linux systems
\n", - "value": 1 + "value": 2 }, { "type": "int", "name": "GIT_CONFIG_LEVEL_XDG", "comments": "XDG compatible configuration file; typically ~/.config/git/config
\n", - "value": 2 + "value": 3 }, { "type": "int", "name": "GIT_CONFIG_LEVEL_GLOBAL", "comments": "User-specific configuration file (also called Global configuration\n file); typically ~/.gitconfig
\n", - "value": 3 + "value": 4 }, { "type": "int", "name": "GIT_CONFIG_LEVEL_LOCAL", "comments": "Repository specific configuration file; $WORK_DIR/.git/config on\n non-bare repos
\n", - "value": 4 + "value": 5 }, { "type": "int", "name": "GIT_CONFIG_LEVEL_APP", "comments": "Application specific configuration file; freely defined by applications
\n", - "value": 5 + "value": 6 }, { "type": "int", "name": "GIT_CONFIG_HIGHEST_LEVEL", @@ -18269,8 +21327,8 @@ "type": "struct", "value": "git_cred_default", "file": "transport.h", - "line": 183, - "lineto": 183, + "line": 176, + "lineto": 176, "tdef": "typedef", "description": " A key for NTLM/Kerberos \"default\" credentials ", "comments": "", @@ -18279,13 +21337,54 @@ "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": "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": "transport.h", - "line": 163, - "lineto": 168, + "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", @@ -18317,8 +21416,8 @@ "type": "struct", "value": "git_cred_ssh_key", "file": "transport.h", - "line": 152, - "lineto": 158, + "line": 145, + "lineto": 151, "block": "git_cred parent\nchar * username\nchar * publickey\nchar * privatekey\nchar * passphrase", "tdef": "typedef", "description": " A ssh key from disk", @@ -18354,8 +21453,8 @@ "type": "struct", "value": "git_cred_username", "file": "transport.h", - "line": 186, - "lineto": 189, + "line": 179, + "lineto": 182, "block": "git_cred parent\nchar [1] username", "tdef": "typedef", "description": " Username-only credential information ", @@ -18404,8 +21503,8 @@ "type": "struct", "value": "git_cred_userpass_plaintext", "file": "transport.h", - "line": 129, - "lineto": 133, + "line": 122, + "lineto": 126, "block": "git_cred parent\nchar * username\nchar * password", "tdef": "typedef", "description": " A plaintext username and password ", @@ -18432,8 +21531,8 @@ "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": "transport.h", - "line": 88, - "lineto": 118, + "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 ", @@ -18484,8 +21583,8 @@ "type": "struct", "value": "git_cvar_map", "file": "config.h", - "line": 90, - "lineto": 94, + "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.", @@ -18505,15 +21604,15 @@ }], "used": { "returns": [], - "needs": [] + "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": "config.h", - "line": 80, - "lineto": 85, + "line": 83, + "lineto": 88, "block": "GIT_CVAR_FALSE\nGIT_CVAR_TRUE\nGIT_CVAR_INT32\nGIT_CVAR_STRING", "tdef": "typedef", "description": " Config var type", @@ -18548,8 +21647,8 @@ "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": "diff.h", - "line": 242, - "lineto": 254, + "line": 246, + "lineto": 258, "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?", @@ -18612,7 +21711,7 @@ }], "used": { "returns": [], - "needs": ["git_diff_status_char"] + "needs": ["git_diff_num_deltas_of_type", "git_diff_status_char"] } }], ["git_describe_format_options", { @@ -18720,27 +21819,85 @@ "needs": [] } }], - ["git_diff", { - "decl": "git_diff", + ["git_diff", { + "decl": "git_diff", + "type": "struct", + "value": "git_diff", + "file": "diff.h", + "line": 219, + "lineto": 219, + "tdef": "typedef", + "description": " The diff object that contains all individual file deltas.", + "comments": "This is an opaque structure which will be allocated by one of the diff generator functions below (such as git_diff_tree_to_tree). You are responsible for releasing the object memory when done, using the git_diff_free() function.
This is an opaque structure which will be allocated by one of the diff generator functions below (such as git_diff_tree_to_tree). You are responsible for releasing the object memory when done, using the git_diff_free() function.
These options mostly mimic parameters that can be passed to git-diff.
\n\nrename_threshold is the same as the -M option with a value - copy_threshold is the same as the -C option with a value - rename_from_rewrite_threshold matches the top of the -B option - break_rewrite_threshold matches the bottom of the -B option - rename_limit is the maximum number of matches to consider for a particular file. This is a little different from the -l option to regular Git because we will still process up to this many matches before abandoning the search.The metric 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.
If the pathspec is set in the diff options, this flags means to\n apply it as an exact match instead of as an fnmatch pattern.
\n", + "comments": "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 only match a directory). If a directory is\n specified, all children will be included.
\n", "value": 4096 }, { "type": "int", @@ -19265,14 +22606,83 @@ "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": "diff.h", + "line": 396, + "lineto": 416, + "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": "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.
\n\nflags is a combination of the git_diff_option_t values above - context_lines is the number of unchanged lines that define the boundary of a hunk (and to display before and after) - interhunk_lines is the maximum number of unchanged lines between hunk boundaries before the hunks will be merged into a one. - old_prefix is the virtual "directory" to prefix to old file names in hunk headers (default "a") - new_prefix is the virtual "directory" to prefix to new file names in hunk headers (default "b") - pathspec is an array of paths / fnmatch patterns to constrain diff - max_size is a file size (in bytes) above which a blob will be marked as binary automatically; pass a negative value to disable. - notify_cb is an optional callback function, notifying the consumer of changes to the diff as new deltas are added. - progress_cb is an optional callback function, notifying the consumer of which files are being examined as the diff is generated. - payload is the payload to pass to the callback functions. - ignore_submodules overrides the submodule ignore setting for all submodules in the diff.Uncommitted changes in index prevented operation
\n", "value": -22 + }, { + "type": "int", + "name": "GIT_EDIRECTORY", + "comments": "The operation is not valid for a directory
\n", + "value": -23 + }, { + "type": "int", + "name": "GIT_EMERGECONFLICT", + "comments": "A merge conflict exists and cannot continue
\n", + "value": -24 }, { "type": "int", "name": "GIT_PASSTHROUGH", @@ -19549,8 +22969,8 @@ "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"], "type": "enum", "file": "errors.h", - "line": 68, - "lineto": 100, + "line": 70, + "lineto": 102, "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", "tdef": "typedef", "description": " Error classes ", @@ -19717,12 +23137,12 @@ } }], ["git_feature_t", { - "decl": ["GIT_FEATURE_THREADS", "GIT_FEATURE_HTTPS", "GIT_FEATURE_SSH"], + "decl": ["GIT_FEATURE_THREADS", "GIT_FEATURE_HTTPS", "GIT_FEATURE_SSH", "GIT_FEATURE_NSEC"], "type": "enum", "file": "common.h", - "line": 100, - "lineto": 104, - "block": "GIT_FEATURE_THREADS\nGIT_FEATURE_HTTPS\nGIT_FEATURE_SSH", + "line": 111, + "lineto": 116, + "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": "", @@ -19741,12 +23161,58 @@ "name": "GIT_FEATURE_SSH", "comments": "", "value": 4 + }, { + "type": "int", + "name": "GIT_FEATURE_NSEC", + "comments": "", + "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_strarray custom_headers"], + "type": "struct", + "value": "git_fetch_options", + "file": "remote.h", + "line": 523, + "lineto": 555, + "block": "int version\ngit_remote_callbacks callbacks\ngit_fetch_prune_t prune\nint update_fetchhead\ngit_remote_autotag_option_t download_tags\ngit_strarray custom_headers", + "tdef": "typedef", + "description": " Fetch options structure.", + "comments": "Zero out for defaults. Initialize with GIT_FETCH_OPTIONS_INIT macro to correctly set the version field. E.g.
git_fetch_options opts = GIT_FETCH_OPTIONS_INIT;\nTo associate extra data with a filter, allocate extra data and put the git_filter struct at the start of your data buffer, then cast the self pointer to your larger structure when your callback is invoked.
version should be set to GIT_FILTER_VERSION
attributes is a whitespace-separated list of attribute names to check for this filter (e.g. "eol crlf text"). If the attribute name is bare, it will be simply loaded and passed to the check callback. If it has a value (i.e. "name=value"), the attribute must match that value for the filter to be applied.
The initialize, shutdown, check, apply, and cleanup callbacks are all documented above with the respective function pointer typedefs.
To associate extra data with a filter, allocate extra data and put the git_filter struct at the start of your data buffer, then cast the self pointer to your larger structure when your callback is invoked.
These are used to select which global option to set or get and are used in git_libgit2_opts().
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.
\n", + "value": 1 + }, { + "type": "int", + "name": "GIT_MERGE_FAIL_ON_CONFLICT", + "comments": "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.
\n", + "value": 2 + }, { + "type": "int", + "name": "GIT_MERGE_SKIP_REUC", + "comments": "Do not write the REUC extension on the generated index
\n", + "value": 4 + }, { + "type": "int", + "name": "GIT_MERGE_NO_RECURSIVE", + "comments": "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 git-merge-resolve.
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.
\n", - "value": 1 - }], - "used": { - "returns": [], - "needs": [] - } - }], ["git_note", { "decl": "git_note", "type": "struct", @@ -20703,7 +24277,7 @@ "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_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"] + "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", { @@ -20718,7 +24292,7 @@ "comments": "", "used": { "returns": [], - "needs": ["git_indexer_new", "git_mempack_new", "git_mempack_reset", "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_foreach", "git_odb_free", "git_odb_init_backend", "git_odb_new", "git_odb_object_data", "git_odb_object_dup", "git_odb_object_free", "git_odb_object_id", "git_odb_object_type", "git_odb_open", "git_odb_open_rstream", "git_odb_open_wstream", "git_odb_read", "git_odb_refresh", "git_odb_stream_finalize_write", "git_odb_stream_free", "git_odb_write_pack", "git_repository_odb", "git_repository_set_odb", "git_repository_wrap_odb"] + "needs": ["git_indexer_new", "git_mempack_new", "git_mempack_reset", "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_foreach", "git_odb_free", "git_odb_get_backend", "git_odb_init_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_set_odb", "git_repository_wrap_odb"] } }], ["git_odb_backend", { @@ -20787,11 +24361,11 @@ }, { "type": "void (*)(git_odb_backend *)", "name": "free", - "comments": "" + "comments": " Frees any resources held by the odb (including the `git_odb_backend`\n itself). An odb backend implementation must provide this function." }], "used": { "returns": [], - "needs": ["git_mempack_new", "git_mempack_reset", "git_odb_add_alternate", "git_odb_add_backend", "git_odb_backend_loose", "git_odb_backend_one_pack", "git_odb_backend_pack", "git_odb_init_backend"] + "needs": ["git_mempack_new", "git_mempack_reset", "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_init_backend"] } }], ["git_odb_object", { @@ -20806,7 +24380,7 @@ "comments": "", "used": { "returns": [], - "needs": ["git_odb_object_data", "git_odb_object_dup", "git_odb_object_free", "git_odb_object_id", "git_odb_object_type", "git_odb_read"] + "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", { @@ -20816,7 +24390,7 @@ "file": "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 *, int) read\nint (*)(git_odb_stream *, const char *, int) write\nint (*)(git_odb_stream *, const int *) finalize_write\nvoid (*)(git_odb_stream *) free", + "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": "", @@ -20841,11 +24415,11 @@ "name": "received_bytes", "comments": "" }, { - "type": "int (*)(git_odb_stream *, char *, int)", + "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 *, int)", + "type": "int (*)(git_odb_stream *, const char *, size_t)", "name": "write", "comments": " Write `len` bytes from `buffer` into the stream." }, { @@ -20859,7 +24433,7 @@ }], "used": { "returns": [], - "needs": ["git_odb_open_rstream", "git_odb_open_wstream", "git_odb_stream_finalize_write", "git_odb_stream_free"] + "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", { @@ -20900,7 +24474,7 @@ "file": "types.h", "line": 93, "lineto": 93, - "block": "git_odb_backend * backend\nint (*)(git_odb_writepack *, const void *, int, git_transfer_progress *) append\nint (*)(git_odb_writepack *, git_transfer_progress *) commit\nvoid (*)(git_odb_writepack *) free", + "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": "", @@ -20909,7 +24483,7 @@ "name": "backend", "comments": "" }, { - "type": "int (*)(git_odb_writepack *, const void *, int, git_transfer_progress *)", + "type": "int (*)(git_odb_writepack *, const void *, size_t, git_transfer_progress *)", "name": "append", "comments": "" }, { @@ -20943,8 +24517,8 @@ "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_filter_source_id", "git_index_checksum", "git_indexer_hash", "git_note_id", "git_object_id", "git_odb_object_id", "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_fromchunks", "git_blob_create_fromdisk", "git_blob_create_fromworkdir", "git_blob_lookup", "git_commit_amend", "git_commit_create_from_callback", "git_commit_lookup", "git_graph_descendant_of", "git_index_write_tree", "git_index_write_tree_to", "git_merge_base", "git_merge_bases", "git_note_create", "git_note_foreach_cb", "git_note_next", "git_note_read", "git_note_remove", "git_object_lookup", "git_odb_exists", "git_odb_foreach_cb", "git_odb_hashfile", "git_odb_open_rstream", "git_odb_read", "git_odb_stream_finalize_write", "git_oid_cmp", "git_oid_cpy", "git_oid_equal", "git_oid_fmt", "git_oid_fromraw", "git_oid_fromstr", "git_oid_fromstrp", "git_oid_iszero", "git_oid_pathfmt", "git_oid_shorten_add", "git_oid_shorten_free", "git_oid_strcmp", "git_oid_streq", "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__alloc", "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_tree_entry_byid", "git_tree_lookup", "git_treebuilder_insert", "git_treebuilder_write"] + "returns": ["git_annotated_commit_id", "git_blob_id", "git_commit_id", "git_commit_parent_id", "git_commit_tree_id", "git_filter_source_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_fromchunks", "git_blob_create_fromdisk", "git_blob_create_fromworkdir", "git_blob_lookup", "git_blob_lookup_prefix", "git_commit_amend", "git_commit_create", "git_commit_create_from_callback", "git_commit_create_v", "git_commit_extract_signature", "git_commit_lookup", "git_commit_lookup_prefix", "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_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__alloc", "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_entry_byid", "git_tree_lookup", "git_tree_lookup_prefix", "git_treebuilder_insert", "git_treebuilder_write"] } }], ["git_oid_shorten", { @@ -20958,10 +24532,35 @@ "description": " OID Shortener object", "comments": "", "used": { - "returns": [], + "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": "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", @@ -21025,7 +24624,7 @@ }], "used": { "returns": ["git_object_string2type", "git_object_type", "git_odb_object_type", "git_tag_target_type", "git_tree_entry_type"], - "needs": ["git_object_lookup", "git_object_lookup_bypath", "git_object_peel", "git_object_type2string", "git_object_typeisloose", "git_odb_hashfile", "git_odb_open_wstream", "git_reference_peel", "git_repository_hashfile"] + "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_wstream", "git_odb_read_header", "git_odb_write", "git_reference_peel", "git_repository_hashfile"] } }], ["git_packbuilder", { @@ -21081,7 +24680,7 @@ "comments": "You can easily loop over the content of patches and get information about them.
\n", "used": { "returns": [], - "needs": ["git_patch_free", "git_patch_from_blobs", "git_patch_get_delta", "git_patch_print", "git_patch_to_buf"] + "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_pathspec", { @@ -21096,7 +24695,7 @@ "comments": "", "used": { "returns": [], - "needs": ["git_pathspec_free", "git_pathspec_match_diff", "git_pathspec_match_index", "git_pathspec_match_list_free", "git_pathspec_match_tree", "git_pathspec_match_workdir", "git_pathspec_matches_path", "git_pathspec_new"] + "needs": ["git_pathspec_free", "git_pathspec_match_diff", "git_pathspec_match_index", "git_pathspec_match_list_diff_entry", "git_pathspec_match_list_entry", "git_pathspec_match_list_entrycount", "git_pathspec_match_list_failed_entry", "git_pathspec_match_list_failed_entrycount", "git_pathspec_match_list_free", "git_pathspec_match_tree", "git_pathspec_match_workdir", "git_pathspec_matches_path", "git_pathspec_new"] } }], ["git_pathspec_flag_t", { @@ -21162,7 +24761,7 @@ "comments": "", "used": { "returns": [], - "needs": ["git_pathspec_match_diff", "git_pathspec_match_index", "git_pathspec_match_list_free", "git_pathspec_match_tree", "git_pathspec_match_workdir"] + "needs": ["git_pathspec_match_diff", "git_pathspec_match_index", "git_pathspec_match_list_diff_entry", "git_pathspec_match_list_entry", "git_pathspec_match_list_entrycount", "git_pathspec_match_list_failed_entry", "git_pathspec_match_list_failed_entrycount", "git_pathspec_match_list_free", "git_pathspec_match_tree", "git_pathspec_match_workdir"] } }], ["git_push", { @@ -21181,13 +24780,13 @@ } }], ["git_push_options", { - "decl": ["unsigned int version", "unsigned int pb_parallelism", "git_remote_callbacks callbacks"], + "decl": ["unsigned int version", "unsigned int pb_parallelism", "git_remote_callbacks callbacks", "git_strarray custom_headers"], "type": "struct", "value": "git_push_options", "file": "remote.h", - "line": 563, - "lineto": 580, - "block": "unsigned int version\nunsigned int pb_parallelism\ngit_remote_callbacks callbacks", + "line": 577, + "lineto": 599, + "block": "unsigned int version\nunsigned int pb_parallelism\ngit_remote_callbacks callbacks\ngit_strarray custom_headers", "tdef": "typedef", "description": " Controls the behavior of a git_push object.", "comments": "", @@ -21203,6 +24802,10 @@ "type": "git_remote_callbacks", "name": "callbacks", "comments": " Callbacks to use for this push operation" + }, { + "type": "git_strarray", + "name": "custom_headers", + "comments": " Extra headers for this push operation" }], "used": { "returns": [], @@ -21214,8 +24817,8 @@ "type": "struct", "value": "git_push_update", "file": "remote.h", - "line": 340, - "lineto": 357, + "line": 341, + "lineto": 358, "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", @@ -21253,8 +24856,8 @@ "description": " Representation of a rebase ", "comments": "", "used": { - "returns": [], - "needs": ["git_rebase_abort", "git_rebase_commit", "git_rebase_finish", "git_rebase_free", "git_rebase_init", "git_rebase_init_options", "git_rebase_next", "git_rebase_open"] + "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", { @@ -21262,8 +24865,8 @@ "type": "struct", "value": "git_rebase_operation", "file": "rebase.h", - "line": 115, - "lineto": 130, + "line": 130, + "lineto": 145, "block": "git_rebase_operation_t type\nconst git_oid id\nconst char * exec", "tdef": "typedef", "description": " A rebase operation", @@ -21282,7 +24885,7 @@ "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": [], + "returns": ["git_rebase_operation_byindex"], "needs": ["git_rebase_next"] } }], @@ -21290,8 +24893,8 @@ "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": "rebase.h", - "line": 64, - "lineto": 100, + "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`.", @@ -21421,7 +25024,7 @@ }, { "type": "int (*)(git_refdb_backend *, const char *, const git_oid *, const char *)", "name": "del", - "comments": " Deletes the given reference from the refdb. A refdb implementation\n must provide this function." + "comments": " Deletes the given reference (and if necessary its reflog)\n from the refdb. A refdb implementation must provide this\n function." }, { "type": "int (*)(git_refdb_backend *)", "name": "compress", @@ -21437,7 +25040,7 @@ }, { "type": "void (*)(git_refdb_backend *)", "name": "free", - "comments": " Frees any resources held by the refdb. A refdb implementation may\n provide this function; if it is not provided, nothing will be done." + "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 (*)(git_reflog **, git_refdb_backend *, const char *)", "name": "reflog_read", @@ -21563,8 +25166,8 @@ "description": " Representation of a reference log ", "comments": "", "used": { - "returns": [], - "needs": ["git_reflog_append", "git_reflog_entry_committer", "git_reflog_entry_id_new", "git_reflog_entry_id_old", "git_reflog_entry_message", "git_reflog_free", "git_reflog_read", "git_reflog_write"] + "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", { @@ -21578,7 +25181,7 @@ "description": " Representation of a reference log entry ", "comments": "", "used": { - "returns": [], + "returns": ["git_reflog_entry_byindex"], "needs": ["git_reflog_entry_committer", "git_reflog_entry_id_new", "git_reflog_entry_id_old", "git_reflog_entry_message"] } }], @@ -21594,15 +25197,15 @@ "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_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_init_callbacks", "git_remote_lookup", "git_remote_name", "git_remote_owner", "git_remote_prune", "git_remote_prune_refs", "git_remote_push", "git_remote_pushurl", "git_remote_set_autotag", "git_remote_stats", "git_remote_stop", "git_remote_update_tips", "git_remote_upload", "git_remote_url", "git_transport_cb", "git_transport_dummy", "git_transport_local", "git_transport_new", "git_transport_smart", "git_transport_ssh_with_paths"] + "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_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_transport_dummy", "git_transport_local", "git_transport_new", "git_transport_smart", "git_transport_ssh_with_paths"] } }], ["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": "remote.h", - "line": 494, - "lineto": 512, + "line": 495, + "lineto": 513, "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", @@ -21638,8 +25241,8 @@ "type": "struct", "value": "git_remote_callbacks", "file": "remote.h", - "line": 373, - "lineto": 457, + "line": 374, + "lineto": 458, "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\nint (*)(const char *, const char *, void *) push_update_reference\ngit_push_negotiation push_negotiation\ngit_transport_cb transport\nvoid * payload", "tdef": null, "description": " The callback settings structure", @@ -21706,8 +25309,8 @@ "decl": ["GIT_REMOTE_COMPLETION_DOWNLOAD", "GIT_REMOTE_COMPLETION_INDEXING", "GIT_REMOTE_COMPLETION_ERROR"], "type": "enum", "file": "remote.h", - "line": 325, - "lineto": 329, + "line": 326, + "lineto": 330, "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.", @@ -21767,7 +25370,7 @@ }], "used": { "returns": [], - "needs": ["git_headlist_cb"] + "needs": ["git_headlist_cb", "git_remote_ls"] } }], ["git_repository", { @@ -21782,7 +25385,7 @@ "comments": "", "used": { "returns": ["git_blob_owner", "git_commit_owner", "git_filter_source_repo", "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_blame_file", "git_blob_create_fromchunks", "git_blob_create_fromdisk", "git_blob_create_fromworkdir", "git_blob_lookup", "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_from_callback", "git_commit_lookup", "git_describe_workdir", "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_new", "git_filter_list_stream_file", "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_base", "git_merge_bases", "git_merge_commits", "git_merge_file_from_index", "git_merge_trees", "git_note_create", "git_note_foreach", "git_note_iterator_new", "git_note_read", "git_note_remove", "git_object_lookup", "git_packbuilder_new", "git_pathspec_match_workdir", "git_rebase_init", "git_rebase_open", "git_refdb_backend_fs", "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__cleanup", "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_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_mergehead_foreach", "git_repository_message", "git_repository_message_remove", "git_repository_new", "git_repository_odb", "git_repository_open", "git_repository_open_bare", "git_repository_open_ext", "git_repository_path", "git_repository_refdb", "git_repository_reinit_filesystem", "git_repository_set_bare", "git_repository_set_config", "git_repository_set_head", "git_repository_set_head_detached", "git_repository_set_head_detached_from_annotated", "git_repository_set_ident", "git_repository_set_index", "git_repository_set_namespace", "git_repository_set_odb", "git_repository_set_refdb", "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_foreach", "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_tree_entry_to_object", "git_tree_lookup", "git_treebuilder_new"] + "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_fromchunks", "git_blob_create_fromdisk", "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_from_callback", "git_commit_create_v", "git_commit_extract_signature", "git_commit_lookup", "git_commit_lookup_prefix", "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_new", "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_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_pathspec_match_workdir", "git_rebase_init", "git_rebase_open", "git_refdb_backend_fs", "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__cleanup", "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_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_mergehead_foreach", "git_repository_message", "git_repository_message_remove", "git_repository_new", "git_repository_odb", "git_repository_open", "git_repository_open_bare", "git_repository_open_ext", "git_repository_path", "git_repository_refdb", "git_repository_reinit_filesystem", "git_repository_set_bare", "git_repository_set_config", "git_repository_set_head", "git_repository_set_head_detached", "git_repository_set_head_detached_from_annotated", "git_repository_set_ident", "git_repository_set_index", "git_repository_set_namespace", "git_repository_set_odb", "git_repository_set_refdb", "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_entry_to_object", "git_tree_lookup", "git_tree_lookup_prefix", "git_treebuilder_new"] } }], ["git_repository_init_flag_t", { @@ -21948,12 +25551,12 @@ } }], ["git_repository_state_t", { - "decl": ["GIT_REPOSITORY_STATE_NONE", "GIT_REPOSITORY_STATE_MERGE", "GIT_REPOSITORY_STATE_REVERT", "GIT_REPOSITORY_STATE_CHERRYPICK", "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"], + "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": "repository.h", "line": 674, - "lineto": 685, - "block": "GIT_REPOSITORY_STATE_NONE\nGIT_REPOSITORY_STATE_MERGE\nGIT_REPOSITORY_STATE_REVERT\nGIT_REPOSITORY_STATE_CHERRYPICK\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", + "lineto": 687, + "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": "These values represent possible states for the repository to be in, based on the current operation which is ongoing.
\n", @@ -21974,39 +25577,49 @@ "value": 2 }, { "type": "int", - "name": "GIT_REPOSITORY_STATE_CHERRYPICK", + "name": "GIT_REPOSITORY_STATE_REVERT_SEQUENCE", "comments": "", "value": 3 }, { "type": "int", - "name": "GIT_REPOSITORY_STATE_BISECT", + "name": "GIT_REPOSITORY_STATE_CHERRYPICK", "comments": "", "value": 4 }, { "type": "int", - "name": "GIT_REPOSITORY_STATE_REBASE", + "name": "GIT_REPOSITORY_STATE_CHERRYPICK_SEQUENCE", "comments": "", "value": 5 }, { "type": "int", - "name": "GIT_REPOSITORY_STATE_REBASE_INTERACTIVE", + "name": "GIT_REPOSITORY_STATE_BISECT", "comments": "", "value": 6 }, { "type": "int", - "name": "GIT_REPOSITORY_STATE_REBASE_MERGE", + "name": "GIT_REPOSITORY_STATE_REBASE", "comments": "", "value": 7 }, { "type": "int", - "name": "GIT_REPOSITORY_STATE_APPLY_MAILBOX", + "name": "GIT_REPOSITORY_STATE_REBASE_INTERACTIVE", "comments": "", "value": 8 }, { "type": "int", - "name": "GIT_REPOSITORY_STATE_APPLY_MAILBOX_OR_REBASE", + "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": [], @@ -22044,6 +25657,39 @@ "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": "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", @@ -22145,7 +25791,7 @@ }], "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_from_callback", "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_new", "git_signature_now", "git_tag_annotation_create", "git_tag_create"] + "needs": ["git_commit_amend", "git_commit_create", "git_commit_create_from_callback", "git_commit_create_v", "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_new", "git_signature_now", "git_tag_annotation_create", "git_tag_create"] } }], ["git_smart_subtransport_definition", { @@ -22153,8 +25799,8 @@ "type": "struct", "value": "git_smart_subtransport_definition", "file": "sys/transport.h", - "line": 296, - "lineto": 309, + "line": 324, + "lineto": 337, "block": "git_smart_subtransport_cb callback\nunsigned int rpc\nvoid * param", "tdef": "typedef", "description": " Definition for a \"subtransport\"", @@ -22287,7 +25933,7 @@ "comments": "", "used": { "returns": [], - "needs": ["git_status_list_free", "git_status_list_get_perfdata", "git_status_list_new"] + "needs": ["git_status_byindex", "git_status_list_entrycount", "git_status_list_free", "git_status_list_get_perfdata", "git_status_list_new"] } }], ["git_status_opt_t", { @@ -22503,6 +26149,31 @@ "needs": [] } }], + ["git_strarray", { + "decl": ["char ** strings", "size_t count"], + "type": "struct", + "value": "git_strarray", + "file": "strarray.h", + "line": 22, + "lineto": 25, + "block": "char ** strings\nsize_t count", + "tdef": "typedef", + "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_pathspec_new", "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_stream", { "decl": ["int version", "int encrypted", "int proxy_support", "int (*)(struct git_stream *) connect", "int (*)(git_cert **, struct git_stream *) certificate", "int (*)(struct git_stream *, const char *) set_proxy", "ssize_t (*)(struct git_stream *, void *, int) read", "ssize_t (*)(struct git_stream *, const char *, int, int) write", "int (*)(struct git_stream *) close", "void (*)(struct git_stream *) free"], "type": "struct", @@ -22557,7 +26228,7 @@ }], "used": { "returns": [], - "needs": [] + "needs": ["git_stream_register_tls"] } }], ["git_submodule", { @@ -22572,7 +26243,7 @@ "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_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"] + "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", { @@ -22733,6 +26404,39 @@ "needs": [] } }], + ["git_submodule_update_options", { + "decl": ["unsigned int version", "git_checkout_options checkout_opts", "git_fetch_options fetch_opts", "unsigned int clone_checkout_strategy"], + "type": "struct", + "value": "git_submodule_update_options", + "file": "submodule.h", + "line": 129, + "lineto": 157, + "block": "unsigned int version\ngit_checkout_options checkout_opts\ngit_fetch_options fetch_opts\nunsigned int clone_checkout_strategy", + "tdef": "typedef", + "description": " Submodule update options structure", + "comments": "Use the GIT_SUBMODULE_UPDATE_OPTIONS_INIT to get the default settings, like this:
\n\ngit_submodule_update_options opts = GIT_SUBMODULE_UPDATE_OPTIONS_INIT;
\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. Use the `clone_checkout_strategy` field\n to set the checkout strategy that will be used in\n the case where update needs to clone the repository." + }, { + "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": "unsigned int", + "name": "clone_checkout_strategy", + "comments": " The checkout strategy to use when the sub repository needs to\n be cloned. Use GIT_CHECKOUT_SAFE to create all files\n in the working directory for the newly cloned repository." + }], + "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", @@ -22786,7 +26490,7 @@ "comments": "", "used": { "returns": [], - "needs": ["git_tag_foreach", "git_tag_free", "git_tag_id", "git_tag_lookup", "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"] + "needs": ["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", { @@ -22877,7 +26581,52 @@ "comments": "", "used": { "returns": [], - "needs": [] + "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": "types.h", + "line": 253, + "lineto": 261, + "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": "