Creates a git_annotated_commit from the given reference.\n The resulting git_annotated_commit must be freed with\n git_annotated_commit_free.
Get the size in bytes of the contents of a blob
\n", @@ -2210,41 +2231,41 @@ ] } }, - "git_blob_filtered_content": { + "git_blob_filter": { "type": "function", - "file": "git2/deprecated.h", - "line": 94, - "lineto": 98, + "file": "git2/blob.h", + "line": 154, + "lineto": 158, "args": [ { "name": "out", "type": "git_buf *", - "comment": null + "comment": "The git_buf to be filled in" }, { "name": "blob", "type": "git_blob *", - "comment": null + "comment": "Pointer to the blob" }, { "name": "as_path", "type": "const char *", - "comment": null + "comment": "Path used for file attribute lookups, etc." }, { - "name": "check_for_binary_data", - "type": "int", - "comment": null + "name": "opts", + "type": "git_blob_filter_options *", + "comment": "Options to use for filtering the blob" } ], - "argline": "git_buf *out, git_blob *blob, const char *as_path, int check_for_binary_data", - "sig": "git_buf *::git_blob *::const char *::int", + "argline": "git_buf *out, git_blob *blob, const char *as_path, git_blob_filter_options *opts", + "sig": "git_buf *::git_blob *::const char *::git_blob_filter_options *", "return": { "type": "int", - "comment": null + "comment": " 0 on success or an error code" }, - "description": "Deprecated in favor of
\n", - "comments": "", + "description": "Get a buffer with the filtered content of a blob.
\n", + "comments": "This applies filters as if the blob was being checked out to the working directory under the specified filename. This may apply CRLF filtering or other types of changes depending on the file attributes set for the blob and the content detected in it.
\n\nThe output is written into a git_buf which the caller must free when done (via git_buf_dispose).
If no filters need to be applied, then the out buffer will just be populated with a pointer to the raw content of the blob. In that case, be careful to not free the blob until done with the buffer or copy it into memory you own.
Create a new branch pointing at a target commit
\n", "comments": "This behaves like git_branch_create() but takes an annotated commit, which lets you specify which extended sha syntax string was specified by a user, allowing for more exact reflog messages.
See the documentation for git_branch_create().
Delete an existing branch reference.
\n", - "comments": "If the branch is successfully deleted, the passed reference object will be invalidated. The reference must be freed manually by the user.
\n", + "comments": "Note that if the deletion succeeds, the reference object will not be valid anymore, and should be freed immediately by the user using git_reference_free().
Move/rename an existing local branch reference.
\n", - "comments": "The new branch name will be checked for validity. See git_tag_create() for rules about valid names.
The new branch name will be checked for validity. See git_tag_create() for rules about valid names.
Note that if the move succeeds, the old reference object will not + be valid anymore, and should be freed immediately by the user using + git_reference_free().
Lookup a branch by its name in a repository.
\n", - "comments": "The generated reference must be freed by the user.
\n\nThe branch name will be checked for validity. See git_tag_create() for rules about valid names.
The generated reference must be freed by the user. The branch name will be checked for validity.
\n", "group": "branch" }, "git_branch_name": { "type": "function", "file": "git2/branch.h", - "line": 186, - "lineto": 188, + "line": 189, + "lineto": 191, "args": [ { "name": "out", "type": "const char **", - "comment": "where the pointer of branch name is stored;\n this is valid as long as the ref is not freed." + "comment": "Pointer to the abbreviated reference name.\n Owned by ref, do not free." }, { "name": "ref", "type": "const git_reference *", - "comment": "the reference ideally pointing to a branch" + "comment": "A reference object, ideally pointing to a branch" } ], "argline": "const char **out, const git_reference *ref", "sig": "const char **::const git_reference *", "return": { "type": "int", - "comment": " 0 on success; otherwise an error code (e.g., if the\n ref is no local or remote branch)." + "comment": " 0 on success; GIT_EINVALID if the reference isn't either a local or\n remote branch, otherwise an error code." }, - "description": "Return the name of the given local or remote branch.
\n", - "comments": "The name of the branch matches the definition of the name for git_branch_lookup. That is, if the returned name is given to git_branch_lookup() then the reference is returned that was given to this function.
\n", + "description": "Get the branch name
\n", + "comments": "Given a reference object, this will check that it really is a branch (ie. it lives under "refs/heads/" or "refs/remotes/"), and return the branch part of it.
\n", "group": "branch", "examples": { "merge.c": [ @@ -2757,13 +2783,13 @@ "git_branch_upstream": { "type": "function", "file": "git2/branch.h", - "line": 202, - "lineto": 204, + "line": 207, + "lineto": 209, "args": [ { "name": "out", "type": "git_reference **", - "comment": "Pointer where to store the retrieved\n reference." + "comment": "Pointer where to store the retrieved reference." }, { "name": "branch", @@ -2775,17 +2801,17 @@ "sig": "git_reference **::const git_reference *", "return": { "type": "int", - "comment": " 0 on success; GIT_ENOTFOUND when no remote tracking\n reference exists, otherwise an error code." + "comment": " 0 on success; GIT_ENOTFOUND when no remote tracking\n reference exists, otherwise an error code." }, - "description": "Return the reference supporting the remote tracking branch,\n given a local branch reference.
\n", - "comments": "", + "description": "Get the upstream of a branch
\n", + "comments": "Given a reference, this will return a new reference object corresponding to its remote tracking branch. The reference must be a local branch.
\n", "group": "branch" }, "git_branch_set_upstream": { "type": "function", "file": "git2/branch.h", - "line": 216, - "lineto": 216, + "line": 226, + "lineto": 228, "args": [ { "name": "branch", @@ -2793,36 +2819,36 @@ "comment": "the branch to configure" }, { - "name": "upstream_name", + "name": "branch_name", "type": "const char *", - "comment": "remote-tracking or local branch to set as\n upstream. Pass NULL to unset." + "comment": "remote-tracking or local branch to set as upstream." } ], - "argline": "git_reference *branch, const char *upstream_name", + "argline": "git_reference *branch, const char *branch_name", "sig": "git_reference *::const char *", "return": { "type": "int", - "comment": " 0 or an error code" + "comment": " 0 on success; GIT_ENOTFOUND if there's no branch named `branch_name`\n or an error code" }, - "description": "Set the upstream configuration for a given local branch
\n", - "comments": "", + "description": "Set a branch's upstream branch
\n", + "comments": "This will update the configuration to set the branch named branch_name as the upstream of branch. Pass a NULL name to unset the upstream information.
Return the name of the reference supporting the remote tracking branch,\n given the name of a local branch reference.
\n", - "comments": "", + "description": "Get the upstream name of a branch
\n", + "comments": "Given a local branch, this will return its remote-tracking branch information, as a full reference name, ie. "feature/nice" would become "refs/remote/origin/feature/nice", depending on that branch's configuration.
\n", "group": "branch" }, "git_branch_is_head": { "type": "function", "file": "git2/branch.h", - "line": 245, - "lineto": 246, + "line": 257, + "lineto": 258, "args": [ { "name": "branch", "type": "const git_reference *", - "comment": "Current underlying reference of the branch." + "comment": "A reference to a local branch." } ], "argline": "const git_reference *branch", "sig": "const git_reference *", "return": { "type": "int", - "comment": " 1 if HEAD points at the branch, 0 if it isn't,\n error code otherwise." + "comment": " 1 if HEAD points at the branch, 0 if it isn't, or a negative value\n \t\t as an error code." }, - "description": "Determine if the current local branch is pointed at by HEAD.
\n", + "description": "Determine if HEAD points to the given branch
\n", "comments": "", "group": "branch" }, "git_branch_is_checked_out": { "type": "function", "file": "git2/branch.h", - "line": 257, - "lineto": 258, + "line": 270, + "lineto": 271, "args": [ { "name": "branch", "type": "const git_reference *", - "comment": "Reference to the branch." + "comment": "A reference to a local branch." } ], "argline": "const git_reference *branch", "sig": "const git_reference *", "return": { "type": "int", - "comment": " 1 if branch is checked out, 0 if it isn't,\n error code otherwise." + "comment": " 1 if branch is checked out, 0 if it isn't, an error code otherwise." }, - "description": "Determine if the current branch is checked out in any linked\n repository.
\n", - "comments": "", + "description": "Determine if any HEAD points to the current branch
\n", + "comments": "This will iterate over all known linked repositories (usually in the form of worktrees) and report whether any HEAD is pointing at the current branch.
\n", "group": "branch" }, "git_branch_remote_name": { "type": "function", "file": "git2/branch.h", - "line": 274, - "lineto": 277, + "line": 289, + "lineto": 292, "args": [ { "name": "out", "type": "git_buf *", - "comment": "Pointer to the user-allocated git_buf which will be filled with the name of the remote." + "comment": "The buffer into which the name will be written." }, { "name": "repo", @@ -2901,26 +2927,26 @@ "comment": "The repository where the branch lives." }, { - "name": "canonical_branch_name", + "name": "refname", "type": "const char *", - "comment": "name of the remote tracking branch." + "comment": "complete name of the remote tracking branch." } ], - "argline": "git_buf *out, git_repository *repo, const char *canonical_branch_name", + "argline": "git_buf *out, git_repository *repo, const char *refname", "sig": "git_buf *::git_repository *::const char *", "return": { "type": "int", - "comment": " 0, GIT_ENOTFOUND\n when no remote matching remote was found,\n GIT_EAMBIGUOUS when the branch maps to several remotes,\n otherwise an error code." + "comment": " 0 on success, GIT_ENOTFOUND when no matching remote was found,\n GIT_EAMBIGUOUS when the branch maps to several remotes,\n otherwise an error code." }, - "description": "Return the name of remote that the remote tracking branch belongs to.
\n", - "comments": "", + "description": "Find the remote name of a remote-tracking branch
\n", + "comments": "This will return the name of the remote whose fetch refspec is matching the given branch. E.g. given a branch "refs/remotes/test/master", it will extract the "test" part. If refspecs from multiple remotes match, the function will return GIT_EAMBIGUOUS.
\n", "group": "branch" }, "git_branch_upstream_remote": { "type": "function", "file": "git2/branch.h", - "line": 288, - "lineto": 288, + "line": 305, + "lineto": 305, "args": [ { "name": "buf", @@ -2944,8 +2970,8 @@ "type": "int", "comment": " 0 or an error code" }, - "description": "Retrieve the name of the upstream remote of a local branch
\n", - "comments": "", + "description": "Retrieve the upstream remote of a local branch
\n", + "comments": "This will return the currently configured "branch.*.remote" for a given branch. This branch must be local.
\n", "group": "branch" }, "git_buf_dispose": { @@ -3201,7 +3227,7 @@ "group": "checkout", "examples": { "checkout.c": [ - "ex/HEAD/checkout.html#git_checkout_tree-5" + "ex/HEAD/checkout.html#git_checkout_tree-8" ], "merge.c": [ "ex/HEAD/merge.html#git_checkout_tree-5" @@ -3259,12 +3285,12 @@ { "name": "our_commit", "type": "git_commit *", - "comment": "the commit to revert against (eg, HEAD)" + "comment": "the commit to cherry-pick against (eg, HEAD)" }, { "name": "mainline", "type": "unsigned int", - "comment": "the parent of the revert commit, if it is a merge" + "comment": "the parent of the `cherrypick_commit`, if it is a merge" }, { "name": "merge_options", @@ -3411,7 +3437,7 @@ "group": "commit", "examples": { "checkout.c": [ - "ex/HEAD/checkout.html#git_commit_lookup-6" + "ex/HEAD/checkout.html#git_commit_lookup-9" ], "general.c": [ "ex/HEAD/general.html#git_commit_lookup-6", @@ -3486,7 +3512,7 @@ "group": "commit", "examples": { "checkout.c": [ - "ex/HEAD/checkout.html#git_commit_free-7" + "ex/HEAD/checkout.html#git_commit_free-10" ], "general.c": [ "ex/HEAD/general.html#git_commit_free-9", @@ -5882,6 +5908,348 @@ "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.
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_cred_has_username": { + "type": "function", + "file": "git2/cred.h", + "line": 153, + "lineto": 153, + "args": [ + { + "name": "cred", + "type": "git_cred *", + "comment": "object to check" + } + ], + "argline": "git_cred *cred", + "sig": "git_cred *", + "return": { + "type": "int", + "comment": " 1 if the credential object has non-NULL username, 0 otherwise" + }, + "description": "Check whether a credential object contains username information.
\n", + "comments": "", + "group": "cred" + }, + "git_cred_get_username": { + "type": "function", + "file": "git2/cred.h", + "line": 161, + "lineto": 161, + "args": [ + { + "name": "cred", + "type": "git_cred *", + "comment": "object to check" + } + ], + "argline": "git_cred *cred", + "sig": "git_cred *", + "return": { + "type": "const char *", + "comment": " the credential username, or NULL if not applicable" + }, + "description": "Return the username associated with a credential object.
\n", + "comments": "", + "group": "cred" + }, + "git_cred_userpass_plaintext_new": { + "type": "function", + "file": "git2/cred.h", + "line": 172, + "lineto": 175, + "args": [ + { + "name": "out", + "type": "git_cred **", + "comment": "The newly created credential object." + }, + { + "name": "username", + "type": "const char *", + "comment": "The username of the credential." + }, + { + "name": "password", + "type": "const char *", + "comment": "The password of the credential." + } + ], + "argline": "git_cred **out, const char *username, const char *password", + "sig": "git_cred **::const char *::const char *", + "return": { + "type": "int", + "comment": " 0 for success or an error code for failure" + }, + "description": "Create a new plain-text username and password credential object.\n The supplied credential parameter will be internally duplicated.
\n", + "comments": "", + "group": "cred" + }, + "git_cred_default_new": { + "type": "function", + "file": "git2/cred.h", + "line": 183, + "lineto": 183, + "args": [ + { + "name": "out", + "type": "git_cred **", + "comment": null + } + ], + "argline": "git_cred **out", + "sig": "git_cred **", + "return": { + "type": "int", + "comment": " 0 for success or an error code for failure" + }, + "description": "Create a "default" credential usable for Negotiate mechanisms like NTLM\n or Kerberos authentication.
\n", + "comments": "", + "group": "cred" + }, + "git_cred_username_new": { + "type": "function", + "file": "git2/cred.h", + "line": 191, + "lineto": 191, + "args": [ + { + "name": "cred", + "type": "git_cred **", + "comment": null + }, + { + "name": "username", + "type": "const char *", + "comment": null + } + ], + "argline": "git_cred **cred, const char *username", + "sig": "git_cred **::const char *", + "return": { + "type": "int", + "comment": null + }, + "description": "Create a credential to specify a username.
\n", + "comments": "This is used with ssh authentication to query for the username if none is specified in the url.
\n", + "group": "cred" + }, + "git_cred_ssh_key_new": { + "type": "function", + "file": "git2/cred.h", + "line": 204, + "lineto": 209, + "args": [ + { + "name": "out", + "type": "git_cred **", + "comment": "The newly created credential object." + }, + { + "name": "username", + "type": "const char *", + "comment": "username to use to authenticate" + }, + { + "name": "publickey", + "type": "const char *", + "comment": "The path to the public key of the credential." + }, + { + "name": "privatekey", + "type": "const char *", + "comment": "The path to the private key of the credential." + }, + { + "name": "passphrase", + "type": "const char *", + "comment": "The passphrase of the credential." + } + ], + "argline": "git_cred **out, const char *username, const char *publickey, const char *privatekey, const char *passphrase", + "sig": "git_cred **::const char *::const char *::const char *::const char *", + "return": { + "type": "int", + "comment": " 0 for success or an error code for failure" + }, + "description": "Create a new passphrase-protected ssh key credential object.\n The supplied credential parameter will be internally duplicated.
\n", + "comments": "", + "group": "cred" + }, + "git_cred_ssh_key_memory_new": { + "type": "function", + "file": "git2/cred.h", + "line": 221, + "lineto": 226, + "args": [ + { + "name": "out", + "type": "git_cred **", + "comment": "The newly created credential object." + }, + { + "name": "username", + "type": "const char *", + "comment": "username to use to authenticate." + }, + { + "name": "publickey", + "type": "const char *", + "comment": "The public key of the credential." + }, + { + "name": "privatekey", + "type": "const char *", + "comment": "The private key of the credential." + }, + { + "name": "passphrase", + "type": "const char *", + "comment": "The passphrase of the credential." + } + ], + "argline": "git_cred **out, const char *username, const char *publickey, const char *privatekey, const char *passphrase", + "sig": "git_cred **::const char *::const char *::const char *::const char *", + "return": { + "type": "int", + "comment": " 0 for success or an error code for failure" + }, + "description": "Create a new ssh key credential object reading the keys from memory.
\n", + "comments": "", + "group": "cred" + }, + "git_cred_ssh_interactive_new": { + "type": "function", + "file": "git2/cred.h", + "line": 256, + "lineto": 260, + "args": [ + { + "name": "out", + "type": "git_cred **", + "comment": null + }, + { + "name": "username", + "type": "const char *", + "comment": "Username to use to authenticate." + }, + { + "name": "prompt_callback", + "type": "git_cred_ssh_interactive_cb", + "comment": "The callback method used for prompts." + }, + { + "name": "payload", + "type": "void *", + "comment": "Additional data to pass to the callback." + } + ], + "argline": "git_cred **out, const char *username, git_cred_ssh_interactive_cb prompt_callback, void *payload", + "sig": "git_cred **::const char *::git_cred_ssh_interactive_cb::void *", + "return": { + "type": "int", + "comment": " 0 for success or an error code for failure." + }, + "description": "Create a new ssh keyboard-interactive based credential object.\n The supplied credential parameter will be internally duplicated.
\n", + "comments": "", + "group": "cred" + }, + "git_cred_ssh_key_from_agent": { + "type": "function", + "file": "git2/cred.h", + "line": 270, + "lineto": 272, + "args": [ + { + "name": "out", + "type": "git_cred **", + "comment": "The newly created credential object." + }, + { + "name": "username", + "type": "const char *", + "comment": "username to use to authenticate" + } + ], + "argline": "git_cred **out, const char *username", + "sig": "git_cred **::const char *", + "return": { + "type": "int", + "comment": " 0 for success or an error code for failure" + }, + "description": "Create a new ssh key credential object used for querying an ssh-agent.\n The supplied credential parameter will be internally duplicated.
\n", + "comments": "", + "group": "cred" + }, + "git_cred_ssh_custom_new": { + "type": "function", + "file": "git2/cred.h", + "line": 298, + "lineto": 304, + "args": [ + { + "name": "out", + "type": "git_cred **", + "comment": "The newly created credential object." + }, + { + "name": "username", + "type": "const char *", + "comment": "username to use to authenticate" + }, + { + "name": "publickey", + "type": "const char *", + "comment": "The bytes of the public key." + }, + { + "name": "publickey_len", + "type": "size_t", + "comment": "The length of the public key in bytes." + }, + { + "name": "sign_callback", + "type": "git_cred_sign_cb", + "comment": "The callback method to sign the data during the challenge." + }, + { + "name": "payload", + "type": "void *", + "comment": "Additional data to pass to the callback." + } + ], + "argline": "git_cred **out, const char *username, const char *publickey, size_t publickey_len, git_cred_sign_cb sign_callback, void *payload", + "sig": "git_cred **::const char *::const char *::size_t::git_cred_sign_cb::void *", + "return": { + "type": "int", + "comment": " 0 for success or an error code for failure" + }, + "description": "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_userpass": { "type": "function", "file": "git2/cred_helpers.h", @@ -5927,8 +6295,8 @@ "git_blob_create_fromworkdir": { "type": "function", "file": "git2/deprecated.h", - "line": 81, - "lineto": 81, + "line": 84, + "lineto": 84, "args": [ { "name": "id", @@ -5956,11 +6324,48 @@ "comments": "These functions are retained for backward compatibility. The newer versions of these functions should be preferred in all new code.
\n\nThere is no plan to remove these backward compatibility values at this time.
\n\n@{
\n", "group": "blob" }, + "git_blob_filtered_content": { + "type": "function", + "file": "git2/deprecated.h", + "line": 97, + "lineto": 101, + "args": [ + { + "name": "out", + "type": "git_buf *", + "comment": null + }, + { + "name": "blob", + "type": "git_blob *", + "comment": null + }, + { + "name": "as_path", + "type": "const char *", + "comment": null + }, + { + "name": "check_for_binary_data", + "type": "int", + "comment": null + } + ], + "argline": "git_buf *out, git_blob *blob, const char *as_path, int check_for_binary_data", + "sig": "git_buf *::git_blob *::const char *::int", + "return": { + "type": "int", + "comment": null + }, + "description": "Deprecated in favor of
\n", + "comments": "", + "group": "blob" + }, "git_buf_free": { "type": "function", "file": "git2/deprecated.h", - "line": 123, - "lineto": 123, + "line": 126, + "lineto": 126, "args": [ { "name": "buffer", @@ -5981,8 +6386,8 @@ "giterr_last": { "type": "function", "file": "git2/deprecated.h", - "line": 197, - "lineto": 197, + "line": 200, + "lineto": 200, "args": [], "argline": "", "sig": "", @@ -5997,8 +6402,8 @@ "giterr_clear": { "type": "function", "file": "git2/deprecated.h", - "line": 209, - "lineto": 209, + "line": 212, + "lineto": 212, "args": [], "argline": "", "sig": "", @@ -6013,8 +6418,8 @@ "giterr_set_str": { "type": "function", "file": "git2/deprecated.h", - "line": 221, - "lineto": 221, + "line": 224, + "lineto": 224, "args": [ { "name": "error_class", @@ -6040,8 +6445,8 @@ "giterr_set_oom": { "type": "function", "file": "git2/deprecated.h", - "line": 233, - "lineto": 233, + "line": 236, + "lineto": 236, "args": [], "argline": "", "sig": "", @@ -6056,8 +6461,8 @@ "git_object__size": { "type": "function", "file": "git2/deprecated.h", - "line": 323, - "lineto": 323, + "line": 326, + "lineto": 326, "args": [ { "name": "type", @@ -6078,8 +6483,8 @@ "git_oid_iszero": { "type": "function", "file": "git2/deprecated.h", - "line": 397, - "lineto": 397, + "line": 400, + "lineto": 400, "args": [ { "name": "id", @@ -6100,8 +6505,8 @@ "git_blame_init_options": { "type": "function", "file": "git2/deprecated.h", - "line": 456, - "lineto": 456, + "line": 459, + "lineto": 459, "args": [ { "name": "opts", @@ -6906,8 +7311,8 @@ "git_diff_print": { "type": "function", "file": "git2/diff.h", - "line": 1110, - "lineto": 1114, + "line": 1111, + "lineto": 1115, "args": [ { "name": "diff", @@ -6951,8 +7356,8 @@ "git_diff_to_buf": { "type": "function", "file": "git2/diff.h", - "line": 1126, - "lineto": 1129, + "line": 1127, + "lineto": 1130, "args": [ { "name": "out", @@ -6983,8 +7388,8 @@ "git_diff_blobs": { "type": "function", "file": "git2/diff.h", - "line": 1166, - "lineto": 1176, + "line": 1167, + "lineto": 1177, "args": [ { "name": "old_blob", @@ -7050,8 +7455,8 @@ "git_diff_blob_to_buffer": { "type": "function", "file": "git2/diff.h", - "line": 1203, - "lineto": 1214, + "line": 1204, + "lineto": 1215, "args": [ { "name": "old_blob", @@ -7122,8 +7527,8 @@ "git_diff_buffers": { "type": "function", "file": "git2/diff.h", - "line": 1237, - "lineto": 1249, + "line": 1238, + "lineto": 1250, "args": [ { "name": "old_buffer", @@ -7199,8 +7604,8 @@ "git_diff_from_buffer": { "type": "function", "file": "git2/diff.h", - "line": 1270, - "lineto": 1273, + "line": 1271, + "lineto": 1274, "args": [ { "name": "out", @@ -7236,8 +7641,8 @@ "git_diff_get_stats": { "type": "function", "file": "git2/diff.h", - "line": 1309, - "lineto": 1311, + "line": 1310, + "lineto": 1312, "args": [ { "name": "out", @@ -7268,8 +7673,8 @@ "git_diff_stats_files_changed": { "type": "function", "file": "git2/diff.h", - "line": 1319, - "lineto": 1320, + "line": 1320, + "lineto": 1321, "args": [ { "name": "stats", @@ -7290,8 +7695,8 @@ "git_diff_stats_insertions": { "type": "function", "file": "git2/diff.h", - "line": 1328, - "lineto": 1329, + "line": 1329, + "lineto": 1330, "args": [ { "name": "stats", @@ -7312,8 +7717,8 @@ "git_diff_stats_deletions": { "type": "function", "file": "git2/diff.h", - "line": 1337, - "lineto": 1338, + "line": 1338, + "lineto": 1339, "args": [ { "name": "stats", @@ -7334,8 +7739,8 @@ "git_diff_stats_to_buf": { "type": "function", "file": "git2/diff.h", - "line": 1349, - "lineto": 1353, + "line": 1350, + "lineto": 1354, "args": [ { "name": "out", @@ -7376,8 +7781,8 @@ "git_diff_stats_free": { "type": "function", "file": "git2/diff.h", - "line": 1361, - "lineto": 1361, + "line": 1362, + "lineto": 1362, "args": [ { "name": "stats", @@ -7403,8 +7808,8 @@ "git_diff_format_email": { "type": "function", "file": "git2/diff.h", - "line": 1413, - "lineto": 1416, + "line": 1415, + "lineto": 1418, "args": [ { "name": "out", @@ -7435,8 +7840,8 @@ "git_diff_commit_as_email": { "type": "function", "file": "git2/diff.h", - "line": 1432, - "lineto": 1439, + "line": 1434, + "lineto": 1441, "args": [ { "name": "out", @@ -7465,7 +7870,7 @@ }, { "name": "flags", - "type": "git_diff_format_email_flags_t", + "type": "uint32_t", "comment": "determines the formatting of the e-mail" }, { @@ -7474,8 +7879,8 @@ "comment": "structure with options to influence diff or NULL for defaults." } ], - "argline": "git_buf *out, git_repository *repo, git_commit *commit, size_t patch_no, size_t total_patches, git_diff_format_email_flags_t flags, const git_diff_options *diff_opts", - "sig": "git_buf *::git_repository *::git_commit *::size_t::size_t::git_diff_format_email_flags_t::const git_diff_options *", + "argline": "git_buf *out, git_repository *repo, git_commit *commit, size_t patch_no, size_t total_patches, uint32_t flags, const git_diff_options *diff_opts", + "sig": "git_buf *::git_repository *::git_commit *::size_t::size_t::uint32_t::const git_diff_options *", "return": { "type": "int", "comment": " 0 or an error code" @@ -7487,8 +7892,8 @@ "git_diff_format_email_options_init": { "type": "function", "file": "git2/diff.h", - "line": 1451, - "lineto": 1453, + "line": 1453, + "lineto": 1455, "args": [ { "name": "opts", @@ -7514,8 +7919,8 @@ "git_diff_patchid_options_init": { "type": "function", "file": "git2/diff.h", - "line": 1479, - "lineto": 1481, + "line": 1481, + "lineto": 1483, "args": [ { "name": "opts", @@ -7541,8 +7946,8 @@ "git_diff_patchid": { "type": "function", "file": "git2/diff.h", - "line": 1502, - "lineto": 1502, + "line": 1504, + "lineto": 1504, "args": [ { "name": "out", @@ -7587,10 +7992,10 @@ "group": "error", "examples": { "checkout.c": [ - "ex/HEAD/checkout.html#git_error_last-8", - "ex/HEAD/checkout.html#git_error_last-9", - "ex/HEAD/checkout.html#git_error_last-10", - "ex/HEAD/checkout.html#git_error_last-11" + "ex/HEAD/checkout.html#git_error_last-11", + "ex/HEAD/checkout.html#git_error_last-12", + "ex/HEAD/checkout.html#git_error_last-13", + "ex/HEAD/checkout.html#git_error_last-14" ], "general.c": [ "ex/HEAD/general.html#git_error_last-33" @@ -11088,8 +11493,8 @@ "git_object_lookup": { "type": "function", "file": "git2/object.h", - "line": 42, - "lineto": 46, + "line": 44, + "lineto": 48, "args": [ { "name": "object", @@ -11133,8 +11538,8 @@ "git_object_lookup_prefix": { "type": "function", "file": "git2/object.h", - "line": 75, - "lineto": 80, + "line": 77, + "lineto": 82, "args": [ { "name": "object_out", @@ -11175,8 +11580,8 @@ "git_object_lookup_bypath": { "type": "function", "file": "git2/object.h", - "line": 93, - "lineto": 97, + "line": 95, + "lineto": 99, "args": [ { "name": "out", @@ -11212,8 +11617,8 @@ "git_object_id": { "type": "function", "file": "git2/object.h", - "line": 105, - "lineto": 105, + "line": 107, + "lineto": 107, "args": [ { "name": "obj", @@ -11259,8 +11664,8 @@ "git_object_short_id": { "type": "function", "file": "git2/object.h", - "line": 119, - "lineto": 119, + "line": 121, + "lineto": 121, "args": [ { "name": "out", @@ -11291,8 +11696,8 @@ "git_object_type": { "type": "function", "file": "git2/object.h", - "line": 127, - "lineto": 127, + "line": 129, + "lineto": 129, "args": [ { "name": "obj", @@ -11323,8 +11728,8 @@ "git_object_owner": { "type": "function", "file": "git2/object.h", - "line": 141, - "lineto": 141, + "line": 143, + "lineto": 143, "args": [ { "name": "obj", @@ -11345,8 +11750,8 @@ "git_object_free": { "type": "function", "file": "git2/object.h", - "line": 158, - "lineto": 158, + "line": 160, + "lineto": 160, "args": [ { "name": "object", @@ -11398,8 +11803,8 @@ "git_object_type2string": { "type": "function", "file": "git2/object.h", - "line": 169, - "lineto": 169, + "line": 171, + "lineto": 171, "args": [ { "name": "type", @@ -11432,8 +11837,8 @@ "git_object_string2type": { "type": "function", "file": "git2/object.h", - "line": 177, - "lineto": 177, + "line": 179, + "lineto": 179, "args": [ { "name": "str", @@ -11454,8 +11859,8 @@ "git_object_typeisloose": { "type": "function", "file": "git2/object.h", - "line": 186, - "lineto": 186, + "line": 188, + "lineto": 188, "args": [ { "name": "type", @@ -11476,8 +11881,8 @@ "git_object_peel": { "type": "function", "file": "git2/object.h", - "line": 211, - "lineto": 214, + "line": 213, + "lineto": 216, "args": [ { "name": "peeled", @@ -11508,8 +11913,8 @@ "git_object_dup": { "type": "function", "file": "git2/object.h", - "line": 223, - "lineto": 223, + "line": 225, + "lineto": 225, "args": [ { "name": "dest", @@ -11967,7 +12372,7 @@ }, { "name": "size", - "type": "git_off_t", + "type": "git_object_size_t", "comment": "final size of the object that will be written" }, { @@ -11976,8 +12381,8 @@ "comment": "type of the object that will be written" } ], - "argline": "git_odb_stream **out, git_odb *db, git_off_t size, git_object_t type", - "sig": "git_odb_stream **::git_odb *::git_off_t::git_object_t", + "argline": "git_odb_stream **out, git_odb *db, git_object_size_t size, git_object_t type", + "sig": "git_odb_stream **::git_odb *::git_object_size_t::git_object_t", "return": { "type": "int", "comment": " 0 if the stream was created; error code otherwise" @@ -14554,8 +14959,8 @@ "git_proxy_options_init": { "type": "function", "file": "git2/proxy.h", - "line": 92, - "lineto": 92, + "line": 94, + "lineto": 94, "args": [ { "name": "opts", @@ -15486,6 +15891,10 @@ "comments": "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.
See git_reference_symbolic_create() for rules about valid names.
Check if a reference is a remote tracking branch
\n", "comments": "", - "group": "reference" + "group": "reference", + "examples": { + "checkout.c": [ + "ex/HEAD/checkout.html#git_reference_is_remote-21" + ] + } }, "git_reference_is_tag": { "type": "function", @@ -17852,6 +18274,9 @@ "comments": "The string array must be freed by the user.
\n", "group": "remote", "examples": { + "checkout.c": [ + "ex/HEAD/checkout.html#git_remote_list-22" + ], "remote.c": [ "ex/HEAD/remote.html#git_remote_list-8" ] @@ -19423,7 +19848,7 @@ "group": "repository", "examples": { "checkout.c": [ - "ex/HEAD/checkout.html#git_repository_set_head-12" + "ex/HEAD/checkout.html#git_repository_set_head-23" ] } }, @@ -19482,7 +19907,7 @@ "group": "repository", "examples": { "checkout.c": [ - "ex/HEAD/checkout.html#git_repository_set_head_detached_from_annotated-13" + "ex/HEAD/checkout.html#git_repository_set_head_detached_from_annotated-24" ] } }, @@ -19531,7 +19956,7 @@ "group": "repository", "examples": { "checkout.c": [ - "ex/HEAD/checkout.html#git_repository_state-14" + "ex/HEAD/checkout.html#git_repository_state-25" ], "merge.c": [ "ex/HEAD/merge.html#git_repository_state-35" @@ -21231,6 +21656,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).
Set up a new git submodule for checkout.
\n", - "comments": "This does "git submodule add" up to the fetch and checkout of the submodule contents. It preps a new submodule, creates an entry in .gitmodules and creates an empty initialized repository either at the given path in the working directory or in .git/modules with a gitlink from the working directory to the new repo.
\n\nTo fully emulate "git submodule add" call this function, then open the submodule repo and perform the clone step as needed. Lastly, call git_submodule_add_finalize() to wrap up adding the new submodule and .gitmodules to the index to be ready to commit.
You must call git_submodule_free on the submodule object when done.
This does "git submodule add" up to the fetch and checkout of the submodule contents. It preps a new submodule, creates an entry in .gitmodules and creates an empty initialized repository either at the given path in the working directory or in .git/modules with a gitlink from the working directory to the new repo.
\n\nTo fully emulate "git submodule add" call this function, then open the submodule repo and perform the clone step as needed (if you don't need anything custom see git_submodule_add_clone()). Lastly, call git_submodule_add_finalize() to wrap up adding the new submodule and .gitmodules to the index to be ready to commit.
You must call git_submodule_free on the submodule object when done.
Perform the clone step for a newly created submodule.
\n", + "comments": "This performs the necessary git_clone to setup a newly-created submodule.
If any references remain locked, they will be unlocked without any changes made to them.
\n", "group": "transaction" }, - "git_cred_has_username": { - "type": "function", - "file": "git2/transport.h", - "line": 233, - "lineto": 233, - "args": [ - { - "name": "cred", - "type": "git_cred *", - "comment": "object to check" - } - ], - "argline": "git_cred *cred", - "sig": "git_cred *", - "return": { - "type": "int", - "comment": " 1 if the credential object has non-NULL username, 0 otherwise" - }, - "description": "Check whether a credential object contains username information.
\n", - "comments": "", - "group": "cred" - }, - "git_cred_userpass_plaintext_new": { - "type": "function", - "file": "git2/transport.h", - "line": 244, - "lineto": 247, - "args": [ - { - "name": "out", - "type": "git_cred **", - "comment": "The newly created credential object." - }, - { - "name": "username", - "type": "const char *", - "comment": "The username of the credential." - }, - { - "name": "password", - "type": "const char *", - "comment": "The password of the credential." - } - ], - "argline": "git_cred **out, const char *username, const char *password", - "sig": "git_cred **::const char *::const char *", - "return": { - "type": "int", - "comment": " 0 for success or an error code for failure" - }, - "description": "Create a new plain-text username and password credential object.\n The supplied credential parameter will be internally duplicated.
\n", - "comments": "", - "group": "cred" - }, - "git_cred_ssh_key_new": { - "type": "function", - "file": "git2/transport.h", - "line": 260, - "lineto": 265, - "args": [ - { - "name": "out", - "type": "git_cred **", - "comment": "The newly created credential object." - }, - { - "name": "username", - "type": "const char *", - "comment": "username to use to authenticate" - }, - { - "name": "publickey", - "type": "const char *", - "comment": "The path to the public key of the credential." - }, - { - "name": "privatekey", - "type": "const char *", - "comment": "The path to the private key of the credential." - }, - { - "name": "passphrase", - "type": "const char *", - "comment": "The passphrase of the credential." - } - ], - "argline": "git_cred **out, const char *username, const char *publickey, const char *privatekey, const char *passphrase", - "sig": "git_cred **::const char *::const char *::const char *::const char *", - "return": { - "type": "int", - "comment": " 0 for success or an error code for failure" - }, - "description": "Create a new passphrase-protected ssh key credential object.\n The supplied credential parameter will be internally duplicated.
\n", - "comments": "", - "group": "cred" - }, - "git_cred_ssh_interactive_new": { - "type": "function", - "file": "git2/transport.h", - "line": 276, - "lineto": 280, - "args": [ - { - "name": "out", - "type": "git_cred **", - "comment": null - }, - { - "name": "username", - "type": "const char *", - "comment": "Username to use to authenticate." - }, - { - "name": "prompt_callback", - "type": "git_cred_ssh_interactive_cb", - "comment": "The callback method used for prompts." - }, - { - "name": "payload", - "type": "void *", - "comment": "Additional data to pass to the callback." - } - ], - "argline": "git_cred **out, const char *username, git_cred_ssh_interactive_cb prompt_callback, void *payload", - "sig": "git_cred **::const char *::git_cred_ssh_interactive_cb::void *", - "return": { - "type": "int", - "comment": " 0 for success or an error code for failure." - }, - "description": "Create a new ssh keyboard-interactive based credential object.\n The supplied credential parameter will be internally duplicated.
\n", - "comments": "", - "group": "cred" - }, - "git_cred_ssh_key_from_agent": { - "type": "function", - "file": "git2/transport.h", - "line": 290, - "lineto": 292, - "args": [ - { - "name": "out", - "type": "git_cred **", - "comment": "The newly created credential object." - }, - { - "name": "username", - "type": "const char *", - "comment": "username to use to authenticate" - } - ], - "argline": "git_cred **out, const char *username", - "sig": "git_cred **::const char *", - "return": { - "type": "int", - "comment": " 0 for success or an error code for failure" - }, - "description": "Create a new ssh key credential object used for querying an ssh-agent.\n The supplied credential parameter will be internally duplicated.
\n", - "comments": "", - "group": "cred" - }, - "git_cred_ssh_custom_new": { - "type": "function", - "file": "git2/transport.h", - "line": 312, - "lineto": 318, - "args": [ - { - "name": "out", - "type": "git_cred **", - "comment": "The newly created credential object." - }, - { - "name": "username", - "type": "const char *", - "comment": "username to use to authenticate" - }, - { - "name": "publickey", - "type": "const char *", - "comment": "The bytes of the public key." - }, - { - "name": "publickey_len", - "type": "size_t", - "comment": "The length of the public key in bytes." - }, - { - "name": "sign_callback", - "type": "git_cred_sign_cb", - "comment": "The callback method to sign the data during the challenge." - }, - { - "name": "payload", - "type": "void *", - "comment": "Additional data to pass to the callback." - } - ], - "argline": "git_cred **out, const char *username, const char *publickey, size_t publickey_len, git_cred_sign_cb sign_callback, void *payload", - "sig": "git_cred **::const char *::const char *::size_t::git_cred_sign_cb::void *", - "return": { - "type": "int", - "comment": " 0 for success or an error code for failure" - }, - "description": "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": "git2/transport.h", - "line": 326, - "lineto": 326, - "args": [ - { - "name": "out", - "type": "git_cred **", - "comment": null - } - ], - "argline": "git_cred **out", - "sig": "git_cred **", - "return": { - "type": "int", - "comment": " 0 for success or an error code for failure" - }, - "description": "Create a "default" credential usable for Negotiate mechanisms like NTLM\n or Kerberos authentication.
\n", - "comments": "", - "group": "cred" - }, - "git_cred_username_new": { - "type": "function", - "file": "git2/transport.h", - "line": 334, - "lineto": 334, - "args": [ - { - "name": "cred", - "type": "git_cred **", - "comment": null - }, - { - "name": "username", - "type": "const char *", - "comment": null - } - ], - "argline": "git_cred **cred, const char *username", - "sig": "git_cred **::const char *", - "return": { - "type": "int", - "comment": null - }, - "description": "Create a credential to specify a username.
\n", - "comments": "This is used with ssh authentication to query for the username if none is specified in the url.
\n", - "group": "cred" - }, - "git_cred_ssh_key_memory_new": { - "type": "function", - "file": "git2/transport.h", - "line": 346, - "lineto": 351, - "args": [ - { - "name": "out", - "type": "git_cred **", - "comment": "The newly created credential object." - }, - { - "name": "username", - "type": "const char *", - "comment": "username to use to authenticate." - }, - { - "name": "publickey", - "type": "const char *", - "comment": "The public key of the credential." - }, - { - "name": "privatekey", - "type": "const char *", - "comment": "The private key of the credential." - }, - { - "name": "passphrase", - "type": "const char *", - "comment": "The passphrase of the credential." - } - ], - "argline": "git_cred **out, const char *username, const char *publickey, const char *privatekey, const char *passphrase", - "sig": "git_cred **::const char *::const char *::const char *::const char *", - "return": { - "type": "int", - "comment": " 0 for success or an error code for failure" - }, - "description": "Create a new ssh key credential object reading the keys from memory.
\n", - "comments": "", - "group": "cred" - }, - "git_cred_free": { - "type": "function", - "file": "git2/transport.h", - "line": 362, - "lineto": 362, - "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": "git2/tree.h", @@ -24805,43 +24945,6 @@ "description": "Prune working tree
\n", "comments": "Prune the working tree, that is remove the git data structures on disk. The repository will only be pruned of git_worktree_is_prunable succeeds.
Get a buffer with the filtered content of a blob.
\n", - "comments": "This applies filters as if the blob was being checked out to the working directory under the specified filename. This may apply CRLF filtering or other types of changes depending on the file attributes set for the blob and the content detected in it.
\n\nThe output is written into a git_buf which the caller must free when done (via git_buf_dispose).
If no filters need to be applied, then the out buffer will just be populated with a pointer to the raw content of the blob. In that case, be careful to not free the blob until done with the buffer or copy it into memory you own.
The callback used with git_attr_foreach.
\n", "comments": "This callback will be invoked only once per attribute name, even if there are multiple rules for a given file. The highest priority rule will be used.
\n" }, + "git_transport_certificate_check_cb": { + "type": "callback", + "file": "git2/cert.h", + "line": 71, + "lineto": 71, + "args": [ + { + "name": "cert", + "type": "struct git_cert *", + "comment": "The host certificate" + }, + { + "name": "valid", + "type": "int", + "comment": "Whether the libgit2 checks (OpenSSL or WinHTTP) think\n this certificate is valid" + }, + { + "name": "host", + "type": "const char *", + "comment": "Hostname of the host libgit2 connected to" + }, + { + "name": "payload", + "type": "void *", + "comment": "Payload provided by the caller" + } + ], + "argline": "struct git_cert *cert, int valid, const char *host, void *payload", + "sig": "struct git_cert *::int::const char *::void *", + "return": { + "type": "int", + "comment": " 0 to proceed with the connection, \n<\n 0 to fail the connection\n or > 0 to indicate that the callback refused to act and that\n the existing validity determination should be honored" + }, + "description": "Callback for the user's custom certificate checks.
\n", + "comments": "" + }, "git_checkout_notify_cb": { "type": "callback", "file": "git2/checkout.h", @@ -25175,11 +25314,52 @@ "description": "A config enumeration callback
\n", "comments": "" }, + "git_cred_acquire_cb": { + "type": "callback", + "file": "git2/cred.h", + "line": 130, + "lineto": 135, + "args": [ + { + "name": "cred", + "type": "git_cred **", + "comment": "The newly created credential object." + }, + { + "name": "url", + "type": "const char *", + "comment": "The resource for which we are demanding a credential." + }, + { + "name": "username_from_url", + "type": "const char *", + "comment": "The username that was embedded in a \"user\n@\nhost\"\n remote url, or NULL if not included." + }, + { + "name": "allowed_types", + "type": "unsigned int", + "comment": "A bitmask stating which cred types are OK to return." + }, + { + "name": "payload", + "type": "void *", + "comment": "The payload provided when specifying this callback." + } + ], + "argline": "git_cred **cred, const char *url, const char *username_from_url, unsigned int allowed_types, void *payload", + "sig": "git_cred **::const char *::const char *::unsigned int::void *", + "return": { + "type": "int", + "comment": " 0 for success, \n<\n 0 to indicate an error, > 0 to indicate\n no credential was acquired" + }, + "description": "Credential acquisition callback.
\n", + "comments": "This callback is usually involved any time another system might need authentication. As such, you are expected to provide a valid git_cred object back, depending on allowed_types (a git_credtype_t bitmask).
\n\nNote that most authentication details are your responsibility - this callback will be called until the authentication succeeds, or you report an error. As such, it's easy to get in a loop if you fail to stop providing the same incorrect credentials.
\n" + }, "git_headlist_cb": { "type": "callback", "file": "git2/deprecated.h", - "line": 442, - "lineto": 442, + "line": 445, + "lineto": 445, "args": [ { "name": "rhead", @@ -26043,11 +26223,42 @@ "description": "An instance for a tracing function
\n", "comments": "" }, + "git_transport_message_cb": { + "type": "callback", + "file": "git2/transport.h", + "line": 34, + "lineto": 34, + "args": [ + { + "name": "str", + "type": "const char *", + "comment": "The message from the transport" + }, + { + "name": "len", + "type": "int", + "comment": "The length of the message" + }, + { + "name": "payload", + "type": "void *", + "comment": "Payload provided by the caller" + } + ], + "argline": "const char *str, int len, void *payload", + "sig": "const char *::int::void *", + "return": { + "type": "int", + "comment": null + }, + "description": "Callback for messages recieved by the transport.
\n", + "comments": "Return a negative value to cancel the network operation.
\n" + }, "git_transport_cb": { "type": "callback", "file": "git2/transport.h", - "line": 24, - "lineto": 24, + "line": 37, + "lineto": 37, "args": [ { "name": "out", @@ -26074,47 +26285,6 @@ "description": "Signature of a function which creates a transport
\n", "comments": "" }, - "git_cred_acquire_cb": { - "type": "callback", - "file": "git2/transport.h", - "line": 376, - "lineto": 381, - "args": [ - { - "name": "cred", - "type": "git_cred **", - "comment": "The newly created credential object." - }, - { - "name": "url", - "type": "const char *", - "comment": "The resource for which we are demanding a credential." - }, - { - "name": "username_from_url", - "type": "const char *", - "comment": "The username that was embedded in a \"user\n@\nhost\"\n remote url, or NULL if not included." - }, - { - "name": "allowed_types", - "type": "unsigned int", - "comment": "A bitmask stating which cred types are OK to return." - }, - { - "name": "payload", - "type": "void *", - "comment": "The payload provided when specifying this callback." - } - ], - "argline": "git_cred **cred, const char *url, const char *username_from_url, unsigned int allowed_types, void *payload", - "sig": "git_cred **::const char *::const char *::unsigned int::void *", - "return": { - "type": "int", - "comment": " 0 for success, \n<\n 0 to indicate an error, > 0 to indicate\n no credential was acquired" - }, - "description": "Signature of a function which acquires a credential object.
\n", - "comments": "" - }, "git_treebuilder_filter_cb": { "type": "callback", "file": "git2/tree.h", @@ -26171,73 +26341,6 @@ }, "description": "Callback for the tree traversal method
\n", "comments": "" - }, - "git_transport_message_cb": { - "type": "callback", - "file": "git2/types.h", - "line": 255, - "lineto": 255, - "args": [ - { - "name": "str", - "type": "const char *", - "comment": "The message from the transport" - }, - { - "name": "len", - "type": "int", - "comment": "The length of the message" - }, - { - "name": "payload", - "type": "void *", - "comment": "Payload provided by the caller" - } - ], - "argline": "const char *str, int len, void *payload", - "sig": "const char *::int::void *", - "return": { - "type": "int", - "comment": null - }, - "description": "Type for messages delivered by the transport. Return a negative value\n to cancel the network operation.
\n", - "comments": "" - }, - "git_transport_certificate_check_cb": { - "type": "callback", - "file": "git2/types.h", - "line": 308, - "lineto": 308, - "args": [ - { - "name": "cert", - "type": "git_cert *", - "comment": "The host certificate" - }, - { - "name": "valid", - "type": "int", - "comment": "Whether the libgit2 checks (OpenSSL or WinHTTP) think\n this certificate is valid" - }, - { - "name": "host", - "type": "const char *", - "comment": "Hostname of the host libgit2 connected to" - }, - { - "name": "payload", - "type": "void *", - "comment": "Payload provided by the caller" - } - ], - "argline": "git_cert *cert, int valid, const char *host, void *payload", - "sig": "git_cert *::int::const char *::void *", - "return": { - "type": "int", - "comment": " 0 to proceed with the connection, \n<\n 0 to fail the connection\n or > 0 to indicate that the callback refused to act and that\n the existing validity determination should be honored" - }, - "description": "Callback for the user's custom certificate checks.
\n", - "comments": "" } }, "globals": {}, @@ -26249,8 +26352,8 @@ "type": "struct", "value": "git_annotated_commit", "file": "git2/types.h", - "line": 186, - "lineto": 186, + "line": 189, + "lineto": 189, "tdef": "typedef", "description": " Annotated commits, the input to merge and rebase. ", "comments": "", @@ -26275,6 +26378,34 @@ } } ], + [ + "git_apply_flags_t", + { + "decl": [ + "GIT_APPLY_CHECK" + ], + "type": "enum", + "file": "git2/apply.h", + "line": 57, + "lineto": 63, + "block": "GIT_APPLY_CHECK", + "tdef": "typedef", + "description": " Flags controlling the behavior of git_apply ", + "comments": "", + "fields": [ + { + "type": "int", + "name": "GIT_APPLY_CHECK", + "comments": "Don't actually make changes, just test that the patch applies.\n This is the equivalent of git apply --check.
Initialize with GIT_APPLY_OPTIONS_INIT. Alternatively, you can use git_apply_options_init.
When set, filters will be loaded from a .gitattributes file\n in the HEAD commit.
SHA-1 is available
\n", "value": 2 + }, + { + "type": "int", + "name": "GIT_CERT_SSH_SHA256", + "comments": "SHA-256 is available
\n", + "value": 4 } ], "used": { @@ -27057,9 +27205,9 @@ "GIT_CERT_STRARRAY" ], "type": "enum", - "file": "git2/types.h", - "line": 261, - "lineto": 284, + "file": "git2/cert.h", + "line": 24, + "lineto": 47, "block": "GIT_CERT_NONE\nGIT_CERT_X509\nGIT_CERT_HOSTKEY_LIBSSH2\nGIT_CERT_STRARRAY\nGIT_CERT_NONE\nGIT_CERT_X509\nGIT_CERT_HOSTKEY_LIBSSH2\nGIT_CERT_STRARRAY", "tdef": "typedef", "description": " Type of host certificate structure that is passed to the check callback", @@ -27100,22 +27248,22 @@ "git_cert_x509", { "decl": [ - "git_cert parent", + "struct git_cert parent", "void * data", "size_t len" ], "type": "struct", "value": "git_cert_x509", - "file": "git2/transport.h", - "line": 64, - "lineto": 76, - "block": "git_cert parent\nvoid * data\nsize_t len", + "file": "git2/cert.h", + "line": 119, + "lineto": 131, + "block": "struct git_cert parent\nvoid * data\nsize_t len", "tdef": "typedef", "description": " X.509 certificate information", "comments": "", "fields": [ { - "type": "git_cert", + "type": "struct git_cert", "name": "parent", "comments": " The parent cert " }, @@ -27234,6 +27382,7 @@ "void * perfdata_payload" ], "type": "struct", + "value": "git_checkout_options", "file": "git2/checkout.h", "line": 263, "lineto": 326, @@ -27354,8 +27503,7 @@ "git_reset", "git_reset_from_annotated" ] - }, - "value": "git_checkout_options" + } } ], [ @@ -27637,14 +27785,10 @@ "file": "git2/clone.h", "line": 33, "lineto": 53, + "block": "GIT_CLONE_LOCAL_AUTO\nGIT_CLONE_LOCAL\nGIT_CLONE_NO_LOCAL\nGIT_CLONE_LOCAL_NO_LINKS", "tdef": "typedef", "description": " Options for bypassing the git-aware transport on clone. Bypassing\n it means that instead of a fetch, libgit2 will copy the object\n database directory instead of figuring out what it needs, which is\n faster. If possible, it will hardlink the files to save space.", "comments": "", - "used": { - "returns": [], - "needs": [] - }, - "block": "GIT_CLONE_LOCAL_AUTO\nGIT_CLONE_LOCAL\nGIT_CLONE_NO_LOCAL\nGIT_CLONE_LOCAL_NO_LINKS", "fields": [ { "type": "int", @@ -27670,7 +27814,11 @@ "comments": "Bypass the git-aware transport, but do not try to use\n hardlinks.
\n", "value": 3 } - ] + ], + "used": { + "returns": [], + "needs": [] + } } ], [ @@ -27693,17 +27841,10 @@ "file": "git2/clone.h", "line": 103, "lineto": 164, + "block": "unsigned int version\ngit_checkout_options checkout_opts\ngit_fetch_options fetch_opts\nint bare\ngit_clone_local_t local\nconst char * checkout_branch\ngit_repository_create_cb repository_cb\nvoid * repository_cb_payload\ngit_remote_create_cb remote_cb\nvoid * remote_cb_payload", "tdef": "typedef", "description": " Clone options structure", "comments": "Initialize with GIT_CLONE_OPTIONS_INIT. Alternatively, you can use git_clone_options_init.
Initialize with GIT_DESCRIBE_FORMAT_OPTIONS_INIT. Alternatively, you can use git_describe_format_options_init.
Although this is called a "file", it could represent a file, a symbolic link, a submodule commit id, or even a tree (although that only if you are tracking type changes or ignored/untracked directories).
\n\nThe id is the git_oid of the item. If the entry represents an absent side of a diff (e.g. the old_file of a GIT_DELTA_ADDED delta), then the oid will be zeroes.
path is the NUL-terminated path to the entry relative to the working directory of the repository.
size is the size of the entry in bytes.
flags is a combination of the git_diff_flag_t types
mode is, roughly, the stat() st_mode value for the item. This will be restricted to one of the git_filemode_t values.
The id_abbrev represents the known length of the id field, when converted to a hex string. It is generally GIT_OID_HEXSZ, unless this delta was created from reading a patch file, in which case it may be abbreviated to something reasonable, like 7 characters.
like git diff --name-status
\n", "value": 5 + }, + { + "type": "int", + "name": "GIT_DIFF_FORMAT_PATCH_ID", + "comments": "git diff as used by git patch-id
\n", + "value": 6 } ], "used": { @@ -29601,6 +29581,7 @@ "char [128] header" ], "type": "struct", + "value": "git_diff_hunk", "file": "git2/diff.h", "line": 545, "lineto": 552, @@ -29652,8 +29633,7 @@ "git_diff_line_cb", "git_patch_get_hunk" ] - }, - "value": "git_diff_hunk" + } } ], [ @@ -29669,6 +29649,7 @@ "const char * content" ], "type": "struct", + "value": "git_diff_line", "file": "git2/diff.h", "line": 600, "lineto": 608, @@ -29725,8 +29706,7 @@ "git_patch_get_line_in_hunk", "git_patch_print" ] - }, - "value": "git_diff_line" + } } ], [ @@ -30168,26 +30148,26 @@ "type": "struct", "value": "git_diff_patchid_options", "file": "git2/diff.h", - "line": 1462, - "lineto": 1464, + "line": 1464, + "lineto": 1466, + "block": "unsigned int version", "tdef": "typedef", "description": " Patch ID options structure", "comments": "Initialize with GIT_PATCHID_OPTIONS_INIT. Alternatively, you can use git_diff_patchid_options_init.
Force pruning off
\n", "value": 2 } - ] + ], + "used": { + "returns": [], + "needs": [] + } } ], [ @@ -31063,8 +31043,8 @@ ], "type": "enum", "file": "git2/types.h", - "line": 210, - "lineto": 217, + "line": 213, + "lineto": 220, "block": "GIT_FILEMODE_UNREADABLE\nGIT_FILEMODE_TREE\nGIT_FILEMODE_BLOB\nGIT_FILEMODE_BLOB_EXECUTABLE\nGIT_FILEMODE_LINK\nGIT_FILEMODE_COMMIT", "tdef": "typedef", "description": " Valid modes for index and tree entries. ", @@ -31346,9 +31326,10 @@ { "decl": "git_index", "type": "struct", + "value": "git_index", "file": "git2/types.h", - "line": 136, - "lineto": 136, + "line": 139, + "lineto": 139, "tdef": "typedef", "description": " Memory representation of an index file. ", "comments": "", @@ -31425,8 +31406,7 @@ "git_repository_index", "git_revert_commit" ] - }, - "value": "git_index" + } } ], [ @@ -31442,14 +31422,10 @@ "file": "git2/index.h", "line": 139, "lineto": 144, + "block": "GIT_INDEX_ADD_DEFAULT\nGIT_INDEX_ADD_FORCE\nGIT_INDEX_ADD_DISABLE_PATHSPEC_MATCH\nGIT_INDEX_ADD_CHECK_PATHSPEC", "tdef": "typedef", "description": " Flags for APIs that add files matching pathspec ", "comments": "", - "used": { - "returns": [], - "needs": [] - }, - "block": "GIT_INDEX_ADD_DEFAULT\nGIT_INDEX_ADD_FORCE\nGIT_INDEX_ADD_DISABLE_PATHSPEC_MATCH\nGIT_INDEX_ADD_CHECK_PATHSPEC", "fields": [ { "type": "int", @@ -31475,7 +31451,11 @@ "comments": "", "value": 4 } - ] + ], + "used": { + "returns": [], + "needs": [] + } } ], [ @@ -31532,9 +31512,10 @@ { "decl": "git_index_conflict_iterator", "type": "struct", + "value": "git_index_conflict_iterator", "file": "git2/types.h", - "line": 142, - "lineto": 142, + "line": 145, + "lineto": 145, "tdef": "typedef", "description": " An iterator for conflicts in the index. ", "comments": "", @@ -31545,8 +31526,7 @@ "git_index_conflict_iterator_new", "git_index_conflict_next" ] - }, - "value": "git_index_conflict_iterator" + } } ], [ @@ -31567,6 +31547,7 @@ "const char * path" ], "type": "struct", + "value": "git_index_entry", "file": "git2/index.h", "line": 53, "lineto": 70, @@ -31652,8 +31633,7 @@ "git_index_iterator_next", "git_merge_file_from_index" ] - }, - "value": "git_index_entry" + } } ], [ @@ -31669,14 +31649,10 @@ "file": "git2/index.h", "line": 116, "lineto": 123, + "block": "GIT_INDEX_ENTRY_INTENT_TO_ADD\nGIT_INDEX_ENTRY_SKIP_WORKTREE\nGIT_INDEX_ENTRY_EXTENDED_FLAGS\nGIT_INDEX_ENTRY_UPTODATE", "tdef": "typedef", "description": " Bitmasks for on-disk fields of `git_index_entry`'s `flags_extended`", "comments": "In memory, the flags_extended fields are divided into two parts: the fields that are read from and written to disk, and other fields that in-memory only and used by libgit2. Only the flags in GIT_INDEX_ENTRY_EXTENDED_FLAGS will get saved on-disk.
Thee first three bitmasks match the three fields in the git_index_entry flags_extended value that belong on disk. You can use them to interpret the data in the flags_extended.
The rest of the bitmasks match the other fields in the git_index_entry flags_extended value that are only used in-memory by libgit2. You can use them to interpret the data in the flags_extended.
The "theirs" side of a conflict.
\n", "value": 3 } - ] + ], + "used": { + "returns": [], + "needs": [] + } } ], [ @@ -31892,6 +31872,7 @@ "unsigned char verify" ], "type": "struct", + "value": "git_indexer_options", "file": "git2/indexer.h", "line": 62, "lineto": 72, @@ -31927,8 +31908,7 @@ "git_indexer_new", "git_indexer_options_init" ] - }, - "value": "git_indexer_options" + } } ], [ @@ -31948,22 +31928,10 @@ "file": "git2/indexer.h", "line": 24, "lineto": 48, + "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 structure is used to provide callers information about the\n progress of indexing a packfile, either directly or part of a\n fetch or clone that downloads a packfile.", "comments": "", - "used": { - "returns": [ - "git_remote_stats" - ], - "needs": [ - "git_indexer_append", - "git_indexer_commit", - "git_indexer_progress_cb", - "git_odb_write_pack", - "git_packbuilder_write" - ] - }, - "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", "fields": [ { "type": "unsigned int", @@ -32000,7 +31968,19 @@ "name": "received_bytes", "comments": " size of the packfile received up to now " } - ] + ], + "used": { + "returns": [ + "git_remote_stats" + ], + "needs": [ + "git_indexer_append", + "git_indexer_commit", + "git_indexer_progress_cb", + "git_odb_write_pack", + "git_packbuilder_write" + ] + } } ], [ @@ -32227,8 +32207,8 @@ "type": "struct", "value": "git_mailmap", "file": "git2/types.h", - "line": 412, - "lineto": 412, + "line": 357, + "lineto": 357, "tdef": "typedef", "description": " Representation of .mailmap file state. ", "comments": "", @@ -32312,6 +32292,7 @@ { "decl": "git_merge_driver_source", "type": "struct", + "value": "git_merge_driver_source", "file": "git2/sys/merge.h", "line": 41, "lineto": 41, @@ -32321,8 +32302,7 @@ "used": { "returns": [], "needs": [] - }, - "value": "git_merge_driver_source" + } } ], [ @@ -32522,14 +32502,15 @@ "const char * our_label", "const char * their_label", "git_merge_file_favor_t favor", - "git_merge_file_flag_t flags", + "uint32_t flags", "unsigned short marker_size" ], "type": "struct", + "value": "git_merge_file_options", "file": "git2/merge.h", "line": 170, "lineto": 200, - "block": "unsigned int version\nconst char * ancestor_label\nconst char * our_label\nconst char * their_label\ngit_merge_file_favor_t favor\ngit_merge_file_flag_t flags\nunsigned short marker_size", + "block": "unsigned int version\nconst char * ancestor_label\nconst char * our_label\nconst char * their_label\ngit_merge_file_favor_t favor\nuint32_t flags\nunsigned short marker_size", "tdef": "typedef", "description": " Options for merging a file", "comments": "", @@ -32560,7 +32541,7 @@ "comments": " The file to favor in region conflicts. " }, { - "type": "git_merge_file_flag_t", + "type": "uint32_t", "name": "flags", "comments": " see `git_merge_file_flag_t` above " }, @@ -32577,8 +32558,7 @@ "git_merge_file_from_index", "git_merge_file_options_init" ] - }, - "value": "git_merge_file_options" + } } ], [ @@ -32691,21 +32671,21 @@ { "decl": [ "unsigned int version", - "git_merge_flag_t flags", + "uint32_t flags", "unsigned int rename_threshold", "unsigned int target_limit", "git_diff_similarity_metric * metric", "unsigned int recursion_limit", "const char * default_driver", "git_merge_file_favor_t file_favor", - "git_merge_file_flag_t file_flags" + "uint32_t file_flags" ], "type": "struct", "value": "git_merge_options", "file": "git2/merge.h", "line": 246, "lineto": 295, - "block": "unsigned int version\ngit_merge_flag_t flags\nunsigned int rename_threshold\nunsigned int target_limit\ngit_diff_similarity_metric * metric\nunsigned int recursion_limit\nconst char * default_driver\ngit_merge_file_favor_t file_favor\ngit_merge_file_flag_t file_flags", + "block": "unsigned int version\nuint32_t flags\nunsigned int rename_threshold\nunsigned int target_limit\ngit_diff_similarity_metric * metric\nunsigned int recursion_limit\nconst char * default_driver\ngit_merge_file_favor_t file_favor\nuint32_t file_flags", "tdef": "typedef", "description": " Merging options", "comments": "", @@ -32716,7 +32696,7 @@ "comments": "" }, { - "type": "git_merge_flag_t", + "type": "uint32_t", "name": "flags", "comments": " See `git_merge_flag_t` above " }, @@ -32751,7 +32731,7 @@ "comments": " Flags for handling conflicting content, to be used with the standard\n (`text`) merge driver." }, { - "type": "git_merge_file_flag_t", + "type": "uint32_t", "name": "file_flags", "comments": " see `git_merge_file_flag_t` above " } @@ -32826,17 +32806,10 @@ "file": "git2/message.h", "line": 43, "lineto": 46, + "block": "const char * key\nconst char * value", "tdef": "typedef", "description": " Represents a single git message trailer.", "comments": "", - "used": { - "returns": [], - "needs": [ - "git_message_trailer_array_free", - "git_message_trailers" - ] - }, - "block": "const char * key\nconst char * value", "fields": [ { "type": "const char *", @@ -32848,7 +32821,14 @@ "name": "value", "comments": "" } - ] + ], + "used": { + "returns": [], + "needs": [ + "git_message_trailer_array_free", + "git_message_trailers" + ] + } } ], [ @@ -32864,17 +32844,10 @@ "file": "git2/message.h", "line": 54, "lineto": 60, + "block": "git_message_trailer * trailers\nsize_t count\nchar * _trailer_block", "tdef": "typedef", "description": " Represents an array of git message trailers.", "comments": "Struct members under the private comment are private, subject to change and should not be used by callers.
\n", - "used": { - "returns": [], - "needs": [ - "git_message_trailer_array_free", - "git_message_trailers" - ] - }, - "block": "git_message_trailer * trailers\nsize_t count\nchar * _trailer_block", "fields": [ { "type": "git_message_trailer *", @@ -32891,7 +32864,14 @@ "name": "_trailer_block", "comments": "" } - ] + ], + "used": { + "returns": [], + "needs": [ + "git_message_trailer_array_free", + "git_message_trailers" + ] + } } ], [ @@ -32901,8 +32881,8 @@ "type": "struct", "value": "git_note", "file": "git2/types.h", - "line": 157, - "lineto": 157, + "line": 160, + "lineto": 160, "tdef": "typedef", "description": " Representation of a git note ", "comments": "", @@ -32930,6 +32910,7 @@ { "decl": "git_note_iterator", "type": "struct", + "value": "git_note_iterator", "file": "git2/notes.h", "line": 35, "lineto": 35, @@ -32944,8 +32925,7 @@ "git_note_iterator_new", "git_note_next" ] - }, - "value": "git_note_iterator" + } } ], [ @@ -32955,13 +32935,14 @@ "type": "struct", "value": "git_object", "file": "git2/types.h", - "line": 112, - "lineto": 112, + "line": 115, + "lineto": 115, "tdef": "typedef", "description": " Representation of a generic object in a repository ", "comments": "", "used": { "returns": [ + "git_blob_rawsize", "git_object_string2type", "git_object_type", "git_odb_object_type", @@ -33021,38 +33002,12 @@ ], "type": "enum", "file": "git2/types.h", - "line": 70, - "lineto": 79, + "line": 73, + "lineto": 82, + "block": "GIT_OBJECT_ANY\nGIT_OBJECT_INVALID\nGIT_OBJECT_COMMIT\nGIT_OBJECT_TREE\nGIT_OBJECT_BLOB\nGIT_OBJECT_TAG\nGIT_OBJECT_OFS_DELTA\nGIT_OBJECT_REF_DELTA", "tdef": "typedef", "description": " Basic type (loose or packed) of any Git object. ", "comments": "", - "used": { - "returns": [ - "git_object_string2type", - "git_object_type", - "git_odb_object_type", - "git_tag_target_type", - "git_tree_entry_type" - ], - "needs": [ - "git_object__size", - "git_object_lookup", - "git_object_lookup_bypath", - "git_object_lookup_prefix", - "git_object_peel", - "git_object_type2string", - "git_object_typeisloose", - "git_odb_hash", - "git_odb_hashfile", - "git_odb_open_rstream", - "git_odb_open_wstream", - "git_odb_read_header", - "git_odb_write", - "git_reference_peel", - "git_repository_hashfile" - ] - }, - "block": "GIT_OBJECT_ANY\nGIT_OBJECT_INVALID\nGIT_OBJECT_COMMIT\nGIT_OBJECT_TREE\nGIT_OBJECT_BLOB\nGIT_OBJECT_TAG\nGIT_OBJECT_OFS_DELTA\nGIT_OBJECT_REF_DELTA", "fields": [ { "type": "int", @@ -33102,7 +33057,33 @@ "comments": "A delta, base is given by object id.
\n", "value": 7 } - ] + ], + "used": { + "returns": [ + "git_object_string2type", + "git_object_type", + "git_odb_object_type", + "git_tag_target_type", + "git_tree_entry_type" + ], + "needs": [ + "git_object__size", + "git_object_lookup", + "git_object_lookup_bypath", + "git_object_lookup_prefix", + "git_object_peel", + "git_object_type2string", + "git_object_typeisloose", + "git_odb_hash", + "git_odb_hashfile", + "git_odb_open_rstream", + "git_odb_open_wstream", + "git_odb_read_header", + "git_odb_write", + "git_reference_peel", + "git_repository_hashfile" + ] + } } ], [ @@ -33112,8 +33093,8 @@ "type": "struct", "value": "git_odb", "file": "git2/types.h", - "line": 82, - "lineto": 82, + "line": 85, + "lineto": 85, "tdef": "typedef", "description": " An open object database handle. ", "comments": "", @@ -33167,8 +33148,8 @@ "type": "struct", "value": "git_odb_backend", "file": "git2/types.h", - "line": 85, - "lineto": 85, + "line": 88, + "lineto": 88, "tdef": "typedef", "description": " A custom backend in an ODB ", "comments": "", @@ -33232,9 +33213,10 @@ { "decl": "git_odb_object", "type": "struct", + "value": "git_odb_object", "file": "git2/types.h", - "line": 88, - "lineto": 88, + "line": 91, + "lineto": 91, "tdef": "typedef", "description": " An object read from the ODB ", "comments": "", @@ -33250,8 +33232,7 @@ "git_odb_read", "git_odb_read_prefix" ] - }, - "value": "git_odb_object" + } } ], [ @@ -33261,9 +33242,9 @@ "type": "struct", "value": "git_odb_stream", "file": "git2/types.h", - "line": 91, - "lineto": 91, - "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 git_oid *) finalize_write\nvoid (*)(git_odb_stream *) free", + "line": 94, + "lineto": 94, + "block": "git_odb_backend * backend\nunsigned int mode\nvoid * hash_ctx\ngit_object_size_t declared_size\ngit_object_size_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 git_oid *) finalize_write\nvoid (*)(git_odb_stream *) free", "tdef": "typedef", "description": " A stream to read/write from the ODB ", "comments": "", @@ -33284,12 +33265,12 @@ "comments": "" }, { - "type": "git_off_t", + "type": "git_object_size_t", "name": "declared_size", "comments": "" }, { - "type": "git_off_t", + "type": "git_object_size_t", "name": "received_bytes", "comments": "" }, @@ -33376,18 +33357,12 @@ "type": "struct", "value": "git_odb_writepack", "file": "git2/types.h", - "line": 94, - "lineto": 94, + "line": 97, + "lineto": 97, + "block": "git_odb_backend * backend\nint (*)(git_odb_writepack *, const void *, size_t, git_indexer_progress *) append\nint (*)(git_odb_writepack *, git_indexer_progress *) commit\nvoid (*)(git_odb_writepack *) free", "tdef": "typedef", "description": " A stream to write a packfile to the ODB ", "comments": "", - "used": { - "returns": [], - "needs": [ - "git_odb_write_pack" - ] - }, - "block": "git_odb_backend * backend\nint (*)(git_odb_writepack *, const void *, size_t, git_indexer_progress *) append\nint (*)(git_odb_writepack *, git_indexer_progress *) commit\nvoid (*)(git_odb_writepack *) free", "fields": [ { "type": "git_odb_backend *", @@ -33409,7 +33384,13 @@ "name": "free", "comments": "" } - ] + ], + "used": { + "returns": [], + "needs": [ + "git_odb_write_pack" + ] + } } ], [ @@ -33600,6 +33581,7 @@ "size_t count" ], "type": "struct", + "value": "git_oidarray", "file": "git2/oidarray.h", "line": 16, "lineto": 19, @@ -33626,8 +33608,7 @@ "git_merge_bases_many", "git_oidarray_free" ] - }, - "value": "git_oidarray" + } } ], [ @@ -33637,8 +33618,8 @@ "type": "struct", "value": "git_packbuilder", "file": "git2/types.h", - "line": 160, - "lineto": 160, + "line": 163, + "lineto": 163, "tdef": "typedef", "description": " Representation of a git packbuilder ", "comments": "", @@ -33881,6 +33862,7 @@ { "decl": "git_pathspec_match_list", "type": "struct", + "value": "git_pathspec_match_list", "file": "git2/pathspec.h", "line": 25, "lineto": 25, @@ -33901,8 +33883,7 @@ "git_pathspec_match_tree", "git_pathspec_match_workdir" ] - }, - "value": "git_pathspec_match_list" + } } ], [ @@ -33919,19 +33900,12 @@ "type": "struct", "value": "git_proxy_options", "file": "git2/proxy.h", - "line": 42, - "lineto": 77, + "line": 44, + "lineto": 79, + "block": "unsigned int version\ngit_proxy_t type\nconst char * url\ngit_cred_acquire_cb credentials\ngit_transport_certificate_check_cb certificate_check\nvoid * payload", "tdef": "typedef", "description": " Options for connecting through a proxy", "comments": "Note that not all types may be supported, depending on the platform and compilation options.
\n", - "used": { - "returns": [], - "needs": [ - "git_proxy_options_init", - "git_remote_connect" - ] - }, - "block": "unsigned int version\ngit_proxy_t type\nconst char * url\ngit_cred_acquire_cb credentials\ngit_transport_certificate_check_cb certificate_check\nvoid * payload", "fields": [ { "type": "unsigned int", @@ -33963,7 +33937,14 @@ "name": "payload", "comments": " Payload to be provided to the credentials and certificate\n check callbacks." } - ] + ], + "used": { + "returns": [], + "needs": [ + "git_proxy_options_init", + "git_remote_connect" + ] + } } ], [ @@ -33976,8 +33957,8 @@ ], "type": "enum", "file": "git2/proxy.h", - "line": 18, - "lineto": 34, + "line": 20, + "lineto": 36, "block": "GIT_PROXY_NONE\nGIT_PROXY_AUTO\nGIT_PROXY_SPECIFIED", "tdef": "typedef", "description": " The type of proxy to use.", @@ -34015,8 +33996,8 @@ "type": "struct", "value": "git_push", "file": "git2/types.h", - "line": 241, - "lineto": 241, + "line": 244, + "lineto": 244, "tdef": "typedef", "description": " Preparation for a push operation. Can be used to configure what to\n push and the level of parallelism of the packfile builder.", "comments": "", @@ -34046,18 +34027,10 @@ "file": "git2/remote.h", "line": 713, "lineto": 740, + "block": "unsigned int version\nunsigned int pb_parallelism\ngit_remote_callbacks callbacks\ngit_proxy_options proxy_opts\ngit_strarray custom_headers", "tdef": "typedef", "description": " Controls the behavior of a git_push object.", "comments": "", - "used": { - "returns": [], - "needs": [ - "git_push_options_init", - "git_remote_push", - "git_remote_upload" - ] - }, - "block": "unsigned int version\nunsigned int pb_parallelism\ngit_remote_callbacks callbacks\ngit_proxy_options proxy_opts\ngit_strarray custom_headers", "fields": [ { "type": "unsigned int", @@ -34084,7 +34057,15 @@ "name": "custom_headers", "comments": " Extra headers for this push operation" } - ] + ], + "used": { + "returns": [], + "needs": [ + "git_push_options_init", + "git_remote_push", + "git_remote_upload" + ] + } } ], [ @@ -34140,9 +34121,10 @@ { "decl": "git_rebase", "type": "struct", + "value": "git_rebase", "file": "git2/types.h", - "line": 192, - "lineto": 192, + "line": 195, + "lineto": 195, "tdef": "typedef", "description": " Representation of a rebase ", "comments": "", @@ -34168,8 +34150,7 @@ "git_rebase_orig_head_id", "git_rebase_orig_head_name" ] - }, - "value": "git_rebase" + } } ], [ @@ -34231,14 +34212,10 @@ "file": "git2/rebase.h", "line": 96, "lineto": 132, + "block": "GIT_REBASE_OPERATION_PICK\nGIT_REBASE_OPERATION_REWORD\nGIT_REBASE_OPERATION_EDIT\nGIT_REBASE_OPERATION_SQUASH\nGIT_REBASE_OPERATION_FIXUP\nGIT_REBASE_OPERATION_EXEC", "tdef": "typedef", "description": " Type of rebase operation in-progress after calling `git_rebase_next`.", "comments": "", - "used": { - "returns": [], - "needs": [] - }, - "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", "fields": [ { "type": "int", @@ -34276,7 +34253,11 @@ "comments": "No commit will be cherry-picked. The client should run the given\n command and (if successful) continue.
\n", "value": 5 } - ] + ], + "used": { + "returns": [], + "needs": [] + } } ], [ @@ -34297,18 +34278,10 @@ "file": "git2/rebase.h", "line": 32, "lineto": 91, + "block": "unsigned int version\nint quiet\nint inmemory\nconst char * rewrite_notes_ref\ngit_merge_options merge_options\ngit_checkout_options checkout_options\ngit_commit_signing_cb signing_cb\nvoid * payload", "tdef": "typedef", "description": " Rebase options", "comments": "Use to tell the rebase machinery how to operate.
\n", - "used": { - "returns": [], - "needs": [ - "git_rebase_init", - "git_rebase_open", - "git_rebase_options_init" - ] - }, - "block": "unsigned int version\nint quiet\nint inmemory\nconst char * rewrite_notes_ref\ngit_merge_options merge_options\ngit_checkout_options checkout_options\ngit_commit_signing_cb signing_cb\nvoid * payload", "fields": [ { "type": "unsigned int", @@ -34350,7 +34323,15 @@ "name": "payload", "comments": " This will be passed to each of the callbacks in this struct\n as the last parameter." } - ] + ], + "used": { + "returns": [], + "needs": [ + "git_rebase_init", + "git_rebase_open", + "git_rebase_options_init" + ] + } } ], [ @@ -34360,8 +34341,8 @@ "type": "struct", "value": "git_refdb", "file": "git2/types.h", - "line": 97, - "lineto": 97, + "line": 100, + "lineto": 100, "tdef": "typedef", "description": " An open refs database handle. ", "comments": "", @@ -34382,17 +34363,17 @@ { "decl": "git_refdb_backend", "type": "struct", + "value": "git_refdb_backend", "file": "git2/types.h", - "line": 100, - "lineto": 100, + "line": 103, + "lineto": 103, "tdef": "typedef", "description": " A custom backend for refs ", "comments": "", "used": { "returns": [], "needs": [] - }, - "value": "git_refdb_backend" + } } ], [ @@ -34402,8 +34383,8 @@ "type": "struct", "value": "git_reference", "file": "git2/types.h", - "line": 177, - "lineto": 177, + "line": 180, + "lineto": 180, "tdef": "typedef", "description": " In-memory representation of a reference. ", "comments": "", @@ -34523,8 +34504,8 @@ "type": "struct", "value": "git_reference_iterator", "file": "git2/types.h", - "line": 180, - "lineto": 180, + "line": 183, + "lineto": 183, "tdef": "typedef", "description": " Iterator for references ", "comments": "", @@ -34551,18 +34532,12 @@ ], "type": "enum", "file": "git2/types.h", - "line": 195, - "lineto": 200, + "line": 198, + "lineto": 203, + "block": "GIT_REFERENCE_INVALID\nGIT_REFERENCE_DIRECT\nGIT_REFERENCE_SYMBOLIC\nGIT_REFERENCE_ALL", "tdef": "typedef", "description": " Basic type of any Git reference. ", "comments": "", - "used": { - "returns": [ - "git_reference_type" - ], - "needs": [] - }, - "block": "GIT_REFERENCE_INVALID\nGIT_REFERENCE_DIRECT\nGIT_REFERENCE_SYMBOLIC\nGIT_REFERENCE_ALL", "fields": [ { "type": "int", @@ -34588,7 +34563,13 @@ "comments": "", "value": 3 } - ] + ], + "used": { + "returns": [ + "git_reference_type" + ], + "needs": [] + } } ], [ @@ -34598,8 +34579,8 @@ "type": "struct", "value": "git_reflog", "file": "git2/types.h", - "line": 154, - "lineto": 154, + "line": 157, + "lineto": 157, "tdef": "typedef", "description": " Representation of a reference log ", "comments": "", @@ -34631,8 +34612,8 @@ "type": "struct", "value": "git_reflog_entry", "file": "git2/types.h", - "line": 151, - "lineto": 151, + "line": 154, + "lineto": 154, "tdef": "typedef", "description": " Representation of a reference log entry ", "comments": "", @@ -34654,9 +34635,10 @@ { "decl": "git_refspec", "type": "struct", + "value": "git_refspec", "file": "git2/types.h", - "line": 223, - "lineto": 223, + "line": 226, + "lineto": 226, "tdef": "typedef", "description": " A refspec specifies the mapping between remote and local reference\n names when fetch or pushing.", "comments": "", @@ -34677,8 +34659,7 @@ "git_refspec_string", "git_refspec_transform" ] - }, - "value": "git_refspec" + } } ], [ @@ -34688,8 +34669,8 @@ "type": "struct", "value": "git_remote", "file": "git2/types.h", - "line": 229, - "lineto": 229, + "line": 232, + "lineto": 232, "tdef": "typedef", "description": " Git's idea of a remote repository. A remote can be anonymous (in\n which case it does not have backing configuration entires).", "comments": "", @@ -34813,6 +34794,7 @@ "git_url_resolve_cb resolve_url" ], "type": "struct", + "value": "git_remote_callbacks", "file": "git2/remote.h", "line": 497, "lineto": 586, @@ -34900,8 +34882,7 @@ "git_remote_prune", "git_remote_update_tips" ] - }, - "value": "git_remote_callbacks" + } } ], [ @@ -34996,17 +34977,10 @@ "file": "git2/remote.h", "line": 62, "lineto": 82, + "block": "unsigned int version\ngit_repository * repository\nconst char * name\nconst char * fetchspec\nunsigned int flags", "tdef": "typedef", "description": " Remote creation options structure", "comments": "Initialize with GIT_REMOTE_CREATE_OPTIONS_INIT. Alternatively, you can use git_remote_create_options_init.
The spec used the '...' operator, which invokes special semantics.
\n", "value": 4 } - ] + ], + "used": { + "returns": [], + "needs": [] + } } ], [ @@ -35992,9 +35974,10 @@ { "decl": "git_revwalk", "type": "struct", + "value": "git_revwalk", "file": "git2/types.h", - "line": 115, - "lineto": 115, + "line": 118, + "lineto": 118, "tdef": "typedef", "description": " Representation of an in-progress walk through the commits in a repo ", "comments": "", @@ -36020,8 +36003,7 @@ "git_revwalk_simplify_first_parent", "git_revwalk_sorting" ] - }, - "value": "git_revwalk" + } } ], [ @@ -36033,9 +36015,10 @@ "git_time when" ], "type": "struct", + "value": "git_signature", "file": "git2/types.h", - "line": 170, - "lineto": 174, + "line": 173, + "lineto": 177, "block": "char * name\nchar * email\ngit_time when", "tdef": "typedef", "description": " An action signature (e.g. for committers, taggers, etc) ", @@ -36093,8 +36076,7 @@ "git_transaction_set_symbolic_target", "git_transaction_set_target" ] - }, - "value": "git_signature" + } } ], [ @@ -36235,16 +36217,17 @@ { "decl": [ "unsigned int version", - "git_stash_apply_flags flags", + "uint32_t flags", "git_checkout_options checkout_options", "git_stash_apply_progress_cb progress_cb", "void * progress_payload" ], "type": "struct", + "value": "git_stash_apply_options", "file": "git2/stash.h", "line": 126, "lineto": 138, - "block": "unsigned int version\ngit_stash_apply_flags flags\ngit_checkout_options checkout_options\ngit_stash_apply_progress_cb progress_cb\nvoid * progress_payload", + "block": "unsigned int version\nuint32_t flags\ngit_checkout_options checkout_options\ngit_stash_apply_progress_cb progress_cb\nvoid * progress_payload", "tdef": "typedef", "description": " Stash application options structure", "comments": "Initialize with GIT_STASH_APPLY_OPTIONS_INIT. Alternatively, you can use git_stash_apply_options_init.
All ignored files are also stashed and then cleaned up from\n the working directory
\n", "value": 4 } - ] + ], + "used": { + "returns": [], + "needs": [] + } } ], [ @@ -36423,6 +36405,7 @@ "git_diff_delta * index_to_workdir" ], "type": "struct", + "value": "git_status_entry", "file": "git2/status.h", "line": 230, "lineto": 234, @@ -36452,8 +36435,7 @@ "git_status_byindex" ], "needs": [] - }, - "value": "git_status_entry" + } } ], [ @@ -36463,8 +36445,8 @@ "type": "struct", "value": "git_status_list", "file": "git2/types.h", - "line": 189, - "lineto": 189, + "line": 192, + "lineto": 192, "tdef": "typedef", "description": " Representation of a status collection ", "comments": "", @@ -36623,6 +36605,7 @@ "git_tree * baseline" ], "type": "struct", + "value": "git_status_options", "file": "git2/status.h", "line": 170, "lineto": 197, @@ -36664,8 +36647,7 @@ "git_status_list_new", "git_status_options_init" ] - }, - "value": "git_status_options" + } } ], [ @@ -36841,9 +36823,22 @@ "file": "git2/strarray.h", "line": 22, "lineto": 25, + "block": "char ** strings\nsize_t count", "tdef": "typedef", "description": " Array of strings ", "comments": "", + "fields": [ + { + "type": "char **", + "name": "strings", + "comments": "" + }, + { + "type": "size_t", + "name": "count", + "comments": "" + } + ], "used": { "returns": [], "needs": [ @@ -36868,20 +36863,7 @@ "git_tag_list_match", "git_worktree_list" ] - }, - "block": "char ** strings\nsize_t count", - "fields": [ - { - "type": "char **", - "name": "strings", - "comments": "" - }, - { - "type": "size_t", - "name": "count", - "comments": "" - } - ] + } } ], [ @@ -36924,9 +36906,10 @@ { "decl": "git_submodule", "type": "struct", + "value": "git_submodule", "file": "git2/types.h", - "line": 313, - "lineto": 313, + "line": 258, + "lineto": 258, "tdef": "typedef", "description": " Opaque structure representing a submodule.", "comments": "", @@ -36942,6 +36925,7 @@ "git_submodule_add_to_index", "git_submodule_branch", "git_submodule_cb", + "git_submodule_clone", "git_submodule_fetch_recurse_submodules", "git_submodule_foreach", "git_submodule_free", @@ -36968,8 +36952,7 @@ "git_submodule_url", "git_submodule_wd_id" ] - }, - "value": "git_submodule" + } } ], [ @@ -36984,8 +36967,8 @@ ], "type": "enum", "file": "git2/types.h", - "line": 377, - "lineto": 384, + "line": 322, + "lineto": 329, "block": "GIT_SUBMODULE_IGNORE_UNSPECIFIED\nGIT_SUBMODULE_IGNORE_NONE\nGIT_SUBMODULE_IGNORE_UNTRACKED\nGIT_SUBMODULE_IGNORE_DIRTY\nGIT_SUBMODULE_IGNORE_ALL", "tdef": "typedef", "description": " Submodule ignore values", @@ -37043,8 +37026,8 @@ ], "type": "enum", "file": "git2/types.h", - "line": 396, - "lineto": 400, + "line": 341, + "lineto": 345, "block": "GIT_SUBMODULE_RECURSE_NO\nGIT_SUBMODULE_RECURSE_YES\nGIT_SUBMODULE_RECURSE_ONDEMAND", "tdef": "typedef", "description": " Options for submodule recurse.", @@ -37212,17 +37195,10 @@ "file": "git2/submodule.h", "line": 128, "lineto": 153, + "block": "unsigned int version\ngit_checkout_options checkout_opts\ngit_fetch_options fetch_opts\nint allow_fetch", "tdef": "typedef", "description": " Submodule update options structure", "comments": "Initialize with GIT_SUBMODULE_UPDATE_OPTIONS_INIT. Alternatively, you can use git_submodule_update_options_init.
Exceptionally detailed debugging data
\n", "value": 6 } - ] + ], + "used": { + "returns": [], + "needs": [ + "git_trace_cb", + "git_trace_set" + ] + } } ], [ @@ -37464,8 +37448,8 @@ "type": "struct", "value": "git_transaction", "file": "git2/types.h", - "line": 183, - "lineto": 183, + "line": 186, + "lineto": 186, "tdef": "typedef", "description": " Transactional interface to references ", "comments": "", @@ -37492,8 +37476,8 @@ "type": "struct", "value": "git_transport", "file": "git2/types.h", - "line": 235, - "lineto": 235, + "line": 238, + "lineto": 238, "tdef": "typedef", "description": " Interface which represents a transport to communicate with a\n remote.", "comments": "", @@ -37512,8 +37496,8 @@ "type": "struct", "value": "git_tree", "file": "git2/types.h", - "line": 130, - "lineto": 130, + "line": 133, + "lineto": 133, "tdef": "typedef", "description": " Representation of a tree object. ", "comments": "", @@ -37581,9 +37565,10 @@ { "decl": "git_tree_entry", "type": "struct", + "value": "git_tree_entry", "file": "git2/types.h", - "line": 127, - "lineto": 127, + "line": 130, + "lineto": 130, "tdef": "typedef", "description": " Representation of each one of the entries in a tree object. ", "comments": "", @@ -37609,8 +37594,7 @@ "git_treebuilder_insert", "git_treewalk_cb" ] - }, - "value": "git_tree_entry" + } } ], [ @@ -37627,16 +37611,10 @@ "file": "git2/tree.h", "line": 448, "lineto": 457, + "block": "git_tree_update_t action\ngit_oid id\ngit_filemode_t filemode\nconst char * path", "tdef": "typedef", "description": " An action to perform during the update of a tree", "comments": "", - "used": { - "returns": [], - "needs": [ - "git_tree_create_updated" - ] - }, - "block": "git_tree_update_t action\ngit_oid id\ngit_filemode_t filemode\nconst char * path", "fields": [ { "type": "git_tree_update_t", @@ -37658,7 +37636,13 @@ "name": "path", "comments": " The full path from the root tree " } - ] + ], + "used": { + "returns": [], + "needs": [ + "git_tree_create_updated" + ] + } } ], [ @@ -37703,8 +37687,8 @@ "type": "struct", "value": "git_treebuilder", "file": "git2/types.h", - "line": 133, - "lineto": 133, + "line": 136, + "lineto": 136, "tdef": "typedef", "description": " Constructor for in-memory trees ", "comments": "", @@ -37769,8 +37753,8 @@ "type": "struct", "value": "git_worktree", "file": "git2/types.h", - "line": 109, - "lineto": 109, + "line": 112, + "lineto": 112, "tdef": "typedef", "description": " Representation of a working tree ", "comments": "", @@ -37805,6 +37789,7 @@ "git_reference * ref" ], "type": "struct", + "value": "git_worktree_add_options", "file": "git2/worktree.h", "line": 84, "lineto": 89, @@ -37835,8 +37820,7 @@ "git_worktree_add", "git_worktree_add_options_init" ] - }, - "value": "git_worktree_add_options" + } } ], [ @@ -37851,6 +37835,7 @@ "file": "git2/worktree.h", "line": 198, "lineto": 202, + "block": "unsigned int version\nuint32_t flags", "tdef": "typedef", "description": " Worktree prune options structure", "comments": "Initialize with GIT_WORKTREE_PRUNE_OPTIONS_INIT. Alternatively, you can use git_worktree_prune_options_init.