Creates a git_annotated_commit from the given commit id.\n The resulting git_annotated_commit must be freed with\n git_annotated_commit_free.
An annotated commit contains information about how it was\n looked up, which may be useful for functions like merge or\n rebase to provide context to the operation. For example,\n conflict files will include the name of the source or target\n branches being merged. It is therefore preferable to use the\n most specific function (eg git_annotated_commit_from_ref)\n instead of this one when that data is known.
An annotated commit contains information about how it was looked up, which may be useful for functions like merge or rebase to provide context to the operation. For example, conflict files will include the name of the source or target branches being merged. It is therefore preferable to use the most specific function (eg git_annotated_commit_from_ref) instead of this one when that data is known.
Creates a git_annotated_comit from a revision string.
See man gitrevisions, or\n http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for\n information on the syntax accepted.
See man gitrevisions, or http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for information on the syntax accepted.
Return the value type for a given attribute.
\n", - "comments": "This can be either TRUE, FALSE, UNSPECIFIED (if the attribute\n was not set at all), or VALUE, if the attribute was set to an\n actual string.
If the attribute has a VALUE string, it can be accessed normally\n as a NULL-terminated C string.
This can be either TRUE, FALSE, UNSPECIFIED (if the attribute was not set at all), or VALUE, if the attribute was set to an actual string.
If the attribute has a VALUE string, it can be accessed normally as a NULL-terminated C string.
Look up the value of one git attribute for path.
\n", "comments": "", "group": "attr" }, @@ -1846,42 +1642,42 @@ { "name": "values_out", "type": "const char **", - "comment": null + "comment": "An array of num_attr entries that will have string\n pointers written into it for the values of the attributes.\n You should not modify or free the values that are written\n into this array (although of course, you should free the\n array itself if you allocated it)." }, { "name": "repo", "type": "git_repository *", - "comment": null + "comment": "The repository containing the path." }, { "name": "flags", - "type": "int", - "comment": null + "type": "uint32_t", + "comment": "A combination of GIT_ATTR_CHECK... flags." }, { "name": "path", "type": "const char *", - "comment": null + "comment": "The path inside the repo to check attributes. This\n does not have to exist, but if it does not, then\n it will be treated as a plain file (i.e. not a directory)." }, { "name": "num_attr", "type": "size_t", - "comment": null + "comment": "The number of attributes being looked up" }, { "name": "names", "type": "const char **", - "comment": null + "comment": "An array of num_attr strings containing attribute names." } ], - "argline": "const char **values_out, git_repository *repo, int flags, const char *path, size_t num_attr, const char **names", - "sig": "const char **::git_repository *::int::const char *::size_t::const char **", + "argline": "const char **values_out, git_repository *repo, uint32_t flags, const char *path, size_t num_attr, const char **names", + "sig": "const char **::git_repository *::uint32_t::const char *::size_t::const char **", "return": { "type": "int", "comment": null }, - "description": "", - "comments": "", + "description": "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": { @@ -1893,36 +1689,36 @@ { "name": "repo", "type": "git_repository *", - "comment": null + "comment": "The repository containing the path." }, { "name": "flags", - "type": "int", - "comment": null + "type": "uint32_t", + "comment": "A combination of GIT_ATTR_CHECK... flags." }, { "name": "path", "type": "const char *", - "comment": null + "comment": "Path inside the repo to check attributes. This does not have\n to exist, but if it does not, then it will be treated as a\n plain file (i.e. not a directory)." }, { "name": "callback", "type": "git_attr_foreach_cb", - "comment": null + "comment": "Function to invoke on each attribute name and value.\n See git_attr_foreach_cb." }, { "name": "payload", "type": "void *", - "comment": null + "comment": "Passed on as extra parameter to callback function." } ], - "argline": "git_repository *repo, int flags, const char *path, git_attr_foreach_cb callback, void *payload", - "sig": "git_repository *::int::const char *::git_attr_foreach_cb::void *", + "argline": "git_repository *repo, uint32_t flags, const char *path, git_attr_foreach_cb callback, void *payload", + "sig": "git_repository *::uint32_t::const char *::git_attr_foreach_cb::void *", "return": { "type": "int", - "comment": null + "comment": " 0 on success, non-zero callback return value, or error code" }, - "description": "", + "description": "Loop over all the git attributes for a path.
\n", "comments": "", "group": "attr" }, @@ -1945,7 +1741,7 @@ "comment": null }, "description": "Flush the gitattributes cache.
\n", - "comments": "Call this if you have reason to believe that the attributes files on\n disk no longer match the cached contents of memory. This will cause\n the attributes files to be reloaded the next time that an attribute\n access function is called.
\n", + "comments": "Call this if you have reason to believe that the attributes files on disk no longer match the cached contents of memory. This will cause the attributes files to be reloaded the next time that an attribute access function is called.
\n", "group": "attr" }, "git_attr_add_macro": { @@ -1977,10 +1773,10 @@ "comment": null }, "description": "Add a macro definition.
\n", - "comments": "Macros will automatically be loaded from the top level .gitattributes\n file of the repository (plus the build-in "binary" macro). This\n function allows you to add others. For example, to add the default\n macro, you would call:
git_attr_add_macro(repo, "binary", "-diff -crlf");\nMacros will automatically be loaded from the top level .gitattributes file of the repository (plus the build-in "binary" macro). This function allows you to add others. For example, to add the default macro, you would call:
git_attr_add_macro(repo, "binary", "-diff -crlf");\nInitialize git_blame_options structure
\n", - "comments": "Initializes a git_blame_options with default values. Equivalent to creating\n an instance with GIT_BLAME_OPTIONS_INIT.
Initializes a git_blame_options with default values. Equivalent to creating an instance with GIT_BLAME_OPTIONS_INIT.
Gets the number of hunks that exist in the blame structure.
\n", "comments": "", "group": "blame" }, @@ -2032,21 +1834,21 @@ { "name": "blame", "type": "git_blame *", - "comment": null + "comment": "the blame structure to query" }, { "name": "index", - "type": "int", - "comment": null + "type": "uint32_t", + "comment": "index of the hunk to retrieve" } ], - "argline": "git_blame *blame, int index", - "sig": "git_blame *::int", + "argline": "git_blame *blame, uint32_t index", + "sig": "git_blame *::uint32_t", "return": { "type": "const git_blame_hunk *", - "comment": null + "comment": " the hunk at the given index, or NULL on error" }, - "description": "", + "description": "Gets the blame hunk at the given index.
\n", "comments": "", "group": "blame" }, @@ -2078,7 +1880,7 @@ "group": "blame", "examples": { "blame.c": [ - "ex/v0.28.0/blame.html#git_blame_get_hunk_byline-1" + "ex/HEAD/blame.html#git_blame_get_hunk_byline-1" ] } }, @@ -2120,7 +1922,7 @@ "group": "blame", "examples": { "blame.c": [ - "ex/v0.28.0/blame.html#git_blame_file-2" + "ex/HEAD/blame.html#git_blame_file-2" ] } }, @@ -2158,7 +1960,7 @@ "comment": " 0 on success, or an error code. (use git_error_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\n having a zero OID for their final_commit_id.
\n", + "comments": "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": { @@ -2184,7 +1986,7 @@ "group": "blame", "examples": { "blame.c": [ - "ex/v0.28.0/blame.html#git_blame_free-3" + "ex/HEAD/blame.html#git_blame_free-3" ] } }, @@ -2221,10 +2023,10 @@ "group": "blob", "examples": { "blame.c": [ - "ex/v0.28.0/blame.html#git_blob_lookup-4" + "ex/HEAD/blame.html#git_blob_lookup-4" ], "general.c": [ - "ex/v0.28.0/general.html#git_blob_lookup-1" + "ex/HEAD/general.html#git_blob_lookup-1" ] } }, @@ -2284,14 +2086,14 @@ "comment": null }, "description": "Close an open blob
\n", - "comments": "This is a wrapper around git_object_free()
\n\nIMPORTANT:\n It is necessary to call this method when you stop\n using a blob. Failure to do so will cause a memory leak.
\n", + "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.28.0/blame.html#git_blob_free-5" + "ex/HEAD/blame.html#git_blob_free-5" ], "general.c": [ - "ex/v0.28.0/general.html#git_blob_free-2" + "ex/HEAD/general.html#git_blob_free-2" ] } }, @@ -2358,17 +2160,17 @@ "comment": " the pointer" }, "description": "Get a read-only buffer with the raw content of a blob.
\n", - "comments": "A pointer to the raw content of a blob is returned;\n this pointer is owned internally by the object and shall\n not be free'd. The pointer may be invalidated at a later\n time.
\n", + "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.28.0/blame.html#git_blob_rawcontent-6" + "ex/HEAD/blame.html#git_blob_rawcontent-6" ], "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_blob_rawcontent-1" + "ex/HEAD/cat-file.html#git_blob_rawcontent-1" ], "general.c": [ - "ex/v0.28.0/general.html#git_blob_rawcontent-3" + "ex/HEAD/general.html#git_blob_rawcontent-3" ] } }, @@ -2395,14 +2197,14 @@ "group": "blob", "examples": { "blame.c": [ - "ex/v0.28.0/blame.html#git_blob_rawsize-7" + "ex/HEAD/blame.html#git_blob_rawsize-7" ], "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_blob_rawsize-2" + "ex/HEAD/cat-file.html#git_blob_rawsize-2" ], "general.c": [ - "ex/v0.28.0/general.html#git_blob_rawsize-4", - "ex/v0.28.0/general.html#git_blob_rawsize-5" + "ex/HEAD/general.html#git_blob_rawsize-4", + "ex/HEAD/general.html#git_blob_rawsize-5" ] } }, @@ -2440,10 +2242,10 @@ "comment": " 0 on success or an error code" }, "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\n working directory under the specified filename. This may apply\n CRLF filtering or other types of changes depending on the file\n 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\n when done (via git_buf_dispose).
If no filters need to be applied, then the out buffer will just\n be populated with a pointer to the raw content of the blob. In\n that case, be careful to not free the blob until done with the\n buffer or copy it into memory you own.
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 stream to write a new blob into the object db
\n", - "comments": "This function may need to buffer the data on disk and will in\n general not be the right choice if you know the size of the data\n to write. If you have data in memory, use\n git_blob_create_frombuffer(). If you do not, but know the size of\n the contents (and don't want/need to perform filtering), use\n git_odb_open_wstream().
Don't close this stream yourself but pass it to\n git_blob_create_fromstream_commit() to commit the write to the\n object db and get the object id.
If the hintpath parameter is filled, it will be used to determine\n what git filters should be applied to the object before it is written\n to the object database.
This function may need to buffer the data on disk and will in general not be the right choice if you know the size of the data to write. If you have data in memory, use git_blob_create_from_buffer(). If you do not, but know the size of the contents (and don't want/need to perform filtering), use git_odb_open_wstream().
Don't close this stream yourself but pass it to git_blob_create_from_stream_commit() to commit the write to the object db and get the object id.
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 stream will be closed and freed.
\n", "group": "blob" }, - "git_blob_create_frombuffer": { + "git_blob_create_from_buffer": { "type": "function", "file": "git2/blob.h", "line": 205, @@ -2622,7 +2424,7 @@ "comment": " 1 if the content of the blob is detected\n as binary; 0 otherwise." }, "description": "Determine if the blob content is most certainly binary or not.
\n", - "comments": "The heuristic used to guess if a file is binary is taken from core git:\n Searching for NUL bytes and looking for a reasonable ratio of printable\n to non-printable characters among the first 8000 bytes.
\n", + "comments": "The heuristic used to guess if a file is binary is taken from core git: Searching for NUL bytes and looking for a reasonable ratio of printable to non-printable characters among the first 8000 bytes.
\n", "group": "blob" }, "git_blob_dup": { @@ -2691,7 +2493,7 @@ "comment": " 0, GIT_EINVALIDSPEC or an error code.\n A proper reference is written in the refs/heads namespace\n pointing to the provided target commit." }, "description": "Create a new branch pointing at a target commit
\n", - "comments": "A new direct reference will be created pointing to\n this target commit. If force is true and a reference\n already exists with the given name, it'll be replaced.
The returned reference must be freed by the user.
\n\nThe branch name will be checked for validity.\n See git_tag_create() for rules about valid names.
A new direct reference will be created pointing to this target commit. If force is true and a reference already exists with the given name, it'll be replaced.
The returned 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.
Create a new branch pointing at a target commit
\n", - "comments": "This behaves like git_branch_create() but takes an annotated\n commit, which lets you specify which extended sha syntax string was\n specified by a user, allowing for more exact reflog messages.
See the documentation for git_branch_create().
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\n object will be invalidated. The reference must be freed manually\n by the user.
\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", "group": "branch" }, "git_branch_iterator_new": { @@ -2878,7 +2680,7 @@ "comment": " 0 on success, GIT_EINVALIDSPEC or an error code." }, "description": "Move/rename an existing local branch reference.
\n", - "comments": "The new branch name will be checked for validity.\n 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.
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.\n See git_tag_create() for rules about valid names.
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.
Return the name of the given local or remote branch.
\n", - "comments": "The name of the branch matches the definition of the name\n for git_branch_lookup. That is, if the returned name is given\n to git_branch_lookup() then the reference is returned that\n was given to this function.
\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", "group": "branch", "examples": { "merge.c": [ - "ex/v0.28.0/merge.html#git_branch_name-4" + "ex/HEAD/merge.html#git_branch_name-4" ] } }, @@ -3163,17 +2965,14 @@ "comment": null }, "description": "Free the memory referred to by the git_buf.
\n", - "comments": "Note that this does not free the git_buf itself, just the memory\n pointed to by buffer->ptr. This will not free the memory if it looks\n like it was not allocated internally, but it will clear the buffer back\n to the empty state.
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.\n the asize field is zero), then ptr will be replaced with a newly\n allocated block of data. Be careful so that memory allocated by the\n caller is not lost. As a special variant, if you pass target_size as\n 0 and the memory is not allocated by libgit2, this will allocate a new\n 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\n marked as invalid for future operations, invaliding the contents.
\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": { @@ -3280,11 +3079,11 @@ "comments": "", "group": "buf" }, - "git_checkout_init_options": { + "git_checkout_options_init": { "type": "function", "file": "git2/checkout.h", - "line": 309, - "lineto": 311, + "line": 322, + "lineto": 324, "args": [ { "name": "opts", @@ -3304,14 +3103,14 @@ "comment": " Zero on success; -1 on failure." }, "description": "Initialize git_checkout_options structure
\n", - "comments": "Initializes a git_checkout_options with default values. Equivalent to creating\n an instance with GIT_CHECKOUT_OPTIONS_INIT.
Initializes a git_checkout_options with default values. Equivalent to creating an instance with GIT_CHECKOUT_OPTIONS_INIT.
Updates files in the index and the working tree to match the content of\n the commit pointed at by HEAD.
\n", - "comments": "Note that this is not the correct mechanism used to switch branches;\n do not change your HEAD and then call this method, that would leave\n you with checkout conflicts since your working directory would then\n appear to be dirty. Instead, checkout the target of the branch and\n then update HEAD using git_repository_set_head to point to the\n branch you checked out.
Note that this is not the correct mechanism used to switch branches; do not change your HEAD and then call this method, that would leave you with checkout conflicts since your working directory would then appear to be dirty. Instead, checkout the target of the branch and then update HEAD using git_repository_set_head to point to the branch you checked out.
Initialize git_cherrypick_options structure
\n", - "comments": "Initializes a git_cherrypick_options with default values. Equivalent to creating\n an instance with GIT_CHERRYPICK_OPTIONS_INIT.
Initializes a git_cherrypick_options with default values. Equivalent to creating an instance with GIT_CHERRYPICK_OPTIONS_INIT.
Initialize git_clone_options structure
\n", - "comments": "Initializes a git_clone_options with default values. Equivalent to creating\n an instance with GIT_CLONE_OPTIONS_INIT.
Initializes a git_clone_options with default values. Equivalent to creating an instance with GIT_CLONE_OPTIONS_INIT.
Clone a remote repository.
\n", - "comments": "By default this creates its repository and initial remote to match\n git's defaults. You can use the options in the callback to\n customize how these are created.
\n", + "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" }, "git_commit_lookup": { @@ -3605,22 +3404,22 @@ "comment": " 0 or an error code" }, "description": "Lookup a commit object from a repository.
\n", - "comments": "The returned object should be released with git_commit_free when no\n longer needed.
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\n longer needed.
The returned object should be released with git_commit_free when no longer needed.
Close an open commit
\n", - "comments": "This is a wrapper around git_object_free()
\n\nIMPORTANT:\n It is necessary to call this method when you stop\n using a commit. Failure to do so will cause a memory leak.
\n", + "comments": "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": { "checkout.c": [ - "ex/v0.28.0/checkout.html#git_commit_free-7" + "ex/HEAD/checkout.html#git_commit_free-7" ], "general.c": [ - "ex/v0.28.0/general.html#git_commit_free-9", - "ex/v0.28.0/general.html#git_commit_free-10", - "ex/v0.28.0/general.html#git_commit_free-11", - "ex/v0.28.0/general.html#git_commit_free-12", - "ex/v0.28.0/general.html#git_commit_free-13" + "ex/HEAD/general.html#git_commit_free-9", + "ex/HEAD/general.html#git_commit_free-10", + "ex/HEAD/general.html#git_commit_free-11", + "ex/HEAD/general.html#git_commit_free-12", + "ex/HEAD/general.html#git_commit_free-13" ], "log.c": [ - "ex/v0.28.0/log.html#git_commit_free-2", - "ex/v0.28.0/log.html#git_commit_free-3", - "ex/v0.28.0/log.html#git_commit_free-4", - "ex/v0.28.0/log.html#git_commit_free-5" + "ex/HEAD/log.html#git_commit_free-2", + "ex/HEAD/log.html#git_commit_free-3", + "ex/HEAD/log.html#git_commit_free-4", + "ex/HEAD/log.html#git_commit_free-5" ] } }, @@ -3724,10 +3523,10 @@ "group": "commit", "examples": { "general.c": [ - "ex/v0.28.0/general.html#git_commit_id-14" + "ex/HEAD/general.html#git_commit_id-14" ], "log.c": [ - "ex/v0.28.0/log.html#git_commit_id-6" + "ex/HEAD/log.html#git_commit_id-6" ] } }, @@ -3754,8 +3553,8 @@ "group": "commit", "examples": { "log.c": [ - "ex/v0.28.0/log.html#git_commit_owner-7", - "ex/v0.28.0/log.html#git_commit_owner-8" + "ex/HEAD/log.html#git_commit_owner-7", + "ex/HEAD/log.html#git_commit_owner-8" ] } }, @@ -3778,7 +3577,7 @@ "comment": " NULL, or the encoding" }, "description": "Get the encoding for the message of a commit,\n as a string representing a standard encoding name.
\n", - "comments": "The encoding may be NULL if the encoding header\n in the commit is missing; in that case UTF-8 is assumed.
The encoding may be NULL if the encoding header in the commit is missing; in that case UTF-8 is assumed.
Get the full message of a commit.
\n", - "comments": "The returned message will be slightly prettified by removing any\n potential leading newlines.
\n", + "comments": "The returned message will be slightly prettified by removing any potential leading newlines.
\n", "group": "commit", "examples": { "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_commit_message-3", - "ex/v0.28.0/cat-file.html#git_commit_message-4" + "ex/HEAD/cat-file.html#git_commit_message-3", + "ex/HEAD/cat-file.html#git_commit_message-4" ], "general.c": [ - "ex/v0.28.0/general.html#git_commit_message-15", - "ex/v0.28.0/general.html#git_commit_message-16", - "ex/v0.28.0/general.html#git_commit_message-17" + "ex/HEAD/general.html#git_commit_message-15", + "ex/HEAD/general.html#git_commit_message-16", + "ex/HEAD/general.html#git_commit_message-17" ], "log.c": [ - "ex/v0.28.0/log.html#git_commit_message-9", - "ex/v0.28.0/log.html#git_commit_message-10", - "ex/v0.28.0/log.html#git_commit_message-11" + "ex/HEAD/log.html#git_commit_message-9", + "ex/HEAD/log.html#git_commit_message-10", + "ex/HEAD/log.html#git_commit_message-11" ], "tag.c": [ - "ex/v0.28.0/tag.html#git_commit_message-2" + "ex/HEAD/tag.html#git_commit_message-2" ] } }, @@ -3863,7 +3662,7 @@ "comment": " the summary of a commit or NULL on error" }, "description": "Get the short "summary" of the git commit message.
\n", - "comments": "The returned message is the summary of the commit, comprising the\n first paragraph of the message with whitespace trimmed and squashed.
\n", + "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": { @@ -3885,7 +3684,7 @@ "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\n everything but the first paragraph of the message. Leading and\n trailing whitespaces are trimmed.
\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": { @@ -3911,8 +3710,8 @@ "group": "commit", "examples": { "general.c": [ - "ex/v0.28.0/general.html#git_commit_time-18", - "ex/v0.28.0/general.html#git_commit_time-19" + "ex/HEAD/general.html#git_commit_time-18", + "ex/HEAD/general.html#git_commit_time-19" ] } }, @@ -3961,13 +3760,13 @@ "group": "commit", "examples": { "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_commit_committer-5" + "ex/HEAD/cat-file.html#git_commit_committer-5" ], "general.c": [ - "ex/v0.28.0/general.html#git_commit_committer-20" + "ex/HEAD/general.html#git_commit_committer-20" ], "log.c": [ - "ex/v0.28.0/log.html#git_commit_committer-12" + "ex/HEAD/log.html#git_commit_committer-12" ] } }, @@ -3994,15 +3793,15 @@ "group": "commit", "examples": { "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_commit_author-6" + "ex/HEAD/cat-file.html#git_commit_author-6" ], "general.c": [ - "ex/v0.28.0/general.html#git_commit_author-21", - "ex/v0.28.0/general.html#git_commit_author-22" + "ex/HEAD/general.html#git_commit_author-21", + "ex/HEAD/general.html#git_commit_author-22" ], "log.c": [ - "ex/v0.28.0/log.html#git_commit_author-13", - "ex/v0.28.0/log.html#git_commit_author-14" + "ex/HEAD/log.html#git_commit_author-13", + "ex/HEAD/log.html#git_commit_author-14" ] } }, @@ -4120,11 +3919,11 @@ "group": "commit", "examples": { "log.c": [ - "ex/v0.28.0/log.html#git_commit_tree-15", - "ex/v0.28.0/log.html#git_commit_tree-16", - "ex/v0.28.0/log.html#git_commit_tree-17", - "ex/v0.28.0/log.html#git_commit_tree-18", - "ex/v0.28.0/log.html#git_commit_tree-19" + "ex/HEAD/log.html#git_commit_tree-15", + "ex/HEAD/log.html#git_commit_tree-16", + "ex/HEAD/log.html#git_commit_tree-17", + "ex/HEAD/log.html#git_commit_tree-18", + "ex/HEAD/log.html#git_commit_tree-19" ] } }, @@ -4151,7 +3950,7 @@ "group": "commit", "examples": { "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_commit_tree_id-7" + "ex/HEAD/cat-file.html#git_commit_tree_id-7" ] } }, @@ -4178,14 +3977,14 @@ "group": "commit", "examples": { "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_commit_parentcount-8" + "ex/HEAD/cat-file.html#git_commit_parentcount-8" ], "general.c": [ - "ex/v0.28.0/general.html#git_commit_parentcount-23" + "ex/HEAD/general.html#git_commit_parentcount-23" ], "log.c": [ - "ex/v0.28.0/log.html#git_commit_parentcount-20", - "ex/v0.28.0/log.html#git_commit_parentcount-21" + "ex/HEAD/log.html#git_commit_parentcount-20", + "ex/HEAD/log.html#git_commit_parentcount-21" ] } }, @@ -4222,11 +4021,11 @@ "group": "commit", "examples": { "general.c": [ - "ex/v0.28.0/general.html#git_commit_parent-24" + "ex/HEAD/general.html#git_commit_parent-24" ], "log.c": [ - "ex/v0.28.0/log.html#git_commit_parent-22", - "ex/v0.28.0/log.html#git_commit_parent-23" + "ex/HEAD/log.html#git_commit_parent-22", + "ex/HEAD/log.html#git_commit_parent-23" ] } }, @@ -4258,10 +4057,10 @@ "group": "commit", "examples": { "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_commit_parent_id-9" + "ex/HEAD/cat-file.html#git_commit_parent_id-9" ], "log.c": [ - "ex/v0.28.0/log.html#git_commit_parent_id-24" + "ex/HEAD/log.html#git_commit_parent_id-24" ] } }, @@ -4294,7 +4093,7 @@ "comment": " 0 on success; GIT_ENOTFOUND if no matching ancestor exists\n or an error code" }, "description": "Get the commit object that is the \n<n
\n\n\n\n", - "comments": "th generation ancestor\n of the named commit object, following only the first parents.\n The returned commit has to be freed by the caller.
\n
Passing 0 as the generation number returns another instance of the\n base commit itself.
Passing 0 as the generation number returns another instance of the base commit itself.
Extract the signature from a commit
\n", - "comments": "If the id is not for a commit, the error class will be\n GIT_ERROR_INVALID. If the commit does not have a signature, the\n error class will be GIT_ERROR_OBJECT.
If the id is not for a commit, the error class will be GIT_ERROR_INVALID. If the commit does not have a signature, the error class will be GIT_ERROR_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\n with the git_message_prettify() function.
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\n with the git_message_prettify() function.
The parents for the commit are specified as a variable list of pointers\n to const git_commit *. Note that this is a convenience method which may\n not be safe to export for certain languages or compilers
All other parameters remain the same as git_commit_create().
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().
Amend an existing commit by replacing only non-NULL values.
\n", - "comments": "This creates a new commit that is exactly the same as the old commit,\n except that any non-NULL values will be updated. The new commit has\n the same parents as the old commit.
\n\nThe update_ref value works as in the regular git_commit_create(),\n updating the ref to point to the newly rewritten commit. If you want\n to amend a commit that is not currently the tip of the branch and then\n rewrite the following commits to reach a ref, pass this as NULL and\n update the rest of the commit chain and ref separately.
Unlike git_commit_create(), the author, committer, message,\n message_encoding, and tree parameters can be NULL in which case this\n will use the values from the original commit_to_amend.
All parameters have the same meanings as in git_commit_create().
This creates a new commit that is exactly the same as the old commit, except that any non-NULL values will be updated. The new commit has the same parents as the old commit.
\n\nThe update_ref value works as in the regular git_commit_create(), updating the ref to point to the newly rewritten commit. If you want to amend a commit that is not currently the tip of the branch and then rewrite the following commits to reach a ref, pass this as NULL and update the rest of the commit chain and ref separately.
Unlike git_commit_create(), the author, committer, message, message_encoding, and tree parameters can be NULL in which case this will use the values from the original commit_to_amend.
All parameters have the same meanings as in git_commit_create().
Create a commit and write it into a buffer
\n", - "comments": "Create a commit as with git_commit_create() but instead of\n writing it to the objectdb, write the contents of the object into a\n buffer.
Create a commit as with git_commit_create() but instead of writing it to the objectdb, write the contents of the object into a buffer.
Create a commit object from the given buffer and signature
\n", - "comments": "Given the unsigned commit object's contents, its signature and the\n header field in which to store the signature, attach the signature\n to the commit and write it into the given repository.
\n", + "comments": "Given the unsigned commit object's contents, its signature and the header field in which to store the signature, attach the signature to the commit and write it into the given repository.
\n", "group": "commit" }, "git_commit_dup": { @@ -4704,8 +4503,8 @@ "git_libgit2_version": { "type": "function", "file": "git2/common.h", - "line": 124, - "lineto": 124, + "line": 121, + "lineto": 121, "args": [ { "name": "major", @@ -4736,8 +4535,8 @@ "git_libgit2_features": { "type": "function", "file": "git2/common.h", - "line": 173, - "lineto": 173, + "line": 170, + "lineto": 170, "args": [], "argline": "", "sig": "", @@ -4746,14 +4545,14 @@ "comment": " A combination of GIT_FEATURE_* values." }, "description": "Query compile time options for libgit2.
\n", - "comments": "GIT_FEATURE_THREADS\nLibgit2 was compiled with thread support. Note that thread support is\nstill to be seen as a 'work in progress' - basic object lookups are\nbelieved to be threadsafe, but other operations may not be.
GIT_FEATURE_HTTPS\nLibgit2 supports the https:// protocol. This requires the openssl\nlibrary to be found when compiling libgit2.
GIT_FEATURE_SSH\nLibgit2 supports the SSH protocol for network operations. This requires\nthe libssh2 library to be found when compiling libgit2
GIT_FEATURE_THREADS Libgit2 was compiled with thread support. Note that thread support is still to be seen as a 'work in progress' - basic object lookups are believed to be threadsafe, but other operations may not be.
GIT_FEATURE_HTTPS Libgit2 supports the https:// protocol. This requires the openssl library to be found when compiling libgit2.
GIT_FEATURE_SSH Libgit2 supports the SSH protocol for network operations. This requires the libssh2 library to be found when compiling libgit2
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\n 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\n > be one of `GIT_CONFIG_LEVEL_SYSTEM`, `GIT_CONFIG_LEVEL_GLOBAL`,\n > `GIT_CONFIG_LEVEL_XDG`, or `GIT_CONFIG_LEVEL_PROGRAMDATA`.\n > 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\n > applied to shared attributes and ignore files, too.\n >\n > - `path` lists directories delimited by GIT_PATH_LIST_SEPARATOR.\n > Pass NULL to reset to the default (generally based on environment\n > variables). Use magic path `$PATH` to include the old value\n > of the path (if you want to prepend or append, for instance).\n >\n > - `level` must be `GIT_CONFIG_LEVEL_SYSTEM`,\n > `GIT_CONFIG_LEVEL_GLOBAL`, `GIT_CONFIG_LEVEL_XDG`, or\n > `GIT_CONFIG_LEVEL_PROGRAMDATA`.\n\n* opts(GIT_OPT_SET_CACHE_OBJECT_LIMIT, git_object_t type, size_t size)\n\n > Set the maximum data size for the given type of object to be\n > considered eligible for caching in memory. Setting to value to\n > zero means that that type of object will not be cached.\n > Defaults to 0 for GIT_OBJECT_BLOB (i.e. won't cache blobs) and 4k\n > for GIT_OBJECT_COMMIT, GIT_OBJECT_TREE, and GIT_OBJECT_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\n > across all repositories before libgit2 starts evicting objects\n > from the cache. This is a soft limit, in that the library might\n > briefly exceed it, but will start aggressively evicting objects\n > 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.\n >\n > Because caches are repository-specific, disabling the cache\n > cannot immediately clear all cached objects, but each cache will\n > 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\n > allowed in the cache.\n\n* opts(GIT_OPT_GET_TEMPLATE_PATH, git_buf *out)\n\n > Get the default template path.\n > 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.\n >\n > - `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.\n >\n > - `file` is the location of a file containing several\n > certificates concatenated together.\n > - `path` is the location of a directory holding several\n > certificates, one per file.\n >\n > 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\n > appended to "git/1.0", for compatibility with other git clients.\n >\n > - `user_agent` is the value that will be delivered as the\n > User-Agent header on HTTP requests.\n\n* opts(GIT_OPT_SET_WINDOWS_SHAREMODE, unsigned long value)\n\n > Set the share mode used when opening files on Windows.\n > For more information, see the documentation for CreateFile.\n > The default is: FILE_SHARE_READ | FILE_SHARE_WRITE. This is\n > ignored and unused on non-Windows platforms.\n\n* opts(GIT_OPT_GET_WINDOWS_SHAREMODE, unsigned long *value)\n\n > Get the share mode used when opening files on Windows.\n\n* opts(GIT_OPT_ENABLE_STRICT_OBJECT_CREATION, int enabled)\n\n > Enable strict input validation when creating new objects\n > to ensure that all inputs to the new objects are valid. For\n > example, when this is enabled, the parent(s) and tree inputs\n > will be validated when creating a new commit. This defaults\n > to enabled.\n\n* opts(GIT_OPT_ENABLE_STRICT_SYMBOLIC_REF_CREATION, int enabled)\n\n > Validate the target of a symbolic ref when creating it. For\n > example, `foobar` is not a valid ref, therefore `foobar` is\n > not a valid target for a symbolic ref by default, whereas\n > `refs/heads/foobar` is. Disabling this bypasses validation\n > so that an arbitrary strings such as `foobar` can be used\n > for a symbolic ref target. This defaults to enabled.\n\n* opts(GIT_OPT_SET_SSL_CIPHERS, const char *ciphers)\n\n > Set the SSL ciphers use for HTTPS connections.\n >\n > - `ciphers` is the list of ciphers that are eanbled.\n\n* opts(GIT_OPT_ENABLE_OFS_DELTA, int enabled)\n\n > Enable or disable the use of "offset deltas" when creating packfiles,\n > and the negotiation of them when talking to a remote server.\n > Offset deltas store a delta base location as an offset into the\n > packfile from the current location, which provides a shorter encoding\n > and thus smaller resultant packfiles.\n > Packfiles containing offset deltas can still be read.\n > This defaults to enabled.\n\n* opts(GIT_OPT_ENABLE_FSYNC_GITDIR, int enabled)\n\n > Enable synchronized writes of files in the gitdir using `fsync`\n > (or the platform equivalent) to ensure that new object data\n > is written to permanent storage, not simply cached. This\n > defaults to disabled.\n\n opts(GIT_OPT_ENABLE_STRICT_HASH_VERIFICATION, int enabled)\n\n > Enable strict verification of object hashsums when reading\n > objects from disk. This may impact performance due to an\n > additional checksum calculation on each object. This defaults\n > to enabled.\n\n opts(GIT_OPT_SET_ALLOCATOR, git_allocator *allocator)\n\n > Set the memory allocator to a different memory allocator. This\n > allocator will then be used to make all memory allocations for\n > libgit2 operations. If the given `allocator` is NULL, then the\n > system default will be restored.\n\n opts(GIT_OPT_ENABLE_UNSAVED_INDEX_SAFETY, int enabled)\n\n > Ensure that there are no unsaved changes in the index before\n > beginning any operation that reloads the index from disk (eg,\n > checkout). If there are unsaved changes, the instruction will\n > fail. (Using the FORCE flag to checkout will still overwrite\n > these changes.)\n\n opts(GIT_OPT_GET_PACK_MAX_OBJECTS, size_t *out)\n\n > Get the maximum number of objects libgit2 will allow in a pack\n > file when downloading a pack file from a remote. This can be\n > used to limit maximum memory usage when fetching from an untrusted\n > remote.\n\n opts(GIT_OPT_SET_PACK_MAX_OBJECTS, size_t objects)\n\n > Set the maximum number of objects libgit2 will allow in a pack\n > file when downloading a pack file from a remote.\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_object_t 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_OBJECT_BLOB (i.e. won't cache blobs) and 4k > for GIT_OBJECT_COMMIT, GIT_OBJECT_TREE, and GIT_OBJECT_TAG.\n\n* opts(GIT_OPT_SET_CACHE_MAX_SIZE, ssize_t max_storage_bytes)\n\n > Set the maximum total data size that will be cached in memory > across all repositories before libgit2 starts evicting objects > from the cache. This is a soft limit, in that the library might > briefly exceed it, but will start aggressively evicting objects > from cache when that happens. The default cache size is 256MB.\n\n* opts(GIT_OPT_ENABLE_CACHING, int enabled)\n\n > Enable or disable caching completely. > > Because caches are repository-specific, disabling the cache > cannot immediately clear all cached objects, but each cache will > be cleared on the next attempt to update anything in it.\n\n* opts(GIT_OPT_GET_CACHED_MEMORY, ssize_t *current, ssize_t *allowed)\n\n > Get the current bytes in cache and the maximum that would be > allowed in the cache.\n\n* opts(GIT_OPT_GET_TEMPLATE_PATH, git_buf *out)\n\n > Get the default template path. > The path is written to the `out` buffer.\n\n* opts(GIT_OPT_SET_TEMPLATE_PATH, const char *path)\n\n > Set the default template path. > > - `path` directory of template.\n\n* opts(GIT_OPT_SET_SSL_CERT_LOCATIONS, const char *file, const char *path)\n\n > Set the SSL certificate-authority locations. > > - `file` is the location of a file containing several > certificates concatenated together. > - `path` is the location of a directory holding several > certificates, one per file. > > Either parameter may be `NULL`, but not both.\n\n* opts(GIT_OPT_SET_USER_AGENT, const char *user_agent)\n\n > Set the value of the User-Agent header. This value will be > appended to "git/1.0", for compatibility with other git clients. > > - `user_agent` is the value that will be delivered as the > User-Agent header on HTTP requests.\n\n* opts(GIT_OPT_SET_WINDOWS_SHAREMODE, unsigned long value)\n\n > Set the share mode used when opening files on Windows. > For more information, see the documentation for CreateFile. > The default is: FILE_SHARE_READ | FILE_SHARE_WRITE. This is > ignored and unused on non-Windows platforms.\n\n* opts(GIT_OPT_GET_WINDOWS_SHAREMODE, unsigned long *value)\n\n > Get the share mode used when opening files on Windows.\n\n* opts(GIT_OPT_ENABLE_STRICT_OBJECT_CREATION, int enabled)\n\n > Enable strict input validation when creating new objects > to ensure that all inputs to the new objects are valid. For > example, when this is enabled, the parent(s) and tree inputs > will be validated when creating a new commit. This defaults > to enabled.\n\n* opts(GIT_OPT_ENABLE_STRICT_SYMBOLIC_REF_CREATION, int enabled)\n\n > Validate the target of a symbolic ref when creating it. For > example, `foobar` is not a valid ref, therefore `foobar` is > not a valid target for a symbolic ref by default, whereas > `refs/heads/foobar` is. Disabling this bypasses validation > so that an arbitrary strings such as `foobar` can be used > for a symbolic ref target. This defaults to enabled.\n\n* opts(GIT_OPT_SET_SSL_CIPHERS, const char *ciphers)\n\n > Set the SSL ciphers use for HTTPS connections. > > - `ciphers` is the list of ciphers that are eanbled.\n\n* opts(GIT_OPT_ENABLE_OFS_DELTA, int enabled)\n\n > Enable or disable the use of "offset deltas" when creating packfiles, > and the negotiation of them when talking to a remote server. > Offset deltas store a delta base location as an offset into the > packfile from the current location, which provides a shorter encoding > and thus smaller resultant packfiles. > Packfiles containing offset deltas can still be read. > This defaults to enabled.\n\n* opts(GIT_OPT_ENABLE_FSYNC_GITDIR, int enabled)\n\n > Enable synchronized writes of files in the gitdir using `fsync` > (or the platform equivalent) to ensure that new object data > is written to permanent storage, not simply cached. This > defaults to disabled.\n\n opts(GIT_OPT_ENABLE_STRICT_HASH_VERIFICATION, int enabled)\n\n > Enable strict verification of object hashsums when reading > objects from disk. This may impact performance due to an > additional checksum calculation on each object. This defaults > to enabled.\n\n opts(GIT_OPT_SET_ALLOCATOR, git_allocator *allocator)\n\n > Set the memory allocator to a different memory allocator. This > allocator will then be used to make all memory allocations for > libgit2 operations. If the given `allocator` is NULL, then the > system default will be restored.\n\n opts(GIT_OPT_ENABLE_UNSAVED_INDEX_SAFETY, int enabled)\n\n > Ensure that there are no unsaved changes in the index before > beginning any operation that reloads the index from disk (eg, > checkout). If there are unsaved changes, the instruction will > fail. (Using the FORCE flag to checkout will still overwrite > these changes.)\n\n opts(GIT_OPT_GET_PACK_MAX_OBJECTS, size_t *out)\n\n > Get the maximum number of objects libgit2 will allow in a pack > file when downloading a pack file from a remote. This can be > used to limit maximum memory usage when fetching from an untrusted > remote.\n\n opts(GIT_OPT_SET_PACK_MAX_OBJECTS, size_t objects)\n\n > Set the maximum number of objects libgit2 will allow in a pack > file when downloading a pack file from a remote.\n\n opts(GIT_OPT_DISABLE_PACK_KEEP_FILE_CHECKS, int enabled) > This will cause .keep file existence checks to be skipped when > accessing packfiles, which can help performance with remote filesystems.\nLocate the path to the global configuration file
\n", - "comments": "The user or global configuration file is usually\n located in $HOME/.gitconfig.
This method will try to guess the full path to that\n file, if the file exists. The returned path\n may be used on any git_config call to load the\n global configuration file.
This method will not guess the path to the xdg compatible\n config file (.config/git/config).
\n", + "comments": "The user or global configuration file is usually located in $HOME/.gitconfig.
This method will try to guess the full path to that file, if the file exists. The returned path may be used on any git_config call to load the global configuration file.
This method will not guess the path to the xdg compatible config file (.config/git/config).
\n", "group": "config" }, "git_config_find_xdg": { @@ -4834,7 +4633,7 @@ "comment": " 0 if a xdg compatible configuration file has been\n\tfound. Its path will be stored in `out`." }, "description": "Locate the path to the global xdg compatible configuration file
\n", - "comments": "The xdg compatible configuration file is usually\n located in $HOME/.config/git/config.
This method will try to guess the full path to that\n file, if the file exists. The returned path\n may be used on any git_config call to load the\n xdg compatible configuration file.
The xdg compatible configuration file is usually located in $HOME/.config/git/config.
This method will try to guess the full path to that file, if the file exists. The returned path may be used on any git_config call to load the xdg compatible configuration file.
Locate the path to the system configuration file
\n", - "comments": "If /etc/gitconfig doesn't exist, it will look for\n %PROGRAMFILES%
\n\n.
\n", + "comments": "If /etc/gitconfig doesn't exist, it will look for %PROGRAMFILES%.
\n", "group": "config" }, "git_config_find_programdata": { @@ -4878,7 +4677,7 @@ "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%
\n\nused by portable git.
\n", + "comments": "Look for the file in %PROGRAMDATA% used by portable git.
\n", "group": "config" }, "git_config_open_default": { @@ -4900,7 +4699,7 @@ "comment": " 0 or an error code" }, "description": "Open the global, XDG and system configuration files
\n", - "comments": "Utility wrapper that finds the global, XDG and system configuration files\n and opens them into a single prioritized config object that can be\n used when accessing default config data outside a repository.
\n", + "comments": "Utility wrapper that finds the global, XDG and system configuration files and opens them into a single prioritized config object that can be used when accessing default config data outside a repository.
\n", "group": "config" }, "git_config_new": { @@ -4922,7 +4721,7 @@ "comment": " 0 or an error code" }, "description": "Allocate a new configuration object
\n", - "comments": "This object is empty, so you have to add a file to it before you\n can do anything with it.
\n", + "comments": "This object is empty, so you have to add a file to it before you can do anything with it.
\n", "group": "config" }, "git_config_add_file_ondisk": { @@ -4964,7 +4763,7 @@ "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\n parsed; it's expected to be a native Git config file following\n the default Git config syntax (see man git-config).
If the file does not exist, the file will still be added and it\n will be created the first time we write to it.
\n\nNote that the configuration object will free the file\n automatically.
\n\nFurther queries on this config object will access each\n of the config file instances in order (instances with\n 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": { @@ -4991,11 +4790,11 @@ "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\n of calls:\n - git_config_new\n - git_config_add_file_ondisk
\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.28.0/general.html#git_config_open_ondisk-26" + "ex/HEAD/general.html#git_config_open_ondisk-26" ] } }, @@ -5028,7 +4827,7 @@ "comment": " 0, GIT_ENOTFOUND if the passed level cannot be found in the\n multi-level parent config, or an error code" }, "description": "Build a single-level focused config object from a multi-level one.
\n", - "comments": "The returned config object can be used to perform get/set/delete operations\n on a single specific level.
\n\nGetting several times the same level from the same parent multi-level config\n will return different config instances, but containing the same config_file\n instance.
\n", + "comments": "The returned config object can be used to perform get/set/delete operations on a single specific level.
\n\nGetting several times the same level from the same parent multi-level config will return different config instances, but containing the same config_file instance.
\n", "group": "config" }, "git_config_open_global": { @@ -5055,7 +4854,7 @@ "comment": null }, "description": "Open the global/XDG configuration file according to git's rules
\n", - "comments": "Git allows you to store your global configuration at\n $HOME/.gitconfig or $XDG_CONFIG_HOME/git/config. For backwards\n compatability, the XDG file shouldn't be used unless the use has\n created it explicitly. With this function you'll open the correct\n one to write to.
Git allows you to store your global configuration at $HOME/.gitconfig or $XDG_CONFIG_HOME/git/config. For backwards compatability, the XDG file shouldn't be used unless the use has created it explicitly. With this function you'll open the correct one to write to.
Create a snapshot of the configuration
\n", - "comments": "Create a snapshot of the current state of a configuration, which\n allows you to look into a consistent view of the configuration for\n looking up complex values (e.g. a remote, submodule).
\n\nThe string returned when querying such a config object is valid\n until it is freed.
\n", + "comments": "Create a snapshot of the current state of a configuration, which allows you to look into a consistent view of the configuration for looking up complex values (e.g. a remote, submodule).
\n\nThe string returned when querying such a config object is valid until it is freed.
\n", "group": "config" }, "git_config_free": { @@ -5108,8 +4907,8 @@ "group": "config", "examples": { "general.c": [ - "ex/v0.28.0/general.html#git_config_free-27", - "ex/v0.28.0/general.html#git_config_free-28" + "ex/HEAD/general.html#git_config_free-27", + "ex/HEAD/general.html#git_config_free-28" ] } }, @@ -5153,33 +4952,33 @@ "args": [ { "name": "out", - "type": "int *", - "comment": null + "type": "int32_t *", + "comment": "pointer to the variable where the value should be stored" }, { "name": "cfg", "type": "const git_config *", - "comment": null + "comment": "where to look for the variable" }, { "name": "name", "type": "const char *", - "comment": null + "comment": "the variable's name" } ], - "argline": "int *out, const git_config *cfg, const char *name", - "sig": "int *::const git_config *::const char *", + "argline": "int32_t *out, const git_config *cfg, const char *name", + "sig": "int32_t *::const git_config *::const char *", "return": { "type": "int", - "comment": null + "comment": " 0 or an error code" }, - "description": "", - "comments": "", + "description": "Get the value of an integer config variable.
\n", + "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.28.0/general.html#git_config_get_int32-29", - "ex/v0.28.0/general.html#git_config_get_int32-30" + "ex/HEAD/general.html#git_config_get_int32-29", + "ex/HEAD/general.html#git_config_get_int32-30" ] } }, @@ -5191,28 +4990,28 @@ "args": [ { "name": "out", - "type": "int *", - "comment": null + "type": "int64_t *", + "comment": "pointer to the variable where the value should be stored" }, { "name": "cfg", "type": "const git_config *", - "comment": null + "comment": "where to look for the variable" }, { "name": "name", "type": "const char *", - "comment": null + "comment": "the variable's name" } ], - "argline": "int *out, const git_config *cfg, const char *name", - "sig": "int *::const git_config *::const char *", + "argline": "int64_t *out, const git_config *cfg, const char *name", + "sig": "int64_t *::const git_config *::const char *", "return": { "type": "int", - "comment": null + "comment": " 0 or an error code" }, - "description": "", - "comments": "", + "description": "Get the value of a long integer config variable.
\n", + "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" }, "git_config_get_bool": { @@ -5244,7 +5043,7 @@ "comment": " 0 or an error code" }, "description": "Get the value of a boolean config variable.
\n", - "comments": "This function uses the usual C convention of 0 being false and\n anything else true.
\n\nAll config files will be looked into, in the order of their\n defined level. A higher level means a higher priority. The\n first occurrence of the variable will be returned here.
\n", + "comments": "This function uses the usual C convention of 0 being false and anything else true.
\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" }, "git_config_get_path": { @@ -5276,7 +5075,7 @@ "comment": " 0 or an error code" }, "description": "Get the value of a path config variable.
\n", - "comments": "A leading '~' will be expanded to the global search path (which\n defaults to the user's home directory but can be overridden via\n git_libgit2_opts().
All config files will be looked into, in the order of their\n defined level. A higher level means a higher priority. The\n first occurrence of the variable will be returned here.
\n", + "comments": "A leading '~' will be expanded to the global search path (which defaults to the user's home directory but can be overridden via git_libgit2_opts().
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" }, "git_config_get_string": { @@ -5308,12 +5107,12 @@ "comment": " 0 or an error code" }, "description": "Get the value of a string config variable.
\n", - "comments": "This function can only be used on snapshot config objects. The\n string is owned by the config and should not be freed by the\n user. The pointer will be valid until the config is freed.
\n\nAll config files will be looked into, in the order of their\n defined level. A higher level means a higher priority. The\n first occurrence of the variable will be returned here.
\n", + "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.28.0/general.html#git_config_get_string-31", - "ex/v0.28.0/general.html#git_config_get_string-32" + "ex/HEAD/general.html#git_config_get_string-31", + "ex/HEAD/general.html#git_config_get_string-32" ] } }, @@ -5346,7 +5145,7 @@ "comment": " 0 or an error code" }, "description": "Get the value of a string config variable.
\n", - "comments": "The value of the config will be copied into the buffer.
\n\nAll config files will be looked into, in the order of their\n defined level. A higher level means a higher priority. The\n first occurrence of the variable will be returned here.
\n", + "comments": "The value of the config will be copied into the buffer.
\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" }, "git_config_get_multivar_foreach": { @@ -5388,7 +5187,7 @@ "comment": null }, "description": "Get each value of a multivar in a foreach callback
\n", - "comments": "The callback will be called on each variable found
\n\nThe regular expression is applied case-sensitively on the normalized form of\n the variable name: the section and variable parts are lower-cased. The\n subsection is left unchanged.
\n", + "comments": "The callback will be called on each variable found
\n\nThe regular expression is applied case-sensitively on the normalized form of the variable name: the section and variable parts are lower-cased. The subsection is left unchanged.
\n", "group": "config" }, "git_config_multivar_iterator_new": { @@ -5425,7 +5224,7 @@ "comment": null }, "description": "Get each value of a multivar
\n", - "comments": "The regular expression is applied case-sensitively on the normalized form of\n the variable name: the section and variable parts are lower-cased. The\n subsection is left unchanged.
\n", + "comments": "The regular expression is applied case-sensitively on the normalized form of the variable name: the section and variable parts are lower-cased. The subsection is left unchanged.
\n", "group": "config" }, "git_config_next": { @@ -5452,7 +5251,7 @@ "comment": " 0 or an error code. GIT_ITEROVER if the iteration has completed" }, "description": "Return the current entry and advance the iterator
\n", - "comments": "The pointers returned by this function are valid until the iterator\n is freed.
\n", + "comments": "The pointers returned by this function are valid until the iterator is freed.
\n", "group": "config" }, "git_config_iterator_free": { @@ -5486,26 +5285,26 @@ { "name": "cfg", "type": "git_config *", - "comment": null + "comment": "where to look for the variable" }, { "name": "name", "type": "const char *", - "comment": null + "comment": "the variable's name" }, { "name": "value", - "type": "int", - "comment": null + "type": "int32_t", + "comment": "Integer value for the variable" } ], - "argline": "git_config *cfg, const char *name, int value", - "sig": "git_config *::const char *::int", + "argline": "git_config *cfg, const char *name, int32_t value", + "sig": "git_config *::const char *::int32_t", "return": { "type": "int", - "comment": null + "comment": " 0 or an error code" }, - "description": "", + "description": "Set the value of an integer config variable in the config file\n with the highest level (usually the local one).
\n", "comments": "", "group": "config" }, @@ -5518,26 +5317,26 @@ { "name": "cfg", "type": "git_config *", - "comment": null + "comment": "where to look for the variable" }, { "name": "name", "type": "const char *", - "comment": null + "comment": "the variable's name" }, { "name": "value", - "type": "int", - "comment": null + "type": "int64_t", + "comment": "Long integer value for the variable" } ], - "argline": "git_config *cfg, const char *name, int value", - "sig": "git_config *::const char *::int", + "argline": "git_config *cfg, const char *name, int64_t value", + "sig": "git_config *::const char *::int64_t", "return": { "type": "int", - "comment": null + "comment": " 0 or an error code" }, - "description": "", + "description": "Set the value of a long integer config variable in the config file\n with the highest level (usually the local one).
\n", "comments": "", "group": "config" }, @@ -5602,7 +5401,7 @@ "comment": " 0 or an error code" }, "description": "Set the value of a string config variable in the config file\n with the highest level (usually the local one).
\n", - "comments": "A copy of the string is made and the user is free to use it\n afterwards.
\n", + "comments": "A copy of the string is made and the user is free to use it afterwards.
\n", "group": "config" }, "git_config_set_multivar": { @@ -5730,7 +5529,7 @@ "comment": " 0 on success, non-zero callback return value, or error code" }, "description": "Perform an operation on each config variable.
\n", - "comments": "The callback receives the normalized name and value of each variable\n in the config backend, and the data pointer passed to this function.\n If the callback returns a non-zero value, the function stops iterating\n and returns that value to the caller.
\n\nThe pointers passed to the callback are only valid as long as the\n iteration is ongoing.
\n", + "comments": "The callback receives the normalized name and value of each variable in the config backend, and the data pointer passed to this function. If the callback returns a non-zero value, the function stops iterating and returns that value to the caller.
\n\nThe pointers passed to the callback are only valid as long as the iteration is ongoing.
\n", "group": "config" }, "git_config_iterator_new": { @@ -5757,7 +5556,7 @@ "comment": null }, "description": "Iterate over all the config variables
\n", - "comments": "Use git_config_next to advance the iteration and\n git_config_iterator_free when done.
Use git_config_next to advance the iteration and git_config_iterator_free when done.
Iterate over all the config variables whose name matches a pattern
\n", - "comments": "Use git_config_next to advance the iteration and\n git_config_iterator_free when done.
The regular expression is applied case-sensitively on the normalized form of\n the variable name: the section and variable parts are lower-cased. The\n subsection is left unchanged.
\n", + "comments": "Use git_config_next to advance the iteration and git_config_iterator_free when done.
The regular expression is applied case-sensitively on the normalized form of the variable name: the section and variable parts are lower-cased. The subsection is left unchanged.
\n", "group": "config" }, "git_config_foreach_match": { @@ -5826,7 +5625,7 @@ "comment": " 0 or the return value of the callback which didn't return 0" }, "description": "Perform an operation on each config variable matching a regular expression.
\n", - "comments": "This behaves like git_config_foreach with an additional filter of a\n regular expression that filters which config keys are passed to the\n callback.
The regular expression is applied case-sensitively on the normalized form of\n the variable name: the section and variable parts are lower-cased. The\n subsection is left unchanged.
\n\nThe regular expression is applied case-sensitively on the normalized form of\n the variable name: the case-insensitive parts are lower-case.
\n", + "comments": "This behaves like git_config_foreach with an additional filter of a regular expression that filters which config keys are passed to the callback.
The regular expression is applied case-sensitively on the normalized form of the variable name: the section and variable parts are lower-cased. The subsection is left unchanged.
\n\nThe regular expression is applied case-sensitively on the normalized form of the variable name: the case-insensitive parts are lower-case.
\n", "group": "config" }, "git_config_get_mapped": { @@ -5868,7 +5667,7 @@ "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\n to a variable to integer constants that easily identify them.
\n\nA mapping array looks as follows:
\n\ngit_cvar_map autocrlf_mapping[] = {\n {GIT_CVAR_FALSE, NULL, GIT_AUTO_CRLF_FALSE},\n {GIT_CVAR_TRUE, NULL, GIT_AUTO_CRLF_TRUE},\n {GIT_CVAR_STRING, "input", GIT_AUTO_CRLF_INPUT},\n {GIT_CVAR_STRING, "default", GIT_AUTO_CRLF_DEFAULT}};\nOn any "false" value for the variable (e.g. "false", "FALSE", "no"), the\n 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\n the GIT_AUTO_CRLF_TRUE variable.
Otherwise, if the value matches the string "input" (with case insensitive comparison),\n 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\n returned.
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.
Parse a string value as a bool.
\n", - "comments": "Valid values for true are: 'true', 'yes', 'on', 1 or any\n number different from 0\n Valid values for false are: 'false', 'no', 'off', 0
\n", + "comments": "Valid values for true are: 'true', 'yes', 'on', 1 or any number different from 0 Valid values for false are: 'false', 'no', 'off', 0
\n", "group": "config" }, "git_config_parse_int32": { @@ -5943,23 +5742,23 @@ "args": [ { "name": "out", - "type": "int *", - "comment": null + "type": "int32_t *", + "comment": "place to store the result of the parsing" }, { "name": "value", "type": "const char *", - "comment": null + "comment": "value to parse" } ], - "argline": "int *out, const char *value", - "sig": "int *::const char *", + "argline": "int32_t *out, const char *value", + "sig": "int32_t *::const char *", "return": { "type": "int", "comment": null }, - "description": "", - "comments": "", + "description": "Parse a string value as an int32.
\n", + "comments": "An optional value suffix of 'k', 'm', or 'g' will cause the value to be multiplied by 1024, 1048576, or 1073741824 prior to output.
\n", "group": "config" }, "git_config_parse_int64": { @@ -5970,23 +5769,23 @@ "args": [ { "name": "out", - "type": "int *", - "comment": null + "type": "int64_t *", + "comment": "place to store the result of the parsing" }, { "name": "value", "type": "const char *", - "comment": null + "comment": "value to parse" } ], - "argline": "int *out, const char *value", - "sig": "int *::const char *", + "argline": "int64_t *out, const char *value", + "sig": "int64_t *::const char *", "return": { "type": "int", "comment": null }, - "description": "", - "comments": "", + "description": "Parse a string value as an int64.
\n", + "comments": "An optional value suffix of 'k', 'm', or 'g' will cause the value to be multiplied by 1024, 1048576, or 1073741824 prior to output.
\n", "group": "config" }, "git_config_parse_path": { @@ -6013,7 +5812,7 @@ "comment": null }, "description": "Parse a string value as a path.
\n", - "comments": "A leading '~' will be expanded to the global search path (which\n defaults to the user's home directory but can be overridden via\n git_libgit2_opts().
If the value does not begin with a tilde, the input will be\n returned.
\n", + "comments": "A leading '~' will be expanded to the global search path (which defaults to the user's home directory but can be overridden via git_libgit2_opts().
If the value does not begin with a tilde, the input will be returned.
\n", "group": "config" }, "git_config_backend_foreach_match": { @@ -6050,7 +5849,7 @@ "comment": null }, "description": "Perform an operation on each config variable in a given config backend,\n matching a regular expression.
\n", - "comments": "This behaves like git_config_foreach_match except that only config\n entries from the given backend entry are enumerated.
The regular expression is applied case-sensitively on the normalized form of\n the variable name: the section and variable parts are lower-cased. The\n subsection is left unchanged.
\n", + "comments": "This behaves like git_config_foreach_match except that only config entries from the given backend entry are enumerated.
The regular expression is applied case-sensitively on the normalized form of the variable name: the section and variable parts are lower-cased. The subsection is left unchanged.
\n", "group": "config" }, "git_config_lock": { @@ -6077,7 +5876,7 @@ "comment": " 0 or an error code" }, "description": "Lock the backend with the highest priority
\n", - "comments": "Locking disallows anybody else from writing to that backend. Any\n updates made after locking will not be visible to a reader until\n the file is unlocked.
\n\nYou can apply the changes by calling git_transaction_commit()\n before freeing the transaction. Either of these actions will unlock\n the config.
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.
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_buf_free": { "type": "function", "file": "git2/deprecated.h", - "line": 51, - "lineto": 51, + "line": 115, + "lineto": 115, "args": [ { "name": "buffer", @@ -6141,14 +5972,14 @@ "comment": null }, "description": "Free the memory referred to by the git_buf. This is an alias of\n git_buf_dispose and is preserved for backward compatibility.
This function is deprecated, but there is no plan to remove this\n function at this time.
\n", + "comments": "This function is deprecated, but there is no plan to remove this function at this time.
\n", "group": "buf" }, "giterr_last": { "type": "function", "file": "git2/deprecated.h", - "line": 112, - "lineto": 112, + "line": 176, + "lineto": 176, "args": [], "argline": "", "sig": "", @@ -6157,14 +5988,14 @@ "comment": null }, "description": "Return the last git_error object that was generated for the\n current thread. This is an alias of git_error_last and is\n preserved for backward compatibility.
This function is deprecated, but there is no plan to remove this\n function at this time.
\n", + "comments": "This function is deprecated, but there is no plan to remove this function at this time.
\n", "group": "giterr" }, "giterr_clear": { "type": "function", "file": "git2/deprecated.h", - "line": 124, - "lineto": 124, + "line": 188, + "lineto": 188, "args": [], "argline": "", "sig": "", @@ -6173,14 +6004,14 @@ "comment": null }, "description": "Clear the last error. This is an alias of git_error_last and is\n preserved for backward compatibility.
This function is deprecated, but there is no plan to remove this\n function at this time.
\n", + "comments": "This function is deprecated, but there is no plan to remove this function at this time.
\n", "group": "giterr" }, "giterr_set_str": { "type": "function", "file": "git2/deprecated.h", - "line": 136, - "lineto": 136, + "line": 200, + "lineto": 200, "args": [ { "name": "error_class", @@ -6200,14 +6031,14 @@ "comment": null }, "description": "Sets the error message to the given string. This is an alias of\n git_error_set_str and is preserved for backward compatibility.
This function is deprecated, but there is no plan to remove this\n function at this time.
\n", + "comments": "This function is deprecated, but there is no plan to remove this function at this time.
\n", "group": "giterr" }, "giterr_set_oom": { "type": "function", "file": "git2/deprecated.h", - "line": 148, - "lineto": 148, + "line": 212, + "lineto": 212, "args": [], "argline": "", "sig": "", @@ -6216,10 +6047,59 @@ "comment": null }, "description": "Indicates that an out-of-memory situation occured. This is an alias\n of git_error_set_oom and is preserved for backward compatibility.
This function is deprecated, but there is no plan to remove this\n function at this time.
\n", + "comments": "This function is deprecated, but there is no plan to remove this function at this time.
\n", "group": "giterr" }, - "git_describe_init_options": { + "git_oid_iszero": { + "type": "function", + "file": "git2/deprecated.h", + "line": 364, + "lineto": 364, + "args": [ + { + "name": "id", + "type": "const git_oid *", + "comment": null + } + ], + "argline": "const git_oid *id", + "sig": "const git_oid *", + "return": { + "type": "int", + "comment": null + }, + "description": "", + "comments": "These types are retained for backward compatibility. The newer versions of these values 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": "oid" + }, + "git_blame_init_options": { + "type": "function", + "file": "git2/deprecated.h", + "line": 423, + "lineto": 423, + "args": [ + { + "name": "opts", + "type": "git_blame_options *", + "comment": null + }, + { + "name": "version", + "type": "unsigned int", + "comment": null + } + ], + "argline": "git_blame_options *opts, unsigned int version", + "sig": "git_blame_options *::unsigned int", + "return": { + "type": "int", + "comment": null + }, + "description": "", + "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 functions at this time.
\n\n@{
\n", + "group": "blame" + }, + "git_describe_options_init": { "type": "function", "file": "git2/describe.h", "line": 82, @@ -6243,15 +6123,15 @@ "comment": " Zero on success; -1 on failure." }, "description": "Initialize git_describe_options structure
\n", - "comments": "Initializes a git_describe_options with default values. Equivalent to creating\n an instance with GIT_DESCRIBE_OPTIONS_INIT.
Initializes a git_describe_options with default values. Equivalent to creating an instance with GIT_DESCRIBE_OPTIONS_INIT.
Initialize git_describe_format_options structure
\n", - "comments": "Initializes a git_describe_format_options with default values. Equivalent to creating\n an instance with GIT_DESCRIBE_FORMAT_OPTIONS_INIT.
Initializes a git_describe_format_options with default values. Equivalent to creating an instance with GIT_DESCRIBE_FORMAT_OPTIONS_INIT.
Describe a commit
\n", - "comments": "Perform the describe operation on the current commit and the\n worktree. After peforming describe on HEAD, a status is run and the\n description is considered to be dirty if there are.
\n", + "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.28.0/describe.html#git_describe_workdir-4" + "ex/HEAD/describe.html#git_describe_workdir-4" ] } }, @@ -6390,7 +6270,7 @@ "group": "describe", "examples": { "describe.c": [ - "ex/v0.28.0/describe.html#git_describe_format-5" + "ex/HEAD/describe.html#git_describe_format-5" ] } }, @@ -6416,7 +6296,7 @@ "comments": "", "group": "describe" }, - "git_diff_init_options": { + "git_diff_options_init": { "type": "function", "file": "git2/diff.h", "line": 454, @@ -6440,10 +6320,10 @@ "comment": " Zero on success; -1 on failure." }, "description": "Initialize git_diff_options structure
\n", - "comments": "Initializes a git_diff_options with default values. Equivalent to creating\n an instance with GIT_DIFF_OPTIONS_INIT.
Initializes a git_diff_options with default values. Equivalent to creating an instance with GIT_DIFF_OPTIONS_INIT.
Initialize git_diff_find_options structure
\n", - "comments": "Initializes a git_diff_find_options with default values. Equivalent to creating\n an instance with GIT_DIFF_FIND_OPTIONS_INIT.
Initializes a git_diff_find_options with default values. Equivalent to creating an instance with GIT_DIFF_FIND_OPTIONS_INIT.
Create a diff with the difference between two tree objects.
\n", - "comments": "This is equivalent to git diff \n<old\n-tree> \n<new\n-tree>
The first tree will be used for the "old_file" side of the delta and the\n second tree will be used for the "new_file" side of the delta. You can\n pass NULL to indicate an empty tree, although it is an error to pass\n NULL for both the old_tree and new_tree.
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.
Create a diff between a tree and repository index.
\n", - "comments": "This is equivalent to `git diff --cached \n<treeish
\n\n\n\n\n\n
or if you pass\n the HEAD tree, then likegit diff --cached`.
The tree you pass will be used for the "old_file" side of the delta, and\n 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\n will be used. In this case, the index will be refreshed from disk\n (if it has changed) before the diff is generated.
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.
Create a diff between the repository index and the workdir directory.
\n", - "comments": "This matches the git diff command. See the note below on\n git_diff_tree_to_workdir for a discussion of the difference between\n git diff and git diff HEAD and how to emulate a `git diff \n<treeish
\n\n\n`\n using libgit2.
\n
The index will be used for the "old_file" side of the delta, and the\n 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\n will be used. In this case, the index will be refreshed from disk\n (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.
Create a diff between a tree and the working directory.
\n", - "comments": "The tree you provide will be used for the "old_file" side of the delta,\n and the working directory will be used for the "new_file" side.
\n\nThis is not the same as `git diff \n<treeish
\n\n\n\n\n\n
orgit diff-index
<treeish
\n\n\n\n\n\n
. Those commands use information from the index, whereas this\n function strictly returns the differences between the tree and the files\n in the working directory, regardless of the state of the index. Use\ngit_diff_tree_to_workdir_with_index` to emulate those commands.
To see difference between this and git_diff_tree_to_workdir_with_index,\n consider the example of a staged file deletion where the file has then\n been put back into the working dir and further modified. The\n tree-to-workdir diff for that file is 'modified', but git diff would\n show status 'deleted' since there is a staged delete.
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.
Create a diff between a tree and the working directory using index data\n to account for staged deletes, tracked files, etc.
\n", - "comments": "This emulates `git diff \n<tree
\n\n\n\n", + "comments": "` by diffing the tree to the index and\n the index to the working directory and blending the results into a\n single diff that includes staged deleted, etc.
\n
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\n second index will be used for the "new_file" side of the delta.
\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": { @@ -6791,7 +6671,7 @@ "comment": null }, "description": "Merge one diff into another.
\n", - "comments": "This merges items from the "from" list into the "onto" list. The\n resulting diff will have all items that appear in either list.\n If an item appears in both lists, then it will be "merged" to appear\n as if the old version was from the "onto" list and the new version\n is from the "from" list (with the exception that if the item has a\n pending DELETE in the middle, then it will show as deleted).
\n", + "comments": "This merges items from the "from" list into the "onto" list. The resulting diff will have all items that appear in either list. If an item appears in both lists, then it will be "merged" to appear as if the old version was from the "onto" list and the new version is from the "from" list (with the exception that if the item has a pending DELETE in the middle, then it will show as deleted).
\n", "group": "diff" }, "git_diff_find_similar": { @@ -6818,11 +6698,11 @@ "comment": " 0 on success, -1 on failure" }, "description": "Transform a diff marking file renames, copies, etc.
\n", - "comments": "This modifies a diff in place, replacing old entries that look\n like renames or copies with new entries reflecting those changes.\n This also will, if requested, break modified files into add/remove\n pairs if the amount of change is above a threshold.
\n", + "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.28.0/diff.html#git_diff_find_similar-8" + "ex/HEAD/diff.html#git_diff_find_similar-8" ] } }, @@ -6849,7 +6729,7 @@ "group": "diff", "examples": { "log.c": [ - "ex/v0.28.0/log.html#git_diff_num_deltas-29" + "ex/HEAD/log.html#git_diff_num_deltas-29" ] } }, @@ -6877,7 +6757,7 @@ "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\n that is a git_delta_t and returns just the count of how many deltas\n match that particular type.
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\n have to release it when you are done with it. It will go away when\n the * git_diff (or any associated git_patch) goes away.
Note that the flags on the delta related to whether it has binary\n content or not may not be set if there are no attributes set for the\n file and there has been no reason to load the file data at this point.\n For now, if you need those flags to be up to date, your only option is\n to either use git_diff_foreach or create a git_patch.
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.
Loop over all deltas in a diff issuing callbacks.
\n", - "comments": "This will iterate through all of the files described in a diff. You\n should provide a file callback to learn about each file.
\n\nThe "hunk" and "line" callbacks are optional, and the text diff of the\n files will only be calculated if they are not NULL. Of course, these\n callbacks will not be invoked for binary files on the diff or for\n files whose only changed is a file mode change.
\n\nReturning a non-zero value from any of the callbacks will terminate\n the iteration and return the value to the user.
\n", + "comments": "This will iterate through all of the files described in a diff. You should provide a file callback to learn about each file.
\n\nThe "hunk" and "line" callbacks are optional, and the text diff of the files will only be calculated if they are not NULL. Of course, these callbacks will not be invoked for binary files on the diff or for files whose only changed is a file mode change.
\n\nReturning a non-zero value from any of the callbacks will terminate the iteration and return the value to the user.
\n", "group": "diff" }, "git_diff_status_char": { @@ -6995,7 +6875,7 @@ "comment": " The single character label for that code" }, "description": "Look up the single character abbreviation for a delta status code.
\n", - "comments": "When you run git diff --name-status it uses single letter codes in\n the output such as 'A' for added, 'D' for deleted, 'M' for modified,\n etc. This function converts a git_delta_t value into these letters for\n your own purposes. GIT_DELTA_UNTRACKED will return a space (i.e. ' ').
When you run git diff --name-status it uses single letter codes in the output such as 'A' for added, 'D' for deleted, 'M' for modified, etc. This function converts a git_delta_t value into these letters for your own purposes. GIT_DELTA_UNTRACKED will return a space (i.e. ' ').
Iterate over a diff generating formatted text output.
\n", - "comments": "Returning a non-zero value from the callbacks will terminate the\n iteration and return the non-zero value to the caller.
\n", + "comments": "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.28.0/diff.html#git_diff_print-9" + "ex/HEAD/diff.html#git_diff_print-9" ], "log.c": [ - "ex/v0.28.0/log.html#git_diff_print-30" + "ex/HEAD/log.html#git_diff_print-30" ] } }, @@ -7139,7 +7019,7 @@ "comment": " 0 on success, non-zero callback return value, or error code" }, "description": "Directly run a diff on two blobs.
\n", - "comments": "Compared to a file, a blob lacks some contextual information. As such,\n the git_diff_file given to the callback will have some fake data; i.e.\n mode will be 0 and path will be NULL.
NULL is allowed for either old_blob or new_blob and will be treated\n as an empty blob, with the oid set to NULL in the git_diff_file data.\n 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\n looks like binary data, the git_diff_delta binary attribute will be set\n to 1 and no call to the hunk_cb nor line_cb will be made (unless you pass\n GIT_DIFF_FORCE_TEXT of course).
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,\n so the git_diff_file parameters to the callbacks will be faked a la the\n rules for git_diff_blobs().
Passing NULL for old_blob will be treated as an empty blob (i.e. the\n file_cb will be invoked with GIT_DELTA_ADDED and the diff will be the\n entire content of the buffer added). Passing NULL to the buffer will do\n the reverse, with GIT_DELTA_REMOVED and blob content removed.
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\n context, so the git_diff_file parameters to the callbacks will be\n faked a la the rules for git_diff_blobs().
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().
Read the contents of a git patch file into a git_diff object.
The diff object produced is similar to the one that would be\n produced if you actually produced it computationally by comparing\n two trees, however there may be subtle differences. For example,\n a patch file likely contains abbreviated object IDs, so the\n object IDs in a git_diff_delta produced by this function will\n also be abbreviated.
This function will only read patch files created by a git\n implementation, it will not read unified diffs produced by\n the diff program, nor any other types of patch files.
The diff object produced is similar to the one that would be produced if you actually produced it computationally by comparing two trees, however there may be subtle differences. For example, a patch file likely contains abbreviated object IDs, so the object IDs in a git_diff_delta produced by this function will also be abbreviated.
This function will only read patch files created by a git implementation, it will not read unified diffs produced by the diff program, nor any other types of patch files.
Does not support creating patches for merge commits (yet).
\n", "group": "diff" }, - "git_diff_format_email_init_options": { + "git_diff_format_email_options_init": { "type": "function", "file": "git2/diff.h", "line": 1451, @@ -7598,10 +7478,10 @@ "comment": " Zero on success; -1 on failure." }, "description": "Initialize git_diff_format_email_options structure
\n", - "comments": "Initializes a git_diff_format_email_options with default values. Equivalent\n to creating an instance with GIT_DIFF_FORMAT_EMAIL_OPTIONS_INIT.
Initializes a git_diff_format_email_options with default values. Equivalent to creating an instance with GIT_DIFF_FORMAT_EMAIL_OPTIONS_INIT.
Initialize git_diff_patchid_options structure
\n", - "comments": "Initializes a git_diff_patchid_options with default values. Equivalent to\n creating an instance with GIT_DIFF_PATCHID_OPTIONS_INIT.
Initializes a git_diff_patchid_options with default values. Equivalent to creating an instance with GIT_DIFF_PATCHID_OPTIONS_INIT.
Calculate the patch ID for the given patch.
\n", - "comments": "Calculate a stable patch ID for the given patch by summing the\n hash of the file diffs, ignoring whitespace and line numbers.\n This can be used to derive whether two diffs are the same with\n a high probability.
\n\nCurrently, this function only calculates stable patch IDs, as\n defined in git-patch-id(1), and should in fact generate the\n same IDs as the upstream git project does.
\n", + "comments": "Calculate a stable patch ID for the given patch by summing the hash of the file diffs, ignoring whitespace and line numbers. This can be used to derive whether two diffs are the same with a high probability.
\n\nCurrently, this function only calculates stable patch IDs, as defined in git-patch-id(1), and should in fact generate the same IDs as the upstream git project does.
\n", "group": "diff" }, "git_error_last": { @@ -7673,21 +7553,21 @@ "comment": " A git_error object." }, "description": "Return the last git_error object that was generated for the\n current thread.
The default behaviour of this function is to return NULL if no previous error has occurred.\n However, libgit2's error strings are not cleared aggressively, so a prior\n (unrelated) error may be returned. This can be avoided by only calling\n this function if the prior call to a libgit2 API returned an error.
\n", + "comments": "The default behaviour of this function is to return NULL if no previous error has occurred. However, libgit2's error strings are not cleared aggressively, so a prior (unrelated) error may be returned. This can be avoided by only calling this function if the prior call to a libgit2 API returned an error.
\n", "group": "error", "examples": { "checkout.c": [ - "ex/v0.28.0/checkout.html#git_error_last-8", - "ex/v0.28.0/checkout.html#git_error_last-9", - "ex/v0.28.0/checkout.html#git_error_last-10", - "ex/v0.28.0/checkout.html#git_error_last-11" + "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" ], "general.c": [ - "ex/v0.28.0/general.html#git_error_last-33" + "ex/HEAD/general.html#git_error_last-33" ], "merge.c": [ - "ex/v0.28.0/merge.html#git_error_last-8", - "ex/v0.28.0/merge.html#git_error_last-9" + "ex/HEAD/merge.html#git_error_last-8", + "ex/HEAD/merge.html#git_error_last-9" ] } }, @@ -7731,7 +7611,7 @@ "comment": null }, "description": "Set the error message string for this thread.
\n", - "comments": "This function is public so that custom ODB backends and the like can\n relay an error message through libgit2. Most regular users of libgit2\n will never need to call this function -- actually, calling it in most\n circumstances (for example, calling from within a callback function)\n will just end up having the value overwritten by libgit2 internals.
\n\nThis error message is stored in thread-local storage and only applies\n to the particular thread that this libgit2 call is made from.
\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", "group": "error" }, "git_error_set_oom": { @@ -7747,7 +7627,7 @@ "comment": null }, "description": "Set the error message to a special value for memory allocation failure.
\n", - "comments": "The normal git_error_set_str() function attempts to strdup() the\n string that is passed in. This is not a good idea when the error in\n question is a memory allocation failure. That circumstance has a\n special setter function that sets the error string to a known and\n statically allocated internal value.
The normal git_error_set_str() function attempts to strdup() the string that is passed in. This is not a good idea when the error in question is a memory allocation failure. That circumstance has a special setter function that sets the error string to a known and statically allocated internal value.
Load the filter list for a given path.
\n", + "comments": "This will return 0 (success) but set the output git_filter_list to NULL if no filters are requested for the given file.
\n", "group": "filter" }, "git_filter_list_contains": { @@ -7821,7 +7701,7 @@ "comment": " 1 if the filter is in the list, 0 otherwise" }, "description": "Query the filter list to see if a given filter (by name) will run.\n The built-in filters "crlf" and "ident" can be queried, otherwise this\n is the name of the filter specified by the filter attribute.
\n", - "comments": "This will return 0 if the given filter is not in the list, or 1 if\n the filter will be applied.
\n", + "comments": "This will return 0 if the given filter is not in the list, or 1 if the filter will be applied.
\n", "group": "filter" }, "git_filter_list_apply_to_data": { @@ -7853,7 +7733,7 @@ "comment": " 0 on success, an error code otherwise" }, "description": "Apply filter list to a data buffer.
\n", - "comments": "See git2/buffer.h for background on git_buf objects.
If the in buffer holds data allocated by libgit2 (i.e. in->asize is\n not zero), then it will be overwritten when applying the filters. If\n not, then it will be left untouched.
If there are no filters to apply (or filters is NULL), then the out\n buffer will reference the in buffer data (with asize set to zero)\n instead of allocating data. This keeps allocations to a minimum, but\n it means you have to be careful about freeing the in data since out\n may be pointing to it!
See git2/buffer.h for background on git_buf objects.
If the in buffer holds data allocated by libgit2 (i.e. in->asize is not zero), then it will be overwritten when applying the filters. If not, then it will be left untouched.
If there are no filters to apply (or filters is NULL), then the out buffer will reference the in buffer data (with asize set to zero) instead of allocating data. This keeps allocations to a minimum, but it means you have to be careful about freeing the in data since out may be pointing to it!
Init the global state
\n", - "comments": "This function must be called before any other libgit2 function in\n order to set up global state and threading.
\n\nThis function may be called multiple times - it will return the number\n of times the initialization has been called (including this one) that have\n not subsequently been shutdown.
\n", + "comments": "This function must be 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.28.0/blame.html#git_libgit2_init-8" - ], - "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_libgit2_init-10" - ], - "checkout.c": [ - "ex/v0.28.0/checkout.html#git_libgit2_init-12" - ], - "describe.c": [ - "ex/v0.28.0/describe.html#git_libgit2_init-6" - ], - "diff.c": [ - "ex/v0.28.0/diff.html#git_libgit2_init-13" - ], "general.c": [ - "ex/v0.28.0/general.html#git_libgit2_init-34" - ], - "init.c": [ - "ex/v0.28.0/init.html#git_libgit2_init-2" - ], - "log.c": [ - "ex/v0.28.0/log.html#git_libgit2_init-31" - ], - "ls-files.c": [ - "ex/v0.28.0/ls-files.html#git_libgit2_init-1" - ], - "merge.c": [ - "ex/v0.28.0/merge.html#git_libgit2_init-10" - ], - "remote.c": [ - "ex/v0.28.0/remote.html#git_libgit2_init-2" - ], - "rev-parse.c": [ - "ex/v0.28.0/rev-parse.html#git_libgit2_init-1" - ], - "status.c": [ - "ex/v0.28.0/status.html#git_libgit2_init-1" - ], - "tag.c": [ - "ex/v0.28.0/tag.html#git_libgit2_init-3" + "ex/HEAD/general.html#git_libgit2_init-34" ] } }, @@ -8121,49 +7962,8 @@ "comment": " the number of remaining initializations of the library, or an\n error code." }, "description": "Shutdown the global state
\n", - "comments": "Clean up the global state and threading context after calling it as\n many times as git_libgit2_init() was called - it will return the\n number of remainining initializations that have not been shutdown\n (after this one).
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\n upstream relationship, but it helps to think of one as a branch and\n the other as its upstream, the ahead and behind values will be\n what git would report for the branches.
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.
Determine if a commit is the descendant of another commit.
\n", - "comments": "Note that a commit is not considered a descendant of itself, in contrast\n to git merge-base --is-ancestor.
Note that a commit is not considered a descendant of itself, in contrast to git merge-base --is-ancestor.
Add ignore rules for a repository.
\n", - "comments": "Excludesfile rules (i.e. .gitignore rules) are generally read from\n .gitignore files in the repository tree or from a shared system file\n only if a "core.excludesfile" config value is set. The library also\n keeps a set of per-repository internal ignores that can be configured\n in-memory and will not persist. This function allows you to add to\n that internal rules list.
\n\nExample usage:
\n\n error = git_ignore_add_rule(myrepo, "*.c\n/
\n\nwith space
\n\n");
\n\nThis would add three rules to the ignores.
\n", + "comments": "Excludesfile rules (i.e. .gitignore rules) are generally read from .gitignore files in the repository tree or from a shared system file only if a "core.excludesfile" config value is set. The library also keeps a set of per-repository internal ignores that can be configured in-memory and will not persist. This function allows you to add to that internal rules list.
\n\nExample usage:
\n\n error = git_ignore_add_rule(myrepo, "*.c/ with space");\nThis would add three rules to the ignores.
\n", "group": "ignore" }, "git_ignore_clear_internal_rules": { @@ -8285,7 +8085,7 @@ "comment": " 0 on success" }, "description": "Clear ignore rules that were explicitly added.
\n", - "comments": "Resets to the default internal ignore rules. This will not turn off\n rules in .gitignore files that actually exist in the filesystem.
\n\nThe default internal ignores ignore ".", ".." and ".git" entries.
\n", + "comments": "Resets to the default internal ignore rules. This will not turn off rules in .gitignore files that actually exist in the filesystem.
\n\nThe default internal ignores ignore ".", ".." and ".git" entries.
\n", "group": "ignore" }, "git_ignore_path_is_ignored": { @@ -8317,14 +8117,14 @@ "comment": " 0 if ignore rules could be processed for the file (regardless\n of whether it exists or not), or an error \n<\n 0 if they could not." }, "description": "Test if the ignore rules apply to a given path.
\n", - "comments": "This function checks the ignore rules to see if they would apply to the\n given file. This indicates if the file would be ignored regardless of\n whether the file is already in the index or committed to the repository.
\n\nOne way to think of this is if you were to do "git check-ignore --no-index"\n on the given file, would it be shown or not?
\n", + "comments": "This function checks the ignore rules to see if they would apply to the given file. This indicates if the file would be ignored regardless of whether the file is already in the index or committed to the repository.
\n\nOne way to think of this is if you were to do "git check-ignore --no-index" on the given file, would it be shown or not?
\n", "group": "ignore" }, "git_index_open": { "type": "function", "file": "git2/index.h", - "line": 186, - "lineto": 186, + "line": 187, + "lineto": 187, "args": [ { "name": "out", @@ -8344,14 +8144,14 @@ "comment": " 0 or an error code" }, "description": "Create a new bare Git index object as a memory representation\n of the Git index file in 'index_path', without a repository\n to back it.
\n", - "comments": "Since there is no ODB or working directory behind this index,\n any Index methods which rely on these (e.g. index_add_bypath)\n will fail with the GIT_ERROR error code.
\n\nIf you need to access the index of an actual repository,\n use the git_repository_index wrapper.
The index must be freed once it's no longer in use.
\n", + "comments": "Since there is no ODB or working directory behind this index, any Index methods which rely on these (e.g. index_add_bypath) will fail with the GIT_ERROR error code.
\n\nIf you need to access the index of an actual repository, use the git_repository_index wrapper.
The index must be freed once it's no longer in use.
\n", "group": "index" }, "git_index_new": { "type": "function", "file": "git2/index.h", - "line": 199, - "lineto": 199, + "line": 200, + "lineto": 200, "args": [ { "name": "out", @@ -8366,14 +8166,14 @@ "comment": " 0 or an error code" }, "description": "Create an in-memory index object.
\n", - "comments": "This index object cannot be read/written to the filesystem,\n but may be used to perform in-memory index operations.
\n\nThe index must be freed once it's no longer in use.
\n", + "comments": "This index object cannot be read/written to the filesystem, but may be used to perform in-memory index operations.
\n\nThe index must be freed once it's no longer in use.
\n", "group": "index" }, "git_index_free": { "type": "function", "file": "git2/index.h", - "line": 206, - "lineto": 206, + "line": 207, + "lineto": 207, "args": [ { "name": "index", @@ -8391,22 +8191,25 @@ "comments": "", "group": "index", "examples": { + "add.c": [ + "ex/HEAD/add.html#git_index_free-1" + ], "general.c": [ - "ex/v0.28.0/general.html#git_index_free-35" + "ex/HEAD/general.html#git_index_free-35" ], "init.c": [ - "ex/v0.28.0/init.html#git_index_free-4" + "ex/HEAD/init.html#git_index_free-2" ], "ls-files.c": [ - "ex/v0.28.0/ls-files.html#git_index_free-3" + "ex/HEAD/ls-files.html#git_index_free-1" ] } }, "git_index_owner": { "type": "function", "file": "git2/index.h", - "line": 214, - "lineto": 214, + "line": 215, + "lineto": 215, "args": [ { "name": "index", @@ -8427,8 +8230,8 @@ "git_index_caps": { "type": "function", "file": "git2/index.h", - "line": 222, - "lineto": 222, + "line": 223, + "lineto": 223, "args": [ { "name": "index", @@ -8449,8 +8252,8 @@ "git_index_set_caps": { "type": "function", "file": "git2/index.h", - "line": 235, - "lineto": 235, + "line": 236, + "lineto": 236, "args": [ { "name": "index", @@ -8470,14 +8273,14 @@ "comment": " 0 on success, -1 on failure" }, "description": "Set index capabilities flags.
\n", - "comments": "If you pass GIT_INDEX_CAPABILITY_FROM_OWNER for the caps, then\n capabilities will be read from the config of the owner object,\n looking at core.ignorecase, core.filemode, core.symlinks.
If you pass GIT_INDEX_CAPABILITY_FROM_OWNER for the caps, then capabilities will be read from the config of the owner object, looking at core.ignorecase, core.filemode, core.symlinks.
Get index on-disk version.
\n", - "comments": "Valid return values are 2, 3, or 4. If 3 is returned, an index\n with version 2 may be written instead, if the extension data in\n version 3 is not necessary.
\n", + "comments": "Valid return values are 2, 3, or 4. If 3 is returned, an index with version 2 may be written instead, if the extension data in version 3 is not necessary.
\n", "group": "index" }, "git_index_set_version": { "type": "function", "file": "git2/index.h", - "line": 260, - "lineto": 260, + "line": 261, + "lineto": 261, "args": [ { "name": "index", @@ -8519,14 +8322,14 @@ "comment": " 0 on success, -1 on failure" }, "description": "Set index on-disk version.
\n", - "comments": "Valid values are 2, 3, or 4. If 2 is given, git_index_write may\n write an index with version 3 instead, if necessary to accurately\n represent the index.
\n", + "comments": "Valid values are 2, 3, or 4. If 2 is given, git_index_write may write an index with version 3 instead, if necessary to accurately represent the index.
\n", "group": "index" }, "git_index_read": { "type": "function", "file": "git2/index.h", - "line": 279, - "lineto": 279, + "line": 280, + "lineto": 280, "args": [ { "name": "index", @@ -8546,14 +8349,14 @@ "comment": " 0 or an error code" }, "description": "Update the contents of an existing index object in memory by reading\n from the hard disk.
\n", - "comments": "If force is true, this performs a "hard" read that discards in-memory\n changes and always reloads the on-disk index data. If there is no\n on-disk version, the index will be cleared.
If force is false, this does a "soft" read that reloads the index\n data from disk only if it has changed since the last time it was\n loaded. Purely in-memory index data will be untouched. Be aware: if\n there are changes on disk, unwritten in-memory changes are discarded.
If force is true, this performs a "hard" read that discards in-memory changes and always reloads the on-disk index data. If there is no on-disk version, the index will be cleared.
If force is false, this does a "soft" read that reloads the index data from disk only if it has changed since the last time it was loaded. Purely in-memory index data will be untouched. Be aware: if there are changes on disk, unwritten in-memory changes are discarded.
Write an existing index object from memory back to disk\n using an atomic file lock.
\n", "comments": "", - "group": "index" + "group": "index", + "examples": { + "add.c": [ + "ex/HEAD/add.html#git_index_write-2" + ] + } }, "git_index_path": { "type": "function", "file": "git2/index.h", - "line": 296, - "lineto": 296, + "line": 297, + "lineto": 297, "args": [ { "name": "index", @@ -8596,8 +8404,8 @@ "git_index_checksum": { "type": "function", "file": "git2/index.h", - "line": 308, - "lineto": 308, + "line": 309, + "lineto": 309, "args": [ { "name": "index", @@ -8612,14 +8420,14 @@ "comment": " a pointer to the checksum of the index" }, "description": "Get the checksum of the index
\n", - "comments": "This checksum is the SHA-1 hash over the index file (except the\n last 20 bytes which are the checksum itself). In cases where the\n index does not exist on-disk, it will be zeroed out.
\n", + "comments": "This checksum is the SHA-1 hash over the index file (except the last 20 bytes which are the checksum itself). In cases where the index does not exist on-disk, it will be zeroed out.
\n", "group": "index" }, "git_index_read_tree": { "type": "function", "file": "git2/index.h", - "line": 319, - "lineto": 319, + "line": 320, + "lineto": 320, "args": [ { "name": "index", @@ -8645,8 +8453,8 @@ "git_index_write_tree": { "type": "function", "file": "git2/index.h", - "line": 340, - "lineto": 340, + "line": 341, + "lineto": 341, "args": [ { "name": "out", @@ -8666,22 +8474,22 @@ "comment": " 0 on success, GIT_EUNMERGED when the index is not clean\n or an error code" }, "description": "Write the index as a tree
\n", - "comments": "This method will scan the index and write a representation\n of its current state back to disk; it recursively creates\n tree objects for each of the subtrees stored in the index,\n but only returns the OID of the root tree. This is the OID\n that can be used e.g. to create a commit.
\n\nThe index instance cannot be bare, and needs to be associated\n to an existing repository.
\n\nThe index must not contain any file in conflict.
\n", + "comments": "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.28.0/init.html#git_index_write_tree-5" + "ex/HEAD/init.html#git_index_write_tree-3" ], "merge.c": [ - "ex/v0.28.0/merge.html#git_index_write_tree-12" + "ex/HEAD/merge.html#git_index_write_tree-10" ] } }, "git_index_write_tree_to": { "type": "function", "file": "git2/index.h", - "line": 357, - "lineto": 357, + "line": 358, + "lineto": 358, "args": [ { "name": "out", @@ -8706,14 +8514,14 @@ "comment": " 0 on success, GIT_EUNMERGED when the index is not clean\n or an error code" }, "description": "Write the index as a tree to the given repository
\n", - "comments": "This method will do the same as git_index_write_tree, but\n letting the user choose the repository where the tree will\n be written.
The index must not contain any file in conflict.
\n", + "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": "git2/index.h", - "line": 376, - "lineto": 376, + "line": 377, + "lineto": 377, "args": [ { "name": "index", @@ -8732,18 +8540,18 @@ "group": "index", "examples": { "general.c": [ - "ex/v0.28.0/general.html#git_index_entrycount-36" + "ex/HEAD/general.html#git_index_entrycount-36" ], "ls-files.c": [ - "ex/v0.28.0/ls-files.html#git_index_entrycount-4" + "ex/HEAD/ls-files.html#git_index_entrycount-2" ] } }, "git_index_clear": { "type": "function", "file": "git2/index.h", - "line": 387, - "lineto": 387, + "line": 388, + "lineto": 388, "args": [ { "name": "index", @@ -8758,14 +8566,14 @@ "comment": " 0 on success, error code \n<\n 0 on failure" }, "description": "Clear the contents (all the entries) of an index object.
\n", - "comments": "This clears the index object in memory; changes must be explicitly\n written to disk for them to take effect persistently.
\n", + "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": "git2/index.h", - "line": 400, - "lineto": 401, + "line": 401, + "lineto": 402, "args": [ { "name": "index", @@ -8785,22 +8593,22 @@ "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\n git_index_entry struct is a publicly defined struct, you should\n be able to make your own permanent copy of the data if necessary.
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.
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\n git_index_entry struct is a publicly defined struct, you should\n be able to make your own permanent copy of the data if necessary.
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.
Add or update an index entry from an in-memory struct
\n", - "comments": "If a previous index entry exists that has the same path and stage\n as the given 'source_entry', it will be replaced. Otherwise, the\n 'source_entry' will be added.
\n\nA full copy (including the 'path' string) of the given\n 'source_entry' will be inserted on the index.
\n", + "comments": "If a previous index entry exists that has the same path and stage as the given 'source_entry', it will be replaced. Otherwise, the 'source_entry' will be added.
\n\nA full copy (including the 'path' string) of the given 'source_entry' will be inserted on the index.
\n", "group": "index" }, "git_index_entry_stage": { "type": "function", "file": "git2/index.h", - "line": 465, - "lineto": 465, + "line": 466, + "lineto": 466, "args": [ { "name": "entry", @@ -8943,14 +8751,14 @@ "comment": " the stage number" }, "description": "Return the stage number from a git index entry
\n", - "comments": "This entry is calculated from the entry's flag attribute like this:
\n\n(entry->flags \n&\n GIT_INDEX_ENTRY_STAGEMASK) >> GIT_INDEX_ENTRY_STAGESHIFT
\n", + "comments": "This entry is calculated from the entry's flag attribute like this:
\n\n(entry->flags & GIT_INDEX_ENTRY_STAGEMASK) >> GIT_INDEX_ENTRY_STAGESHIFT\nAdd or update an index entry from a file on disk
\n", - "comments": "The file path must be relative to the repository's\n 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\n at gitignore rules. Those rules can be evaluated through\n the git_status APIs (in status.h) before calling this.
\n\nIf this file currently is the result of a merge conflict, this\n file will no longer be marked as conflicting. The data about\n the conflict will be moved to the "resolve undo" (REUC) section.
\n", + "comments": "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": { + "git_index_add_from_buffer": { "type": "function", "file": "git2/index.h", - "line": 574, - "lineto": 577, + "line": 575, + "lineto": 578, "args": [ { "name": "index", @@ -9105,14 +8913,14 @@ "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\n index and then add the index entry to the index. The path of the\n entry represents the position of the blob relative to the\n repository's root folder.
If a previous index entry exists that has the same path as the\n given 'entry', it will be replaced. Otherwise, the 'entry' will be\n added. The id and the file_size of the 'entry' are updated with the\n real value of the blob.
This forces the file to be added to the index, not looking\n at gitignore rules. Those rules can be evaluated through\n the git_status APIs (in status.h) before calling this.
\n\nIf this file currently is the result of a merge conflict, this\n file will no longer be marked as conflicting. The data about\n the conflict will be moved to the "resolve undo" (REUC) section.
\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": "git2/index.h", - "line": 593, - "lineto": 593, + "line": 594, + "lineto": 594, "args": [ { "name": "index", @@ -9132,14 +8940,14 @@ "comment": " 0 or an error code" }, "description": "Remove an index entry corresponding to a file on disk
\n", - "comments": "The file path must be relative to the repository's\n working folder. It may exist.
If this file currently is the result of a merge conflict, this\n file will no longer be marked as conflicting. The data about\n the conflict will be moved to the "resolve undo" (REUC) section.
\n", + "comments": "The file path must be relative to the repository's working folder. It may exist.
If this file currently is the result of a merge conflict, this file will no longer be marked as conflicting. The data about the conflict will be moved to the "resolve undo" (REUC) section.
\n", "group": "index" }, "git_index_add_all": { "type": "function", "file": "git2/index.h", - "line": 641, - "lineto": 646, + "line": 642, + "lineto": 647, "args": [ { "name": "index", @@ -9174,14 +8982,19 @@ "comment": " 0 on success, negative callback return value, or error code" }, "description": "Add or update index entries matching files in the working directory.
\n", - "comments": "This method will fail in bare index instances.
\n\nThe pathspec is a list of file names or shell glob patterns that will\n be matched against files in the repository's working directory. Each\n file that matches will be added to the index (either updating an\n existing entry or adding a new entry). You can disable glob expansion\n and force exact matching with the GIT_INDEX_ADD_DISABLE_PATHSPEC_MATCH\n flag.
Files that are ignored will be skipped (unlike git_index_add_bypath).\n If a file is already tracked in the index, then it will be updated\n even if it is ignored. Pass the GIT_INDEX_ADD_FORCE flag to skip\n the checking of ignore rules.
To emulate git add -A and generate an error if the pathspec contains\n the exact path of an ignored file (when not using FORCE), add the\n GIT_INDEX_ADD_CHECK_PATHSPEC flag. This checks that each entry\n in the pathspec that is an exact match to a filename on disk is\n either not ignored or already in the index. If this check fails, the\n function will return GIT_EINVALIDSPEC.
To emulate git add -A with the "dry-run" option, just use a callback\n function that always returns a positive value. See below for details.
If any files are currently the result of a merge conflict, those files\n will no longer be marked as conflicting. The data about the conflicts\n will be moved to the "resolve undo" (REUC) section.
\n\nIf you provide a callback function, it will be invoked on each matching\n item in the working directory immediately before it is added to /\n updated in the index. Returning zero will add the item to the index,\n greater than zero will skip the item, and less than zero will abort the\n scan and return that value to the caller.
\n", - "group": "index" + "comments": "This method will fail in bare index instances.
\n\nThe pathspec is a list of file names or shell glob patterns that will be matched against files in the repository's working directory. Each file that matches will be added to the index (either updating an existing entry or adding a new entry). You can disable glob expansion and force exact matching with the GIT_INDEX_ADD_DISABLE_PATHSPEC_MATCH flag.
Files that are ignored will be skipped (unlike git_index_add_bypath). If a file is already tracked in the index, then it will be updated even if it is ignored. Pass the GIT_INDEX_ADD_FORCE flag to skip the checking of ignore rules.
To emulate git add -A and generate an error if the pathspec contains the exact path of an ignored file (when not using FORCE), add the GIT_INDEX_ADD_CHECK_PATHSPEC flag. This checks that each entry in the pathspec that is an exact match to a filename on disk is either not ignored or already in the index. If this check fails, the function will return GIT_EINVALIDSPEC.
To emulate git add -A with the "dry-run" option, just use a callback function that always returns a positive value. See below for details.
If any files are currently the result of a merge conflict, those files will no longer be marked as conflicting. The data about the conflicts will be moved to the "resolve undo" (REUC) section.
\n\nIf you provide a callback function, it will be invoked on each matching item in the working directory immediately before it is added to / updated in the index. Returning zero will add the item to the index, greater than zero will skip the item, and less than zero will abort the scan and return that value to the caller.
\n", + "group": "index", + "examples": { + "add.c": [ + "ex/HEAD/add.html#git_index_add_all-3" + ] + } }, "git_index_remove_all": { "type": "function", "file": "git2/index.h", - "line": 663, - "lineto": 667, + "line": 664, + "lineto": 668, "args": [ { "name": "index", @@ -9211,14 +9024,14 @@ "comment": " 0 on success, negative callback return value, or error code" }, "description": "Remove all matching index entries.
\n", - "comments": "If you provide a callback function, it will be invoked on each matching\n item in the index immediately before it is removed. Return 0 to\n remove the item, > 0 to skip the item, and \n<\n 0 to abort the scan.
\n", + "comments": "If you provide a callback function, it will be invoked on each matching item in the index immediately before it is removed. Return 0 to remove the item, > 0 to skip the item, and < 0 to abort the scan.
\n", "group": "index" }, "git_index_update_all": { "type": "function", "file": "git2/index.h", - "line": 692, - "lineto": 696, + "line": 693, + "lineto": 697, "args": [ { "name": "index", @@ -9248,14 +9061,19 @@ "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\n working directory, deleting them if the corresponding working directory\n file no longer exists otherwise updating the information (including\n 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\n item in the index immediately before it is updated (either refreshed\n or removed depending on working directory state). Return 0 to proceed\n with updating the item, > 0 to skip the item, and \n<\n 0 to abort the scan.
\n", - "group": "index" + "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", + "examples": { + "add.c": [ + "ex/HEAD/add.html#git_index_update_all-4" + ] + } }, "git_index_find": { "type": "function", "file": "git2/index.h", - "line": 707, - "lineto": 707, + "line": 708, + "lineto": 708, "args": [ { "name": "at_pos", @@ -9286,8 +9104,8 @@ "git_index_find_prefix": { "type": "function", "file": "git2/index.h", - "line": 718, - "lineto": 718, + "line": 719, + "lineto": 719, "args": [ { "name": "at_pos", @@ -9318,8 +9136,8 @@ "git_index_conflict_add": { "type": "function", "file": "git2/index.h", - "line": 743, - "lineto": 747, + "line": 744, + "lineto": 748, "args": [ { "name": "index", @@ -9349,14 +9167,14 @@ "comment": " 0 or an error code" }, "description": "Add or update index entries to represent a conflict. Any staged\n entries that exist at the given paths will be removed.
\n", - "comments": "The entries are the entries from the tree included in the merge. Any\n entry may be null to indicate that that file was not present in the\n trees during the merge. For example, ancestor_entry may be NULL to\n indicate that a file was added in both branches and must be resolved.
\n", + "comments": "The entries are the entries from the tree included in the merge. Any entry may be null to indicate that that file was not present in the trees during the merge. For example, ancestor_entry may be NULL to indicate that a file was added in both branches and must be resolved.
\n", "group": "index" }, "git_index_conflict_get": { "type": "function", "file": "git2/index.h", - "line": 763, - "lineto": 768, + "line": 764, + "lineto": 769, "args": [ { "name": "ancestor_out", @@ -9391,14 +9209,14 @@ "comment": " 0 or an error code" }, "description": "Get the index entries that represent a conflict of a single file.
\n", - "comments": "The entries are not modifiable and should not be freed. Because the\n git_index_entry struct is a publicly defined struct, you should\n be able to make your own permanent copy of the data if necessary.
The entries are 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.
Get the packfile's hash
\n", - "comments": "A packfile's name is derived from the sorted hashing of all object\n names. This is only correct after the index has been finalized.
\n", + "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" }, "git_indexer_free": { "type": "function", "file": "git2/indexer.h", - "line": 98, - "lineto": 98, + "line": 142, + "lineto": 142, "args": [ { "name": "idx", @@ -9748,33 +9566,6 @@ "comments": "", "group": "indexer" }, - "imaxdiv": { - "type": "function", - "file": "git2/inttypes.h", - "line": 284, - "lineto": 298, - "args": [ - { - "name": "numer", - "type": "intmax_t", - "comment": null - }, - { - "name": "denom", - "type": "intmax_t", - "comment": null - } - ], - "argline": "intmax_t numer, intmax_t denom", - "sig": "intmax_t::intmax_t", - "return": { - "type": "int", - "comment": null - }, - "description": "", - "comments": "", - "group": "imaxdiv" - }, "git_mailmap_new": { "type": "function", "file": "git2/mailmap.h", @@ -9794,7 +9585,7 @@ "comment": " 0 on success, or an error code" }, "description": "Allocate a new mailmap object.
\n", - "comments": "This object is empty, so you'll have to add a mailmap file before you can do\n anything with it. The mailmap must be freed with 'git_mailmap_free'.
\n", + "comments": "This object is empty, so you'll have to add a mailmap file before you can do anything with it. The mailmap must be freed with 'git_mailmap_free'.
\n", "group": "mailmap" }, "git_mailmap_free": { @@ -9917,7 +9708,7 @@ "comment": " 0 on success, or an error code" }, "description": "Create a new mailmap instance from a repository, loading mailmap files based\n on the repository's configuration.
\n", - "comments": "Mailmaps are loaded in the following order:\n 1. '.mailmap' in the root of the repository's working directory, if present.\n 2. The blob object identified by the 'mailmap.blob' config entry, if set.\n [NOTE: 'mailmap.blob' defaults to 'HEAD:.mailmap' in bare repositories]\n 3. The path in the 'mailmap.file' config entry, if set.
\n", + "comments": "Mailmaps are loaded in the following order: 1. '.mailmap' in the root of the repository's working directory, if present. 2. The blob object identified by the 'mailmap.blob' config entry, if set. [NOTE: 'mailmap.blob' defaults to 'HEAD:.mailmap' in bare repositories] 3. The path in the 'mailmap.file' config entry, if set.
\n", "group": "mailmap" }, "git_mailmap_resolve": { @@ -9994,7 +9785,7 @@ "comments": "Call git_signature_free() to free the data.
Initialize git_merge_file_options structure
\n", - "comments": "Initializes a git_merge_file_options with default values. Equivalent to\n creating an instance with GIT_MERGE_FILE_OPTIONS_INIT.
Initializes a git_merge_file_options with default values. Equivalent to creating an instance with GIT_MERGE_FILE_OPTIONS_INIT.
Initialize git_merge_options structure
\n", - "comments": "Initializes a git_merge_options with default values. Equivalent to\n creating an instance with GIT_MERGE_OPTIONS_INIT.
Initializes a git_merge_options with default values. Equivalent to creating an instance with GIT_MERGE_OPTIONS_INIT.
Merge two files as they exist in the in-memory data structures, using\n the given common ancestor as the baseline, producing a\n git_merge_file_result that reflects the merge result. The\n git_merge_file_result must be freed with git_merge_file_result_free.
Note that this function does not reference a repository and any\n configuration must be passed as git_merge_file_options.
Note that this function does not reference a repository and any configuration must be passed as git_merge_file_options.
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\n state. Once the commit is done (or if the uses wishes to abort),\n you should clear this state by calling\n git_repository_state_cleanup().
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().
Parse trailers out of a message, filling the array pointed to by +arr+.
\n", - "comments": "Trailers are key/value pairs in the last paragraph of a message, not\n including any patches or conflicts that may be present.
\n", + "comments": "Trailers are key/value pairs in the last paragraph of a message, not including any patches or conflicts that may be present.
\n", "group": "message" }, "git_message_trailer_array_free": { @@ -11086,7 +10877,7 @@ "comment": " 0 or an error code" }, "description": "Add a note for an object from a commit
\n", - "comments": "This function will create a notes commit for a given object,\n the commit is a dangling commit, no reference is created.
\n", + "comments": "This function will create a notes commit for a given object, the commit is a dangling commit, no reference is created.
\n", "group": "note" }, "git_note_remove": { @@ -11298,14 +11089,14 @@ "comment": " 0 or an error code" }, "description": "Lookup a reference to one of the objects in a repository.
\n", - "comments": "The generated reference is owned by the repository and\n should be closed with the git_object_free method\n instead of free'd manually.
The 'type' parameter must match the type of the object\n in the odb; the method will fail otherwise.\n The special value 'GIT_OBJECT_ANY' may be passed to let\n the method guess the object's type.
\n", + "comments": "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_OBJECT_ANY' may be passed to let the method guess the object's type.
\n", "group": "object", "examples": { "log.c": [ - "ex/v0.28.0/log.html#git_object_lookup-34" + "ex/HEAD/log.html#git_object_lookup-32" ], "merge.c": [ - "ex/v0.28.0/merge.html#git_object_lookup-19" + "ex/HEAD/merge.html#git_object_lookup-17" ] } }, @@ -11348,7 +11139,7 @@ "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\n matches the first 'len' hexadecimal characters\n (packets of 4 bits) of the given 'id'.\n 'len' must be at least GIT_OID_MINPREFIXLEN, and\n long enough to identify a unique object matching\n the prefix; otherwise the method will fail.
\n\nThe generated reference is owned by the repository and\n should be closed with the git_object_free method\n instead of free'd manually.
The 'type' parameter must match the type of the object\n in the odb; the method will fail otherwise.\n The special value 'GIT_OBJECT_ANY' may be passed to let\n the method guess the object's type.
\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_OBJECT_ANY' may be passed to let the method guess the object's type.
\n", "group": "object" }, "git_object_lookup_bypath": { @@ -11411,27 +11202,27 @@ "group": "object", "examples": { "blame.c": [ - "ex/v0.28.0/blame.html#git_object_id-10", - "ex/v0.28.0/blame.html#git_object_id-11", - "ex/v0.28.0/blame.html#git_object_id-12", - "ex/v0.28.0/blame.html#git_object_id-13" + "ex/HEAD/blame.html#git_object_id-8", + "ex/HEAD/blame.html#git_object_id-9", + "ex/HEAD/blame.html#git_object_id-10", + "ex/HEAD/blame.html#git_object_id-11" ], "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_object_id-12", - "ex/v0.28.0/cat-file.html#git_object_id-13" + "ex/HEAD/cat-file.html#git_object_id-10", + "ex/HEAD/cat-file.html#git_object_id-11" ], "log.c": [ - "ex/v0.28.0/log.html#git_object_id-35", - "ex/v0.28.0/log.html#git_object_id-36", - "ex/v0.28.0/log.html#git_object_id-37", - "ex/v0.28.0/log.html#git_object_id-38" + "ex/HEAD/log.html#git_object_id-33", + "ex/HEAD/log.html#git_object_id-34", + "ex/HEAD/log.html#git_object_id-35", + "ex/HEAD/log.html#git_object_id-36" ], "rev-parse.c": [ - "ex/v0.28.0/rev-parse.html#git_object_id-4", - "ex/v0.28.0/rev-parse.html#git_object_id-5", - "ex/v0.28.0/rev-parse.html#git_object_id-6", - "ex/v0.28.0/rev-parse.html#git_object_id-7", - "ex/v0.28.0/rev-parse.html#git_object_id-8" + "ex/HEAD/rev-parse.html#git_object_id-2", + "ex/HEAD/rev-parse.html#git_object_id-3", + "ex/HEAD/rev-parse.html#git_object_id-4", + "ex/HEAD/rev-parse.html#git_object_id-5", + "ex/HEAD/rev-parse.html#git_object_id-6" ] } }, @@ -11459,11 +11250,11 @@ "comment": " 0 on success, \n<\n0 for error" }, "description": "Get a short abbreviated OID string for the object
\n", - "comments": "This starts at the "core.abbrev" length (default 7 characters) and\n iteratively extends to a longer string if that length is ambiguous.\n The result will be unambiguous (at least until new objects are added to\n the repository).
\n", + "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.28.0/tag.html#git_object_short_id-5" + "ex/HEAD/tag.html#git_object_short_id-3" ] } }, @@ -11490,12 +11281,12 @@ "group": "object", "examples": { "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_object_type-14", - "ex/v0.28.0/cat-file.html#git_object_type-15", - "ex/v0.28.0/cat-file.html#git_object_type-16" + "ex/HEAD/cat-file.html#git_object_type-12", + "ex/HEAD/cat-file.html#git_object_type-13", + "ex/HEAD/cat-file.html#git_object_type-14" ], "tag.c": [ - "ex/v0.28.0/tag.html#git_object_type-6" + "ex/HEAD/tag.html#git_object_type-4" ] } }, @@ -11518,7 +11309,7 @@ "comment": " the repository who owns this object" }, "description": "Get the repository that owns this object
\n", - "comments": "Freeing or calling git_repository_close on the\n returned pointer will invalidate the actual object.
Any other operation may be run on the repository without\n affecting the object.
\n", + "comments": "Freeing or calling git_repository_close on the returned pointer will invalidate the actual object.
Any other operation may be run on the repository without affecting the object.
\n", "group": "object" }, "git_object_free": { @@ -11540,37 +11331,37 @@ "comment": null }, "description": "Close an open object
\n", - "comments": "This method instructs the library to close an existing\n object; note that git_objects are owned and cached by the repository\n so the object may or may not be freed after this library call,\n depending on how aggressive is the caching mechanism used\n by the repository.
\n\nIMPORTANT:\n It is necessary to call this method when you stop using\n an object. Failure to do so will cause a memory leak.
\n", + "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.28.0/blame.html#git_object_free-14", - "ex/v0.28.0/blame.html#git_object_free-15", - "ex/v0.28.0/blame.html#git_object_free-16", - "ex/v0.28.0/blame.html#git_object_free-17" + "ex/HEAD/blame.html#git_object_free-12", + "ex/HEAD/blame.html#git_object_free-13", + "ex/HEAD/blame.html#git_object_free-14", + "ex/HEAD/blame.html#git_object_free-15" ], "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_object_free-17" + "ex/HEAD/cat-file.html#git_object_free-15" ], "general.c": [ - "ex/v0.28.0/general.html#git_object_free-38" + "ex/HEAD/general.html#git_object_free-38" ], "log.c": [ - "ex/v0.28.0/log.html#git_object_free-39" + "ex/HEAD/log.html#git_object_free-37" ], "merge.c": [ - "ex/v0.28.0/merge.html#git_object_free-20" + "ex/HEAD/merge.html#git_object_free-18" ], "rev-parse.c": [ - "ex/v0.28.0/rev-parse.html#git_object_free-9", - "ex/v0.28.0/rev-parse.html#git_object_free-10", - "ex/v0.28.0/rev-parse.html#git_object_free-11" + "ex/HEAD/rev-parse.html#git_object_free-7", + "ex/HEAD/rev-parse.html#git_object_free-8", + "ex/HEAD/rev-parse.html#git_object_free-9" ], "tag.c": [ - "ex/v0.28.0/tag.html#git_object_free-7", - "ex/v0.28.0/tag.html#git_object_free-8", - "ex/v0.28.0/tag.html#git_object_free-9", - "ex/v0.28.0/tag.html#git_object_free-10" + "ex/HEAD/tag.html#git_object_free-5", + "ex/HEAD/tag.html#git_object_free-6", + "ex/HEAD/tag.html#git_object_free-7", + "ex/HEAD/tag.html#git_object_free-8" ] } }, @@ -11593,18 +11384,18 @@ "comment": " the corresponding string representation." }, "description": "Convert an object type to its string representation.
\n", - "comments": "The result is a pointer to a string in static memory and\n should not be free()'ed.
\n", + "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.28.0/cat-file.html#git_object_type2string-18", - "ex/v0.28.0/cat-file.html#git_object_type2string-19", - "ex/v0.28.0/cat-file.html#git_object_type2string-20", - "ex/v0.28.0/cat-file.html#git_object_type2string-21" + "ex/HEAD/cat-file.html#git_object_type2string-16", + "ex/HEAD/cat-file.html#git_object_type2string-17", + "ex/HEAD/cat-file.html#git_object_type2string-18", + "ex/HEAD/cat-file.html#git_object_type2string-19" ], "general.c": [ - "ex/v0.28.0/general.html#git_object_type2string-39", - "ex/v0.28.0/general.html#git_object_type2string-40" + "ex/HEAD/general.html#git_object_type2string-39", + "ex/HEAD/general.html#git_object_type2string-40" ] } }, @@ -11652,7 +11443,7 @@ "comments": "", "group": "object" }, - "git_object__size": { + "git_object_size": { "type": "function", "file": "git2/object.h", "line": 200, @@ -11671,7 +11462,7 @@ "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\n of calling sizeof(git_commit) if the core types\n were not opaque on the external API.
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.
Recursively peel an object until an object of the specified type is met.
\n", - "comments": "If the query cannot be satisfied due to the object model,\n GIT_EINVALIDSPEC will be returned (e.g. trying to peel a blob to a\n tree).
\n\nIf you pass GIT_OBJECT_ANY as the target type, then the object will\n be peeled until the type changes. A tag will be peeled until the\n referenced object is no longer a tag, and a commit will be peeled\n to a tree. Any other object type will return GIT_EINVALIDSPEC.
If peeling a tag we discover an object which cannot be peeled to\n the target type due to the object model, GIT_EPEEL will be\n returned.
\n\nYou must free the returned object.
\n", + "comments": "If the query cannot be satisfied due to the object model, GIT_EINVALIDSPEC will be returned (e.g. trying to peel a blob to a tree).
\n\nIf you pass GIT_OBJECT_ANY as the target type, then the object will be peeled until the type changes. A tag will be peeled until the referenced object is no longer a tag, and a commit will be peeled to a tree. Any other object type will return GIT_EINVALIDSPEC.
If peeling a tag we discover an object which cannot be peeled to the target type due to the object model, GIT_EPEEL will be returned.
\n\nYou must free the returned object.
\n", "group": "object" }, "git_object_dup": { @@ -11736,8 +11527,8 @@ "git_odb_new": { "type": "function", "file": "git2/odb.h", - "line": 39, - "lineto": 39, + "line": 40, + "lineto": 40, "args": [ { "name": "out", @@ -11752,14 +11543,14 @@ "comment": " 0 or an error code" }, "description": "Create a new object database with no backends.
\n", - "comments": "Before the ODB can be used for read/writing, a custom database\n backend must be manually added using git_odb_add_backend()
Before the ODB can be used for read/writing, a custom database backend must be manually added using git_odb_add_backend()
Create a new object database and automatically add\n the two default backends:
\n", - "comments": "- git_odb_backend_loose: read and write loose object files\n from disk, assuming `objects_dir` as the Objects folder\n\n- git_odb_backend_pack: read objects from packfiles,\n assuming `objects_dir` as the Objects folder which\n contains a 'pack/' folder with the corresponding data\n- git_odb_backend_loose: read and write loose object files from disk, assuming `objects_dir` as the Objects folder\n\n- git_odb_backend_pack: read objects from packfiles, assuming `objects_dir` as the Objects folder which contains a 'pack/' folder with the corresponding data\nAdd an on-disk alternate to an existing Object DB.
\n", - "comments": "Note that the added path must point to an objects, not\n to a full repository, to use it as an alternate store.
Alternate backends are always checked for objects after\n all the main backends have been exhausted.
\n\nWriting is disabled on alternate backends.
\n", + "comments": "Note that the added path must point to an objects, not to a full repository, to use it as an alternate store.
Alternate backends are always checked for objects after all the main backends have been exhausted.
\n\nWriting is disabled on alternate backends.
\n", "group": "odb" }, "git_odb_free": { "type": "function", "file": "git2/odb.h", - "line": 81, - "lineto": 81, + "line": 82, + "lineto": 82, "args": [ { "name": "db", @@ -11832,18 +11623,18 @@ "group": "odb", "examples": { "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_odb_free-22" + "ex/HEAD/cat-file.html#git_odb_free-20" ], "general.c": [ - "ex/v0.28.0/general.html#git_odb_free-41" + "ex/HEAD/general.html#git_odb_free-41" ] } }, "git_odb_read": { "type": "function", "file": "git2/odb.h", - "line": 100, - "lineto": 100, + "line": 101, + "lineto": 101, "args": [ { "name": "out", @@ -11868,22 +11659,22 @@ "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\n trying to read the given OID.
\n\nThe returned object is reference counted and\n internally cached, so it should be closed\n by the user once it's no longer in use.
\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.28.0/cat-file.html#git_odb_read-23" + "ex/HEAD/cat-file.html#git_odb_read-21" ], "general.c": [ - "ex/v0.28.0/general.html#git_odb_read-42" + "ex/HEAD/general.html#git_odb_read-42" ] } }, "git_odb_read_prefix": { "type": "function", "file": "git2/odb.h", - "line": 129, - "lineto": 129, + "line": 130, + "lineto": 130, "args": [ { "name": "out", @@ -11913,14 +11704,14 @@ "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\n trying to match the 'len' first hexadecimal\n characters of the 'short_id'.\n The remaining (GIT_OID_HEXSZ-len)*4 bits of\n 'short_id' must be 0s.\n 'len' must be at least GIT_OID_MINPREFIXLEN,\n and the prefix must be long enough to identify\n a unique object in all the backends; the\n method will fail otherwise.
\n\nThe returned object is reference counted and\n internally cached, so it should be closed\n by the user once it's no longer in use.
\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_header": { "type": "function", "file": "git2/odb.h", - "line": 149, - "lineto": 149, + "line": 150, + "lineto": 150, "args": [ { "name": "len_out", @@ -11950,14 +11741,14 @@ "comment": " - 0 if the object was read;\n - GIT_ENOTFOUND if the object is not in the database." }, "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\n of an object, so the whole object will be read and then the\n header will be returned.
\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", "file": "git2/odb.h", - "line": 160, - "lineto": 160, + "line": 161, + "lineto": 161, "args": [ { "name": "db", @@ -11983,8 +11774,8 @@ "git_odb_exists_prefix": { "type": "function", "file": "git2/odb.h", - "line": 173, - "lineto": 174, + "line": 174, + "lineto": 175, "args": [ { "name": "out", @@ -12020,8 +11811,8 @@ "git_odb_expand_ids": { "type": "function", "file": "git2/odb.h", - "line": 215, - "lineto": 218, + "line": 216, + "lineto": 219, "args": [ { "name": "db", @@ -12046,14 +11837,14 @@ "comment": " 0 on success or an error code on failure" }, "description": "Determine if one or more objects can be found in the object database\n by their abbreviated object ID and type. The given array will be\n updated in place: for each abbreviated ID that is unique in the\n database, and of the given type (if specified), the full object ID,\n object ID length (GIT_OID_HEXSZ) and type will be written back to\n the array. For IDs that are not found (or are ambiguous), the\n array entry will be zeroed.
Note that since this function operates on multiple objects, the\n underlying database will not be asked to be reloaded if an object is\n not found (which is unlike other object database operations.)
\n", + "comments": "Note that since this function operates on multiple objects, the underlying database will not be asked to be reloaded if an object is not found (which is unlike other object database operations.)
\n", "group": "odb" }, "git_odb_refresh": { "type": "function", "file": "git2/odb.h", - "line": 238, - "lineto": 238, + "line": 239, + "lineto": 239, "args": [ { "name": "db", @@ -12068,14 +11859,14 @@ "comment": " 0 on success, error code otherwise" }, "description": "Refresh the object database to load newly added files.
\n", - "comments": "If the object databases have changed on disk while the library\n is running, this function will force a reload of the underlying\n indexes.
\n\nUse this function when you're confident that an external\n application has tampered with the ODB.
\n\nNOTE that it is not necessary to call this function at all. The\n library will automatically attempt to refresh the ODB\n when a lookup fails, to see if the looked up object exists\n on disk but hasn't been loaded yet.
\n", + "comments": "If the object databases have changed on disk while the library is running, this function will force a reload of the underlying indexes.
\n\nUse this function when you're confident that an external application has tampered with the ODB.
\n\nNOTE that it is not necessary to call this function at all. The library will automatically attempt to refresh the ODB when a lookup fails, to see if the looked up object exists on disk but hasn't been loaded yet.
\n", "group": "odb" }, "git_odb_foreach": { "type": "function", "file": "git2/odb.h", - "line": 253, - "lineto": 253, + "line": 254, + "lineto": 254, "args": [ { "name": "db", @@ -12100,14 +11891,14 @@ "comment": " 0 on success, non-zero callback return value, or error code" }, "description": "List all objects available in the database
\n", - "comments": "The callback will be called for each object available in the\n database. Note that the objects are likely to be returned in the index\n order, which would make accessing the objects in that order inefficient.\n Return a non-zero value from the callback to stop looping.
\n", + "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": "git2/odb.h", - "line": 273, - "lineto": 273, + "line": 274, + "lineto": 274, "args": [ { "name": "out", @@ -12142,19 +11933,19 @@ "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.\n For most cases, it is preferred to write objects through a write\n stream, which is both faster and less memory intensive, specially\n for big objects.
\n\nThis method is provided for compatibility with custom backends\n which are not able to support streaming writes
\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.28.0/general.html#git_odb_write-43" + "ex/HEAD/general.html#git_odb_write-43" ] } }, "git_odb_open_wstream": { "type": "function", "file": "git2/odb.h", - "line": 296, - "lineto": 296, + "line": 297, + "lineto": 297, "args": [ { "name": "out", @@ -12184,14 +11975,14 @@ "comment": " 0 if the stream was created; error code otherwise" }, "description": "Open a stream to write an object into the ODB
\n", - "comments": "The type and final length of the object must be specified\n when opening the stream.
\n\nThe returned stream will be of type GIT_STREAM_WRONLY, and it\n won't be effective until git_odb_stream_finalize_write is called\n and returns without an error
The stream must always be freed when done with git_odb_stream_free or\n will leak memory.
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\n size declared with git_odb_open_wstream()
This method will fail if the total number of received bytes exceeds the size declared with git_odb_open_wstream()
Finish writing to an odb stream
\n", - "comments": "The object will take its final name and will be available to the\n odb.
\n\nThis method will fail if the total number of received bytes\n differs from 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()
Open a stream to read an object from the ODB
\n", - "comments": "Note that most backends do not support streaming reads\n because they store their objects as compressed/delta'ed blobs.
\n\nIt's recommended to use git_odb_read instead, which is\n assured to work on all backends.
The returned stream will be of type GIT_STREAM_RDONLY and\n will have the following methods:
- stream->read: read `n` bytes from the stream\n - stream->free: free the stream\nThe stream must always be free'd or will leak memory.
\n", + "comments": "Note that most backends do not support streaming reads because they store their objects as compressed/delta'ed blobs.
\n\nIt's recommended to use git_odb_read instead, which is assured to work on all backends.
The returned stream will be of type GIT_STREAM_RDONLY and will have the following methods:
- stream->read: read `n` bytes from the stream - stream->free: free the stream\nThe stream must always be free'd or will leak memory.
\n", "group": "odb" }, "git_odb_write_pack": { "type": "function", "file": "git2/odb.h", - "line": 391, - "lineto": 395, + "line": 392, + "lineto": 396, "args": [ { "name": "out", @@ -12360,7 +12151,7 @@ }, { "name": "progress_cb", - "type": "git_transfer_progress_cb", + "type": "git_indexer_progress_cb", "comment": "function to call with progress information.\n Be aware that this is called inline with network and indexing operations,\n so performance may be affected." }, { @@ -12369,21 +12160,21 @@ "comment": "payload for the progress callback" } ], - "argline": "git_odb_writepack **out, git_odb *db, git_transfer_progress_cb progress_cb, void *progress_payload", - "sig": "git_odb_writepack **::git_odb *::git_transfer_progress_cb::void *", + "argline": "git_odb_writepack **out, git_odb *db, git_indexer_progress_cb progress_cb, void *progress_payload", + "sig": "git_odb_writepack **::git_odb *::git_indexer_progress_cb::void *", "return": { "type": "int", "comment": null }, "description": "Open a stream for writing a pack file to the ODB.
\n", - "comments": "If the ODB layer understands pack files, then the given\n packfile will likely be streamed directly to disk (and a\n corresponding index created). If the ODB layer does not\n understand pack files, the objects will be stored in whatever\n format the ODB layer uses.
\n", + "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": "git2/odb.h", - "line": 409, - "lineto": 409, + "line": 410, + "lineto": 410, "args": [ { "name": "out", @@ -12413,14 +12204,14 @@ "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\n buffer as if the data buffer it were to written to the ODB.
\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": "git2/odb.h", - "line": 424, - "lineto": 424, + "line": 425, + "lineto": 425, "args": [ { "name": "out", @@ -12451,8 +12242,8 @@ "git_odb_object_dup": { "type": "function", "file": "git2/odb.h", - "line": 438, - "lineto": 438, + "line": 439, + "lineto": 439, "args": [ { "name": "dest", @@ -12472,14 +12263,14 @@ "comment": " 0 or an error code" }, "description": "Create a copy of an odb_object
\n", - "comments": "The returned copy must be manually freed with git_odb_object_free.\n Note that because of an implementation detail, the returned copy will be\n the same pointer as source: the object is internally refcounted, so the\n copy still needs to be freed twice.
The returned copy must be manually freed with git_odb_object_free. Note that because of an implementation detail, the returned copy will be the same pointer as source: the object is internally refcounted, so the copy still needs to be freed twice.
Close an ODB object
\n", - "comments": "This method must always be called once a git_odb_object is no\n longer needed, otherwise memory will leak.
This method must always be called once a git_odb_object is no longer needed, otherwise memory will leak.
Return the data of an ODB object
\n", - "comments": "This is the uncompressed, raw data as read from the ODB,\n without the leading header.
\n\nThis pointer is owned by the object and shall not be free'd.
\n", + "comments": "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.28.0/general.html#git_odb_object_data-45" + "ex/HEAD/general.html#git_odb_object_data-45" ] } }, "git_odb_object_size": { "type": "function", "file": "git2/odb.h", - "line": 482, - "lineto": 482, + "line": 483, + "lineto": 483, "args": [ { "name": "object", @@ -12573,22 +12364,22 @@ "comment": " the size" }, "description": "Return the size of an ODB object
\n", - "comments": "This is the real size of the data buffer, not the\n actual size of the object.
This is the real size of the data buffer, not the actual size of the object.
Add a custom backend to an existing Object DB
\n", - "comments": "The backends are checked in relative ordering, based on the\n value of the priority parameter.
Read \n
The backends are checked in relative ordering, based on the value of the priority parameter.
Read
Add a custom backend to an existing Object DB; this\n backend will work as an alternate.
\n", - "comments": "Alternate backends are always checked for objects after\n all the main backends have been exhausted.
\n\nThe backends are checked in relative ordering, based on the\n value of the priority parameter.
Writing is disabled on alternate backends.
\n\nRead \n
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
Create a backend out of a single packfile
\n", - "comments": "This can be useful for inspecting the contents of a single\n packfile.
\n", + "comments": "This can be useful for inspecting the contents of a single packfile.
\n", "group": "odb" }, "git_oid_fromstr": { @@ -12858,14 +12649,14 @@ "group": "oid", "examples": { "general.c": [ - "ex/v0.28.0/general.html#git_oid_fromstr-48", - "ex/v0.28.0/general.html#git_oid_fromstr-49", - "ex/v0.28.0/general.html#git_oid_fromstr-50", - "ex/v0.28.0/general.html#git_oid_fromstr-51", - "ex/v0.28.0/general.html#git_oid_fromstr-52", - "ex/v0.28.0/general.html#git_oid_fromstr-53", - "ex/v0.28.0/general.html#git_oid_fromstr-54", - "ex/v0.28.0/general.html#git_oid_fromstr-55" + "ex/HEAD/general.html#git_oid_fromstr-48", + "ex/HEAD/general.html#git_oid_fromstr-49", + "ex/HEAD/general.html#git_oid_fromstr-50", + "ex/HEAD/general.html#git_oid_fromstr-51", + "ex/HEAD/general.html#git_oid_fromstr-52", + "ex/HEAD/general.html#git_oid_fromstr-53", + "ex/HEAD/general.html#git_oid_fromstr-54", + "ex/HEAD/general.html#git_oid_fromstr-55" ] } }, @@ -12925,7 +12716,7 @@ "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, the last byte's high nibble will be read in and the\n low nibble set to zero.
\n", + "comments": "If N is odd, the last byte's high nibble will be read in and the low nibble set to zero.
\n", "group": "oid" }, "git_oid_fromraw": { @@ -12982,20 +12773,20 @@ "comments": "", "group": "oid", "examples": { + "fetch.c": [ + "ex/HEAD/fetch.html#git_oid_fmt-1", + "ex/HEAD/fetch.html#git_oid_fmt-2" + ], "general.c": [ - "ex/v0.28.0/general.html#git_oid_fmt-56", - "ex/v0.28.0/general.html#git_oid_fmt-57", - "ex/v0.28.0/general.html#git_oid_fmt-58", - "ex/v0.28.0/general.html#git_oid_fmt-59", - "ex/v0.28.0/general.html#git_oid_fmt-60", - "ex/v0.28.0/general.html#git_oid_fmt-61" - ], - "network/fetch.c": [ - "ex/v0.28.0/network/fetch.html#git_oid_fmt-1", - "ex/v0.28.0/network/fetch.html#git_oid_fmt-2" - ], - "network/ls-remote.c": [ - "ex/v0.28.0/network/ls-remote.html#git_oid_fmt-1" + "ex/HEAD/general.html#git_oid_fmt-56", + "ex/HEAD/general.html#git_oid_fmt-57", + "ex/HEAD/general.html#git_oid_fmt-58", + "ex/HEAD/general.html#git_oid_fmt-59", + "ex/HEAD/general.html#git_oid_fmt-60", + "ex/HEAD/general.html#git_oid_fmt-61" + ], + "ls-remote.c": [ + "ex/HEAD/ls-remote.html#git_oid_fmt-1" ] } }, @@ -13055,7 +12846,7 @@ "comment": null }, "description": "Format a git_oid into a loose-object path string.
\n", - "comments": "The resulting string is "aa/...", where "aa" is the first two\n hex digits of the oid and "..." is the remaining 38 digits.
\n", + "comments": "The resulting string is "aa/...", where "aa" is the first two hex digits of the oid and "..." is the remaining 38 digits.
\n", "group": "oid" }, "git_oid_tostr_s": { @@ -13077,12 +12868,12 @@ "comment": " the c-string" }, "description": "Format a git_oid into a statically allocated c-string.
\n", - "comments": "The c-string is owned by the library and should not be freed\n by the user. If libgit2 is built with thread support, the string\n will be stored in TLS (i.e. one buffer per thread) to allow for\n concurrent calls of the function.
\n", + "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", "examples": { "merge.c": [ - "ex/v0.28.0/merge.html#git_oid_tostr_s-21", - "ex/v0.28.0/merge.html#git_oid_tostr_s-22" + "ex/HEAD/merge.html#git_oid_tostr_s-19", + "ex/HEAD/merge.html#git_oid_tostr_s-20" ] } }, @@ -13115,29 +12906,29 @@ "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\n oid c-string will be truncated to n-1 characters (but will still be\n NUL-byte terminated).
\n\nIf there are any input parameter errors (out == NULL, n == 0, oid ==\n NULL), then a pointer to an empty string is returned, so that the\n return value can always be printed.
\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.28.0/blame.html#git_oid_tostr-18", - "ex/v0.28.0/blame.html#git_oid_tostr-19" + "ex/HEAD/blame.html#git_oid_tostr-16", + "ex/HEAD/blame.html#git_oid_tostr-17" ], "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_oid_tostr-26", - "ex/v0.28.0/cat-file.html#git_oid_tostr-27", - "ex/v0.28.0/cat-file.html#git_oid_tostr-28", - "ex/v0.28.0/cat-file.html#git_oid_tostr-29", - "ex/v0.28.0/cat-file.html#git_oid_tostr-30" + "ex/HEAD/cat-file.html#git_oid_tostr-24", + "ex/HEAD/cat-file.html#git_oid_tostr-25", + "ex/HEAD/cat-file.html#git_oid_tostr-26", + "ex/HEAD/cat-file.html#git_oid_tostr-27", + "ex/HEAD/cat-file.html#git_oid_tostr-28" ], "log.c": [ - "ex/v0.28.0/log.html#git_oid_tostr-40", - "ex/v0.28.0/log.html#git_oid_tostr-41" + "ex/HEAD/log.html#git_oid_tostr-38", + "ex/HEAD/log.html#git_oid_tostr-39" ], "rev-parse.c": [ - "ex/v0.28.0/rev-parse.html#git_oid_tostr-12", - "ex/v0.28.0/rev-parse.html#git_oid_tostr-13", - "ex/v0.28.0/rev-parse.html#git_oid_tostr-14", - "ex/v0.28.0/rev-parse.html#git_oid_tostr-15" + "ex/HEAD/rev-parse.html#git_oid_tostr-10", + "ex/HEAD/rev-parse.html#git_oid_tostr-11", + "ex/HEAD/rev-parse.html#git_oid_tostr-12", + "ex/HEAD/rev-parse.html#git_oid_tostr-13" ] } }, @@ -13169,9 +12960,9 @@ "group": "oid", "examples": { "blame.c": [ - "ex/v0.28.0/blame.html#git_oid_cpy-20", - "ex/v0.28.0/blame.html#git_oid_cpy-21", - "ex/v0.28.0/blame.html#git_oid_cpy-22" + "ex/HEAD/blame.html#git_oid_cpy-18", + "ex/HEAD/blame.html#git_oid_cpy-19", + "ex/HEAD/blame.html#git_oid_cpy-20" ] } }, @@ -13315,7 +13106,7 @@ "comments": "", "group": "oid" }, - "git_oid_iszero": { + "git_oid_is_zero": { "type": "function", "file": "git2/oid.h", "line": 210, @@ -13338,10 +13129,10 @@ "group": "oid", "examples": { "blame.c": [ - "ex/v0.28.0/blame.html#git_oid_iszero-23" + "ex/HEAD/blame.html#git_oid_is_zero-21" ], - "network/fetch.c": [ - "ex/v0.28.0/network/fetch.html#git_oid_iszero-3" + "fetch.c": [ + "ex/HEAD/fetch.html#git_oid_is_zero-3" ] } }, @@ -13364,7 +13155,7 @@ "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\n in text form and return the shortest length that would\n uniquely identify all of them.
\n\nE.g. look at the result of git log --abbrev.
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.
Add a new OID to set of shortened OIDs and calculate\n the minimal length to uniquely identify all the OIDs in\n the set.
\n", - "comments": "The OID is expected to be a 40-char hexadecimal string.\n The OID is owned by the user and will not be modified\n or freed.
\n\nFor performance reasons, there is a hard-limit of how many\n OIDs can be added to a single set (around ~32000, assuming\n a mostly randomized distribution), which should be enough\n for any kind of program, and keeps the algorithm fast and\n memory-efficient.
\n\nAttempting to add more than those OIDs will result in a\n GIT_ERROR_INVALID error
\n", + "comments": "The OID is expected to be a 40-char hexadecimal string. The OID is owned by the user and will not be modified or freed.
\n\nFor performance reasons, there is a hard-limit of how many OIDs can be added to a single set (around ~32000, assuming a mostly randomized distribution), which should be enough for any kind of program, and keeps the algorithm fast and memory-efficient.
\n\nAttempting to add more than those OIDs will result in a GIT_ERROR_INVALID error
\n", "group": "oid" }, "git_oid_shorten_free": { @@ -13435,14 +13226,14 @@ "comment": null }, "description": "Free the OID array
\n", - "comments": "This method must (and must only) be called on git_oidarray\n objects where the array is allocated by the library. Not doing so,\n will result in a memory leak.
This does not free the git_oidarray itself, since the library will\n never allocate that object directly itself (it is more commonly embedded\n inside another struct or created on the stack).
This method must (and must only) be called on git_oidarray objects where the array is allocated by the library. Not doing so, will result in a memory leak.
This does not free the git_oidarray 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 number of threads to spawn
\n", - "comments": "By default, libgit2 won't spawn any threads at all;\n when set to 0, libgit2 will autodetect the number of\n CPUs.
\n", + "comments": "By default, libgit2 won't spawn any threads at all; when set to 0, libgit2 will autodetect the number of CPUs.
\n", "group": "packbuilder" }, "git_packbuilder_insert": { "type": "function", "file": "git2/pack.h", - "line": 91, - "lineto": 91, + "line": 92, + "lineto": 92, "args": [ { "name": "pb", @@ -13521,14 +13312,14 @@ "comment": " 0 or an error code" }, "description": "Insert a single object
\n", - "comments": "For an optimal pack it's mandatory to insert objects in recency order,\n commits followed by trees and blobs.
\n", + "comments": "For an optimal pack it's mandatory to insert objects in recency order, commits followed by trees and blobs.
\n", "group": "packbuilder" }, "git_packbuilder_insert_tree": { "type": "function", "file": "git2/pack.h", - "line": 103, - "lineto": 103, + "line": 104, + "lineto": 104, "args": [ { "name": "pb", @@ -13554,8 +13345,8 @@ "git_packbuilder_insert_commit": { "type": "function", "file": "git2/pack.h", - "line": 115, - "lineto": 115, + "line": 116, + "lineto": 116, "args": [ { "name": "pb", @@ -13581,8 +13372,8 @@ "git_packbuilder_insert_walk": { "type": "function", "file": "git2/pack.h", - "line": 128, - "lineto": 128, + "line": 129, + "lineto": 129, "args": [ { "name": "pb", @@ -13602,14 +13393,14 @@ "comment": " 0 or an error code" }, "description": "Insert objects as given by the walk
\n", - "comments": "Those commits and all objects they reference will be inserted into\n the packbuilder.
\n", + "comments": "Those commits and all objects they reference will be inserted into the packbuilder.
\n", "group": "packbuilder" }, "git_packbuilder_insert_recur": { "type": "function", "file": "git2/pack.h", - "line": 140, - "lineto": 140, + "line": 141, + "lineto": 141, "args": [ { "name": "pb", @@ -13640,8 +13431,8 @@ "git_packbuilder_write_buf": { "type": "function", "file": "git2/pack.h", - "line": 151, - "lineto": 151, + "line": 152, + "lineto": 152, "args": [ { "name": "buf", @@ -13661,14 +13452,14 @@ "comment": null }, "description": "Write the contents of the packfile to an in-memory buffer
\n", - "comments": "The contents of the buffer will become a valid packfile, even though there\n will be no attached index
\n", + "comments": "The contents of the buffer will become a valid packfile, even though there will be no attached index
\n", "group": "packbuilder" }, "git_packbuilder_write": { "type": "function", "file": "git2/pack.h", - "line": 164, - "lineto": 169, + "line": 165, + "lineto": 170, "args": [ { "name": "pb", @@ -13687,7 +13478,7 @@ }, { "name": "progress_cb", - "type": "git_transfer_progress_cb", + "type": "git_indexer_progress_cb", "comment": "function to call with progress information from the indexer (optional)" }, { @@ -13696,8 +13487,8 @@ "comment": "payload for the progress callback (optional)" } ], - "argline": "git_packbuilder *pb, const char *path, unsigned int mode, git_transfer_progress_cb progress_cb, void *progress_cb_payload", - "sig": "git_packbuilder *::const char *::unsigned int::git_transfer_progress_cb::void *", + "argline": "git_packbuilder *pb, const char *path, unsigned int mode, git_indexer_progress_cb progress_cb, void *progress_cb_payload", + "sig": "git_packbuilder *::const char *::unsigned int::git_indexer_progress_cb::void *", "return": { "type": "int", "comment": " 0 or an error code" @@ -13709,8 +13500,8 @@ "git_packbuilder_hash": { "type": "function", "file": "git2/pack.h", - "line": 179, - "lineto": 179, + "line": 180, + "lineto": 180, "args": [ { "name": "pb", @@ -13725,14 +13516,14 @@ "comment": null }, "description": "Get the packfile's hash
\n", - "comments": "A packfile's name is derived from the sorted hashing of all object\n names. This is only correct after the packfile has been written.
\n", + "comments": "A packfile's name is derived from the sorted hashing of all object names. This is only correct after the packfile has been written.
\n", "group": "packbuilder" }, "git_packbuilder_foreach": { "type": "function", "file": "git2/pack.h", - "line": 191, - "lineto": 191, + "line": 202, + "lineto": 202, "args": [ { "name": "pb", @@ -13763,8 +13554,8 @@ "git_packbuilder_object_count": { "type": "function", "file": "git2/pack.h", - "line": 199, - "lineto": 199, + "line": 210, + "lineto": 210, "args": [ { "name": "pb", @@ -13785,8 +13576,8 @@ "git_packbuilder_written": { "type": "function", "file": "git2/pack.h", - "line": 207, - "lineto": 207, + "line": 218, + "lineto": 218, "args": [ { "name": "pb", @@ -13807,8 +13598,8 @@ "git_packbuilder_set_callbacks": { "type": "function", "file": "git2/pack.h", - "line": 226, - "lineto": 229, + "line": 237, + "lineto": 240, "args": [ { "name": "pb", @@ -13839,8 +13630,8 @@ "git_packbuilder_free": { "type": "function", "file": "git2/pack.h", - "line": 236, - "lineto": 236, + "line": 247, + "lineto": 247, "args": [ { "name": "pb", @@ -13887,7 +13678,7 @@ "comment": " 0 on success, other value \n<\n 0 on error" }, "description": "Return a patch for an entry in the diff list.
\n", - "comments": "The git_patch is a newly created object contains the text diffs\n for the delta. You have to call git_patch_free() when you are\n done with it. You can use the patch object to loop over all the hunks\n and lines in the diff of the one delta.
For an unchanged file or a binary file, no git_patch will be\n created, the output will be set to NULL, and the binary flag will be\n set true in the git_diff_delta structure.
It is okay to pass NULL for either of the output parameters; if you pass\n NULL for the git_patch, then the text diff will not be calculated.
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.
Directly generate a patch from the difference between two blobs.
\n", - "comments": "This is just like git_diff_blobs() except it generates a patch object\n for the difference instead of directly making callbacks. You can use the\n standard git_patch accessor functions to read the patch data, and\n you must call git_patch_free() on the patch when done.
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\n object for the difference instead of directly making callbacks. You can\n use the standard git_patch accessor functions to read the patch\n data, and you must call git_patch_free() on the patch when done.
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\n object for the difference instead of directly making callbacks. You can\n use the standard git_patch accessor functions to read the patch\n data, and you must call git_patch_free() on the patch when done.
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 line counts of each type in a patch.
\n", - "comments": "This helps imitate a diff --numstat type of output. For that purpose,\n you only need the total_additions and total_deletions values, but we\n include the total_context line count in case you want the total number\n of lines of diff output that will be generated.
All outputs are optional. Pass NULL if you don't need a particular count.
\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": { @@ -14183,7 +13974,7 @@ "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\n information about that hunk. Any of the output pointers can be passed\n as NULL if you don't care about that particular piece of information.
\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": { @@ -14247,7 +14038,7 @@ "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\n will return a lot of details about that line. If you pass a hunk\n index larger than the number of hunks or a line index larger than\n the number of lines in the hunk, this will return -1.
\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": { @@ -14284,7 +14075,7 @@ "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\n 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\n of all of the diff output; if you pass it as false (zero), this will\n only include the actual changed lines (as if context_lines was 0).
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).
Serialize the patch to text via callback.
\n", - "comments": "Returning a non-zero value from the callback will terminate the iteration\n and return that value to the caller.
\n", + "comments": "Returning a non-zero value from the callback will terminate the iteration and return that value to the caller.
\n", "group": "patch" }, "git_patch_to_buf": { @@ -14374,7 +14165,7 @@ "group": "pathspec", "examples": { "log.c": [ - "ex/v0.28.0/log.html#git_pathspec_new-42" + "ex/HEAD/log.html#git_pathspec_new-40" ] } }, @@ -14401,7 +14192,7 @@ "group": "pathspec", "examples": { "log.c": [ - "ex/v0.28.0/log.html#git_pathspec_free-43" + "ex/HEAD/log.html#git_pathspec_free-41" ] } }, @@ -14414,27 +14205,27 @@ { "name": "ps", "type": "const git_pathspec *", - "comment": null + "comment": "The compiled pathspec" }, { "name": "flags", - "type": "int", - "comment": null + "type": "uint32_t", + "comment": "Combination of git_pathspec_flag_t options to control match" }, { "name": "path", "type": "const char *", - "comment": null + "comment": "The pathname to attempt to match" } ], - "argline": "const git_pathspec *ps, int flags, const char *path", - "sig": "const git_pathspec *::int::const char *", + "argline": "const git_pathspec *ps, uint32_t flags, const char *path", + "sig": "const git_pathspec *::uint32_t::const char *", "return": { "type": "int", - "comment": null + "comment": " 1 is path matches spec, 0 if it does not" }, - "description": "", - "comments": "", + "description": "Try to match a path against a pathspec
\n", + "comments": "Unlike most of the other pathspec matching functions, this will not fall back on the native case-sensitivity for your platform. You must explicitly pass flags to control case sensitivity or else this will fall back on being case sensitive.
\n", "group": "pathspec" }, "git_pathspec_match_workdir": { @@ -14446,32 +14237,32 @@ { "name": "out", "type": "git_pathspec_match_list **", - "comment": null + "comment": "Output list of matches; pass NULL to just get return value" }, { "name": "repo", "type": "git_repository *", - "comment": null + "comment": "The repository in which to match; bare repo is an error" }, { "name": "flags", - "type": "int", - "comment": null + "type": "uint32_t", + "comment": "Combination of git_pathspec_flag_t options to control match" }, { "name": "ps", "type": "git_pathspec *", - "comment": null + "comment": "Pathspec to be matched" } ], - "argline": "git_pathspec_match_list **out, git_repository *repo, int flags, git_pathspec *ps", - "sig": "git_pathspec_match_list **::git_repository *::int::git_pathspec *", + "argline": "git_pathspec_match_list **out, git_repository *repo, uint32_t flags, git_pathspec *ps", + "sig": "git_pathspec_match_list **::git_repository *::uint32_t::git_pathspec *", "return": { "type": "int", - "comment": null + "comment": " 0 on success, -1 on error, GIT_ENOTFOUND if no matches and\n the GIT_PATHSPEC_NO_MATCH_ERROR flag was given" }, - "description": "", - "comments": "", + "description": "Match a pathspec against the working directory of a repository.
\n", + "comments": "This matches the pathspec against the current files in the working directory of the repository. It is an error to invoke this on a bare repo. This handles git ignores (i.e. ignored files will not be considered to match the pathspec unless the file is tracked in the index).
If 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.
Match a pathspec against entries in an index.
\n", + "comments": "This matches the pathspec against the files in the repository index.
\n\nNOTE: At the moment, the case sensitivity of this match is controlled by the current case-sensitivity of the index object itself and the USE_CASE and IGNORE_CASE flags will have no effect. This behavior will be corrected in a future release.
\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.
Match a pathspec against files in a tree.
\n", + "comments": "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.
Match a pathspec against files in a diff list.
\n", + "comments": "This matches the pathspec against the files in the given diff list.
\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.
Get a matching filename by position.
\n", - "comments": "This routine cannot be used if the match list was generated by\n git_pathspec_match_diff. If so, it will always return NULL.
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\n git_pathspec_match_diff. Otherwise it will always return NULL.
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\n generating the git_pathspec_match_list.
\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": { @@ -14737,7 +14528,7 @@ "comments": "This will be return NULL for positions out of range.
\n", "group": "pathspec" }, - "git_proxy_init_options": { + "git_proxy_options_init": { "type": "function", "file": "git2/proxy.h", "line": 92, @@ -14761,10 +14552,10 @@ "comment": " Zero on success; -1 on failure." }, "description": "Initialize git_proxy_options structure
\n", - "comments": "Initializes a git_proxy_options with default values. Equivalent to\n creating an instance with GIT_PROXY_OPTIONS_INIT.
Initializes a git_proxy_options with default values. Equivalent to creating an instance with GIT_PROXY_OPTIONS_INIT.
Initialize git_rebase_options structure
\n", - "comments": "Initializes a git_rebase_options with default values. Equivalent to\n creating an instance with GIT_REBASE_OPTIONS_INIT.
Initializes a git_rebase_options with default values. Equivalent to creating an instance with GIT_REBASE_OPTIONS_INIT.
Gets the original HEAD ref name for merge rebases.
Gets the original HEAD id for merge rebases.
Gets the onto ref name for merge rebases.
Gets the onto id for merge rebases.
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\n a working directory, the changes were applied to the repository's\n index.
\n", + "comments": "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": "git2/rebase.h", - "line": 284, - "lineto": 290, + "line": 312, + "lineto": 318, "args": [ { "name": "id", @@ -15045,8 +14924,8 @@ "git_rebase_abort": { "type": "function", "file": "git2/rebase.h", - "line": 300, - "lineto": 300, + "line": 328, + "lineto": 328, "args": [ { "name": "rebase", @@ -15067,8 +14946,8 @@ "git_rebase_finish": { "type": "function", "file": "git2/rebase.h", - "line": 310, - "lineto": 312, + "line": 338, + "lineto": 340, "args": [ { "name": "rebase", @@ -15094,8 +14973,8 @@ "git_rebase_free": { "type": "function", "file": "git2/rebase.h", - "line": 319, - "lineto": 319, + "line": 347, + "lineto": 347, "args": [ { "name": "rebase", @@ -15137,7 +15016,7 @@ "comment": " 0 or an error code" }, "description": "Create a new reference database with no backends.
\n", - "comments": "Before the Ref DB can be used for read/writing, a custom database\n backend must be manually set using git_refdb_set_backend()
Before the Ref DB can be used for read/writing, a custom database backend must be manually set using git_refdb_set_backend()
Create a new reference database and automatically add\n the default backends:
\n", - "comments": "Read the reflog for the given reference
\n", - "comments": "If there is no reflog file for the given\n reference yet, an empty reflog object will\n be returned.
\n\nThe reflog must be freed manually by using\n git_reflog_free().
\n", + "comments": "If there is no reflog file for the given reference yet, an empty reflog object will be returned.
\n\nThe reflog must be freed manually by using git_reflog_free().
\n", "group": "reflog" }, "git_reflog_write": { @@ -15331,7 +15210,7 @@ "comment": " 0 on success, GIT_EINVALIDSPEC or an error code" }, "description": "Rename a reflog
\n", - "comments": "The reflog to be renamed is expected to already exist
\n\nThe new name will be checked for validity.\n See git_reference_create_symbolic() for rules about valid names.
The reflog to be renamed is expected to already exist
\n\nThe new name will be checked for validity. See git_reference_create_symbolic() for rules about valid names.
Lookup an entry by its index
\n", - "comments": "Requesting the reflog entry with an index of 0 (zero) will\n return the most recently created entry.
\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": { @@ -15439,7 +15318,7 @@ "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\n param value to 1. When deleting entry n, member old_oid of entry n-1\n (if any) will be updated with the value of member new_oid of entry n+1.
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.
Lookup a reference by name in a repository.
\n", - "comments": "The returned reference must be freed by the user.
\n\nThe name will be checked for validity.\n See git_reference_symbolic_create() for rules about valid names.
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.
Lookup a reference by name and resolve immediately to OID.
\n", - "comments": "This function provides a quick way to resolve a reference name straight\n through to the object id that it refers to. This avoids having to\n allocate or free any git_reference objects for simple situations.
The name will be checked for validity.\n See git_reference_symbolic_create() for rules about valid names.
This function provides a quick way to resolve a reference name straight through to the object id that it refers to. This avoids having to allocate or free any git_reference objects for simple situations.
The name will be checked for validity. See git_reference_symbolic_create() for rules about valid names.
Lookup a reference by DWIMing its short name
\n", - "comments": "Apply the git precendence rules to the given shorthand to determine\n which reference the user is referring to.
\n", + "comments": "Apply the git precendence rules to the given shorthand to determine which reference the user is referring to.
\n", "group": "reference", "examples": { "merge.c": [ - "ex/v0.28.0/merge.html#git_reference_dwim-24" + "ex/HEAD/merge.html#git_reference_dwim-22" ] } }, @@ -15710,7 +15589,7 @@ "comment": " 0 on success, GIT_EEXISTS, GIT_EINVALIDSPEC, GIT_EMODIFIED or an error code" }, "description": "Conditionally create a new symbolic reference.
\n", - "comments": "A symbolic reference is a reference name that refers to another\n reference name. If the other name moves, the symbolic name will move,\n too. As a simple example, the "HEAD" reference might refer to\n "refs/heads/master" while on the "master" branch of a repository.
\n\nThe symbolic reference will be created in the repository and written to\n the disk. The generated reference object must be freed by the user.
\n\nValid reference names must follow one of two patterns:
\n\nThis function will return an error if a reference already exists with the\n given name unless force is true, in which case it will be overwritten.
The message for the reflog will be ignored if the reference does\n not belong in the standard set (HEAD, branches and remote-tracking\n branches) and it does not have a reflog.
\n\nIt will return GIT_EMODIFIED if the reference's value at the time\n of updating does not match the one passed through current_value\n (i.e. if the ref has changed since the user read it).
A symbolic reference is a reference name that refers to another reference name. If the other name moves, the symbolic name will move, too. As a simple example, the "HEAD" reference might refer to "refs/heads/master" while on the "master" branch of a repository.
\n\nThe symbolic reference will be created in the repository and written to the disk. The generated reference object must be freed by the user.
\n\nValid reference names must follow one of two patterns:
\n\nThis function will return an error if a reference already exists with the given name unless force is true, in which case it will be overwritten.
The message for the reflog will be ignored if the reference does not belong in the standard set (HEAD, branches and remote-tracking branches) and it does not have a reflog.
\n\nIt will return GIT_EMODIFIED if the reference's value at the time of updating does not match the one passed through current_value (i.e. if the ref has changed since the user read it).
Create a new symbolic reference.
\n", - "comments": "A symbolic reference is a reference name that refers to another\n reference name. If the other name moves, the symbolic name will move,\n too. As a simple example, the "HEAD" reference might refer to\n "refs/heads/master" while on the "master" branch of a repository.
\n\nThe symbolic reference will be created in the repository and written to\n the disk. The generated reference object must be freed by the user.
\n\nValid reference names must follow one of two patterns:
\n\nThis function will return an error if a reference already exists with the\n given name unless force is true, in which case it will be overwritten.
The message for the reflog will be ignored if the reference does\n not belong in the standard set (HEAD, branches and remote-tracking\n branches) and it does not have a reflog.
\n", + "comments": "A symbolic reference is a reference name that refers to another reference name. If the other name moves, the symbolic name will move, too. As a simple example, the "HEAD" reference might refer to "refs/heads/master" while on the "master" branch of a repository.
\n\nThe symbolic reference will be created in the repository and written to the disk. The generated reference object must be freed by the user.
\n\nValid reference names must follow one of two patterns:
\n\nThis function will return an error if a reference already exists with the given name unless force is true, in which case it will be overwritten.
The message for the reflog will be ignored if the reference does not belong in the standard set (HEAD, branches and remote-tracking branches) and it does not have a reflog.
\n", "group": "reference" }, "git_reference_create": { @@ -15804,11 +15683,11 @@ "comment": " 0 on success, GIT_EEXISTS, GIT_EINVALIDSPEC or an error code" }, "description": "Create a new direct reference.
\n", - "comments": "A direct reference (also called an object id reference) refers directly\n to a specific object id (a.k.a. OID or SHA) in the repository. The id\n permanently refers to the object (although the reference itself can be\n moved). For example, in libgit2 the direct ref "refs/tags/v0.17.0"\n refers to OID 5b9fac39d8a76b9139667c26a63e6b3f204b3977.
\n\nThe direct reference will be created in the repository and written to\n the disk. The generated reference object must be freed by the user.
\n\nValid reference names must follow one of two patterns:
\n\nThis function will return an error if a reference already exists with the\n given name unless force is true, in which case it will be overwritten.
The message for the reflog will be ignored if the reference does\n not belong in the standard set (HEAD, branches and remote-tracking\n branches) and and it does not have a reflog.
\n", + "comments": "A direct reference (also called an object id reference) refers directly to a specific object id (a.k.a. OID or SHA) in the repository. The id permanently refers to the object (although the reference itself can be moved). For example, in libgit2 the direct ref "refs/tags/v0.17.0" refers to OID 5b9fac39d8a76b9139667c26a63e6b3f204b3977.
\n\nThe direct reference will be created in the repository and written to the disk. The generated reference object must be freed by the user.
\n\nValid reference names must follow one of two patterns:
\n\nThis function will return an error if a reference already exists with the given name unless force is true, in which case it will be overwritten.
The message for the reflog will be ignored if the reference does not belong in the standard set (HEAD, branches and remote-tracking branches) and and it does not have a reflog.
\n", "group": "reference", "examples": { "merge.c": [ - "ex/v0.28.0/merge.html#git_reference_create-25" + "ex/HEAD/merge.html#git_reference_create-23" ] } }, @@ -15861,7 +15740,7 @@ "comment": " 0 on success, GIT_EMODIFIED if the value of the reference\n has changed, GIT_EEXISTS, GIT_EINVALIDSPEC or an error code" }, "description": "Conditionally create new direct reference
\n", - "comments": "A direct reference (also called an object id reference) refers directly\n to a specific object id (a.k.a. OID or SHA) in the repository. The id\n permanently refers to the object (although the reference itself can be\n moved). For example, in libgit2 the direct ref "refs/tags/v0.17.0"\n refers to OID 5b9fac39d8a76b9139667c26a63e6b3f204b3977.
\n\nThe direct reference will be created in the repository and written to\n the disk. The generated reference object must be freed by the user.
\n\nValid reference names must follow one of two patterns:
\n\nThis function will return an error if a reference already exists with the\n given name unless force is true, in which case it will be overwritten.
The message for the reflog will be ignored if the reference does\n not belong in the standard set (HEAD, branches and remote-tracking\n branches) and and it does not have a reflog.
\n\nIt will return GIT_EMODIFIED if the reference's value at the time\n of updating does not match the one passed through current_id\n (i.e. if the ref has changed since the user read it).
A direct reference (also called an object id reference) refers directly to a specific object id (a.k.a. OID or SHA) in the repository. The id permanently refers to the object (although the reference itself can be moved). For example, in libgit2 the direct ref "refs/tags/v0.17.0" refers to OID 5b9fac39d8a76b9139667c26a63e6b3f204b3977.
\n\nThe direct reference will be created in the repository and written to the disk. The generated reference object must be freed by the user.
\n\nValid reference names must follow one of two patterns:
\n\nThis function will return an error if a reference already exists with the given name unless force is true, in which case it will be overwritten.
The message for the reflog will be ignored if the reference does not belong in the standard set (HEAD, branches and remote-tracking branches) and and it does not have a reflog.
\n\nIt will return GIT_EMODIFIED if the reference's value at the time of updating does not match the one passed through current_id (i.e. if the ref has changed since the user read it).
Get the OID pointed to by a direct reference.
\n", - "comments": "Only available if the reference is direct (i.e. an object id reference,\n not a symbolic one).
\n\nTo find the OID of a symbolic ref, call git_reference_resolve() and\n then this function (or maybe use git_reference_name_to_id() to\n directly resolve a reference name all the way through to an OID).
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).
Return the peeled OID target of this reference.
\n", - "comments": "This peeled OID only applies to direct references that point to\n a hard Tag object: it is the result of peeling such Tag.
\n", + "comments": "This peeled OID only applies to direct references that point to a hard Tag object: it is the result of peeling such Tag.
\n", "group": "reference" }, "git_reference_symbolic_target": { @@ -15936,10 +15815,10 @@ "group": "reference", "examples": { "general.c": [ - "ex/v0.28.0/general.html#git_reference_symbolic_target-64" + "ex/HEAD/general.html#git_reference_symbolic_target-64" ], "merge.c": [ - "ex/v0.28.0/merge.html#git_reference_symbolic_target-26" + "ex/HEAD/merge.html#git_reference_symbolic_target-24" ] } }, @@ -15966,7 +15845,7 @@ "group": "reference", "examples": { "general.c": [ - "ex/v0.28.0/general.html#git_reference_type-65" + "ex/HEAD/general.html#git_reference_type-65" ] } }, @@ -15993,7 +15872,7 @@ "group": "reference", "examples": { "merge.c": [ - "ex/v0.28.0/merge.html#git_reference_name-27" + "ex/HEAD/merge.html#git_reference_name-25" ] } }, @@ -16021,7 +15900,7 @@ "comment": " 0 or an error code" }, "description": "Resolve a symbolic reference to a direct reference.
\n", - "comments": "This method iteratively peels a symbolic reference until it resolves to\n a direct reference to an OID.
\n\nThe peeled reference is returned in the resolved_ref argument, and\n must be freed manually once it's no longer needed.
If a direct reference is passed as an argument, a copy of that\n reference is returned. This copy must be manually freed too.
\n", + "comments": "This method iteratively peels a symbolic reference until it resolves to a direct reference to an OID.
\n\nThe peeled reference is returned in the resolved_ref argument, and must be freed manually once it's no longer needed.
If a direct reference is passed as an argument, a copy of that reference is returned. This copy must be manually freed too.
\n", "group": "reference" }, "git_reference_owner": { @@ -16080,7 +15959,7 @@ "comment": " 0 on success, GIT_EINVALIDSPEC or an error code" }, "description": "Create a new reference with the same name as the given reference but a\n different symbolic target. The reference must be a symbolic reference,\n otherwise this will fail.
\n", - "comments": "The new reference will be written to disk, overwriting the given reference.
\n\nThe target name will be checked for validity.\n See git_reference_symbolic_create() for rules about valid names.
The message for the reflog will be ignored if the reference does\n not belong in the standard set (HEAD, branches and remote-tracking\n branches) and and it does not have a reflog.
\n", + "comments": "The new reference will be written to disk, overwriting the given reference.
\n\nThe target name will be checked for validity. See git_reference_symbolic_create() for rules about valid names.
The message for the reflog will be ignored if the reference does not belong in the standard set (HEAD, branches and remote-tracking branches) and and it does not have a reflog.
\n", "group": "reference" }, "git_reference_set_target": { @@ -16121,7 +16000,7 @@ "group": "reference", "examples": { "merge.c": [ - "ex/v0.28.0/merge.html#git_reference_set_target-28" + "ex/HEAD/merge.html#git_reference_set_target-26" ] } }, @@ -16164,7 +16043,7 @@ "comment": " 0 on success, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code" }, "description": "Rename an existing reference.
\n", - "comments": "This method works for both direct and symbolic references.
\n\nThe new name will be checked for validity.\n See git_reference_symbolic_create() for rules about valid names.
If the force flag is not enabled, and there's already\n a reference with the given name, the renaming will fail.
IMPORTANT:\n The user needs to write a proper reflog entry if the\n reflog is enabled for the repository. We only rename\n the reflog if it exists.
\n", + "comments": "This method works for both direct and symbolic references.
\n\nThe new name will be checked for validity. See git_reference_symbolic_create() for rules about valid names.
If the force flag is not enabled, and there's already a reference with the given name, the renaming will fail.
IMPORTANT: The user needs to write a proper reflog entry if the reflog is enabled for the repository. We only rename the reflog if it exists.
\n", "group": "reference" }, "git_reference_delete": { @@ -16186,7 +16065,7 @@ "comment": " 0, GIT_EMODIFIED or an error code" }, "description": "Delete an existing reference.
\n", - "comments": "This method works for both direct and symbolic references. The reference\n will be immediately removed on disk but the memory will not be freed.\n Callers must call git_reference_free.
This function will return an error if the reference has changed\n from the time it was looked up.
\n", + "comments": "This method works for both direct and symbolic references. The reference will be immediately removed on disk but the memory will not be freed. Callers must call git_reference_free.
This function will return an error if the reference has changed from the time it was looked up.
\n", "group": "reference" }, "git_reference_remove": { @@ -16213,7 +16092,7 @@ "comment": " 0 or an error code" }, "description": "Delete an existing reference by name
\n", - "comments": "This method removes the named reference from the repository without\n looking at its old value.
\n", + "comments": "This method removes the named reference from the repository without looking at its old value.
\n", "group": "reference" }, "git_reference_list": { @@ -16240,19 +16119,19 @@ "comment": " 0 or an error code" }, "description": "Fill a list with all the references that can be found in a repository.
\n", - "comments": "The string array will be filled with the names of all references; these\n values are owned by the user and should be free'd manually when no\n longer needed, using git_strarray_free().
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().
Perform a callback on each reference in the repository.
\n", - "comments": "The callback function will be called for each reference in the\n repository, receiving the reference object and the payload value\n passed to this method. Returning a non-zero value from the callback\n will terminate the iteration.
Note that the callback function is responsible to call git_reference_free\n on each reference passed to it.
The callback function will be called for each reference in the repository, receiving the reference object and the payload value passed to this method. Returning a non-zero value from the callback will terminate the iteration.
Note that the callback function is responsible to call git_reference_free on each reference passed to it.
Perform a callback on the fully-qualified name of each reference.
\n", - "comments": "The callback function will be called for each reference in the\n repository, receiving the name of the reference and the payload value\n passed to this method. Returning a non-zero value from the callback\n will terminate the iteration.
The callback function will be called for each reference in the repository, receiving the name of the reference and the payload value passed to this method. Returning a non-zero value from the callback will terminate the iteration.
Get the next reference's name
\n", - "comments": "This function is provided for convenience in case only the names\n are interesting as it avoids the allocation of the git_reference\n object which git_reference_next() needs.
This function is provided for convenience in case only the names are interesting as it avoids the allocation of the git_reference object which git_reference_next() needs.
Perform a callback on each reference in the repository whose name\n matches the given pattern.
\n", - "comments": "This function acts like git_reference_foreach() with an additional\n pattern match being applied to the reference name before issuing the\n callback function. See that function for more information.
The pattern is matched using fnmatch or "glob" style where a '*' matches\n any sequence of letters, a '?' matches any letter, and square brackets\n can be used to define character ranges (such as "[0-9]" for digits).
\n", + "comments": "This function acts like git_reference_foreach() with an additional pattern match being applied to the reference name before issuing the callback function. See that function for more information.
The pattern is matched using fnmatch or "glob" style where a '*' matches any sequence of letters, a '?' matches any letter, and square brackets can be used to define character ranges (such as "[0-9]" for digits).
\n", "group": "reference" }, "git_reference_has_log": { "type": "function", "file": "git2/refs.h", - "line": 582, - "lineto": 582, + "line": 601, + "lineto": 601, "args": [ { "name": "repo", @@ -16603,8 +16482,8 @@ "git_reference_ensure_log": { "type": "function", "file": "git2/refs.h", - "line": 594, - "lineto": 594, + "line": 613, + "lineto": 613, "args": [ { "name": "repo", @@ -16624,14 +16503,14 @@ "comment": " 0 or an error code." }, "description": "Ensure there is a reflog for a particular reference.
\n", - "comments": "Make sure that successive updates to the reference will append to\n its log.
\n", + "comments": "Make sure that successive updates to the reference will append to its log.
\n", "group": "reference" }, "git_reference_is_branch": { "type": "function", "file": "git2/refs.h", - "line": 604, - "lineto": 604, + "line": 623, + "lineto": 623, "args": [ { "name": "ref", @@ -16652,8 +16531,8 @@ "git_reference_is_remote": { "type": "function", "file": "git2/refs.h", - "line": 614, - "lineto": 614, + "line": 633, + "lineto": 633, "args": [ { "name": "ref", @@ -16674,8 +16553,8 @@ "git_reference_is_tag": { "type": "function", "file": "git2/refs.h", - "line": 624, - "lineto": 624, + "line": 643, + "lineto": 643, "args": [ { "name": "ref", @@ -16696,8 +16575,8 @@ "git_reference_is_note": { "type": "function", "file": "git2/refs.h", - "line": 634, - "lineto": 634, + "line": 653, + "lineto": 653, "args": [ { "name": "ref", @@ -16718,8 +16597,8 @@ "git_reference_normalize_name": { "type": "function", "file": "git2/refs.h", - "line": 690, - "lineto": 694, + "line": 709, + "lineto": 713, "args": [ { "name": "buffer_out", @@ -16749,14 +16628,14 @@ "comment": " 0 on success, GIT_EBUFS if buffer is too small, GIT_EINVALIDSPEC\n or an error code." }, "description": "Normalize reference name and check validity.
\n", - "comments": "This will normalize the reference name by removing any leading slash\n '/' characters and collapsing runs of adjacent slashes between name\n components into a single slash.
\n\nOnce normalized, if the reference name is valid, it will be returned in\n the user allocated buffer.
\n\nSee git_reference_symbolic_create() for rules about valid names.
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.
Recursively peel reference until object of the specified type is found.
\n", - "comments": "The retrieved peeled object is owned by the repository\n and should be closed with the git_object_free method.
If you pass GIT_OBJECT_ANY as the target type, then the object\n will be peeled until a non-tag object is met.
The retrieved peeled object is owned by the repository and should be closed with the git_object_free method.
If you pass GIT_OBJECT_ANY as the target type, then the object will be peeled until a non-tag object is met.
Ensure the reference name is well-formed.
\n", - "comments": "Valid reference names must follow one of two patterns:
\n\nValid reference names must follow one of two patterns:
\n\nGet the reference's short name
\n", - "comments": "This will transform the reference name into a name "human-readable"\n version. If no shortname is appropriate, it will return the full\n name.
\n\nThe memory is owned by the reference and must not be freed.
\n", + "comments": "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.28.0/status.html#git_reference_shorthand-4" + "ex/HEAD/status.html#git_reference_shorthand-2" ] } }, @@ -17158,11 +17037,11 @@ "group": "remote", "examples": { "remote.c": [ - "ex/v0.28.0/remote.html#git_remote_create-4" + "ex/HEAD/remote.html#git_remote_create-1" ] } }, - "git_remote_create_init_options": { + "git_remote_create_options_init": { "type": "function", "file": "git2/remote.h", "line": 97, @@ -17186,7 +17065,7 @@ "comment": " Zero on success; -1 on failure." }, "description": "Initialize git_remote_create_options structure
\n", - "comments": "Initializes a git_remote_create_options with default values. Equivalent to\n creating an instance with GIT_REMOTE_CREATE_OPTIONS_INIT.
Initializes a git_remote_create_options with default values. Equivalent to creating an instance with GIT_REMOTE_CREATE_OPTIONS_INIT.
Create an anonymous remote
\n", - "comments": "Create a remote with the given url in-memory. You can use this when\n you have a URL instead of a remote's name.
\n", + "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.28.0/network/fetch.html#git_remote_create_anonymous-4" + "fetch.c": [ + "ex/HEAD/fetch.html#git_remote_create_anonymous-4" ], - "network/ls-remote.c": [ - "ex/v0.28.0/network/ls-remote.html#git_remote_create_anonymous-2" + "ls-remote.c": [ + "ex/HEAD/ls-remote.html#git_remote_create_anonymous-2" ] } }, @@ -17327,7 +17206,7 @@ "comment": " 0 or an error code" }, "description": "Create a remote without a connected local repo
\n", - "comments": "Create a remote with the given url in-memory. You can use this when\n you have a URL instead of a remote's name.
\n\nContrasted with git_remote_create_anonymous, a detached remote\n will not consider any repo configuration values (such as insteadof url\n substitutions).
\n", + "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\nContrasted with git_remote_create_anonymous, a detached remote will not consider any repo configuration values (such as insteadof url substitutions).
\n", "group": "remote" }, "git_remote_lookup": { @@ -17359,17 +17238,17 @@ "comment": " 0, GIT_ENOTFOUND, GIT_EINVALIDSPEC or an error code" }, "description": "Get the information for a particular remote
\n", - "comments": "The name will be checked for validity.\n See git_tag_create() for rules about valid names.
The name will be checked for validity. See git_tag_create() for rules about valid names.
Get the remote's url
\n", - "comments": "If url.*.insteadOf has been configured for this URL, it will\n return the modified URL.
\n", + "comments": "If url.*.insteadOf has been configured for this URL, it will return the modified URL.
\n", "group": "remote", "examples": { "remote.c": [ - "ex/v0.28.0/remote.html#git_remote_url-6" + "ex/HEAD/remote.html#git_remote_url-3" ] } }, @@ -17490,11 +17369,11 @@ "comment": " a pointer to the url or NULL if no special url for pushing is set" }, "description": "Get the remote's url for pushing
\n", - "comments": "If url.*.pushInsteadOf has been configured for this URL, it\n will return the modified URL.
\n", + "comments": "If url.*.pushInsteadOf has been configured for this URL, it will return the modified URL.
\n", "group": "remote", "examples": { "remote.c": [ - "ex/v0.28.0/remote.html#git_remote_pushurl-7" + "ex/HEAD/remote.html#git_remote_pushurl-4" ] } }, @@ -17527,11 +17406,11 @@ "comment": " 0 or an error value" }, "description": "Set the remote's url in the configuration
\n", - "comments": "Remote objects already in memory will not be affected. This assumes\n the common case of a single-url remote and will otherwise return an error.
\n", + "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.28.0/remote.html#git_remote_set_url-8" + "ex/HEAD/remote.html#git_remote_set_url-5" ] } }, @@ -17564,11 +17443,11 @@ "comment": null }, "description": "Set the remote's url for pushing in the configuration.
\n", - "comments": "Remote objects already in memory will not be affected. This assumes\n the common case of a single-url remote and will otherwise return an error.
\n", + "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.28.0/remote.html#git_remote_set_pushurl-9" + "ex/HEAD/remote.html#git_remote_set_pushurl-6" ] } }, @@ -17601,7 +17480,7 @@ "comment": " 0, GIT_EINVALIDSPEC if refspec is invalid or an error value" }, "description": "Add a fetch refspec to the remote's configuration
\n", - "comments": "Add the given refspec to the fetch list in the configuration. No\n loaded remote instances will be affected.
\n", + "comments": "Add the given refspec to the fetch list in the configuration. No loaded remote instances will be affected.
\n", "group": "remote" }, "git_remote_get_fetch_refspecs": { @@ -17628,7 +17507,7 @@ "comment": null }, "description": "Get the remote's list of fetch refspecs
\n", - "comments": "The memory is owned by the user and should be freed with\n git_strarray_free.
The memory is owned by the user and should be freed with git_strarray_free.
Add a push refspec to the remote's configuration
\n", - "comments": "Add the given refspec to the push list in the configuration. No\n loaded remote instances will be affected.
\n", + "comments": "Add the given refspec to the push list in the configuration. No loaded remote instances will be affected.
\n", "group": "remote" }, "git_remote_get_push_refspecs": { @@ -17687,7 +17566,7 @@ "comment": null }, "description": "Get the remote's list of push refspecs
\n", - "comments": "The memory is owned by the user and should be freed with\n git_strarray_free.
The memory is owned by the user and should be freed with git_strarray_free.
Open a connection to a remote
\n", - "comments": "The transport is selected based on the URL. The direction argument\n is due to a limitation of the git protocol (over TCP or SSH) which\n starts up a specific binary which can only do the one or the other.
\n", + "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/ls-remote.c": [ - "ex/v0.28.0/network/ls-remote.html#git_remote_connect-4" + "ls-remote.c": [ + "ex/HEAD/ls-remote.html#git_remote_connect-4" ] } }, @@ -17815,11 +17694,11 @@ "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\n connection.
\n\nThe remote (or more exactly its transport) must have connected to\n the remote repository. This list is available as soon as the\n connection to the remote is initiated and it remains available\n after disconnecting.
\n\nThe memory belongs to the remote. The pointer will be valid as long\n as a new connection is not initiated, but it is recommended that\n you make a copy in order to make use of the data.
\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.28.0/network/ls-remote.html#git_remote_ls-5" + "ls-remote.c": [ + "ex/HEAD/ls-remote.html#git_remote_ls-5" ] } }, @@ -17842,7 +17721,7 @@ "comment": " 1 if it's connected, 0 otherwise." }, "description": "Check whether the remote is connected
\n", - "comments": "Check whether the remote's underlying transport is connected to the\n remote host.
\n", + "comments": "Check whether the remote's underlying transport is connected to the remote host.
\n", "group": "remote" }, "git_remote_stop": { @@ -17864,7 +17743,7 @@ "comment": null }, "description": "Cancel the operation
\n", - "comments": "At certain points in its operation, the network code checks whether\n the operation has been cancelled and if so stops the operation.
\n", + "comments": "At certain points in its operation, the network code checks whether the operation has been cancelled and if so stops the operation.
\n", "group": "remote" }, "git_remote_disconnect": { @@ -17908,18 +17787,18 @@ "comment": null }, "description": "Free the memory associated with a remote
\n", - "comments": "This also disconnects from the remote, if the connection\n has not been closed yet (using git_remote_disconnect).
\n", + "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.28.0/network/fetch.html#git_remote_free-6", - "ex/v0.28.0/network/fetch.html#git_remote_free-7" + "fetch.c": [ + "ex/HEAD/fetch.html#git_remote_free-6", + "ex/HEAD/fetch.html#git_remote_free-7" ], - "network/ls-remote.c": [ - "ex/v0.28.0/network/ls-remote.html#git_remote_free-6" + "ls-remote.c": [ + "ex/HEAD/ls-remote.html#git_remote_free-6" ], "remote.c": [ - "ex/v0.28.0/remote.html#git_remote_free-10" + "ex/HEAD/remote.html#git_remote_free-7" ] } }, @@ -17951,15 +17830,15 @@ "group": "remote", "examples": { "remote.c": [ - "ex/v0.28.0/remote.html#git_remote_list-11" + "ex/HEAD/remote.html#git_remote_list-8" ] } }, "git_remote_init_callbacks": { "type": "function", "file": "git2/remote.h", - "line": 577, - "lineto": 579, + "line": 598, + "lineto": 600, "args": [ { "name": "opts", @@ -17982,11 +17861,11 @@ "comments": "", "group": "remote" }, - "git_fetch_init_options": { + "git_fetch_options_init": { "type": "function", "file": "git2/remote.h", - "line": 682, - "lineto": 684, + "line": 704, + "lineto": 706, "args": [ { "name": "opts", @@ -18006,14 +17885,14 @@ "comment": " Zero on success; -1 on failure." }, "description": "Initialize git_fetch_options structure
\n", - "comments": "Initializes a git_fetch_options with default values. Equivalent to\n creating an instance with GIT_FETCH_OPTIONS_INIT.
Initializes a git_fetch_options with default values. Equivalent to creating an instance with GIT_FETCH_OPTIONS_INIT.
Initialize git_push_options structure
\n", - "comments": "Initializes a git_push_options with default values. Equivalent to\n creating an instance with GIT_PUSH_OPTIONS_INIT.
Initializes a git_push_options with default values. Equivalent to creating an instance with GIT_PUSH_OPTIONS_INIT.
Download and index the packfile
\n", - "comments": "Connect to the remote if it hasn't been done yet, negotiate with\n the remote git which objects are missing, download and index the\n packfile.
\n\nThe .idx file will be created and both it and the packfile with be\n renamed to their final name.
\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" }, "git_remote_upload": { "type": "function", "file": "git2/remote.h", - "line": 766, - "lineto": 766, + "line": 788, + "lineto": 788, "args": [ { "name": "remote", @@ -18097,14 +17976,14 @@ "comment": " 0 or an error code" }, "description": "Create a packfile and send it to the server
\n", - "comments": "Connect to the remote if it hasn't been done yet, negotiate with\n the remote git which objects are missing, create a packfile with the missing objects and send it.
\n", + "comments": "Connect to the remote if it hasn't been done yet, negotiate with the remote git which objects are missing, create a packfile with the missing objects and send it.
\n", "group": "remote" }, "git_remote_update_tips": { "type": "function", "file": "git2/remote.h", - "line": 782, - "lineto": 787, + "line": 804, + "lineto": 809, "args": [ { "name": "remote", @@ -18145,8 +18024,8 @@ "git_remote_fetch": { "type": "function", "file": "git2/remote.h", - "line": 803, - "lineto": 807, + "line": 825, + "lineto": 829, "args": [ { "name": "remote", @@ -18176,19 +18055,19 @@ "comment": " 0 or an error code" }, "description": "Download new data and update tips
\n", - "comments": "Convenience function to connect to a remote, download the data,\n disconnect and update the remote-tracking branches.
\n", + "comments": "Convenience function to connect to a remote, download the data, disconnect and update the remote-tracking branches.
\n", "group": "remote", "examples": { - "network/fetch.c": [ - "ex/v0.28.0/network/fetch.html#git_remote_fetch-8" + "fetch.c": [ + "ex/HEAD/fetch.html#git_remote_fetch-8" ] } }, "git_remote_prune": { "type": "function", "file": "git2/remote.h", - "line": 816, - "lineto": 816, + "line": 838, + "lineto": 838, "args": [ { "name": "remote", @@ -18214,8 +18093,8 @@ "git_remote_push": { "type": "function", "file": "git2/remote.h", - "line": 828, - "lineto": 830, + "line": 850, + "lineto": 852, "args": [ { "name": "remote", @@ -18246,8 +18125,8 @@ "git_remote_stats": { "type": "function", "file": "git2/remote.h", - "line": 835, - "lineto": 835, + "line": 857, + "lineto": 857, "args": [ { "name": "remote", @@ -18258,23 +18137,23 @@ "argline": "git_remote *remote", "sig": "git_remote *", "return": { - "type": "const git_transfer_progress *", + "type": "const git_indexer_progress *", "comment": null }, "description": "Get the statistics structure that is filled in by the fetch operation.
\n", "comments": "", "group": "remote", "examples": { - "network/fetch.c": [ - "ex/v0.28.0/network/fetch.html#git_remote_stats-9" + "fetch.c": [ + "ex/HEAD/fetch.html#git_remote_stats-9" ] } }, "git_remote_autotag": { "type": "function", "file": "git2/remote.h", - "line": 843, - "lineto": 843, + "line": 865, + "lineto": 865, "args": [ { "name": "remote", @@ -18295,8 +18174,8 @@ "git_remote_set_autotag": { "type": "function", "file": "git2/remote.h", - "line": 855, - "lineto": 855, + "line": 877, + "lineto": 877, "args": [ { "name": "repo", @@ -18321,14 +18200,14 @@ "comment": null }, "description": "Set the remote's tag following setting.
\n", - "comments": "The change will be made in the configuration. No loaded remotes\n will be affected.
\n", + "comments": "The change will be made in the configuration. No loaded remotes will be affected.
\n", "group": "remote" }, "git_remote_prune_refs": { "type": "function", "file": "git2/remote.h", - "line": 862, - "lineto": 862, + "line": 884, + "lineto": 884, "args": [ { "name": "remote", @@ -18349,8 +18228,8 @@ "git_remote_rename": { "type": "function", "file": "git2/remote.h", - "line": 884, - "lineto": 888, + "line": 906, + "lineto": 910, "args": [ { "name": "problems", @@ -18380,19 +18259,19 @@ "comment": " 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code" }, "description": "Give the remote a new name
\n", - "comments": "All remote-tracking branches and configuration settings\n for the remote are updated.
\n\nThe new name will be checked for validity.\n See git_tag_create() for rules about valid names.
No loaded instances of a the remote with the old name will change\n their name or their list of refspecs.
\n", + "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.28.0/remote.html#git_remote_rename-12" + "ex/HEAD/remote.html#git_remote_rename-9" ] } }, "git_remote_is_valid_name": { "type": "function", "file": "git2/remote.h", - "line": 896, - "lineto": 896, + "line": 918, + "lineto": 918, "args": [ { "name": "remote_name", @@ -18413,8 +18292,8 @@ "git_remote_delete": { "type": "function", "file": "git2/remote.h", - "line": 908, - "lineto": 908, + "line": 930, + "lineto": 930, "args": [ { "name": "repo", @@ -18434,19 +18313,19 @@ "comment": " 0 on success, or an error code." }, "description": "Delete an existing persisted remote.
\n", - "comments": "All remote-tracking branches and configuration settings\n for the remote will be removed.
\n", + "comments": "All remote-tracking branches and configuration settings for the remote will be removed.
\n", "group": "remote", "examples": { "remote.c": [ - "ex/v0.28.0/remote.html#git_remote_delete-13" + "ex/HEAD/remote.html#git_remote_delete-10" ] } }, "git_remote_default_branch": { "type": "function", "file": "git2/remote.h", - "line": 926, - "lineto": 926, + "line": 948, + "lineto": 948, "args": [ { "name": "out", @@ -18466,7 +18345,7 @@ "comment": " 0, GIT_ENOTFOUND if the remote does not have any references\n or none of them point to HEAD's commit, or an error message." }, "description": "Retrieve the name of the remote's default branch
\n", - "comments": "The default branch of a repository is the branch which HEAD points\n to. If the remote does not support reporting this information\n directly, it performs the guess as git does; that is, if there are\n multiple branches which point to the same commit, the first one is\n chosen. If the master branch is a candidate, it wins.
\n\nThis function must only be called after connecting.
\n", + "comments": "The default branch of a repository is the branch which HEAD points to. If the remote does not support reporting this information directly, it performs the guess as git does; that is, if there are multiple branches which point to the same commit, the first one is chosen. If the master branch is a candidate, it wins.
\n\nThis function must only be called after connecting.
\n", "group": "remote" }, "git_repository_open": { @@ -18493,14 +18372,11 @@ "comment": " 0 or an error code" }, "description": "Open a git repository.
\n", - "comments": "The 'path' argument must point to either a git repository\n folder, or an existing work dir.
\n\nThe method will automatically detect if 'path' is a normal\n or bare repository or fail is 'path' is neither.
\n", + "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.28.0/general.html#git_repository_open-68" - ], - "remote.c": [ - "ex/v0.28.0/remote.html#git_repository_open-14" + "ex/HEAD/general.html#git_repository_open-68" ] } }, @@ -18528,7 +18404,7 @@ "comment": " 0 or an error code" }, "description": "Open working tree as a repository
\n", - "comments": "Open the working directory of the working tree as a normal\n repository that can then be worked on.
\n", + "comments": "Open the working directory of the working tree as a normal repository that can then be worked on.
\n", "group": "repository" }, "git_repository_wrap_odb": { @@ -18555,7 +18431,7 @@ "comment": " 0 or an error code" }, "description": "Create a "fake" repository to wrap an object database
\n", - "comments": "Create a repository object to wrap an object database to be used\n with the API when all you have is an object database. This doesn't\n have any paths associated with it, so use with care.
\n", + "comments": "Create a repository object to wrap an object database to be used with the API when all you have is an object database. This doesn't have any paths associated with it, so use with care.
\n", "group": "repository" }, "git_repository_discover": { @@ -18592,13 +18468,8 @@ "comment": " 0 or an error code" }, "description": "Look for a git repository and copy its path in the given buffer.\n The lookup start from base_path and walk across parent directories\n if nothing has been found. The lookup ends when the first repository\n is found, or when reaching a directory referenced in ceiling_dirs\n or when the filesystem changes (in case across_fs is true).
\n", - "comments": "The method will automatically detect if the repository is bare\n (if there is a repository).
\n", - "group": "repository", - "examples": { - "remote.c": [ - "ex/v0.28.0/remote.html#git_repository_discover-15" - ] - } + "comments": "The method will automatically detect if the repository is bare (if there is a repository).
\n", + "group": "repository" }, "git_repository_open_ext": { "type": "function", @@ -18637,39 +18508,8 @@ "comments": "", "group": "repository", "examples": { - "blame.c": [ - "ex/v0.28.0/blame.html#git_repository_open_ext-24" - ], - "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_repository_open_ext-31" - ], - "checkout.c": [ - "ex/v0.28.0/checkout.html#git_repository_open_ext-14" - ], - "describe.c": [ - "ex/v0.28.0/describe.html#git_repository_open_ext-8" - ], - "diff.c": [ - "ex/v0.28.0/diff.html#git_repository_open_ext-15" - ], "log.c": [ - "ex/v0.28.0/log.html#git_repository_open_ext-45", - "ex/v0.28.0/log.html#git_repository_open_ext-46" - ], - "ls-files.c": [ - "ex/v0.28.0/ls-files.html#git_repository_open_ext-7" - ], - "merge.c": [ - "ex/v0.28.0/merge.html#git_repository_open_ext-33" - ], - "rev-parse.c": [ - "ex/v0.28.0/rev-parse.html#git_repository_open_ext-16" - ], - "status.c": [ - "ex/v0.28.0/status.html#git_repository_open_ext-5" - ], - "tag.c": [ - "ex/v0.28.0/tag.html#git_repository_open_ext-11" + "ex/HEAD/log.html#git_repository_open_ext-43" ] } }, @@ -18697,7 +18537,7 @@ "comment": " 0 on success, or an error code" }, "description": "Open a bare repository on the serverside.
\n", - "comments": "This is a fast open for bare repositories that will come in handy\n if you're e.g. hosting git repositories and need to access them\n efficiently
\n", + "comments": "This is a fast open for bare repositories that will come in handy if you're e.g. hosting git repositories and need to access them efficiently
\n", "group": "repository" }, "git_repository_free": { @@ -18719,47 +18559,14 @@ "comment": null }, "description": "Free a previously allocated repository
\n", - "comments": "Note that after a repository is free'd, all the objects it has spawned\n will still exist until they are manually closed by the user\n with git_object_free, but accessing any of the attributes of\n an object without a backing repository will result in undefined\n behavior
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
Creates a new Git repository in the given folder.
\n", - "comments": "TODO:\n - Reinit the repository
\n", + "comments": "TODO: - Reinit the repository
\n", "group": "repository", "examples": { "init.c": [ - "ex/v0.28.0/init.html#git_repository_init-7" + "ex/HEAD/init.html#git_repository_init-5" ] } }, - "git_repository_init_init_options": { + "git_repository_init_options_init": { "type": "function", "file": "git2/repository.h", "line": 326, @@ -18824,7 +18631,7 @@ "comment": " Zero on success; -1 on failure." }, "description": "Initialize git_repository_init_options structure
\n", - "comments": "Initializes a git_repository_init_options with default values. Equivalent to\n creating an instance with GIT_REPOSITORY_INIT_OPTIONS_INIT.
Initializes a git_repository_init_options with default values. Equivalent to creating an instance with GIT_REPOSITORY_INIT_OPTIONS_INIT.
Create a new Git repository in the given folder with extended controls.
\n", - "comments": "This will initialize a new git repository (creating the repo_path\n if requested by flags) and working directory as needed. It will\n auto-detect the case sensitivity of the file system and if the\n file system supports file mode bits correctly.
\n", + "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.28.0/init.html#git_repository_init_ext-8" + "ex/HEAD/init.html#git_repository_init_ext-6" ] } }, @@ -18888,15 +18695,15 @@ "comment": " 0 on success, GIT_EUNBORNBRANCH when HEAD points to a non existing\n branch, GIT_ENOTFOUND when HEAD is missing; an error code otherwise" }, "description": "Retrieve and resolve the reference pointed at by HEAD.
\n", - "comments": "The returned git_reference will be owned by caller and\n git_reference_free() must be called when done with it to release the\n allocated memory and prevent a leak.
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.
Check if a repository's HEAD is detached
\n", - "comments": "A repository's HEAD is detached when it points directly to a commit\n instead of a branch.
\n", + "comments": "A repository's HEAD is detached when it points directly to a commit instead of a branch.
\n", "group": "repository" }, "git_repository_head_detached_for_worktree": { @@ -18978,7 +18785,7 @@ "comment": " 1 if HEAD is detached, 0 if its not; error code if\n there was an error" }, "description": "Check if a worktree's HEAD is detached
\n", - "comments": "A worktree's HEAD is detached when it points directly to a\n commit instead of a branch.
\n", + "comments": "A worktree's HEAD is detached when it points directly to a commit instead of a branch.
\n", "group": "repository" }, "git_repository_head_unborn": { @@ -19000,7 +18807,7 @@ "comment": " 1 if the current branch is unborn, 0 if it's not; error\n code if there was an error" }, "description": "Check if the current branch is unborn
\n", - "comments": "An unborn branch is one named from HEAD but which doesn't exist in\n the refs namespace, because it doesn't have any commit to point to.
\n", + "comments": "An unborn branch is one named from HEAD but which doesn't exist in the refs namespace, because it doesn't have any commit to point to.
\n", "group": "repository" }, "git_repository_is_empty": { @@ -19022,7 +18829,7 @@ "comment": " 1 if the repository is empty, 0 if it isn't, error code\n if the repository is corrupted" }, "description": "Check if a repository is empty
\n", - "comments": "An empty repository has just been initialized and contains no references\n apart from HEAD, which must be pointing to the unborn master branch.
\n", + "comments": "An empty repository has just been initialized and contains no references apart from HEAD, which must be pointing to the unborn master branch.
\n", "group": "repository" }, "git_repository_item_path": { @@ -19054,7 +18861,7 @@ "comment": " 0, GIT_ENOTFOUND if the path cannot exist or an error code" }, "description": "Get the location of a specific repository file or directory
\n", - "comments": "This function will retrieve the path of a specific repository\n item. It will thereby honor things like the repository's\n common directory, gitdir, etc. In case a file path cannot\n exist for a given item (e.g. the working directory of a bare\n repository), GIT_ENOTFOUND is returned.
\n", + "comments": "This function will retrieve the path of a specific repository item. It will thereby honor things like the repository's common directory, gitdir, etc. In case a file path cannot exist for a given item (e.g. the working directory of a bare repository), GIT_ENOTFOUND is returned.
\n", "group": "repository" }, "git_repository_path": { @@ -19076,14 +18883,14 @@ "comment": " the path to the repository" }, "description": "Get the path of this repository
\n", - "comments": "This is the path of the .git folder for normal repositories,\n or of the repository itself for bare repositories.
This is the path of the .git folder for normal repositories, or of the repository itself for bare repositories.
Get the path of the working directory for this repository
\n", - "comments": "If the repository is bare, this function will always return\n NULL.
\n", + "comments": "If the repository is bare, this function will always return NULL.
\n", "group": "repository", "examples": { "init.c": [ - "ex/v0.28.0/init.html#git_repository_workdir-10" + "ex/HEAD/init.html#git_repository_workdir-8" ] } }, @@ -19133,7 +18940,7 @@ "comment": " the path to the common dir" }, "description": "Get the path of the shared common directory for this repository
\n", - "comments": "If the repository is bare is not a worktree, the git directory\n path is returned.
\n", + "comments": "If the repository is bare is not a worktree, the git directory path is returned.
\n", "group": "repository" }, "git_repository_set_workdir": { @@ -19165,7 +18972,7 @@ "comment": " 0, or an error code" }, "description": "Set the path to the working directory for this repository
\n", - "comments": "The working directory doesn't need to be the same one\n that contains the .git folder for this repository.
If this repository is bare, setting its working directory\n will turn it into a normal repository, capable of performing\n all the common workdir operations (checkout, status, index\n manipulation, etc).
\n", + "comments": "The working directory doesn't need to be the same one that contains the .git folder for this repository.
If this repository is bare, setting its working directory will turn it into a normal repository, capable of performing all the common workdir operations (checkout, status, index manipulation, etc).
\n", "group": "repository" }, "git_repository_is_bare": { @@ -19191,7 +18998,7 @@ "group": "repository", "examples": { "status.c": [ - "ex/v0.28.0/status.html#git_repository_is_bare-9" + "ex/HEAD/status.html#git_repository_is_bare-5" ] } }, @@ -19241,7 +19048,7 @@ "comment": " 0, or an error code" }, "description": "Get the configuration file for this repository.
\n", - "comments": "If a configuration file has not been set, the default\n config set for the repository will be returned, including\n global and system configurations (if they are available).
\n\nThe configuration file must be freed once it's no longer\n being used by the user.
\n", + "comments": "If a configuration file has not been set, the default config set for the repository will be returned, including global and system configurations (if they are available).
\n\nThe configuration file must be freed once it's no longer being used by the user.
\n", "group": "repository" }, "git_repository_config_snapshot": { @@ -19268,12 +19075,12 @@ "comment": " 0, or an error code" }, "description": "Get a snapshot of the repository's configuration
\n", - "comments": "Convenience function to take a snapshot from the repository's\n configuration. The contents of this snapshot will not change,\n even if the underlying config files are modified.
\n\nThe configuration file must be freed once it's no longer\n being used by the user.
\n", + "comments": "Convenience function to take a snapshot from the repository's configuration. The contents of this snapshot will not change, even if the underlying config files are modified.
\n\nThe configuration file must be freed once it's no longer being used by the user.
\n", "group": "repository", "examples": { "general.c": [ - "ex/v0.28.0/general.html#git_repository_config_snapshot-70", - "ex/v0.28.0/general.html#git_repository_config_snapshot-71" + "ex/HEAD/general.html#git_repository_config_snapshot-70", + "ex/HEAD/general.html#git_repository_config_snapshot-71" ] } }, @@ -19301,14 +19108,14 @@ "comment": " 0, or an error code" }, "description": "Get the Object Database for this repository.
\n", - "comments": "If a custom ODB has not been set, the default\n database for the repository will be returned (the one\n located in .git/objects).
The ODB must be freed once it's no longer being used by\n the user.
\n", + "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.28.0/cat-file.html#git_repository_odb-33" + "ex/HEAD/cat-file.html#git_repository_odb-29" ], "general.c": [ - "ex/v0.28.0/general.html#git_repository_odb-72" + "ex/HEAD/general.html#git_repository_odb-72" ] } }, @@ -19336,7 +19143,7 @@ "comment": " 0, or an error code" }, "description": "Get the Reference Database Backend for this repository.
\n", - "comments": "If a custom refsdb has not been set, the default database for\n the repository will be returned (the one that manipulates loose\n and packed references in the .git directory).
The refdb must be freed once it's no longer being used by\n the user.
\n", + "comments": "If a custom refsdb has not been set, the default database for the repository will be returned (the one that manipulates loose and packed references in the .git directory).
The refdb must be freed once it's no longer being used by the user.
\n", "group": "repository" }, "git_repository_index": { @@ -19363,20 +19170,23 @@ "comment": " 0, or an error code" }, "description": "Get the Index file for this repository.
\n", - "comments": "If a custom index has not been set, the default\n index for the repository will be returned (the one\n located in .git/index).
The index must be freed once it's no longer being used by\n the user.
\n", + "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": { + "add.c": [ + "ex/HEAD/add.html#git_repository_index-5" + ], "general.c": [ - "ex/v0.28.0/general.html#git_repository_index-73" + "ex/HEAD/general.html#git_repository_index-73" ], "init.c": [ - "ex/v0.28.0/init.html#git_repository_index-11" + "ex/HEAD/init.html#git_repository_index-9" ], "ls-files.c": [ - "ex/v0.28.0/ls-files.html#git_repository_index-9" + "ex/HEAD/ls-files.html#git_repository_index-5" ], "merge.c": [ - "ex/v0.28.0/merge.html#git_repository_index-37" + "ex/HEAD/merge.html#git_repository_index-33" ] } }, @@ -19404,7 +19214,7 @@ "comment": " 0, GIT_ENOTFOUND if no message exists or an error code" }, "description": "Retrieve git's prepared message
\n", - "comments": "Operations such as git revert/cherry-pick/merge with the -n option\n stop just short of creating a commit with the changes and save\n their prepared message in .git/MERGE_MSG so the next git-commit\n execution can present it to the user for them to amend if they\n wish.
\n\nUse this function to get the contents of this file. Don't forget to\n remove the file after you create the commit.
\n", + "comments": "Operations such as git revert/cherry-pick/merge with the -n option stop just short of creating a commit with the changes and save their prepared message in .git/MERGE_MSG so the next git-commit execution can present it to the user for them to amend if they wish.
\n\nUse this function to get the contents of this file. Don't forget to remove the file after you create the commit.
\n", "group": "repository" }, "git_repository_message_remove": { @@ -19452,15 +19262,15 @@ "group": "repository", "examples": { "merge.c": [ - "ex/v0.28.0/merge.html#git_repository_state_cleanup-38" + "ex/HEAD/merge.html#git_repository_state_cleanup-34" ] } }, "git_repository_fetchhead_foreach": { "type": "function", "file": "git2/repository.h", - "line": 660, - "lineto": 663, + "line": 672, + "lineto": 675, "args": [ { "name": "repo", @@ -19491,8 +19301,8 @@ "git_repository_mergehead_foreach": { "type": "function", "file": "git2/repository.h", - "line": 680, - "lineto": 683, + "line": 701, + "lineto": 704, "args": [ { "name": "repo", @@ -19523,8 +19333,8 @@ "git_repository_hashfile": { "type": "function", "file": "git2/repository.h", - "line": 708, - "lineto": 713, + "line": 729, + "lineto": 734, "args": [ { "name": "out", @@ -19559,14 +19369,14 @@ "comment": " 0 on success, or an error code" }, "description": "Calculate hash of file using repository filtering rules.
\n", - "comments": "If you simply want to calculate the hash of a file on disk with no filters,\n you can just use the git_odb_hashfile() API. However, if you want to\n hash a file in the repository and you want to apply filtering rules (e.g.\n crlf filters) before generating the SHA, then use this function.
Note: if the repository has core.safecrlf set to fail and the\n filtering triggers that failure, then this function will return an\n error and not calculate the hash of the file.
If you simply want to calculate the hash of a file on disk with no filters, you can just use the git_odb_hashfile() API. However, if you want to hash a file in the repository and you want to apply filtering rules (e.g. crlf filters) before generating the SHA, then use this function.
Note: if the repository has core.safecrlf set to fail and the filtering triggers that failure, then this function will return an error and not calculate the hash of the file.
Make the repository HEAD point to the specified reference.
\n", - "comments": "If the provided reference points to a Tree or a Blob, the HEAD is\n unaltered and -1 is returned.
\n\nIf the provided reference points to a branch, the HEAD will point\n to that branch, staying attached, or become attached if it isn't yet.\n If the branch doesn't exist yet, no error will be return. The HEAD\n will then be attached to an unborn branch.
\n\nOtherwise, the HEAD will be detached and will directly point to\n the Commit.
\n", + "comments": "If the provided reference points to a Tree or a Blob, the HEAD is unaltered and -1 is returned.
\n\nIf the provided reference points to a branch, the HEAD will point to that branch, staying attached, or become attached if it isn't yet. If the branch doesn't exist yet, no error will be return. The HEAD will then be attached to an unborn branch.
\n\nOtherwise, the HEAD will be detached and will directly point to the Commit.
\n", "group": "repository", "examples": { "checkout.c": [ - "ex/v0.28.0/checkout.html#git_repository_set_head-16" + "ex/HEAD/checkout.html#git_repository_set_head-12" ] } }, "git_repository_set_head_detached": { "type": "function", "file": "git2/repository.h", - "line": 753, - "lineto": 755, + "line": 774, + "lineto": 776, "args": [ { "name": "repo", @@ -19618,14 +19428,14 @@ "comment": " 0 on success, or an error code" }, "description": "Make the repository HEAD directly point to the Commit.
\n", - "comments": "If the provided committish cannot be found in the repository, the HEAD\n is unaltered and GIT_ENOTFOUND is returned.
\n\nIf the provided commitish cannot be peeled into a commit, the HEAD\n is unaltered and -1 is returned.
\n\nOtherwise, the HEAD will eventually be detached and will directly point to\n the peeled Commit.
\n", + "comments": "If the provided committish cannot be found in the repository, the HEAD is unaltered and GIT_ENOTFOUND is returned.
\n\nIf the provided commitish cannot be peeled into a commit, the HEAD is unaltered and -1 is returned.
\n\nOtherwise, the HEAD will eventually be detached and will directly point to the peeled Commit.
\n", "group": "repository" }, "git_repository_set_head_detached_from_annotated": { "type": "function", "file": "git2/repository.h", - "line": 769, - "lineto": 771, + "line": 790, + "lineto": 792, "args": [ { "name": "repo", @@ -19645,19 +19455,19 @@ "comment": null }, "description": "Make the repository HEAD directly point to the Commit.
\n", - "comments": "This behaves like git_repository_set_head_detached() but takes an\n annotated commit, which lets you specify which extended sha syntax\n string was specified by a user, allowing for more exact reflog\n messages.
See the documentation for git_repository_set_head_detached().
This behaves like git_repository_set_head_detached() 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_repository_set_head_detached().
Detach the HEAD.
\n", - "comments": "If the HEAD is already detached and points to a Commit, 0 is returned.
\n\nIf the HEAD is already detached and points to a Tag, the HEAD is\n updated into making it point to the peeled Commit, and 0 is returned.
\n\nIf the HEAD is already detached and points to a non commitish, the HEAD is\n unaltered, and -1 is returned.
\n\nOtherwise, the HEAD will be detached and point to the peeled Commit.
\n", + "comments": "If the HEAD is already detached and points to a Commit, 0 is returned.
\n\nIf the HEAD is already detached and points to a Tag, the HEAD is updated into making it point to the peeled Commit, and 0 is returned.
\n\nIf the HEAD is already detached and points to a non commitish, the HEAD is unaltered, and -1 is returned.
\n\nOtherwise, the HEAD will be detached and point to the peeled Commit.
\n", "group": "repository" }, "git_repository_state": { "type": "function", "file": "git2/repository.h", - "line": 821, - "lineto": 821, + "line": 842, + "lineto": 842, "args": [ { "name": "repo", @@ -19698,18 +19508,18 @@ "group": "repository", "examples": { "checkout.c": [ - "ex/v0.28.0/checkout.html#git_repository_state-18" + "ex/HEAD/checkout.html#git_repository_state-14" ], "merge.c": [ - "ex/v0.28.0/merge.html#git_repository_state-39" + "ex/HEAD/merge.html#git_repository_state-35" ] } }, "git_repository_set_namespace": { "type": "function", "file": "git2/repository.h", - "line": 835, - "lineto": 835, + "line": 856, + "lineto": 856, "args": [ { "name": "repo", @@ -19729,14 +19539,14 @@ "comment": " 0 on success, -1 on error" }, "description": "Sets the active namespace for this Git Repository
\n", - "comments": "This namespace affects all reference operations for the repo.\n See man gitnamespaces
This namespace affects all reference operations for the repo. See man gitnamespaces
Retrieve the configured identity to use for reflogs
\n", - "comments": "The memory is owned by the repository and must not be freed by the\n user.
\n", + "comments": "The memory is owned by the repository and must not be freed by the user.
\n", "group": "repository" }, "git_repository_set_ident": { "type": "function", "file": "git2/repository.h", - "line": 877, - "lineto": 877, + "line": 898, + "lineto": 898, "args": [ { "name": "repo", @@ -19837,7 +19647,7 @@ "comment": null }, "description": "Set the identity to be used for writing reflogs
\n", - "comments": "If both are set, this name and email will be used to write to the\n reflog. Pass NULL to unset. When unset, the identity will be taken\n from the repository's configuration.
\n", + "comments": "If both are set, this name and email will be used to write to the reflog. Pass NULL to unset. When unset, the identity will be taken from the repository's configuration.
\n", "group": "repository" }, "git_reset": { @@ -19874,7 +19684,7 @@ "comment": " 0 on success or an error code" }, "description": "Sets the current head to the specified commit oid and optionally\n resets the index and working tree to match.
\n", - "comments": "SOFT reset means the Head will be moved to the commit.
\n\nMIXED reset will trigger a SOFT reset, plus the index will be replaced\n with the content of the commit tree.
\n\nHARD reset will trigger a MIXED reset and the working directory will be\n replaced with the content of the index. (Untracked and ignored files\n will be left alone, however.)
\n\nTODO: Implement remaining kinds of resets.
\n", + "comments": "SOFT reset means the Head will be moved to the commit.
\n\nMIXED reset will trigger a SOFT reset, plus the index will be replaced with the content of the commit tree.
\n\nHARD reset will trigger a MIXED reset and the working directory will be replaced with the content of the index. (Untracked and ignored files will be left alone, however.)
\n\nTODO: Implement remaining kinds of resets.
\n", "group": "reset" }, "git_reset_from_annotated": { @@ -19911,7 +19721,7 @@ "comment": null }, "description": "Sets the current head to the specified commit oid and optionally\n resets the index and working tree to match.
\n", - "comments": "This behaves like git_reset() but takes an annotated commit,\n which lets you specify which extended sha syntax string was\n specified by a user, allowing for more exact reflog messages.
See the documentation for git_reset().
This behaves like git_reset() 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_reset().
Updates some entries in the index from the target commit tree.
\n", - "comments": "The scope of the updated entries is determined by the paths\n being passed in the pathspec parameters.
Passing a NULL target will result in removing\n entries in the index matching the provided pathspecs.
The scope of the updated entries is determined by the paths being passed in the pathspec parameters.
Passing a NULL target will result in removing entries in the index matching the provided pathspecs.
Initialize git_revert_options structure
\n", - "comments": "Initializes a git_revert_options with default values. Equivalent to\n creating an instance with GIT_REVERT_OPTIONS_INIT.
Initializes a git_revert_options with default values. Equivalent to creating an instance with GIT_REVERT_OPTIONS_INIT.
Find a single object, as specified by a revision string.
\n", - "comments": "See man gitrevisions, or\n http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for\n information on the syntax accepted.
The returned object should be released with git_object_free when no\n longer needed.
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.
Find a single object and intermediate reference by a revision string.
\n", - "comments": "See man gitrevisions, or\n http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for\n information on the syntax accepted.
In some cases (\n@\n{\n<\n-n>} or `\n<branchname
\n\n\n@\n{upstream}
\n), the expression may\n point to an intermediate reference. When such expressions are being passed\n in,reference_out` will be valued as well.
The returned object should be released with git_object_free and the\n returned reference with git_reference_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.
In some cases (@{<-n>} or <branchname>@{upstream}), the expression may point to an intermediate reference. When such expressions are being passed in, reference_out will be valued as well.
The returned object should be released with git_object_free and the returned reference with git_reference_free when no longer needed.
Parse a revision string for from, to, and intent.
See man gitrevisions or\n http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for\n information on the syntax accepted.
See man gitrevisions or http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for information on the syntax accepted.
Allocate a new revision walker to iterate through a repo.
\n", - "comments": "This revision walker uses a custom memory pool and an internal\n commit cache, so it is relatively expensive to allocate.
\n\nFor maximum performance, this revision walker should be\n reused for different walks.
\n\nThis revision walker is not thread safe: it may only be\n used to walk a repository on a single thread; however,\n it is possible to have several revision walkers in\n several different threads walking the same repository.
\n", + "comments": "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.28.0/general.html#git_revwalk_new-74" + "ex/HEAD/general.html#git_revwalk_new-74" ], "log.c": [ - "ex/v0.28.0/log.html#git_revwalk_new-50", - "ex/v0.28.0/log.html#git_revwalk_new-51" + "ex/HEAD/log.html#git_revwalk_new-46", + "ex/HEAD/log.html#git_revwalk_new-47" ] } }, @@ -20240,7 +20050,7 @@ "comment": null }, "description": "Reset the revision walker for reuse.
\n", - "comments": "This will clear all the pushed and hidden commits, and\n leave the walker in a blank state (just like at\n creation) ready to receive new commit pushes and\n start a new walk.
\n\nThe revision walk is automatically reset when a walk\n is over.
\n", + "comments": "This will clear all the pushed and hidden commits, and leave the walker in a blank state (just like at creation) ready to receive new commit pushes and start a new walk.
\n\nThe revision walk is automatically reset when a walk is over.
\n", "group": "revwalk" }, "git_revwalk_push": { @@ -20267,14 +20077,14 @@ "comment": " 0 or an error code" }, "description": "Add a new root for the traversal
\n", - "comments": "The pushed commit will be marked as one of the roots from which to\n start the walk. This commit may not be walked if it or a child is\n hidden.
\n\nAt least one commit must be pushed onto the walker before a walk\n can be started.
\n\nThe given id must belong to a committish on the walked\n repository.
\n", + "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.28.0/general.html#git_revwalk_push-75" + "ex/HEAD/general.html#git_revwalk_push-75" ], "log.c": [ - "ex/v0.28.0/log.html#git_revwalk_push-52" + "ex/HEAD/log.html#git_revwalk_push-48" ] } }, @@ -20302,7 +20112,7 @@ "comment": " 0 or an error code" }, "description": "Push matching references
\n", - "comments": "The OIDs pointed to by the references that match the given glob\n pattern will be pushed to the revision walker.
\n\nA leading 'refs/' is implied if not present as well as a trailing\n '/\n\\\n*' if the glob lacks '?', '\n\\\n*' or '['.
\n\nAny references matching this glob which do not point to a\n committish will be ignored.
\n", + "comments": "The OIDs pointed to by the references that match the given glob pattern will be pushed to the revision walker.
\n\nA leading 'refs/' is implied if not present as well as a trailing '/*' if the glob lacks '?', '*' or '['.
\n\nAny references matching this glob which do not point to a committish will be ignored.
\n", "group": "revwalk" }, "git_revwalk_push_head": { @@ -20328,7 +20138,7 @@ "group": "revwalk", "examples": { "log.c": [ - "ex/v0.28.0/log.html#git_revwalk_push_head-53" + "ex/HEAD/log.html#git_revwalk_push_head-49" ] } }, @@ -20356,11 +20166,11 @@ "comment": " 0 or an error code" }, "description": "Mark a commit (and its ancestors) uninteresting for the output.
\n", - "comments": "The given id must belong to a committish on the walked\n repository.
\n\nThe resolved commit and all its parents will be hidden from the\n output on the revision walk.
\n", + "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.28.0/log.html#git_revwalk_hide-54" + "ex/HEAD/log.html#git_revwalk_hide-50" ] } }, @@ -20388,7 +20198,7 @@ "comment": " 0 or an error code" }, "description": "Hide matching references.
\n", - "comments": "The OIDs pointed to by the references that match the given glob\n pattern and their ancestors will be hidden from the output on the\n revision walk.
\n\nA leading 'refs/' is implied if not present as well as a trailing\n '/\n\\\n*' if the glob lacks '?', '\n\\\n*' or '['.
\n\nAny references matching this glob which do not point to a\n committish will be ignored.
\n", + "comments": "The OIDs pointed to by the references that match the given glob pattern and their ancestors will be hidden from the output on the revision walk.
\n\nA leading 'refs/' is implied if not present as well as a trailing '/*' if the glob lacks '?', '*' or '['.
\n\nAny references matching this glob which do not point to a committish will be ignored.
\n", "group": "revwalk" }, "git_revwalk_hide_head": { @@ -20491,14 +20301,14 @@ "comment": " 0 if the next commit was found;\n\tGIT_ITEROVER if there are no commits left to iterate" }, "description": "Get the next commit from the revision walk.
\n", - "comments": "The initial call to this method is not blocking when\n iterating through a repo with a time-sorting mode.
\n\nIterating with Topological or inverted modes makes the initial\n call blocking to preprocess the commit list, but this block should be\n mostly unnoticeable on most repositories (topological preprocessing\n times at 0.3s on the git.git repo).
\n\nThe revision walker is reset when the walk is over.
\n", + "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.28.0/general.html#git_revwalk_next-76" + "ex/HEAD/general.html#git_revwalk_next-76" ], "log.c": [ - "ex/v0.28.0/log.html#git_revwalk_next-55" + "ex/HEAD/log.html#git_revwalk_next-51" ] } }, @@ -20530,11 +20340,11 @@ "group": "revwalk", "examples": { "general.c": [ - "ex/v0.28.0/general.html#git_revwalk_sorting-77" + "ex/HEAD/general.html#git_revwalk_sorting-77" ], "log.c": [ - "ex/v0.28.0/log.html#git_revwalk_sorting-56", - "ex/v0.28.0/log.html#git_revwalk_sorting-57" + "ex/HEAD/log.html#git_revwalk_sorting-52", + "ex/HEAD/log.html#git_revwalk_sorting-53" ] } }, @@ -20562,7 +20372,7 @@ "comment": " 0 or an error code" }, "description": "Push and hide the respective endpoints of the given range.
\n", - "comments": "The range should be of the form
\n\n<commit
\n\n\n\n", + "comments": "..\n<commit
\n\nwhere each \n<commit\nis in the form accepted by 'git_revparse_single'.\n The left-hand commit will be hidden and the right-hand commit pushed.
\n
The range should be of the form
Create a new action signature.
\n", - "comments": "Call git_signature_free() to free the data.
Note: angle brackets ('\n<\n' and '>') characters are not allowed\n to be used in either the name or the email parameter.
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.
Create a new action signature with default user and now timestamp.
\n", - "comments": "This looks up the user.name and user.email from the configuration and\n uses the current time as the timestamp, and creates a new signature\n based on that information. It will return GIT_ENOTFOUND if either the\n user.name or user.email are not set.
\n", + "comments": "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.28.0/init.html#git_signature_default-12" + "ex/HEAD/init.html#git_signature_default-10" ], "tag.c": [ - "ex/v0.28.0/tag.html#git_signature_default-17" + "ex/HEAD/tag.html#git_signature_default-13" ] } }, @@ -20864,18 +20674,18 @@ "comment": null }, "description": "Free an existing signature.
\n", - "comments": "Because the signature is not an opaque structure, it is legal to free it\n manually, but be sure to free the "name" and "email" strings in addition\n to the structure itself.
\n", + "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": { "general.c": [ - "ex/v0.28.0/general.html#git_signature_free-81", - "ex/v0.28.0/general.html#git_signature_free-82" + "ex/HEAD/general.html#git_signature_free-81", + "ex/HEAD/general.html#git_signature_free-82" ], "init.c": [ - "ex/v0.28.0/init.html#git_signature_free-13" + "ex/HEAD/init.html#git_signature_free-11" ], "tag.c": [ - "ex/v0.28.0/tag.html#git_signature_free-18" + "ex/HEAD/tag.html#git_signature_free-14" ] } }, @@ -20888,40 +20698,40 @@ { "name": "out", "type": "git_oid *", - "comment": null + "comment": "Object id of the commit containing the stashed state.\n This commit is also the target of the direct reference refs/stash." }, { "name": "repo", "type": "git_repository *", - "comment": null + "comment": "The owning repository." }, { "name": "stasher", "type": "const git_signature *", - "comment": null + "comment": "The identity of the person performing the stashing." }, { "name": "message", "type": "const char *", - "comment": null + "comment": "Optional description along with the stashed state." }, { "name": "flags", - "type": "int", - "comment": null + "type": "uint32_t", + "comment": "Flags to control the stashing process. (see GIT_STASH_* above)" } ], - "argline": "git_oid *out, git_repository *repo, const git_signature *stasher, const char *message, int flags", - "sig": "git_oid *::git_repository *::const git_signature *::const char *::int", + "argline": "git_oid *out, git_repository *repo, const git_signature *stasher, const char *message, uint32_t flags", + "sig": "git_oid *::git_repository *::const git_signature *::const char *::uint32_t", "return": { "type": "int", - "comment": null + "comment": " 0 on success, GIT_ENOTFOUND where there's nothing to stash,\n or error code." }, - "description": "", + "description": "Save the local modifications to a new stash.
\n", "comments": "", "group": "stash" }, - "git_stash_apply_init_options": { + "git_stash_apply_options_init": { "type": "function", "file": "git2/stash.h", "line": 156, @@ -20945,7 +20755,7 @@ "comment": " Zero on success; -1 on failure." }, "description": "Initialize git_stash_apply_options structure
\n", - "comments": "Initializes a git_stash_apply_options with default values. Equivalent to\n creating an instance with GIT_STASH_APPLY_OPTIONS_INIT.
Initializes a git_stash_apply_options with default values. Equivalent to creating an instance with GIT_STASH_APPLY_OPTIONS_INIT.
Apply a single stashed state from the stash list.
\n", - "comments": "If local changes in the working directory conflict with changes in the\n stash then GIT_EMERGECONFLICT will be returned. In this case, the index\n will always remain unmodified and all files in the working directory will\n remain unmodified. However, if you are restoring untracked files or\n ignored files and there is a conflict when applying the modified files,\n then those files will remain in the working directory.
\n\nIf passing the GIT_STASH_APPLY_REINSTATE_INDEX flag and there would be\n conflicts when reinstating the index, the function will return\n GIT_EMERGECONFLICT and both the working directory and index will be left\n unmodified.
\n\nNote that a minimum checkout strategy of GIT_CHECKOUT_SAFE is implied.
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.
Initialize git_status_options structure
\n", - "comments": "Initializes a git_status_options with default values. Equivalent to\n creating an instance with GIT_STATUS_OPTIONS_INIT.
Initializes a git_status_options with default values. Equivalent to creating an instance with GIT_STATUS_OPTIONS_INIT.
Gather file statuses and run a callback for each one.
\n", - "comments": "The callback is passed the path of the file, the status (a combination of\n the git_status_t values above) and the payload data pointer passed\n into this function.
If the callback returns a non-zero value, this function will stop looping\n and return that value to caller.
\n", + "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.28.0/status.html#git_status_foreach-10" + "ex/HEAD/status.html#git_status_foreach-6" ] } }, @@ -21169,11 +20979,11 @@ "comment": " 0 on success, non-zero callback return value, or error code" }, "description": "Gather file status information and run callbacks as requested.
\n", - "comments": "This is an extended version of the git_status_foreach() API that\n allows for more granular control over which paths will be processed and\n in what order. See the git_status_options structure for details\n about the additional controls that this makes available.
Note that if a pathspec is given in the git_status_options to filter\n the status, then the results from rename detection (if you enable it) may\n not be accurate. To do rename detection properly, this must be called\n with no pathspec so that all files can be considered.
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.
Get file status for a single file.
\n", - "comments": "This tries to get status for the filename that you give. If no files\n match that name (in either the HEAD, index, or working directory), this\n returns GIT_ENOTFOUND.
\n\nIf the name matches multiple files (for example, if the path names a\n directory or if running on a case- insensitive filesystem and yet the\n HEAD has two entries that both match the path), then this returns\n GIT_EAMBIGUOUS because it cannot give correct results.
This does not do any sort of rename detection. Renames require a set of\n targets and because of the path filtering, there is not enough\n information to check renames correctly. To check file status with rename\n detection, there is no choice but to do a full git_status_list_new and\n scan through looking for the path that you are interested in.
This tries to get status for the filename that you give. If no files match that name (in either the HEAD, index, or working directory), this returns GIT_ENOTFOUND.
\n\nIf the name matches multiple files (for example, if the path names a directory or if running on a case- insensitive filesystem and yet the HEAD has two entries that both match the path), then this returns GIT_EAMBIGUOUS because it cannot give correct results.
This does not do any sort of rename detection. Renames require a set of targets and because of the path filtering, there is not enough information to check renames correctly. To check file status with rename detection, there is no choice but to do a full git_status_list_new and scan through looking for the path that you are interested in.
Gather file status information and populate the git_status_list.
Note that if a pathspec is given in the git_status_options to filter\n the status, then the results from rename detection (if you enable it) may\n not be accurate. To do rename detection properly, this must be called\n 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\n when the status list was created), this can return 0.
\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.28.0/status.html#git_status_list_entrycount-14", - "ex/v0.28.0/status.html#git_status_list_entrycount-15" + "ex/HEAD/status.html#git_status_list_entrycount-10", + "ex/HEAD/status.html#git_status_list_entrycount-11" ] } }, @@ -21303,12 +21118,12 @@ "group": "status", "examples": { "status.c": [ - "ex/v0.28.0/status.html#git_status_byindex-16", - "ex/v0.28.0/status.html#git_status_byindex-17", - "ex/v0.28.0/status.html#git_status_byindex-18", - "ex/v0.28.0/status.html#git_status_byindex-19", - "ex/v0.28.0/status.html#git_status_byindex-20", - "ex/v0.28.0/status.html#git_status_byindex-21" + "ex/HEAD/status.html#git_status_byindex-12", + "ex/HEAD/status.html#git_status_byindex-13", + "ex/HEAD/status.html#git_status_byindex-14", + "ex/HEAD/status.html#git_status_byindex-15", + "ex/HEAD/status.html#git_status_byindex-16", + "ex/HEAD/status.html#git_status_byindex-17" ] } }, @@ -21335,7 +21150,7 @@ "group": "status", "examples": { "status.c": [ - "ex/v0.28.0/status.html#git_status_list_free-22" + "ex/HEAD/status.html#git_status_list_free-18" ] } }, @@ -21368,7 +21183,7 @@ "comment": " 0 if ignore rules could be processed for the file (regardless\n of whether it exists or not), or an error \n<\n 0 if they could not." }, "description": "Test if the ignore rules apply to a given file.
\n", - "comments": "This function checks the ignore rules to see if they would apply to the\n given file. This indicates if the file would be ignored regardless of\n whether the file is already in the index or committed to the repository.
\n\nOne way to think of this is if you were to do "git add ." on the\n directory containing the file, would it be added or not?
\n", + "comments": "This function checks the ignore rules to see if they would apply to the given file. This indicates if the file would be ignored regardless of whether the file is already in the index or committed to the repository.
\n\nOne way to think of this is if you were to do "git add ." on the directory containing the file, would it be added or not?
\n", "group": "status" }, "git_strarray_free": { @@ -21390,18 +21205,18 @@ "comment": null }, "description": "Close a string array object
\n", - "comments": "This method should be called on git_strarray objects where the strings\n array is allocated and contains allocated strings, such as what you\n would get from git_strarray_copy(). Not doing so, will result in a\n memory leak.
This does not free the git_strarray itself, since the library will\n never allocate that object directly itself (it is more commonly embedded\n inside another struct or created on the stack).
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).
Copy a string array object from source to target.
\n", - "comments": "Note: target is overwritten and hence should be empty, otherwise its\n contents are leaked. Call git_strarray_free() if necessary.
\n", + "comments": "Note: target is overwritten and hence should be empty, otherwise its contents are leaked. Call git_strarray_free() if necessary.
\n", "group": "strarray" }, - "git_submodule_update_init_options": { + "git_submodule_update_options_init": { "type": "function", "file": "git2/submodule.h", "line": 171, @@ -21456,7 +21271,7 @@ "comment": " Zero on success; -1 on failure." }, "description": "Initialize git_submodule_update_options structure
\n", - "comments": "Initializes a git_submodule_update_options with default values. Equivalent to\n creating an instance with GIT_SUBMODULE_UPDATE_OPTIONS_INIT.
Initializes a git_submodule_update_options with default values. Equivalent to creating an instance with GIT_SUBMODULE_UPDATE_OPTIONS_INIT.
Lookup submodule information by name or path.
\n", - "comments": "Given either the submodule name or path (they are usually the same), this\n returns a structure describing the submodule.
\n\nThere are two expected error scenarios:
\n\nYou must call git_submodule_free when done with the submodule.
Given either the submodule name or path (they are usually the same), this returns a structure describing the submodule.
\n\nThere are two expected error scenarios:
\n\nYou must call git_submodule_free when done with the submodule.
Iterate over all tracked submodules of a repository.
\n", - "comments": "See the note on git_submodule above. This iterates over the tracked\n submodules as described therein.
If you are concerned about items in the working directory that look like\n submodules but are not tracked, the diff API will generate a diff record\n for workdir items that look like submodules but are not tracked, showing\n them as added in the workdir. Also, the status API will treat the entire\n subdirectory of a contained git repo as a single GIT_STATUS_WT_NEW item.
\n", + "comments": "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.28.0/status.html#git_submodule_foreach-23" + "ex/HEAD/status.html#git_submodule_foreach-19" ] } }, @@ -21621,7 +21436,7 @@ "comment": " 0 on success, GIT_EEXISTS if submodule already exists,\n -1 on other errors." }, "description": "Set up a new git submodule for checkout.
\n", - "comments": "This does "git submodule add" up to the fetch and checkout of the\n submodule contents. It preps a new submodule, creates an entry in\n .gitmodules and creates an empty initialized repository either at the\n given path in the working directory or in .git/modules with a gitlink\n from the working directory to the new repo.
\n\nTo fully emulate "git submodule add" call this function, then open the\n submodule repo and perform the clone step as needed. Lastly, call\n git_submodule_add_finalize() to wrap up adding the new submodule and\n .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. 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.
Resolve the setup of a new git submodule.
\n", - "comments": "This should be called on a submodule once you have called add setup\n and done the clone of the submodule. This adds the .gitmodules file\n and the newly cloned submodule to the index to be ready to be committed\n (but doesn't actually do the commit).
\n", + "comments": "This should be called on a submodule once you have called add setup and done the clone of the submodule. This adds the .gitmodules file and the newly cloned submodule to the index to be ready to be committed (but doesn't actually do the commit).
\n", "group": "submodule" }, "git_submodule_add_to_index": { @@ -21692,7 +21507,7 @@ "comment": " Pointer to `git_repository`" }, "description": "Get the containing repository for a submodule.
\n", - "comments": "This returns a pointer to the repository that contains the submodule.\n This is a just a reference to the repository that was passed to the\n original git_submodule_lookup() call, so if that repository has been\n freed, then this may be a dangling reference.
This returns a pointer to the repository that contains the submodule. This is a just a reference to the repository that was passed to the original git_submodule_lookup() call, so if that repository has been freed, then this may be a dangling reference.
Get the path to the submodule.
\n", - "comments": "The path is almost always the same as the submodule name, but the\n two are actually not required to match.
\n", + "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.28.0/status.html#git_submodule_path-25" + "ex/HEAD/status.html#git_submodule_path-21" ] } }, @@ -21854,7 +21669,7 @@ "comment": " 0 on success, \n<\n0 on failure" }, "description": "Set the branch for the submodule in the configuration
\n", - "comments": "After calling this, you may wish to call git_submodule_sync() to\n write the changes to the checked out submodule repository.
After calling this, you may wish to call git_submodule_sync() to write the changes to the checked out submodule repository.
Set the URL for the submodule in the configuration
\n", - "comments": "After calling this, you may wish to call git_submodule_sync() to\n write the changes to the checked out submodule repository.
After calling this, you may wish to call git_submodule_sync() to write the changes to the checked out submodule repository.
Get the OID for the submodule in the current working directory.
\n", - "comments": "This returns the OID that corresponds to looking up 'HEAD' in the checked\n out submodule. If there are pending changes in the index or anything\n else, this won't notice that. You should call git_submodule_status()\n for a more complete picture about the state of the working directory.
This returns the OID that corresponds to looking up 'HEAD' in the checked out submodule. If there are pending changes in the index or anything else, this won't notice that. You should call git_submodule_status() for a more complete picture about the state of the working directory.
Get the ignore rule that will be used for the submodule.
\n", - "comments": "These values control the behavior of git_submodule_status() for this\n submodule. There are four ignore values:
git_status_foreach() on the submodule) but\nUNTRACKED files will not count as making the submodule dirty.These values control the behavior of git_submodule_status() for this submodule. There are four ignore values:
git_status_foreach() on the submodule) but UNTRACKED files will not count as making the submodule dirty. - GIT_SUBMODULE_IGNORE_DIRTY means to only check if the HEAD of the submodule has moved for status. This is fast since it does not need to scan the working tree of the submodule at all. - GIT_SUBMODULE_IGNORE_ALL means not to open the submodule repo. The working directory will be consider clean so long as there is a checked out version present.Get the update rule that will be used for the submodule.
\n", - "comments": "This value controls the behavior of the git submodule update command.\n There are four useful values documented with git_submodule_update_t.
This value controls the behavior of the git submodule update command. There are four useful values documented with git_submodule_update_t.
Read the fetchRecurseSubmodules rule for a submodule.
\n", - "comments": "This accesses the submodule.\n<name
\n\n\n\n\n.fetchRecurseSubmodules value for\n the submodule that controls fetching behavior for the submodule.
\n
Note that at this time, libgit2 does not honor this setting and the\n fetch functionality current ignores submodules.
\n", + "comments": "This accesses the submodule.
Note that at this time, libgit2 does not honor this setting and the fetch functionality current ignores submodules.
\n", "group": "submodule" }, "git_submodule_set_fetch_recurse_submodules": { @@ -22141,7 +21956,7 @@ "comment": " 0 on success, \n<\n0 on failure." }, "description": "Copy submodule info into ".git/config" file.
\n", - "comments": "Just like "git submodule init", this copies information about the\n submodule into ".git/config". You can use the accessor functions\n above to alter the in-memory git_submodule object and control what\n is written to the config, overriding what is in .gitmodules.
\n", + "comments": "Just like "git submodule init", this copies information about the submodule into ".git/config". You can use the accessor functions above to alter the in-memory git_submodule object and control what is written to the config, overriding what is in .gitmodules.
\n", "group": "submodule" }, "git_submodule_repo_init": { @@ -22173,7 +21988,7 @@ "comment": " 0 on success, \n<\n0 on failure." }, "description": "Set up the subrepository for a submodule in preparation for clone.
\n", - "comments": "This function can be called to init and set up a submodule\n repository from a submodule in preparation to clone it from\n its remote.
\n", + "comments": "This function can be called to init and set up a submodule repository from a submodule in preparation to clone it from its remote.
\n", "group": "submodule" }, "git_submodule_sync": { @@ -22195,7 +22010,7 @@ "comment": null }, "description": "Copy submodule remote info into submodule repo.
\n", - "comments": "This copies the information about the submodules URL into the checked out\n submodule config, acting like "git submodule sync". This is useful if\n you have altered the URL for the submodule (or it has been altered by a\n fetch of upstream changes) and you need to update your local repo.
\n", + "comments": "This copies the information about the submodules URL into the checked out submodule config, acting like "git submodule sync". This is useful if you have altered the URL for the submodule (or it has been altered by a fetch of upstream changes) and you need to update your local repo.
\n", "group": "submodule" }, "git_submodule_open": { @@ -22222,7 +22037,7 @@ "comment": " 0 on success, \n<\n0 if submodule repo could not be opened." }, "description": "Open the repository for a submodule.
\n", - "comments": "This is a newly opened repository object. The caller is responsible for\n calling git_repository_free() on it when done. Multiple calls to this\n function will return distinct git_repository objects. This will only\n work if the submodule is checked out into the working directory.
This is a newly opened repository object. The caller is responsible for calling git_repository_free() on it when done. Multiple calls to this function will return distinct git_repository objects. This will only work if the submodule is checked out into the working directory.
Reread submodule info from config, index, and HEAD.
\n", - "comments": "Call this to reread cached submodule information for this submodule if\n you have reason to believe that it has changed.
\n", + "comments": "Call this to reread cached submodule information for this submodule if you have reason to believe that it has changed.
\n", "group": "submodule" }, "git_submodule_status": { @@ -22286,11 +22101,11 @@ "comment": " 0 on success, \n<\n0 on error" }, "description": "Get the status for a submodule.
\n", - "comments": "This looks at a submodule and tries to determine the status. It\n will return a combination of the GIT_SUBMODULE_STATUS values above.\n How deeply it examines the working directory to do this will depend\n on the git_submodule_ignore_t value for the submodule.
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.
Get the locations of submodule information.
\n", - "comments": "This is a bit like a very lightweight version of git_submodule_status.\n It just returns a made of the first four submodule status values (i.e.\n the ones like GIT_SUBMODULE_STATUS_IN_HEAD, etc) that tell you where the\n submodule data comes from (i.e. the HEAD commit, gitmodules file, etc.).\n This can be useful if you want to know if the submodule is present in the\n working directory at this point in time, etc.
This is a bit like a very lightweight version of git_submodule_status. It just returns a made of the first four submodule status values (i.e. the ones like GIT_SUBMODULE_STATUS_IN_HEAD, etc) that tell you where the submodule data comes from (i.e. the HEAD commit, gitmodules file, etc.). This can be useful if you want to know if the submodule is present in the working directory at this point in time, etc.
Initialize the allocator structure to use the stdalloc pointer.
Set up the structure so that all of its members are using the standard\n "stdalloc" allocator functions. The structure can then be used with\n git_allocator_setup.
Initialize the allocator structure to use the crtdbg pointer.
Set up the structure so that all of its members are using the "crtdbg"\n allocator functions. Note that this allocator is only available on Windows\n platforms and only if libgit2 is being compiled with "-DMSVC_CRTDBG".
\n", - "group": "win32" - }, - "git_commit_create_from_ids": { + "git_tag_lookup": { "type": "function", - "file": "git2/sys/commit.h", - "line": 34, - "lineto": 44, + "file": "git2/tag.h", + "line": 33, + "lineto": 34, "args": [ { - "name": "id", - "type": "git_oid *", - "comment": null + "name": "out", + "type": "git_tag **", + "comment": "pointer to the looked up tag" }, { "name": "repo", "type": "git_repository *", - "comment": null - }, - { - "name": "update_ref", - "type": "const char *", - "comment": null - }, - { - "name": "author", - "type": "const git_signature *", - "comment": null - }, - { - "name": "committer", - "type": "const git_signature *", - "comment": null - }, - { - "name": "message_encoding", - "type": "const char *", - "comment": null - }, - { - "name": "message", - "type": "const char *", - "comment": null + "comment": "the repo to use when locating the tag." }, { - "name": "tree", + "name": "id", "type": "const git_oid *", - "comment": null - }, - { - "name": "parent_count", - "type": "size_t", - "comment": null - }, - { - "name": "parents", - "type": "const git_oid *[]", - "comment": null + "comment": "identity of the tag to locate." } ], - "argline": "git_oid *id, git_repository *repo, const char *update_ref, const git_signature *author, const git_signature *committer, const char *message_encoding, const char *message, const git_oid *tree, size_t parent_count, const git_oid *[] parents", - "sig": "git_oid *::git_repository *::const char *::const git_signature *::const git_signature *::const char *::const char *::const git_oid *::size_t::const git_oid *[]", + "argline": "git_tag **out, git_repository *repo, const git_oid *id", + "sig": "git_tag **::git_repository *::const git_oid *", "return": { "type": "int", - "comment": null + "comment": " 0 or an error code" }, - "description": "Create new commit in the repository from a list of git_oid values.
See documentation for git_commit_create() for information about the\n parameters, as the meaning is identical excepting that tree and\n parents now take git_oid. This is a dangerous API in that nor\n the tree, neither the parents list of git_oids are checked for\n validity.
Lookup a tag object from the repository.
\n", + "comments": "", + "group": "tag", + "examples": { + "general.c": [ + "ex/HEAD/general.html#git_tag_lookup-84" + ] + } }, - "git_commit_create_from_callback": { + "git_tag_lookup_prefix": { "type": "function", - "file": "git2/sys/commit.h", - "line": 66, - "lineto": 76, + "file": "git2/tag.h", + "line": 48, + "lineto": 49, "args": [ { - "name": "id", - "type": "git_oid *", - "comment": null + "name": "out", + "type": "git_tag **", + "comment": "pointer to the looked up tag" }, { "name": "repo", "type": "git_repository *", - "comment": null - }, - { - "name": "update_ref", - "type": "const char *", - "comment": null - }, - { - "name": "author", - "type": "const git_signature *", - "comment": null - }, - { - "name": "committer", - "type": "const git_signature *", - "comment": null - }, - { - "name": "message_encoding", - "type": "const char *", - "comment": null - }, - { - "name": "message", - "type": "const char *", - "comment": null + "comment": "the repo to use when locating the tag." }, { - "name": "tree", + "name": "id", "type": "const git_oid *", - "comment": null - }, - { - "name": "parent_cb", - "type": "git_commit_parent_callback", - "comment": null + "comment": "identity of the tag to locate." }, { - "name": "parent_payload", - "type": "void *", - "comment": null + "name": "len", + "type": "size_t", + "comment": "the length of the short identifier" } ], - "argline": "git_oid *id, git_repository *repo, const char *update_ref, const git_signature *author, const git_signature *committer, const char *message_encoding, const char *message, const git_oid *tree, git_commit_parent_callback parent_cb, void *parent_payload", - "sig": "git_oid *::git_repository *::const char *::const git_signature *::const git_signature *::const char *::const char *::const git_oid *::git_commit_parent_callback::void *", + "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": null + "comment": " 0 or an error code" }, - "description": "Create a new commit in the repository with an callback to supply parents.
\n", - "comments": "See documentation for git_commit_create() for information about the\n parameters, as the meaning is identical excepting that tree takes a\n git_oid and doesn't check for validity, and parent_cb is invoked\n with parent_payload and should return git_oid values or NULL to\n indicate that all parents are accounted for.
Lookup a tag object from the repository,\n given a prefix of its identifier (short id).
\n", + "comments": "", + "group": "tag" }, - "git_config_init_backend": { + "git_tag_free": { "type": "function", - "file": "git2/sys/config.h", - "line": 97, - "lineto": 99, + "file": "git2/tag.h", + "line": 61, + "lineto": 61, "args": [ { - "name": "backend", - "type": "git_config_backend *", - "comment": "the `git_config_backend` struct to initialize." - }, - { - "name": "version", - "type": "unsigned int", - "comment": "Version of struct; pass `GIT_CONFIG_BACKEND_VERSION`" + "name": "tag", + "type": "git_tag *", + "comment": "the tag to close" } ], - "argline": "git_config_backend *backend, unsigned int version", - "sig": "git_config_backend *::unsigned int", + "argline": "git_tag *tag", + "sig": "git_tag *", "return": { - "type": "int", - "comment": " Zero on success; -1 on failure." + "type": "void", + "comment": null }, - "description": "Initializes a git_config_backend with default values. Equivalent to\n creating an instance with GIT_CONFIG_BACKEND_INIT.
Close an open tag
\n", + "comments": "You can no longer use the git_tag pointer after this call.
\n\nIMPORTANT: You MUST call this method when you are through with a tag to release memory. Failure to do so will cause a memory leak.
\n", + "group": "tag", + "examples": { + "general.c": [ + "ex/HEAD/general.html#git_tag_free-85" + ] + } }, - "git_config_add_backend": { + "git_tag_id": { "type": "function", - "file": "git2/sys/config.h", - "line": 121, - "lineto": 126, + "file": "git2/tag.h", + "line": 69, + "lineto": 69, "args": [ { - "name": "cfg", - "type": "git_config *", - "comment": "the configuration to add the file to" - }, - { - "name": "file", - "type": "git_config_backend *", - "comment": "the configuration file (backend) to add" - }, - { - "name": "level", - "type": "git_config_level_t", - "comment": "the priority level of the backend" - }, - { - "name": "repo", - "type": "const git_repository *", - "comment": "optional repository to allow parsing of\n conditional includes" - }, - { - "name": "force", - "type": "int", - "comment": "if a config file already exists for the given\n priority level, replace it" + "name": "tag", + "type": "const git_tag *", + "comment": "a previously loaded tag." } ], - "argline": "git_config *cfg, git_config_backend *file, git_config_level_t level, const git_repository *repo, int force", - "sig": "git_config *::git_config_backend *::git_config_level_t::const git_repository *::int", + "argline": "const git_tag *tag", + "sig": "const git_tag *", "return": { - "type": "int", - "comment": " 0 on success, GIT_EEXISTS when adding more than one file\n for a given priority level (and force_replace set to 0), or error code" + "type": "const git_oid *", + "comment": " object identity for the tag." }, - "description": "Add a generic config file instance to an existing config
\n", - "comments": "Note that the configuration object will free the file\n automatically.
\n\nFurther queries on this config object will access each\n of the config file instances in order (instances with\n a higher priority level will be accessed first).
\n", - "group": "config" + "description": "Get the id of a tag.
\n", + "comments": "", + "group": "tag" }, - "git_diff_print_callback__to_buf": { + "git_tag_owner": { "type": "function", - "file": "git2/sys/diff.h", - "line": 37, - "lineto": 41, + "file": "git2/tag.h", + "line": 77, + "lineto": 77, "args": [ { - "name": "delta", - "type": "const git_diff_delta *", - "comment": null - }, - { - "name": "hunk", - "type": "const git_diff_hunk *", - "comment": null - }, - { - "name": "line", - "type": "const git_diff_line *", - "comment": null - }, - { - "name": "payload", - "type": "void *", - "comment": null + "name": "tag", + "type": "const git_tag *", + "comment": "A previously loaded tag." } ], - "argline": "const git_diff_delta *delta, const git_diff_hunk *hunk, const git_diff_line *line, void *payload", - "sig": "const git_diff_delta *::const git_diff_hunk *::const git_diff_line *::void *", + "argline": "const git_tag *tag", + "sig": "const git_tag *", "return": { - "type": "int", - "comment": null + "type": "git_repository *", + "comment": " Repository that contains this tag." }, - "description": "Diff print callback that writes to a git_buf.
\n", - "comments": "This function is provided not for you to call it directly, but instead\n so you can use it as a function pointer to the git_diff_print or\n git_patch_print APIs. When using those APIs, you specify a callback\n to actually handle the diff and/or patch data.
Use this callback to easily write that data to a git_buf buffer. You\n must pass a git_buf * value as the payload to the git_diff_print\n and/or git_patch_print function. The data will be appended to the\n buffer (after any existing content).
Get the repository that contains the tag.
\n", + "comments": "", + "group": "tag" }, - "git_diff_print_callback__to_file_handle": { + "git_tag_target": { "type": "function", - "file": "git2/sys/diff.h", - "line": 57, - "lineto": 61, + "file": "git2/tag.h", + "line": 89, + "lineto": 89, "args": [ { - "name": "delta", - "type": "const git_diff_delta *", - "comment": null - }, - { - "name": "hunk", - "type": "const git_diff_hunk *", - "comment": null - }, - { - "name": "line", - "type": "const git_diff_line *", - "comment": null + "name": "target_out", + "type": "git_object **", + "comment": "pointer where to store the target" }, { - "name": "payload", - "type": "void *", - "comment": null + "name": "tag", + "type": "const git_tag *", + "comment": "a previously loaded tag." } ], - "argline": "const git_diff_delta *delta, const git_diff_hunk *hunk, const git_diff_line *line, void *payload", - "sig": "const git_diff_delta *::const git_diff_hunk *::const git_diff_line *::void *", + "argline": "git_object **target_out, const git_tag *tag", + "sig": "git_object **::const git_tag *", "return": { "type": "int", - "comment": null + "comment": " 0 or an error code" }, - "description": "Diff print callback that writes to stdio FILE handle.
\n", - "comments": "This function is provided not for you to call it directly, but instead\n so you can use it as a function pointer to the git_diff_print or\n git_patch_print APIs. When using those APIs, you specify a callback\n to actually handle the diff and/or patch data.
Use this callback to easily write that data to a stdio FILE handle. You\n must pass a FILE * value (such as stdout or stderr or the return\n value from fopen()) as the payload to the git_diff_print\n and/or git_patch_print function. If you pass NULL, this will write\n data to stdout.
Get the tagged object of a tag
\n", + "comments": "This method performs a repository lookup for the given object and returns it
\n", + "group": "tag", + "examples": { + "general.c": [ + "ex/HEAD/general.html#git_tag_target-86" + ] + } }, - "git_diff_get_perfdata": { + "git_tag_target_id": { "type": "function", - "file": "git2/sys/diff.h", - "line": 83, - "lineto": 84, + "file": "git2/tag.h", + "line": 97, + "lineto": 97, "args": [ { - "name": "out", - "type": "git_diff_perfdata *", - "comment": "Structure to be filled with diff performance data" - }, - { - "name": "diff", - "type": "const git_diff *", - "comment": "Diff to read performance data from" + "name": "tag", + "type": "const git_tag *", + "comment": "a previously loaded tag." } ], - "argline": "git_diff_perfdata *out, const git_diff *diff", - "sig": "git_diff_perfdata *::const git_diff *", + "argline": "const git_tag *tag", + "sig": "const git_tag *", "return": { - "type": "int", - "comment": " 0 for success, \n<\n0 for error" + "type": "const git_oid *", + "comment": " pointer to the OID" }, - "description": "Get performance data for a diff object.
\n", + "description": "Get the OID of the tagged object of a tag
\n", "comments": "", - "group": "diff" + "group": "tag", + "examples": { + "cat-file.c": [ + "ex/HEAD/cat-file.html#git_tag_target_id-31" + ] + } }, - "git_status_list_get_perfdata": { + "git_tag_target_type": { "type": "function", - "file": "git2/sys/diff.h", - "line": 89, - "lineto": 90, + "file": "git2/tag.h", + "line": 105, + "lineto": 105, "args": [ { - "name": "out", - "type": "git_diff_perfdata *", - "comment": null - }, - { - "name": "status", - "type": "const git_status_list *", - "comment": null + "name": "tag", + "type": "const git_tag *", + "comment": "a previously loaded tag." } ], - "argline": "git_diff_perfdata *out, const git_status_list *status", - "sig": "git_diff_perfdata *::const git_status_list *", + "argline": "const git_tag *tag", + "sig": "const git_tag *", "return": { - "type": "int", - "comment": null + "type": "git_object_t", + "comment": " type of the tagged object" }, - "description": "Get performance data for diffs from a git_status_list
\n", + "description": "Get the type of a tag's tagged object
\n", "comments": "", - "group": "status" + "group": "tag", + "examples": { + "cat-file.c": [ + "ex/HEAD/cat-file.html#git_tag_target_type-32" + ], + "general.c": [ + "ex/HEAD/general.html#git_tag_target_type-87" + ] + } }, - "git_filter_lookup": { + "git_tag_name": { "type": "function", - "file": "git2/sys/filter.h", - "line": 27, - "lineto": 27, + "file": "git2/tag.h", + "line": 113, + "lineto": 113, "args": [ { - "name": "name", - "type": "const char *", - "comment": "The name of the filter" + "name": "tag", + "type": "const git_tag *", + "comment": "a previously loaded tag." } ], - "argline": "const char *name", - "sig": "const char *", + "argline": "const git_tag *tag", + "sig": "const git_tag *", "return": { - "type": "git_filter *", - "comment": " Pointer to the filter object or NULL if not found" + "type": "const char *", + "comment": " name of the tag" }, - "description": "Look up a filter by name
\n", + "description": "Get the name of a tag
\n", "comments": "", - "group": "filter" + "group": "tag", + "examples": { + "cat-file.c": [ + "ex/HEAD/cat-file.html#git_tag_name-33" + ], + "general.c": [ + "ex/HEAD/general.html#git_tag_name-88" + ], + "tag.c": [ + "ex/HEAD/tag.html#git_tag_name-16" + ] + } }, - "git_filter_list_new": { - "type": "function", - "file": "git2/sys/filter.h", - "line": 57, - "lineto": 61, - "args": [ - { - "name": "out", - "type": "git_filter_list **", - "comment": null - }, - { - "name": "repo", - "type": "git_repository *", - "comment": null - }, - { - "name": "mode", - "type": "git_filter_mode_t", - "comment": null - }, - { - "name": "options", - "type": "int", - "comment": null - } - ], - "argline": "git_filter_list **out, git_repository *repo, git_filter_mode_t mode, int options", - "sig": "git_filter_list **::git_repository *::git_filter_mode_t::int", - "return": { - "type": "int", - "comment": null - }, - "description": "", - "comments": "", - "group": "filter" - }, - "git_filter_list_push": { - "type": "function", - "file": "git2/sys/filter.h", - "line": 76, - "lineto": 77, - "args": [ - { - "name": "fl", - "type": "git_filter_list *", - "comment": null - }, - { - "name": "filter", - "type": "git_filter *", - "comment": null - }, - { - "name": "payload", - "type": "void *", - "comment": null - } - ], - "argline": "git_filter_list *fl, git_filter *filter, void *payload", - "sig": "git_filter_list *::git_filter *::void *", - "return": { - "type": "int", - "comment": null - }, - "description": "Add a filter to a filter list with the given payload.
\n", - "comments": "Normally you won't have to do this because the filter list is created\n by calling the "check" function on registered filters when the filter\n attributes are set, but this does allow more direct manipulation of\n filter lists when desired.
\n\nNote that normally the "check" function can set up a payload for the\n filter. Using this function, you can either pass in a payload if you\n know the expected payload format, or you can pass NULL. Some filters\n may fail with a NULL payload. Good luck!
\n", - "group": "filter" - }, - "git_filter_list_length": { - "type": "function", - "file": "git2/sys/filter.h", - "line": 90, - "lineto": 90, - "args": [ - { - "name": "fl", - "type": "const git_filter_list *", - "comment": "A filter list" - } - ], - "argline": "const git_filter_list *fl", - "sig": "const git_filter_list *", - "return": { - "type": "size_t", - "comment": " The number of filters in the list" - }, - "description": "Look up how many filters are in the list
\n", - "comments": "We will attempt to apply all of these filters to any data passed in,\n but note that the filter apply action still has the option of skipping\n data that is passed in (for example, the CRLF filter will skip data\n that appears to be binary).
\n", - "group": "filter" - }, - "git_filter_source_repo": { - "type": "function", - "file": "git2/sys/filter.h", - "line": 100, - "lineto": 100, - "args": [ - { - "name": "src", - "type": "const git_filter_source *", - "comment": null - } - ], - "argline": "const git_filter_source *src", - "sig": "const git_filter_source *", - "return": { - "type": "git_repository *", - "comment": null - }, - "description": "Get the repository that the source data is coming from.
\n", - "comments": "", - "group": "filter" - }, - "git_filter_source_path": { - "type": "function", - "file": "git2/sys/filter.h", - "line": 105, - "lineto": 105, - "args": [ - { - "name": "src", - "type": "const git_filter_source *", - "comment": null - } - ], - "argline": "const git_filter_source *src", - "sig": "const git_filter_source *", - "return": { - "type": "const char *", - "comment": null - }, - "description": "Get the path that the source data is coming from.
\n", - "comments": "", - "group": "filter" - }, - "git_filter_source_filemode": { - "type": "function", - "file": "git2/sys/filter.h", - "line": 111, - "lineto": 111, - "args": [], - "argline": "", - "sig": "", - "return": { - "type": "int", - "comment": null - }, - "description": "", - "comments": "", - "group": "filter" - }, - "git_filter_source_id": { - "type": "function", - "file": "git2/sys/filter.h", - "line": 118, - "lineto": 118, - "args": [ - { - "name": "src", - "type": "const git_filter_source *", - "comment": null - } - ], - "argline": "const git_filter_source *src", - "sig": "const git_filter_source *", - "return": { - "type": "const git_oid *", - "comment": null - }, - "description": "Get the OID of the source\n If the OID is unknown (often the case with GIT_FILTER_CLEAN) then\n this will return NULL.
\n", - "comments": "", - "group": "filter" - }, - "git_filter_source_mode": { - "type": "function", - "file": "git2/sys/filter.h", - "line": 123, - "lineto": 123, - "args": [ - { - "name": "src", - "type": "const git_filter_source *", - "comment": null - } - ], - "argline": "const git_filter_source *src", - "sig": "const git_filter_source *", - "return": { - "type": "git_filter_mode_t", - "comment": null - }, - "description": "Get the git_filter_mode_t to be used
\n", - "comments": "", - "group": "filter" - }, - "git_filter_source_flags": { - "type": "function", - "file": "git2/sys/filter.h", - "line": 128, - "lineto": 128, - "args": [], - "argline": "", - "sig": "", - "return": { - "type": "int", - "comment": null - }, - "description": "", - "comments": "", - "group": "filter" - }, - "git_filter_init": { - "type": "function", - "file": "git2/sys/filter.h", - "line": 284, - "lineto": 284, - "args": [ - { - "name": "filter", - "type": "git_filter *", - "comment": "the `git_filter` struct to initialize." - }, - { - "name": "version", - "type": "unsigned int", - "comment": "Version the struct; pass `GIT_FILTER_VERSION`" - } - ], - "argline": "git_filter *filter, unsigned int version", - "sig": "git_filter *::unsigned int", - "return": { - "type": "int", - "comment": " Zero on success; -1 on failure." - }, - "description": "Initializes a git_filter with default values. Equivalent to\n creating an instance with GIT_FILTER_INIT.
Register a filter under a given name with a given priority.
\n", - "comments": "As mentioned elsewhere, the initialize callback will not be invoked\n immediately. It is deferred until the filter is used in some way.
\n\nA filter's attribute checks and check and apply callbacks will be\n issued in order of priority on smudge (to workdir), and in reverse\n order of priority on clean (to odb).
Two filters are preregistered with libgit2:\n - GIT_FILTER_CRLF with priority 0\n - GIT_FILTER_IDENT with priority 100
\n\nCurrently the filter registry is not thread safe, so any registering or\n deregistering of filters must be done outside of any possible usage of\n the filters (i.e. during application setup or shutdown).
\n", - "group": "filter" - }, - "git_filter_unregister": { - "type": "function", - "file": "git2/sys/filter.h", - "line": 328, - "lineto": 328, - "args": [ - { - "name": "name", - "type": "const char *", - "comment": "The name under which the filter was registered" - } - ], - "argline": "const char *name", - "sig": "const char *", - "return": { - "type": "int", - "comment": " 0 on success, error code \n<\n0 on failure" - }, - "description": "Remove the filter with the given name
\n", - "comments": "Attempting to remove the builtin libgit2 filters is not permitted and\n will return an error.
\n\nCurrently the filter registry is not thread safe, so any registering or\n deregistering of filters must be done outside of any possible usage of\n the filters (i.e. during application setup or shutdown).
\n", - "group": "filter" - }, - "git_hashsig_create": { - "type": "function", - "file": "git2/sys/hashsig.h", - "line": 62, - "lineto": 66, - "args": [ - { - "name": "out", - "type": "git_hashsig **", - "comment": "The computed similarity signature." - }, - { - "name": "buf", - "type": "const char *", - "comment": "The input buffer." - }, - { - "name": "buflen", - "type": "size_t", - "comment": "The input buffer size." - }, - { - "name": "opts", - "type": "git_hashsig_option_t", - "comment": "The signature computation options (see above)." - } - ], - "argline": "git_hashsig **out, const char *buf, size_t buflen, git_hashsig_option_t opts", - "sig": "git_hashsig **::const char *::size_t::git_hashsig_option_t", - "return": { - "type": "int", - "comment": " 0 on success, GIT_EBUFS if the buffer doesn't contain enough data to\n compute a valid signature (unless GIT_HASHSIG_ALLOW_SMALL_FILES is set), or\n error code." - }, - "description": "Compute a similarity signature for a text buffer
\n", - "comments": "If you have passed the option GIT_HASHSIG_IGNORE_WHITESPACE, then the\n whitespace will be removed from the buffer while it is being processed,\n modifying the buffer in place. Sorry about that!
\n", - "group": "hashsig" - }, - "git_hashsig_create_fromfile": { - "type": "function", - "file": "git2/sys/hashsig.h", - "line": 81, - "lineto": 84, - "args": [ - { - "name": "out", - "type": "git_hashsig **", - "comment": "The computed similarity signature." - }, - { - "name": "path", - "type": "const char *", - "comment": "The path to the input file." - }, - { - "name": "opts", - "type": "git_hashsig_option_t", - "comment": "The signature computation options (see above)." - } - ], - "argline": "git_hashsig **out, const char *path, git_hashsig_option_t opts", - "sig": "git_hashsig **::const char *::git_hashsig_option_t", - "return": { - "type": "int", - "comment": " 0 on success, GIT_EBUFS if the buffer doesn't contain enough data to\n compute a valid signature (unless GIT_HASHSIG_ALLOW_SMALL_FILES is set), or\n error code." - }, - "description": "Compute a similarity signature for a text file
\n", - "comments": "This walks through the file, only loading a maximum of 4K of file data at\n a time. Otherwise, it acts just like git_hashsig_create.
Release memory for a content similarity signature
\n", - "comments": "", - "group": "hashsig" - }, - "git_hashsig_compare": { - "type": "function", - "file": "git2/sys/hashsig.h", - "line": 100, - "lineto": 102, - "args": [ - { - "name": "a", - "type": "const git_hashsig *", - "comment": "The first similarity signature to compare." - }, - { - "name": "b", - "type": "const git_hashsig *", - "comment": "The second similarity signature to compare." - } - ], - "argline": "const git_hashsig *a, const git_hashsig *b", - "sig": "const git_hashsig *::const git_hashsig *", - "return": { - "type": "int", - "comment": " [0 to 100] on success as the similarity score, or error code." - }, - "description": "Measure similarity score between two similarity signatures
\n", - "comments": "", - "group": "hashsig" - }, - "git_index_name_entrycount": { - "type": "function", - "file": "git2/sys/index.h", - "line": 48, - "lineto": 48, - "args": [ - { - "name": "index", - "type": "git_index *", - "comment": "an existing index object" - } - ], - "argline": "git_index *index", - "sig": "git_index *", - "return": { - "type": "size_t", - "comment": " integer of count of current filename conflict entries" - }, - "description": "Get the count of filename conflict entries currently in the index.
\n", - "comments": "", - "group": "index" - }, - "git_index_name_get_byindex": { - "type": "function", - "file": "git2/sys/index.h", - "line": 60, - "lineto": 61, - "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_name_entry *", - "comment": " a pointer to the filename conflict entry; NULL if out of bounds" - }, - "description": "Get a filename conflict entry from the index.
\n", - "comments": "The returned entry is read-only and should not be modified\n or freed by the caller.
\n", - "group": "index" - }, - "git_index_name_add": { - "type": "function", - "file": "git2/sys/index.h", - "line": 71, - "lineto": 72, - "args": [ - { - "name": "index", - "type": "git_index *", - "comment": "an existing index object" - }, - { - "name": "ancestor", - "type": "const char *", - "comment": "the path of the file as it existed in the ancestor" - }, - { - "name": "ours", - "type": "const char *", - "comment": "the path of the file as it existed in our tree" - }, - { - "name": "theirs", - "type": "const char *", - "comment": "the path of the file as it existed in their tree" - } - ], - "argline": "git_index *index, const char *ancestor, const char *ours, const char *theirs", - "sig": "git_index *::const char *::const char *::const char *", - "return": { - "type": "int", - "comment": null - }, - "description": "Record the filenames involved in a rename conflict.
\n", - "comments": "", - "group": "index" - }, - "git_index_name_clear": { - "type": "function", - "file": "git2/sys/index.h", - "line": 79, - "lineto": 79, - "args": [ - { - "name": "index", - "type": "git_index *", - "comment": "an existing index object" - } - ], - "argline": "git_index *index", - "sig": "git_index *", - "return": { - "type": "void", - "comment": null - }, - "description": "Remove all filename conflict entries.
\n", - "comments": "", - "group": "index" - }, - "git_index_reuc_entrycount": { - "type": "function", - "file": "git2/sys/index.h", - "line": 96, - "lineto": 96, - "args": [ - { - "name": "index", - "type": "git_index *", - "comment": "an existing index object" - } - ], - "argline": "git_index *index", - "sig": "git_index *", - "return": { - "type": "size_t", - "comment": " integer of count of current resolve undo entries" - }, - "description": "Get the count of resolve undo entries currently in the index.
\n", - "comments": "", - "group": "index" - }, - "git_index_reuc_find": { - "type": "function", - "file": "git2/sys/index.h", - "line": 107, - "lineto": 107, - "args": [ - { - "name": "at_pos", - "type": "size_t *", - "comment": "the address to which the position of the reuc 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": " 0 if found, \n<\n 0 otherwise (GIT_ENOTFOUND)" - }, - "description": "Finds the resolve undo entry that points to the given path in the Git\n index.
\n", - "comments": "", - "group": "index" - }, - "git_index_reuc_get_bypath": { - "type": "function", - "file": "git2/sys/index.h", - "line": 119, - "lineto": 119, - "args": [ - { - "name": "index", - "type": "git_index *", - "comment": "an existing index object" - }, - { - "name": "path", - "type": "const char *", - "comment": "path to search" - } - ], - "argline": "git_index *index, const char *path", - "sig": "git_index *::const char *", - "return": { - "type": "const git_index_reuc_entry *", - "comment": " the resolve undo entry; NULL if not found" - }, - "description": "Get a resolve undo entry from the index.
\n", - "comments": "The returned entry is read-only and should not be modified\n or freed by the caller.
\n", - "group": "index" - }, - "git_index_reuc_get_byindex": { - "type": "function", - "file": "git2/sys/index.h", - "line": 131, - "lineto": 131, - "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_reuc_entry *", - "comment": " a pointer to the resolve undo entry; NULL if out of bounds" - }, - "description": "Get a resolve undo entry from the index.
\n", - "comments": "The returned entry is read-only and should not be modified\n or freed by the caller.
\n", - "group": "index" - }, - "git_index_reuc_add": { - "type": "function", - "file": "git2/sys/index.h", - "line": 155, - "lineto": 158, - "args": [ - { - "name": "index", - "type": "git_index *", - "comment": "an existing index object" - }, - { - "name": "path", - "type": "const char *", - "comment": "filename to add" - }, - { - "name": "ancestor_mode", - "type": "int", - "comment": "mode of the ancestor file" - }, - { - "name": "ancestor_id", - "type": "const git_oid *", - "comment": "oid of the ancestor file" - }, - { - "name": "our_mode", - "type": "int", - "comment": "mode of our file" - }, - { - "name": "our_id", - "type": "const git_oid *", - "comment": "oid of our file" - }, - { - "name": "their_mode", - "type": "int", - "comment": "mode of their file" - }, - { - "name": "their_id", - "type": "const git_oid *", - "comment": "oid of their file" - } - ], - "argline": "git_index *index, const char *path, int ancestor_mode, const git_oid *ancestor_id, int our_mode, const git_oid *our_id, int their_mode, const git_oid *their_id", - "sig": "git_index *::const char *::int::const git_oid *::int::const git_oid *::int::const git_oid *", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Adds a resolve undo entry for a file based on the given parameters.
\n", - "comments": "The resolve undo entry contains the OIDs of files that were involved\n in a merge conflict after the conflict has been resolved. This allows\n conflicts to be re-resolved later.
\n\nIf there exists a resolve undo entry for the given path in the index,\n it will be removed.
\n\nThis method will fail in bare index instances.
\n", - "group": "index" - }, - "git_index_reuc_remove": { - "type": "function", - "file": "git2/sys/index.h", - "line": 167, - "lineto": 167, - "args": [ - { - "name": "index", - "type": "git_index *", - "comment": "an existing index object" - }, - { - "name": "n", - "type": "size_t", - "comment": "position of the resolve undo entry to remove" - } - ], - "argline": "git_index *index, size_t n", - "sig": "git_index *::size_t", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Remove an resolve undo entry from the index
\n", - "comments": "", - "group": "index" - }, - "git_index_reuc_clear": { - "type": "function", - "file": "git2/sys/index.h", - "line": 174, - "lineto": 174, - "args": [ - { - "name": "index", - "type": "git_index *", - "comment": "an existing index object" - } - ], - "argline": "git_index *index", - "sig": "git_index *", - "return": { - "type": "void", - "comment": null - }, - "description": "Remove all resolve undo entries from the index
\n", - "comments": "", - "group": "index" - }, - "git_mempack_new": { - "type": "function", - "file": "git2/sys/mempack.h", - "line": 45, - "lineto": 45, - "args": [ - { - "name": "out", - "type": "git_odb_backend **", - "comment": "Pointer where to store the ODB backend" - } - ], - "argline": "git_odb_backend **out", - "sig": "git_odb_backend **", - "return": { - "type": "int", - "comment": " 0 on success; error code otherwise" - }, - "description": "Instantiate a new mempack backend.
\n", - "comments": "The backend must be added to an existing ODB with the highest\n priority.
\n\n git_mempack_new(\n&mempacker\n);\n git_repository_odb(\n&odb\n, repository);\n git_odb_add_backend(odb, mempacker, 999);
\n\nOnce the backend has been loaded, all writes to the ODB will\n instead be queued in memory, and can be finalized with\n git_mempack_dump.
Subsequent reads will also be served from the in-memory store\n to ensure consistency, until the memory store is dumped.
\n", - "group": "mempack" - }, - "git_mempack_dump": { - "type": "function", - "file": "git2/sys/mempack.h", - "line": 68, - "lineto": 68, - "args": [ - { - "name": "pack", - "type": "git_buf *", - "comment": "Buffer where to store the raw packfile" - }, - { - "name": "repo", - "type": "git_repository *", - "comment": "The active repository where the backend is loaded" - }, - { - "name": "backend", - "type": "git_odb_backend *", - "comment": "The mempack backend" - } - ], - "argline": "git_buf *pack, git_repository *repo, git_odb_backend *backend", - "sig": "git_buf *::git_repository *::git_odb_backend *", - "return": { - "type": "int", - "comment": " 0 on success; error code otherwise" - }, - "description": "Dump all the queued in-memory writes to a packfile.
\n", - "comments": "The contents of the packfile will be stored in the given buffer.\n It is the caller's responsibility to ensure that the generated\n packfile is available to the repository (e.g. by writing it\n to disk, or doing something crazy like distributing it across\n several copies of the repository over a network).
\n\nOnce the generated packfile is available to the repository,\n call git_mempack_reset to cleanup the memory store.
Calling git_mempack_reset before the packfile has been\n written to disk will result in an inconsistent repository\n (the objects in the memory store won't be accessible).
Reset the memory packer by clearing all the queued objects.
\n", - "comments": "This assumes that git_mempack_dump has been called before to\n store all the queued objects into a single packfile.
Alternatively, call reset without a previous dump to "undo"\n all the recently written objects, giving transaction-like\n semantics to the Git repository.
Look up a merge driver by name
\n", - "comments": "", - "group": "merge" - }, - "git_merge_driver_source_repo": { - "type": "function", - "file": "git2/sys/merge.h", - "line": 44, - "lineto": 45, - "args": [ - { - "name": "src", - "type": "const git_merge_driver_source *", - "comment": null - } - ], - "argline": "const git_merge_driver_source *src", - "sig": "const git_merge_driver_source *", - "return": { - "type": "const git_repository *", - "comment": null - }, - "description": "Get the repository that the source data is coming from.
\n", - "comments": "", - "group": "merge" - }, - "git_merge_driver_source_ancestor": { - "type": "function", - "file": "git2/sys/merge.h", - "line": 48, - "lineto": 49, - "args": [ - { - "name": "src", - "type": "const git_merge_driver_source *", - "comment": null - } - ], - "argline": "const git_merge_driver_source *src", - "sig": "const git_merge_driver_source *", - "return": { - "type": "const git_index_entry *", - "comment": null - }, - "description": "Gets the ancestor of the file to merge.
\n", - "comments": "", - "group": "merge" - }, - "git_merge_driver_source_ours": { - "type": "function", - "file": "git2/sys/merge.h", - "line": 52, - "lineto": 53, - "args": [ - { - "name": "src", - "type": "const git_merge_driver_source *", - "comment": null - } - ], - "argline": "const git_merge_driver_source *src", - "sig": "const git_merge_driver_source *", - "return": { - "type": "const git_index_entry *", - "comment": null - }, - "description": "Gets the ours side of the file to merge.
\n", - "comments": "", - "group": "merge" - }, - "git_merge_driver_source_theirs": { - "type": "function", - "file": "git2/sys/merge.h", - "line": 56, - "lineto": 57, - "args": [ - { - "name": "src", - "type": "const git_merge_driver_source *", - "comment": null - } - ], - "argline": "const git_merge_driver_source *src", - "sig": "const git_merge_driver_source *", - "return": { - "type": "const git_index_entry *", - "comment": null - }, - "description": "Gets the theirs side of the file to merge.
\n", - "comments": "", - "group": "merge" - }, - "git_merge_driver_source_file_options": { - "type": "function", - "file": "git2/sys/merge.h", - "line": 60, - "lineto": 61, - "args": [ - { - "name": "src", - "type": "const git_merge_driver_source *", - "comment": null - } - ], - "argline": "const git_merge_driver_source *src", - "sig": "const git_merge_driver_source *", - "return": { - "type": "const git_merge_file_options *", - "comment": null - }, - "description": "Gets the merge file options that the merge was invoked with
\n", - "comments": "", - "group": "merge" - }, - "git_merge_driver_register": { - "type": "function", - "file": "git2/sys/merge.h", - "line": 162, - "lineto": 163, - "args": [ - { - "name": "name", - "type": "const char *", - "comment": "The name of this driver to match an attribute. Attempting\n \t\t\tto register with an in-use name will return GIT_EEXISTS." - }, - { - "name": "driver", - "type": "git_merge_driver *", - "comment": "The merge driver definition. This pointer will be stored\n\t\t\tas is by libgit2 so it must be a durable allocation (either\n\t\t\tstatic or on the heap)." - } - ], - "argline": "const char *name, git_merge_driver *driver", - "sig": "const char *::git_merge_driver *", - "return": { - "type": "int", - "comment": " 0 on successful registry, error code \n<\n0 on failure" - }, - "description": "Register a merge driver under a given name.
\n", - "comments": "As mentioned elsewhere, the initialize callback will not be invoked\n immediately. It is deferred until the driver is used in some way.
\n\nCurrently the merge driver registry is not thread safe, so any\n registering or deregistering of merge drivers must be done outside of\n any possible usage of the drivers (i.e. during application setup or\n shutdown).
\n", - "group": "merge" - }, - "git_merge_driver_unregister": { - "type": "function", - "file": "git2/sys/merge.h", - "line": 178, - "lineto": 178, - "args": [ - { - "name": "name", - "type": "const char *", - "comment": "The name under which the merge driver was registered" - } - ], - "argline": "const char *name", - "sig": "const char *", - "return": { - "type": "int", - "comment": " 0 on success, error code \n<\n0 on failure" - }, - "description": "Remove the merge driver with the given name.
\n", - "comments": "Attempting to remove the builtin libgit2 merge drivers is not permitted\n and will return an error.
\n\nCurrently the merge driver registry is not thread safe, so any\n registering or deregistering of drivers must be done outside of any\n possible usage of the drivers (i.e. during application setup or shutdown).
\n", - "group": "merge" - }, - "git_odb_init_backend": { - "type": "function", - "file": "git2/sys/odb_backend.h", - "line": 116, - "lineto": 118, - "args": [ - { - "name": "backend", - "type": "git_odb_backend *", - "comment": "the `git_odb_backend` struct to initialize." - }, - { - "name": "version", - "type": "unsigned int", - "comment": "Version the struct; pass `GIT_ODB_BACKEND_VERSION`" - } - ], - "argline": "git_odb_backend *backend, unsigned int version", - "sig": "git_odb_backend *::unsigned int", - "return": { - "type": "int", - "comment": " Zero on success; -1 on failure." - }, - "description": "Initializes a git_odb_backend with default values. Equivalent to\n creating an instance with GIT_ODB_BACKEND_INIT.
Initialize the OpenSSL locks
\n", - "comments": "OpenSSL requires the application to determine how it performs\n locking.
\n\nThis is a last-resort convenience function which libgit2 provides for\n allocating and initializing the locks as well as setting the\n locking function to use the system's native locking functions.
\n\nThe locking function will be cleared and the memory will be freed\n when you call git_threads_sutdown().
\n\nIf your programming language has an OpenSSL package/bindings, it\n likely sets up locking. You should very strongly prefer that over\n this function.
\n", - "group": "openssl" - }, - "git_path_is_gitfile": { - "type": "function", - "file": "git2/sys/path.h", - "line": 60, - "lineto": 60, - "args": [ - { - "name": "path", - "type": "const char *", - "comment": "the path component to check" - }, - { - "name": "pathlen", - "type": "size_t", - "comment": "the length of `path` that is to be checked" - }, - { - "name": "gitfile", - "type": "git_path_gitfile", - "comment": "which file to check against" - }, - { - "name": "fs", - "type": "git_path_fs", - "comment": "which filesystem-specific checks to use" - } - ], - "argline": "const char *path, size_t pathlen, git_path_gitfile gitfile, git_path_fs fs", - "sig": "const char *::size_t::git_path_gitfile::git_path_fs", - "return": { - "type": "int", - "comment": " 0 in case the file does not match, a positive value if\n it does; -1 in case of an error" - }, - "description": "Check whether a path component corresponds to a .git$SUFFIX\n file.
\n", - "comments": "As some filesystems do special things to filenames when\n writing files to disk, you cannot always do a plain string\n comparison to verify whether a file name matches an expected\n path or not. This function can do the comparison for you,\n depending on the filesystem you're on.
\n", - "group": "path" - }, - "git_refdb_init_backend": { - "type": "function", - "file": "git2/sys/refdb_backend.h", - "line": 183, - "lineto": 185, - "args": [ - { - "name": "backend", - "type": "git_refdb_backend *", - "comment": "the `git_refdb_backend` struct to initialize" - }, - { - "name": "version", - "type": "unsigned int", - "comment": "Version of struct; pass `GIT_REFDB_BACKEND_VERSION`" - } - ], - "argline": "git_refdb_backend *backend, unsigned int version", - "sig": "git_refdb_backend *::unsigned int", - "return": { - "type": "int", - "comment": " Zero on success; -1 on failure." - }, - "description": "Initializes a git_refdb_backend with default values. Equivalent to\n creating an instance with GIT_REFDB_BACKEND_INIT.
Constructors for default filesystem-based refdb backend
\n", - "comments": "Under normal usage, this is called for you when the repository is\n opened / created, but you can use this to explicitly construct a\n filesystem refdb backend for a repository.
\n", - "group": "refdb" - }, - "git_refdb_set_backend": { - "type": "function", - "file": "git2/sys/refdb_backend.h", - "line": 212, - "lineto": 214, - "args": [ - { - "name": "refdb", - "type": "git_refdb *", - "comment": "database to add the backend to" - }, - { - "name": "backend", - "type": "git_refdb_backend *", - "comment": "pointer to a git_refdb_backend instance" - } - ], - "argline": "git_refdb *refdb, git_refdb_backend *backend", - "sig": "git_refdb *::git_refdb_backend *", - "return": { - "type": "int", - "comment": " 0 on success; error code otherwise" - }, - "description": "Sets the custom backend to an existing reference DB
\n", - "comments": "The git_refdb will take ownership of the git_refdb_backend so you\n should NOT free it after calling this function.
Create a new direct reference from an OID.
\n", - "comments": "", - "group": "reference" - }, - "git_reference__alloc_symbolic": { - "type": "function", - "file": "git2/sys/refs.h", - "line": 43, - "lineto": 45, - "args": [ - { - "name": "name", - "type": "const char *", - "comment": "the reference name" - }, - { - "name": "target", - "type": "const char *", - "comment": "the target for a symbolic reference" - } - ], - "argline": "const char *name, const char *target", - "sig": "const char *::const char *", - "return": { - "type": "git_reference *", - "comment": " the created git_reference or NULL on error" - }, - "description": "Create a new symbolic reference.
\n", - "comments": "", - "group": "reference" - }, - "git_repository_new": { - "type": "function", - "file": "git2/sys/repository.h", - "line": 31, - "lineto": 31, - "args": [ - { - "name": "out", - "type": "git_repository **", - "comment": "The blank repository" - } - ], - "argline": "git_repository **out", - "sig": "git_repository **", - "return": { - "type": "int", - "comment": " 0 on success, or an error code" - }, - "description": "Create a new repository with neither backends nor config object
\n", - "comments": "Note that this is only useful if you wish to associate the repository\n with a non-filesystem-backed object database and config store.
\n", - "group": "repository" - }, - "git_repository__cleanup": { - "type": "function", - "file": "git2/sys/repository.h", - "line": 44, - "lineto": 44, - "args": [ - { - "name": "repo", - "type": "git_repository *", - "comment": null - } - ], - "argline": "git_repository *repo", - "sig": "git_repository *", - "return": { - "type": "void", - "comment": null - }, - "description": "Reset all the internal state in a repository.
\n", - "comments": "This will free all the mapped memory and internal objects\n of the repository and leave it in a "blank" state.
\n\nThere's no need to call this function directly unless you're\n trying to aggressively cleanup the repo before its\n deallocation. git_repository_free already performs this operation\n before deallocation the repo.
Update the filesystem config settings for an open repository
\n", - "comments": "When a repository is initialized, config values are set based on the\n properties of the filesystem that the repository is on, such as\n "core.ignorecase", "core.filemode", "core.symlinks", etc. If the\n repository is moved to a new filesystem, these properties may no\n longer be correct and API calls may not behave as expected. This\n call reruns the phase of repository initialization that sets those\n properties to compensate for the current filesystem of the repo.
\n", - "group": "repository" - }, - "git_repository_set_config": { - "type": "function", - "file": "git2/sys/repository.h", - "line": 78, - "lineto": 78, - "args": [ - { - "name": "repo", - "type": "git_repository *", - "comment": "A repository object" - }, - { - "name": "config", - "type": "git_config *", - "comment": "A Config object" - } - ], - "argline": "git_repository *repo, git_config *config", - "sig": "git_repository *::git_config *", - "return": { - "type": "void", - "comment": null - }, - "description": "Set the configuration file for this repository
\n", - "comments": "This configuration file will be used for all configuration\n queries involving this repository.
\n\nThe repository will keep a reference to the config file;\n the user must still free the config after setting it\n to the repository, or it will leak.
\n", - "group": "repository" - }, - "git_repository_set_odb": { - "type": "function", - "file": "git2/sys/repository.h", - "line": 93, - "lineto": 93, - "args": [ - { - "name": "repo", - "type": "git_repository *", - "comment": "A repository object" - }, - { - "name": "odb", - "type": "git_odb *", - "comment": "An ODB object" - } - ], - "argline": "git_repository *repo, git_odb *odb", - "sig": "git_repository *::git_odb *", - "return": { - "type": "void", - "comment": null - }, - "description": "Set the Object Database for this repository
\n", - "comments": "The ODB will be used for all object-related operations\n involving this repository.
\n\nThe repository will keep a reference to the ODB; the user\n must still free the ODB object after setting it to the\n repository, or it will leak.
\n", - "group": "repository" - }, - "git_repository_set_refdb": { - "type": "function", - "file": "git2/sys/repository.h", - "line": 108, - "lineto": 108, - "args": [ - { - "name": "repo", - "type": "git_repository *", - "comment": "A repository object" - }, - { - "name": "refdb", - "type": "git_refdb *", - "comment": "An refdb object" - } - ], - "argline": "git_repository *repo, git_refdb *refdb", - "sig": "git_repository *::git_refdb *", - "return": { - "type": "void", - "comment": null - }, - "description": "Set the Reference Database Backend for this repository
\n", - "comments": "The refdb will be used for all reference related operations\n involving this repository.
\n\nThe repository will keep a reference to the refdb; the user\n must still free the refdb object after setting it to the\n repository, or it will leak.
\n", - "group": "repository" - }, - "git_repository_set_index": { - "type": "function", - "file": "git2/sys/repository.h", - "line": 123, - "lineto": 123, - "args": [ - { - "name": "repo", - "type": "git_repository *", - "comment": "A repository object" - }, - { - "name": "index", - "type": "git_index *", - "comment": "An index object" - } - ], - "argline": "git_repository *repo, git_index *index", - "sig": "git_repository *::git_index *", - "return": { - "type": "void", - "comment": null - }, - "description": "Set the index file for this repository
\n", - "comments": "This index will be used for all index-related operations\n involving this repository.
\n\nThe repository will keep a reference to the index file;\n the user must still free the index after setting it\n to the repository, or it will leak.
\n", - "group": "repository" - }, - "git_repository_set_bare": { - "type": "function", - "file": "git2/sys/repository.h", - "line": 136, - "lineto": 136, - "args": [ - { - "name": "repo", - "type": "git_repository *", - "comment": "Repo to make bare" - } - ], - "argline": "git_repository *repo", - "sig": "git_repository *", - "return": { - "type": "int", - "comment": " 0 on success, \n<\n0 on failure" - }, - "description": "Set a repository to be bare.
\n", - "comments": "Clear the working directory and set core.bare to true. You may also\n want to call git_repository_set_index(repo, NULL) since a bare repo\n typically does not have an index, but this function will not do that\n for you.
Load and cache all submodules.
\n", - "comments": "Because the .gitmodules file is unstructured, loading submodules is an\n O(N) operation. Any operation (such as git_rebase_init) that requires\n accessing all submodules is O(N^2) in the number of submodules, if it\n has to look each one up individually. This function loads all submodules\n and caches them so that subsequent calls to git_submodule_lookup are O(1).
Clear the submodule cache.
\n", - "comments": "Clear the submodule cache populated by git_repository_submodule_cache_all.\n If there is no cache, do nothing.
The cache incorporates data from the repository's configuration, as well\n as the state of the working tree, the index, and HEAD. So any time any\n of these has changed, the cache might become invalid.
\n", - "group": "repository" - }, - "git_stream_register": { - "type": "function", - "file": "git2/sys/stream.h", - "line": 98, - "lineto": 99, - "args": [ - { - "name": "type", - "type": "git_stream_t", - "comment": "the type or types of stream to register" - }, - { - "name": "registration", - "type": "git_stream_registration *", - "comment": "the registration data" - } - ], - "argline": "git_stream_t type, git_stream_registration *registration", - "sig": "git_stream_t::git_stream_registration *", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Register stream constructors for the library to use
\n", - "comments": "If a registration structure is already set, it will be overwritten.\n Pass NULL in order to deregister the current constructor and return\n to the system defaults.
The type parameter may be a bitwise AND of types.
\n", - "group": "stream" - }, - "git_stream_register_tls": { - "type": "function", - "file": "git2/sys/stream.h", - "line": 130, - "lineto": 130, - "args": [ - { - "name": "ctor", - "type": "git_stream_cb", - "comment": null - } - ], - "argline": "git_stream_cb ctor", - "sig": "git_stream_cb", - "return": { - "type": "int", - "comment": null - }, - "description": "Register a TLS stream constructor for the library to use. This stream\n will not support HTTP CONNECT proxies. This internally calls\n git_stream_register and is preserved for backward compatibility.
This function is deprecated, but there is no plan to remove this\n function at this time.
\n", - "group": "stream" - }, - "git_time_monotonic": { - "type": "function", - "file": "git2/sys/time.h", - "line": 27, - "lineto": 27, - "args": [], - "argline": "", - "sig": "", - "return": { - "type": "double", - "comment": null - }, - "description": "Return a monotonic time value, useful for measuring running time\n and setting up timeouts.
\n", - "comments": "The returned value is an arbitrary point in time -- it can only be\n used when comparing it to another git_time_monotonic call.
The time is returned in seconds, with a decimal fraction that differs\n on accuracy based on the underlying system, but should be least\n accurate to Nanoseconds.
\n\nThis function cannot fail.
\n", - "group": "time" - }, - "git_transport_init": { - "type": "function", - "file": "git2/sys/transport.h", - "line": 137, - "lineto": 139, - "args": [ - { - "name": "opts", - "type": "git_transport *", - "comment": "the `git_transport` struct to initialize" - }, - { - "name": "version", - "type": "unsigned int", - "comment": "Version of struct; pass `GIT_TRANSPORT_VERSION`" - } - ], - "argline": "git_transport *opts, unsigned int version", - "sig": "git_transport *::unsigned int", - "return": { - "type": "int", - "comment": " Zero on success; -1 on failure." - }, - "description": "Initializes a git_transport with default values. Equivalent to\n creating an instance with GIT_TRANSPORT_INIT.
Function to use to create a transport from a URL. The transport database\n is scanned to find a transport that implements the scheme of the URI (i.e.\n git:// or http://) and a transport object is returned to the caller.
\n", - "comments": "", - "group": "transport" - }, - "git_transport_ssh_with_paths": { - "type": "function", - "file": "git2/sys/transport.h", - "line": 167, - "lineto": 167, - "args": [ - { - "name": "out", - "type": "git_transport **", - "comment": "the resulting transport" - }, - { - "name": "owner", - "type": "git_remote *", - "comment": "the owning remote" - }, - { - "name": "payload", - "type": "void *", - "comment": "a strarray with the paths" - } - ], - "argline": "git_transport **out, git_remote *owner, void *payload", - "sig": "git_transport **::git_remote *::void *", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Create an ssh transport with custom git command paths
\n", - "comments": "This is a factory function suitable for setting as the transport\n callback in a remote (or for a clone in the options).
\n\nThe payload argument must be a strarray pointer with the paths for\n the git-upload-pack and git-receive-pack at index 0 and 1.
Add a custom transport definition, to be used in addition to the built-in\n set of transports that come with libgit2.
\n", - "comments": "The caller is responsible for synchronizing calls to git_transport_register\n and git_transport_unregister with other calls to the library that\n instantiate transports.
\n", - "group": "transport" - }, - "git_transport_unregister": { - "type": "function", - "file": "git2/sys/transport.h", - "line": 198, - "lineto": 199, - "args": [ - { - "name": "prefix", - "type": "const char *", - "comment": "From the previous call to git_transport_register" - } - ], - "argline": "const char *prefix", - "sig": "const char *", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Unregister a custom transport definition which was previously registered\n with git_transport_register.
\n", - "comments": "The caller is responsible for synchronizing calls to git_transport_register\n and git_transport_unregister with other calls to the library that\n instantiate transports.
\n", - "group": "transport" - }, - "git_transport_dummy": { - "type": "function", - "file": "git2/sys/transport.h", - "line": 212, - "lineto": 215, - "args": [ - { - "name": "out", - "type": "git_transport **", - "comment": "The newly created transport (out)" - }, - { - "name": "owner", - "type": "git_remote *", - "comment": "The git_remote which will own this transport" - }, - { - "name": "payload", - "type": "void *", - "comment": "You must pass NULL for this parameter." - } - ], - "argline": "git_transport **out, git_remote *owner, void *payload", - "sig": "git_transport **::git_remote *::void *", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Create an instance of the dummy transport.
\n", - "comments": "", - "group": "transport" - }, - "git_transport_local": { - "type": "function", - "file": "git2/sys/transport.h", - "line": 225, - "lineto": 228, - "args": [ - { - "name": "out", - "type": "git_transport **", - "comment": "The newly created transport (out)" - }, - { - "name": "owner", - "type": "git_remote *", - "comment": "The git_remote which will own this transport" - }, - { - "name": "payload", - "type": "void *", - "comment": "You must pass NULL for this parameter." - } - ], - "argline": "git_transport **out, git_remote *owner, void *payload", - "sig": "git_transport **::git_remote *::void *", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Create an instance of the local transport.
\n", - "comments": "", - "group": "transport" - }, - "git_transport_smart": { - "type": "function", - "file": "git2/sys/transport.h", - "line": 238, - "lineto": 241, - "args": [ - { - "name": "out", - "type": "git_transport **", - "comment": "The newly created transport (out)" - }, - { - "name": "owner", - "type": "git_remote *", - "comment": "The git_remote which will own this transport" - }, - { - "name": "payload", - "type": "void *", - "comment": "A pointer to a git_smart_subtransport_definition" - } - ], - "argline": "git_transport **out, git_remote *owner, void *payload", - "sig": "git_transport **::git_remote *::void *", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Create an instance of the smart transport.
\n", - "comments": "", - "group": "transport" - }, - "git_transport_smart_certificate_check": { - "type": "function", - "file": "git2/sys/transport.h", - "line": 255, - "lineto": 255, - "args": [ - { - "name": "transport", - "type": "git_transport *", - "comment": "a smart transport" - }, - { - "name": "cert", - "type": "git_cert *", - "comment": "the certificate to pass to the caller" - }, - { - "name": "valid", - "type": "int", - "comment": "whether we believe the certificate is valid" - }, - { - "name": "hostname", - "type": "const char *", - "comment": "the hostname we connected to" - } - ], - "argline": "git_transport *transport, git_cert *cert, int valid, const char *hostname", - "sig": "git_transport *::git_cert *::int::const char *", - "return": { - "type": "int", - "comment": " the return value of the callback: 0 for no error, GIT_PASSTHROUGH\n to indicate that there is no callback registered (or the callback\n refused to validate the certificate and callers should behave as\n if no callback was set), or \n<\n 0 for an error" - }, - "description": "Call the certificate check for this transport.
\n", - "comments": "", - "group": "transport" - }, - "git_transport_smart_credentials": { - "type": "function", - "file": "git2/sys/transport.h", - "line": 269, - "lineto": 269, - "args": [ - { - "name": "out", - "type": "git_cred **", - "comment": "the pointer where the creds are to be stored" - }, - { - "name": "transport", - "type": "git_transport *", - "comment": "a smart transport" - }, - { - "name": "user", - "type": "const char *", - "comment": "the user we saw on the url (if any)" - }, - { - "name": "methods", - "type": "int", - "comment": "available methods for authentication" - } - ], - "argline": "git_cred **out, git_transport *transport, const char *user, int methods", - "sig": "git_cred **::git_transport *::const char *::int", - "return": { - "type": "int", - "comment": " the return value of the callback: 0 for no error, GIT_PASSTHROUGH\n to indicate that there is no callback registered (or the callback\n refused to provide credentials and callers should behave as if no\n callback was set), or \n<\n 0 for an error" - }, - "description": "Call the credentials callback for this transport
\n", - "comments": "", - "group": "transport" - }, - "git_transport_smart_proxy_options": { - "type": "function", - "file": "git2/sys/transport.h", - "line": 279, - "lineto": 279, - "args": [ - { - "name": "out", - "type": "git_proxy_options *", - "comment": "options struct to fill" - }, - { - "name": "transport", - "type": "git_transport *", - "comment": "the transport to extract the data from." - } - ], - "argline": "git_proxy_options *out, git_transport *transport", - "sig": "git_proxy_options *::git_transport *", - "return": { - "type": "int", - "comment": null - }, - "description": "Get a copy of the proxy options
\n", - "comments": "The url is copied and must be freed by the caller.
\n", - "group": "transport" - }, - "git_smart_subtransport_http": { - "type": "function", - "file": "git2/sys/transport.h", - "line": 408, - "lineto": 411, - "args": [ - { - "name": "out", - "type": "git_smart_subtransport **", - "comment": "The newly created subtransport" - }, - { - "name": "owner", - "type": "git_transport *", - "comment": "The smart transport to own this subtransport" - }, - { - "name": "param", - "type": "void *", - "comment": null - } - ], - "argline": "git_smart_subtransport **out, git_transport *owner, void *param", - "sig": "git_smart_subtransport **::git_transport *::void *", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Create an instance of the http subtransport.
\n", - "comments": "This subtransport also supports https.
\n", - "group": "smart" - }, - "git_smart_subtransport_git": { - "type": "function", - "file": "git2/sys/transport.h", - "line": 420, - "lineto": 423, - "args": [ - { - "name": "out", - "type": "git_smart_subtransport **", - "comment": "The newly created subtransport" - }, - { - "name": "owner", - "type": "git_transport *", - "comment": "The smart transport to own this subtransport" - }, - { - "name": "param", - "type": "void *", - "comment": null - } - ], - "argline": "git_smart_subtransport **out, git_transport *owner, void *param", - "sig": "git_smart_subtransport **::git_transport *::void *", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Create an instance of the git subtransport.
\n", - "comments": "", - "group": "smart" - }, - "git_smart_subtransport_ssh": { - "type": "function", - "file": "git2/sys/transport.h", - "line": 432, - "lineto": 435, - "args": [ - { - "name": "out", - "type": "git_smart_subtransport **", - "comment": "The newly created subtransport" - }, - { - "name": "owner", - "type": "git_transport *", - "comment": "The smart transport to own this subtransport" - }, - { - "name": "param", - "type": "void *", - "comment": null - } - ], - "argline": "git_smart_subtransport **out, git_transport *owner, void *param", - "sig": "git_smart_subtransport **::git_transport *::void *", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Create an instance of the ssh subtransport.
\n", - "comments": "", - "group": "smart" - }, - "git_tag_lookup": { - "type": "function", - "file": "git2/tag.h", - "line": 33, - "lineto": 34, - "args": [ - { - "name": "out", - "type": "git_tag **", - "comment": "pointer to the looked up tag" - }, - { - "name": "repo", - "type": "git_repository *", - "comment": "the repo to use when locating the tag." - }, - { - "name": "id", - "type": "const git_oid *", - "comment": "identity of the tag to locate." - } - ], - "argline": "git_tag **out, git_repository *repo, const git_oid *id", - "sig": "git_tag **::git_repository *::const git_oid *", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Lookup a tag object from the repository.
\n", - "comments": "", - "group": "tag", - "examples": { - "general.c": [ - "ex/v0.28.0/general.html#git_tag_lookup-84" - ] - } - }, - "git_tag_lookup_prefix": { - "type": "function", - "file": "git2/tag.h", - "line": 48, - "lineto": 49, - "args": [ - { - "name": "out", - "type": "git_tag **", - "comment": "pointer to the looked up tag" - }, - { - "name": "repo", - "type": "git_repository *", - "comment": "the repo to use when locating the tag." - }, - { - "name": "id", - "type": "const git_oid *", - "comment": "identity of the tag to locate." - }, - { - "name": "len", - "type": "size_t", - "comment": "the length of the short identifier" - } - ], - "argline": "git_tag **out, git_repository *repo, const git_oid *id, size_t len", - "sig": "git_tag **::git_repository *::const git_oid *::size_t", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "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": "git2/tag.h", - "line": 61, - "lineto": 61, - "args": [ - { - "name": "tag", - "type": "git_tag *", - "comment": "the tag to close" - } - ], - "argline": "git_tag *tag", - "sig": "git_tag *", - "return": { - "type": "void", - "comment": null - }, - "description": "Close an open tag
\n", - "comments": "You can no longer use the git_tag pointer after this call.
\n\nIMPORTANT: You MUST call this method when you are through with a tag to\n release memory. Failure to do so will cause a memory leak.
\n", - "group": "tag", - "examples": { - "general.c": [ - "ex/v0.28.0/general.html#git_tag_free-85" - ] - } - }, - "git_tag_id": { - "type": "function", - "file": "git2/tag.h", - "line": 69, - "lineto": 69, - "args": [ - { - "name": "tag", - "type": "const git_tag *", - "comment": "a previously loaded tag." - } - ], - "argline": "const git_tag *tag", - "sig": "const git_tag *", - "return": { - "type": "const git_oid *", - "comment": " object identity for the tag." - }, - "description": "Get the id of a tag.
\n", - "comments": "", - "group": "tag" - }, - "git_tag_owner": { - "type": "function", - "file": "git2/tag.h", - "line": 77, - "lineto": 77, - "args": [ - { - "name": "tag", - "type": "const git_tag *", - "comment": "A previously loaded tag." - } - ], - "argline": "const git_tag *tag", - "sig": "const git_tag *", - "return": { - "type": "git_repository *", - "comment": " Repository that contains this tag." - }, - "description": "Get the repository that contains the tag.
\n", - "comments": "", - "group": "tag" - }, - "git_tag_target": { - "type": "function", - "file": "git2/tag.h", - "line": 89, - "lineto": 89, - "args": [ - { - "name": "target_out", - "type": "git_object **", - "comment": "pointer where to store the target" - }, - { - "name": "tag", - "type": "const git_tag *", - "comment": "a previously loaded tag." - } - ], - "argline": "git_object **target_out, const git_tag *tag", - "sig": "git_object **::const git_tag *", - "return": { - "type": "int", - "comment": " 0 or an error code" - }, - "description": "Get the tagged object of a tag
\n", - "comments": "This method performs a repository lookup for the\n given object and returns it
\n", - "group": "tag", - "examples": { - "general.c": [ - "ex/v0.28.0/general.html#git_tag_target-86" - ] - } - }, - "git_tag_target_id": { - "type": "function", - "file": "git2/tag.h", - "line": 97, - "lineto": 97, - "args": [ - { - "name": "tag", - "type": "const git_tag *", - "comment": "a previously loaded tag." - } - ], - "argline": "const git_tag *tag", - "sig": "const git_tag *", - "return": { - "type": "const git_oid *", - "comment": " pointer to the OID" - }, - "description": "Get the OID of the tagged object of a tag
\n", - "comments": "", - "group": "tag", - "examples": { - "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_tag_target_id-35" - ] - } - }, - "git_tag_target_type": { - "type": "function", - "file": "git2/tag.h", - "line": 105, - "lineto": 105, - "args": [ - { - "name": "tag", - "type": "const git_tag *", - "comment": "a previously loaded tag." - } - ], - "argline": "const git_tag *tag", - "sig": "const git_tag *", - "return": { - "type": "git_object_t", - "comment": " type of the tagged object" - }, - "description": "Get the type of a tag's tagged object
\n", - "comments": "", - "group": "tag", - "examples": { - "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_tag_target_type-36" - ], - "general.c": [ - "ex/v0.28.0/general.html#git_tag_target_type-87" - ] - } - }, - "git_tag_name": { - "type": "function", - "file": "git2/tag.h", - "line": 113, - "lineto": 113, - "args": [ - { - "name": "tag", - "type": "const git_tag *", - "comment": "a previously loaded tag." - } - ], - "argline": "const git_tag *tag", - "sig": "const git_tag *", - "return": { - "type": "const char *", - "comment": " name of the tag" - }, - "description": "Get the name of a tag
\n", - "comments": "", - "group": "tag", - "examples": { - "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_tag_name-37" - ], - "general.c": [ - "ex/v0.28.0/general.html#git_tag_name-88" - ], - "tag.c": [ - "ex/v0.28.0/tag.html#git_tag_name-20" - ] - } - }, - "git_tag_tagger": { + "git_tag_tagger": { "type": "function", "file": "git2/tag.h", "line": 121, @@ -25030,7 +22426,7 @@ "group": "tag", "examples": { "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_tag_tagger-38" + "ex/HEAD/cat-file.html#git_tag_tagger-34" ] } }, @@ -25057,14 +22453,14 @@ "group": "tag", "examples": { "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_tag_message-39", - "ex/v0.28.0/cat-file.html#git_tag_message-40" + "ex/HEAD/cat-file.html#git_tag_message-35", + "ex/HEAD/cat-file.html#git_tag_message-36" ], "general.c": [ - "ex/v0.28.0/general.html#git_tag_message-89" + "ex/HEAD/general.html#git_tag_message-89" ], "tag.c": [ - "ex/v0.28.0/tag.html#git_tag_message-21" + "ex/HEAD/tag.html#git_tag_message-17" ] } }, @@ -25117,11 +22513,11 @@ "comment": " 0 on success, GIT_EINVALIDSPEC or an error code\n\tA tag object is written to the ODB, and a proper reference\n\tis written in the /refs/tags folder, pointing to it" }, "description": "Create a new tag in the repository from an object
\n", - "comments": "A new reference will also be created pointing to\n this tag object. If force is true and a reference\n already exists with the given name, it'll be replaced.
The message will not be cleaned up. This can be achieved\n through git_message_prettify().
The tag name will be checked for validity. You must avoid\n the characters '~', '^', ':', '\n\\\n', '?', '[', and '*', and the\n sequences ".." and "\n@\n{" which have special meaning to revparse.
\n", + "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.28.0/tag.html#git_tag_create-22" + "ex/HEAD/tag.html#git_tag_create-18" ] } }, @@ -25169,10 +22565,10 @@ "comment": " 0 on success or an error code" }, "description": "Create a new tag in the object database pointing to a git_object
\n", - "comments": "The message will not be cleaned up. This can be achieved\n through git_message_prettify().
The message will not be cleaned up. This can be achieved through git_message_prettify().
Create a new lightweight tag pointing at a target object
\n", - "comments": "A new direct reference will be created pointing to\n this target object. If force is true and a reference\n already exists with the given name, it'll be replaced.
The tag name will be checked for validity.\n See git_tag_create() for rules about valid names.
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.
Delete an existing tag reference.
\n", - "comments": "The tag name will be checked for validity.\n 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.
Fill a list with all the tags in the Repository
\n", - "comments": "The string array will be filled with the names of the\n matching tags; these values are owned by the user and\n should be free'd manually when no longer needed, using\n git_strarray_free.
The string array will be filled with the names of the matching tags; these values are owned by the user and should be free'd manually when no longer needed, using git_strarray_free.
Fill a list with all the tags in the Repository\n which name match a defined pattern
\n", - "comments": "If an empty pattern is provided, all the tags\n will be returned.
\n\nThe string array will be filled with the names of the\n matching tags; these values are owned by the user and\n should be free'd manually when no longer needed, using\n git_strarray_free.
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.
Recursively peel a tag until a non tag git_object is found
\n", - "comments": "The retrieved tag_target object is owned by the repository\n and should be closed with the git_object_free method.
The retrieved tag_target object is owned by the repository and should be closed with the git_object_free method.
Create a new transaction object
\n", - "comments": "This does not lock anything, but sets up the transaction object to\n know from which repository to lock.
\n", + "comments": "This does not lock anything, but sets up the transaction object to know from which repository to lock.
\n", "group": "transaction" }, "git_transaction_lock_ref": { @@ -25516,7 +22912,7 @@ "comment": " 0 or an error message" }, "description": "Lock a reference
\n", - "comments": "Lock the specified reference. This is the first step to updating a\n reference.
\n", + "comments": "Lock the specified reference. This is the first step to updating a reference.
\n", "group": "transaction" }, "git_transaction_set_target": { @@ -25558,7 +22954,7 @@ "comment": " 0, GIT_ENOTFOUND if the reference is not among the locked ones, or an error code" }, "description": "Set the target of a reference
\n", - "comments": "Set the target of the specified reference. This reference must be\n locked.
\n", + "comments": "Set the target of the specified reference. This reference must be locked.
\n", "group": "transaction" }, "git_transaction_set_symbolic_target": { @@ -25600,7 +22996,7 @@ "comment": " 0, GIT_ENOTFOUND if the reference is not among the locked ones, or an error code" }, "description": "Set the target of a reference
\n", - "comments": "Set the target of the specified reference. This reference must be\n locked.
\n", + "comments": "Set the target of the specified reference. This reference must be locked.
\n", "group": "transaction" }, "git_transaction_set_reflog": { @@ -25632,7 +23028,7 @@ "comment": " 0, GIT_ENOTFOUND if the reference is not among the locked ones, or an error code" }, "description": "Set the reflog of a reference
\n", - "comments": "Set the specified reference's reflog. If this is combined with\n setting the target, that update won't be written to the reflog.
\n", + "comments": "Set the specified reference's reflog. If this is combined with setting the target, that update won't be written to the reflog.
\n", "group": "transaction" }, "git_transaction_remove": { @@ -25681,7 +23077,7 @@ "comment": " 0 or an error code" }, "description": "Commit the changes from the transaction
\n", - "comments": "Perform the changes that have been queued. The updates will be made\n one by one, and the first failure will stop the processing.
\n", + "comments": "Perform the changes that have been queued. The updates will be made one by one, and the first failure will stop the processing.
\n", "group": "transaction" }, "git_transaction_free": { @@ -25703,7 +23099,7 @@ "comment": null }, "description": "Free the resources allocated by this transaction
\n", - "comments": "If any references remain locked, they will be unlocked without any\n changes made to them.
\n", + "comments": "If any references remain locked, they will be unlocked without any changes made to them.
\n", "group": "transaction" }, "git_cred_has_username": { @@ -25820,7 +23216,7 @@ }, { "name": "prompt_callback", - "type": "git_cred_ssh_interactive_callback", + "type": "git_cred_ssh_interactive_cb", "comment": "The callback method used for prompts." }, { @@ -25829,8 +23225,8 @@ "comment": "Additional data to pass to the callback." } ], - "argline": "git_cred **out, const char *username, git_cred_ssh_interactive_callback prompt_callback, void *payload", - "sig": "git_cred **::const char *::git_cred_ssh_interactive_callback::void *", + "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." @@ -25894,7 +23290,7 @@ }, { "name": "sign_callback", - "type": "git_cred_sign_callback", + "type": "git_cred_sign_cb", "comment": "The callback method to sign the data during the challenge." }, { @@ -25903,14 +23299,14 @@ "comment": "Additional data to pass to the callback." } ], - "argline": "git_cred **out, const char *username, const char *publickey, size_t publickey_len, git_cred_sign_callback sign_callback, void *payload", - "sig": "git_cred **::const char *::const char *::size_t::git_cred_sign_callback::void *", + "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\n and wraps libssh2_userauth_publickey(), which is undocumented.
The supplied credential parameter will be internally duplicated.
\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": { @@ -25959,7 +23355,7 @@ "comment": null }, "description": "Create a credential to specify a username.
\n", - "comments": "This is used with ssh authentication to query for the username if\n none is specified in the url.
\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": { @@ -26023,7 +23419,7 @@ "comment": null }, "description": "Free a credential.
\n", - "comments": "This is only necessary if you own the object; that is, if you are a\n transport.
\n", + "comments": "This is only necessary if you own the object; that is, if you are a transport.
\n", "group": "cred" }, "git_tree_lookup": { @@ -26059,14 +23455,14 @@ "group": "tree", "examples": { "general.c": [ - "ex/v0.28.0/general.html#git_tree_lookup-90", - "ex/v0.28.0/general.html#git_tree_lookup-91" + "ex/HEAD/general.html#git_tree_lookup-90", + "ex/HEAD/general.html#git_tree_lookup-91" ], "init.c": [ - "ex/v0.28.0/init.html#git_tree_lookup-14" + "ex/HEAD/init.html#git_tree_lookup-12" ], "merge.c": [ - "ex/v0.28.0/merge.html#git_tree_lookup-41" + "ex/HEAD/merge.html#git_tree_lookup-37" ] } }, @@ -26126,26 +23522,26 @@ "comment": null }, "description": "Close an open tree
\n", - "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\n release memory. Failure to do so will cause a memory leak.
\n", + "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.28.0/diff.html#git_tree_free-17", - "ex/v0.28.0/diff.html#git_tree_free-18" + "ex/HEAD/diff.html#git_tree_free-13", + "ex/HEAD/diff.html#git_tree_free-14" ], "general.c": [ - "ex/v0.28.0/general.html#git_tree_free-92", - "ex/v0.28.0/general.html#git_tree_free-93" + "ex/HEAD/general.html#git_tree_free-92", + "ex/HEAD/general.html#git_tree_free-93" ], "init.c": [ - "ex/v0.28.0/init.html#git_tree_free-15" + "ex/HEAD/init.html#git_tree_free-13" ], "log.c": [ - "ex/v0.28.0/log.html#git_tree_free-59", - "ex/v0.28.0/log.html#git_tree_free-60", - "ex/v0.28.0/log.html#git_tree_free-61", - "ex/v0.28.0/log.html#git_tree_free-62", - "ex/v0.28.0/log.html#git_tree_free-63" + "ex/HEAD/log.html#git_tree_free-55", + "ex/HEAD/log.html#git_tree_free-56", + "ex/HEAD/log.html#git_tree_free-57", + "ex/HEAD/log.html#git_tree_free-58", + "ex/HEAD/log.html#git_tree_free-59" ] } }, @@ -26216,10 +23612,10 @@ "group": "tree", "examples": { "cat-file.c": [ - "ex/v0.28.0/cat-file.html#git_tree_entrycount-41" + "ex/HEAD/cat-file.html#git_tree_entrycount-37" ], "general.c": [ - "ex/v0.28.0/general.html#git_tree_entrycount-94" + "ex/HEAD/general.html#git_tree_entrycount-94" ] } }, @@ -26247,11 +23643,11 @@ "comment": " the tree entry; NULL if not found" }, "description": "Lookup a tree entry by its filename
\n", - "comments": "This returns a git_tree_entry that is owned by the git_tree. You don't\n have to free it, but you must not use it after the git_tree is released.
\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": { "general.c": [ - "ex/v0.28.0/general.html#git_tree_entry_byname-95" + "ex/HEAD/general.html#git_tree_entry_byname-95" ] } }, @@ -26279,14 +23675,14 @@ "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\n have to free it, but you must not use it after the git_tree is released.
\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.28.0/cat-file.html#git_tree_entry_byindex-42" + "ex/HEAD/cat-file.html#git_tree_entry_byindex-38" ], "general.c": [ - "ex/v0.28.0/general.html#git_tree_entry_byindex-96" + "ex/HEAD/general.html#git_tree_entry_byindex-96" ] } }, @@ -26314,7 +23710,7 @@ "comment": " the tree entry; NULL if not found" }, "description": "Lookup a tree entry by SHA value.
\n", - "comments": "This returns a git_tree_entry that is owned by the git_tree. You don't\n have to free it, but you must not use it after the git_tree is released.
\n\nWarning: this must examine every entry in the tree, so it is not fast.
\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\nWarning: this must examine every entry in the tree, so it is not fast.
\n", "group": "tree" }, "git_tree_entry_bypath": { @@ -26346,7 +23742,7 @@ "comment": " 0 on success; GIT_ENOTFOUND if the path does not exist" }, "description": "Retrieve a tree entry contained in a tree or in any of its subtrees,\n given its relative path.
\n", - "comments": "Unlike the other lookup functions, the returned tree entry is owned by\n the user and must be freed explicitly with git_tree_entry_free().
Unlike the other lookup functions, the returned tree entry is owned by the user and must be freed explicitly with git_tree_entry_free().
Duplicate a tree entry
\n", - "comments": "Create a copy of a tree entry. The returned copy is owned by the user,\n and must be freed explicitly with git_tree_entry_free().
Create a copy of a tree entry. The returned copy is owned by the user, and must be freed explicitly with git_tree_entry_free().
Free a user-owned tree entry
\n", - "comments": "IMPORTANT: This function is only needed for tree entries owned by the\n user, such as the ones returned by git_tree_entry_dup() or\n git_tree_entry_bypath().
IMPORTANT: This function is only needed for tree entries owned by the user, such as the ones returned by git_tree_entry_dup() or git_tree_entry_bypath().
Get the raw UNIX file attributes of a tree entry
\n", - "comments": "This function does not perform any normalization and is only useful\n if you need to be able to recreate the original tree object.
\n", + "comments": "This function does not perform any normalization and is only useful if you need to be able to recreate the original tree object.
\n", "group": "tree" }, "git_tree_entry_cmp": { @@ -26592,7 +23988,7 @@ "group": "tree", "examples": { "general.c": [ - "ex/v0.28.0/general.html#git_tree_entry_to_object-99" + "ex/HEAD/general.html#git_tree_entry_to_object-99" ] } }, @@ -26625,7 +24021,7 @@ "comment": " 0 on success; error code otherwise" }, "description": "Create a new tree builder.
\n", - "comments": "The tree builder can be used to create or modify trees in memory and\n write them as tree objects to the database.
\n\nIf the source parameter is not NULL, the tree builder will be\n initialized with the entries of the given tree.
If the source parameter is NULL, the tree builder will start with no\n entries and will have to be filled manually.
The tree builder can be used to create or modify trees in memory and write them as tree objects to the database.
\n\nIf the source parameter is not NULL, the tree builder will be initialized with the entries of the given tree.
If the source parameter is NULL, the tree builder will start with no entries and will have to be filled manually.
Free a tree builder
\n", - "comments": "This will clear all the entries and free to builder.\n Failing to free the builder after you're done using it\n will result in a memory leak
\n", + "comments": "This will clear all the entries and free to builder. Failing to free the builder after you're done using it will result in a memory leak
\n", "group": "treebuilder" }, "git_treebuilder_get": { @@ -26718,7 +24114,7 @@ "comment": " pointer to the entry; NULL if not found" }, "description": "Get an entry from the builder from its filename
\n", - "comments": "The returned entry is owned by the builder and should\n not be freed manually.
\n", + "comments": "The returned entry is owned by the builder and should not be freed manually.
\n", "group": "treebuilder" }, "git_treebuilder_insert": { @@ -26760,7 +24156,7 @@ "comment": " 0 or an error code" }, "description": "Add or update an entry to the builder
\n", - "comments": "Insert a new entry for filename in the builder with the\n given attributes.
If an entry named filename already exists, its attributes\n will be updated with the given ones.
The optional pointer out can be used to retrieve a pointer to the\n newly created/updated entry. Pass NULL if you do not need it. The\n pointer may not be valid past the next operation in this\n builder. Duplicate the entry if you want to keep it.
By default the entry that you are inserting will be checked for\n validity; that it exists in the object database and is of the\n correct type. If you do not want this behavior, set the\n GIT_OPT_ENABLE_STRICT_OBJECT_CREATION library option to false.
Insert a new entry for filename in the builder with the given attributes.
If an entry named filename already exists, its attributes will be updated with the given ones.
The optional pointer out can be used to retrieve a pointer to the newly created/updated entry. Pass NULL if you do not need it. The pointer may not be valid past the next operation in this builder. Duplicate the entry if you want to keep it.
By default the entry that you are inserting will be checked for validity; that it exists in the object database and is of the correct type. If you do not want this behavior, set the GIT_OPT_ENABLE_STRICT_OBJECT_CREATION library option to false.
Selectively remove entries in the tree
\n", - "comments": "The filter callback will be called for each entry in the tree with a\n pointer to the entry and the provided payload; if the callback returns\n non-zero, the entry will be filtered (removed from the builder).
The filter callback will be called for each entry in the tree with a pointer to the entry and the provided payload; if the callback returns non-zero, the entry will be filtered (removed from the builder).
Write the contents of the tree builder as a tree object
\n", - "comments": "The tree builder will be written to the given repo, and its\n identifying SHA1 hash will be stored in the id pointer.
The tree builder will be written to the given repo, and its identifying SHA1 hash will be stored in the id pointer.
Traverse the entries in a tree and its subtrees in post or pre order.
\n", - "comments": "The entries will be traversed in the specified order, children subtrees\n will be automatically loaded as required, and the callback will be\n called once per entry with the current (relative) root for the entry and\n the entry data itself.
If the callback returns a positive value, the passed entry will be\n skipped on the traversal (in pre mode). A negative value stops the walk.
\n", + "comments": "The entries will be traversed in the specified order, children subtrees will be automatically loaded as required, and the callback will be called once per entry with the current (relative) root for the entry and the entry data itself.
If the callback returns a positive value, the passed entry will be skipped on the traversal (in pre mode). A negative value stops the walk.
\n", "group": "tree" }, "git_tree_dup": { @@ -26984,7 +24380,7 @@ "comment": null }, "description": "Create a tree based on another one with the specified modifications
\n", - "comments": "Given the baseline perform the changes described in the list of\n updates and create a new tree.
This function is optimized for common file/directory addition, removal and\n replacement in trees. It is much more efficient than reading the tree into a\n git_index and modifying that, but in exchange it is not as flexible.
Deleting and adding the same entry is undefined behaviour, changing\n a tree to a blob or viceversa is not supported.
\n", + "comments": "Given the baseline perform the changes described in the list of updates and create a new tree.
This function is optimized for common file/directory addition, removal and replacement in trees. It is much more efficient than reading the tree into a git_index and modifying that, but in exchange it is not as flexible.
Deleting and adding the same entry is undefined behaviour, changing a tree to a blob or viceversa is not supported.
\n", "group": "tree" }, "git_worktree_list": { @@ -27011,7 +24407,7 @@ "comment": " 0 or an error code" }, "description": "List names of linked working trees
\n", - "comments": "The returned list should be released with git_strarray_free\n when no longer needed.
The returned list should be released with git_strarray_free when no longer needed.
Open a worktree of a given repository
\n", - "comments": "If a repository is not the main tree but a worktree, this\n function will look up the worktree inside the parent\n repository and create a new git_worktree structure.
If a repository is not the main tree but a worktree, this function will look up the worktree inside the parent repository and create a new git_worktree structure.
Check if worktree is valid
\n", - "comments": "A valid worktree requires both the git data structures inside\n the linked parent repository and the linked working copy to be\n present.
\n", + "comments": "A valid worktree requires both the git data structures inside the linked parent repository and the linked working copy to be present.
\n", "group": "worktree" }, - "git_worktree_add_init_options": { + "git_worktree_add_options_init": { "type": "function", "file": "git2/worktree.h", "line": 104, @@ -27141,7 +24537,7 @@ "comment": " Zero on success; -1 on failure." }, "description": "Initialize git_worktree_add_options structure
\n", - "comments": "Initializes a git_worktree_add_options with default values. Equivalent to\n creating an instance with GIT_WORKTREE_ADD_OPTIONS_INIT.
Initializes a git_worktree_add_options with default values. Equivalent to creating an instance with GIT_WORKTREE_ADD_OPTIONS_INIT.
Add a new working tree
\n", - "comments": "Add a new working tree for the repository, that is create the\n required data structures inside the repository and check out\n the current HEAD at path
Add a new working tree for the repository, that is create the required data structures inside the repository and check out the current HEAD at path
Lock worktree if not already locked
\n", - "comments": "Lock a worktree, optionally specifying a reason why the linked\n working tree is being locked.
\n", + "comments": "Lock a worktree, optionally specifying a reason why the linked working tree is being locked.
\n", "group": "worktree" }, "git_worktree_unlock": { @@ -27259,7 +24655,7 @@ "comment": " 0 when the working tree not locked, a value greater\n than zero if it is locked, less than zero if there was an\n error" }, "description": "Check if worktree is locked
\n", - "comments": "A worktree may be locked if the linked working tree is stored\n on a portable device which is not available.
\n", + "comments": "A worktree may be locked if the linked working tree is stored on a portable device which is not available.
\n", "group": "worktree" }, "git_worktree_name": { @@ -27306,7 +24702,7 @@ "comments": "", "group": "worktree" }, - "git_worktree_prune_init_options": { + "git_worktree_prune_options_init": { "type": "function", "file": "git2/worktree.h", "line": 217, @@ -27330,7 +24726,7 @@ "comment": " Zero on success; -1 on failure." }, "description": "Initialize git_worktree_prune_options structure
\n", - "comments": "Initializes a git_worktree_prune_options with default values. Equivalent to\n creating an instance with GIT_WORKTREE_PRUNE_OPTIONS_INIT.
Initializes a git_worktree_prune_options with default values. Equivalent to creating an instance with GIT_WORKTREE_PRUNE_OPTIONS_INIT.
Is the worktree prunable with the given options?
\n", - "comments": "A worktree is not prunable in the following scenarios:
\n\nvalid member will cause this check to be ignored.locked flag will cause this\ncheck to be ignored.If the worktree is not valid and not locked or if the above\n flags have been passed in, this function will return a\n positive value.
\n", + "comments": "A worktree is not prunable in the following scenarios:
\n\nvalid member will cause this check to be ignored. - the worktree is locked. The locked flag will cause this check to be ignored.If the worktree is not valid and not locked or if the above flags have been passed in, this function will return a positive value.
\n", "group": "worktree" }, "git_worktree_prune": { @@ -27384,7 +24780,7 @@ "comment": " 0 or an error code" }, "description": "Prune working tree
\n", - "comments": "Prune the working tree, that is remove the git data\n structures on disk. The repository will only be pruned of\n git_worktree_is_prunable succeeds.
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.
When applying a patch, callback that will be made per delta (file).
\n", - "comments": "When the callback:\n - returns \n<\n 0, the apply process will be aborted.\n - returns > 0, the delta will not be applied, but the apply process\n continues\n - returns 0, the delta is applied, and the apply process continues.
\n" + "comments": "When the callback: - returns < 0, the apply process will be aborted. - returns > 0, the delta will not be applied, but the apply process continues - returns 0, the delta is applied, and the apply process continues.
\n" }, "git_apply_hunk_cb": { "type": "callback", @@ -27439,7 +24835,7 @@ "comment": null }, "description": "When applying a patch, callback that will be made per hunk.
\n", - "comments": "When the callback:\n - returns \n<\n 0, the apply process will be aborted.\n - returns > 0, the hunk will not be applied, but the apply process\n continues\n - returns 0, the hunk is applied, and the apply process continues.
\n" + "comments": "When the callback: - returns < 0, the apply process will be aborted. - returns > 0, the hunk will not be applied, but the apply process continues - returns 0, the hunk is applied, and the apply process continues.
\n" }, "git_attr_foreach_cb": { "type": "callback", @@ -27470,13 +24866,13 @@ "comment": " 0 to continue looping, non-zero to stop. This value will be returned\n from git_attr_foreach." }, "description": "The callback used with git_attr_foreach.
\n", - "comments": "This callback will be invoked only once per attribute name, even if there\n are multiple rules for a given file. The highest priority rule will be\n used.
\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_checkout_notify_cb": { "type": "callback", "file": "git2/checkout.h", - "line": 223, - "lineto": 229, + "line": 236, + "lineto": 242, "args": [ { "name": "why", @@ -27521,8 +24917,8 @@ "git_checkout_progress_cb": { "type": "callback", "file": "git2/checkout.h", - "line": 232, - "lineto": 236, + "line": 245, + "lineto": 249, "args": [ { "name": "path", @@ -27557,8 +24953,8 @@ "git_checkout_perfdata_cb": { "type": "callback", "file": "git2/checkout.h", - "line": 239, - "lineto": 241, + "line": 252, + "lineto": 254, "args": [ { "name": "perfdata", @@ -27619,7 +25015,7 @@ "comment": " 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code" }, "description": "The signature of a function matching git_remote_create, with an additional\n void* as a callback payload.
\n", - "comments": "Callers of git_clone may provide a function matching this signature to override\n the remote creation and customization process during a clone operation.
\n" + "comments": "Callers of git_clone may provide a function matching this signature to override the remote creation and customization process during a clone operation.
\n" }, "git_repository_create_cb": { "type": "callback", @@ -27655,7 +25051,7 @@ "comment": " 0, or a negative value to indicate error" }, "description": "The signature of a function matchin git_repository_init, with an\n aditional void * as callback payload.
\n", - "comments": "Callers of git_clone my provide a function matching this signature\n to override the repository creation and customization process\n during a clone operation.
\n" + "comments": "Callers of git_clone my provide a function matching this signature to override the repository creation and customization process during a clone operation.
\n" }, "git_config_foreach_cb": { "type": "callback", @@ -27683,6 +25079,32 @@ "description": "A config enumeration callback
\n", "comments": "" }, + "git_headlist_cb": { + "type": "callback", + "file": "git2/deprecated.h", + "line": 409, + "lineto": 409, + "args": [ + { + "name": "rhead", + "type": "git_remote_head *", + "comment": null + }, + { + "name": "payload", + "type": "void *", + "comment": null + } + ], + "argline": "git_remote_head *rhead, void *payload", + "sig": "git_remote_head *::void *", + "return": { + "type": "int", + "comment": null + }, + "description": "Callback for listing the remote heads
\n", + "comments": "" + }, "git_diff_notify_cb": { "type": "callback", "file": "git2/diff.h", @@ -27717,7 +25139,7 @@ "comment": null }, "description": "Diff notification callback function.
\n", - "comments": "The callback will be called for each file, just before the git_diff_delta\n gets inserted into the diff.
When the callback:\n - returns \n<\n 0, the diff process will be aborted.\n - returns > 0, the delta will not be inserted into the diff, but the\n diff process continues.\n - returns 0, the delta is inserted into the diff, and the diff process\n continues.
\n" + "comments": "The callback will be called for each file, just before the git_diff_delta 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", @@ -27882,7 +25304,7 @@ "comment": null }, "description": "When iterating over a diff, callback that will be made per text diff\n line. In this context, the provided range will be NULL.
\n", - "comments": "When printing a diff, callback that will be made to output each line\n of text. This uses some extra GIT_DIFF_LINE_... constants for output\n of lines of file and hunk headers.
\n" + "comments": "When printing a diff, callback that will be made to output each line of text. This uses some extra GIT_DIFF_LINE_... constants for output of lines of file and hunk headers.
\n" }, "git_index_matched_path_cb": { "type": "callback", @@ -27915,30 +25337,30 @@ "description": "Callback for APIs that add/remove/update files matching pathspec
\n", "comments": "" }, - "git_headlist_cb": { + "git_indexer_progress_cb": { "type": "callback", - "file": "git2/net.h", - "line": 55, - "lineto": 55, + "file": "git2/indexer.h", + "line": 57, + "lineto": 57, "args": [ { - "name": "rhead", - "type": "git_remote_head *", - "comment": null + "name": "stats", + "type": "const git_indexer_progress *", + "comment": "Structure containing information about the state of the tran sfer" }, { "name": "payload", "type": "void *", - "comment": null + "comment": "Payload provided by caller" } ], - "argline": "git_remote_head *rhead, void *payload", - "sig": "git_remote_head *::void *", + "argline": "const git_indexer_progress *stats, void *payload", + "sig": "const git_indexer_progress *::void *", "return": { "type": "int", "comment": null }, - "description": "Callback for listing the remote heads
\n", + "description": "Type for progress callbacks during indexing. Return a value less\n than zero to cancel the indexing or download.
\n", "comments": "" }, "git_note_foreach_cb": { @@ -27970,13 +25392,13 @@ "comment": null }, "description": "Callback for git_note_foreach.
\n", - "comments": "Receives:\n - blob_id: Oid of the blob containing the message\n - annotated_object_id: Oid of the git object being annotated\n - payload: Payload data passed to git_note_foreach
Receives: - blob_id: Oid of the blob containing the message - annotated_object_id: Oid of the git object being annotated - payload: Payload data passed to git_note_foreach
Callback used to iterate over packed objects
\n", "comments": "" }, "git_packbuilder_progress": { "type": "callback", "file": "git2/pack.h", - "line": 210, - "lineto": 214, + "line": 221, + "lineto": 225, "args": [ { "name": "stage", @@ -28042,12 +25464,12 @@ }, { "name": "current", - "type": "int", + "type": "uint32_t", "comment": null }, { "name": "total", - "type": "int", + "type": "uint32_t", "comment": null }, { @@ -28056,8 +25478,8 @@ "comment": null } ], - "argline": "int stage, int current, int total, void *payload", - "sig": "int::int::int::void *", + "argline": "int stage, uint32_t current, uint32_t total, void *payload", + "sig": "int::uint32_t::uint32_t::void *", "return": { "type": "int", "comment": null @@ -28068,56 +25490,56 @@ "git_reference_foreach_cb": { "type": "callback", "file": "git2/refs.h", - "line": 425, - "lineto": 425, + "line": 434, + "lineto": 434, "args": [ { "name": "reference", "type": "git_reference *", - "comment": null + "comment": "The reference object" }, { "name": "payload", "type": "void *", - "comment": null + "comment": "Payload passed to git_reference_foreach" } ], "argline": "git_reference *reference, void *payload", "sig": "git_reference *::void *", "return": { "type": "int", - "comment": null + "comment": " non-zero to terminate the iteration" }, - "description": "", + "description": "Callback used to iterate over references
\n", "comments": "" }, "git_reference_foreach_name_cb": { "type": "callback", "file": "git2/refs.h", - "line": 426, - "lineto": 426, + "line": 445, + "lineto": 445, "args": [ { "name": "name", "type": "const char *", - "comment": null + "comment": "The reference name" }, { "name": "payload", "type": "void *", - "comment": null + "comment": "Payload passed to git_reference_foreach_name" } ], "argline": "const char *name, void *payload", "sig": "const char *::void *", "return": { "type": "int", - "comment": null + "comment": " non-zero to terminate the iteration" }, - "description": "", + "description": "Callback used to iterate over reference names
\n", "comments": "" }, - "git_push_transfer_progress": { + "git_push_transfer_progress_cb": { "type": "callback", "file": "git2/remote.h", "line": 425, @@ -28156,8 +25578,8 @@ "git_push_negotiation": { "type": "callback", "file": "git2/remote.h", - "line": 460, - "lineto": 460, + "line": 461, + "lineto": 461, "args": [ { "name": "updates", @@ -28187,8 +25609,8 @@ "git_push_update_reference_cb": { "type": "callback", "file": "git2/remote.h", - "line": 474, - "lineto": 474, + "line": 475, + "lineto": 475, "args": [ { "name": "refname", @@ -28213,73 +25635,109 @@ "comment": " 0 on success, otherwise an error" }, "description": "Callback used to inform of the update status from the remote.
\n", - "comments": "Called for each updated reference on push. If status is\n not NULL, the update was rejected by the remote server\n and status contains the reason given.
Called for each updated reference on push. If status is not NULL, the update was rejected by the remote server and status contains the reason given.
Callback to resolve URLs before connecting to remote
\n", + "comments": "If you return GIT_PASSTHROUGH, you don't need to write anything to url_resolved.
\n" }, "git_repository_fetchhead_foreach_cb": { "type": "callback", "file": "git2/repository.h", - "line": 643, - "lineto": 647, + "line": 655, + "lineto": 659, "args": [ { "name": "ref_name", "type": "const char *", - "comment": null + "comment": "The reference name" }, { "name": "remote_url", "type": "const char *", - "comment": null + "comment": "The remote URL" }, { "name": "oid", "type": "const git_oid *", - "comment": null + "comment": "The reference target OID" }, { "name": "is_merge", "type": "unsigned int", - "comment": null + "comment": "Was the reference the result of a merge" }, { "name": "payload", "type": "void *", - "comment": null + "comment": "Payload passed to git_repository_fetchhead_foreach" } ], "argline": "const char *ref_name, const char *remote_url, const git_oid *oid, unsigned int is_merge, void *payload", "sig": "const char *::const char *::const git_oid *::unsigned int::void *", "return": { "type": "int", - "comment": null + "comment": " non-zero to terminate the iteration" }, - "description": "", + "description": "Callback used to iterate over each FETCH_HEAD entry
\n", "comments": "" }, "git_repository_mergehead_foreach_cb": { "type": "callback", "file": "git2/repository.h", - "line": 665, - "lineto": 666, + "line": 686, + "lineto": 687, "args": [ { "name": "oid", "type": "const git_oid *", - "comment": null + "comment": "The merge OID" }, { "name": "payload", "type": "void *", - "comment": null + "comment": "Payload passed to git_repository_mergehead_foreach" } ], "argline": "const git_oid *oid, void *payload", "sig": "const git_oid *::void *", "return": { "type": "int", - "comment": null + "comment": " non-zero to terminate the iteration" }, - "description": "", + "description": "Callback used to iterate over each MERGE_HEAD entry
\n", "comments": "" }, "git_revwalk_hide_cb": { @@ -28432,374 +25890,38 @@ "description": "Function pointer to receive each submodule
\n", "comments": "" }, - "git_filter_init_fn": { - "type": "callback", - "file": "git2/sys/filter.h", - "line": 141, - "lineto": 141, - "args": [ - { - "name": "self", - "type": "git_filter *", - "comment": null - } - ], - "argline": "git_filter *self", - "sig": "git_filter *", - "return": { - "type": "int", - "comment": null - }, - "description": "Initialize callback on filter
\n", - "comments": "Specified as filter.initialize, this is an optional callback invoked\n before a filter is first used. It will be called once at most.
If non-NULL, the filter's initialize callback will be invoked right\n before the first use of the filter, so you can defer expensive\n initialization operations (in case libgit2 is being used in a way that\n doesn't need the filter).
Shutdown callback on filter
\n", - "comments": "Specified as filter.shutdown, this is an optional callback invoked\n when the filter is unregistered or when libgit2 is shutting down. It\n will be called once at most and should release resources as needed.\n This may be called even if the initialize callback was not made.
Typically this function will free the git_filter object itself.
Callback to decide if a given source needs this filter
\n", - "comments": "Specified as filter.check, this is an optional callback that checks\n if filtering is needed for a given source.
It should return 0 if the filter should be applied (i.e. success),\n GIT_PASSTHROUGH if the filter should not be applied, or an error code\n to fail out of the filter processing pipeline and return to the caller.
\n\nThe attr_values will be set to the values of any attributes given in\n the filter definition. See git_filter below for more detail.
The payload will be a pointer to a reference payload for the filter.\n This will start as NULL, but check can assign to this pointer for\n later use by the apply callback. Note that the value should be heap\n allocated (not stack), so that it doesn't go away before the apply\n callback can use it. If a filter allocates and assigns a value to the\n payload, it will need a cleanup callback to free the payload.
Callback to actually perform the data filtering
\n", - "comments": "Specified as filter.apply, this is the callback that actually filters\n data. If it successfully writes the output, it should return 0. Like\n check, it can return GIT_PASSTHROUGH to indicate that the filter\n doesn't want to run. Other error codes will stop filter processing and\n return to the caller.
The payload value will refer to any payload that was set by the\n check callback. It may be read from or written to as needed.
Callback to clean up after filtering has been applied
\n", - "comments": "Specified as filter.cleanup, this is an optional callback invoked\n after the filter has been applied. If the check or apply callbacks\n allocated a payload to keep per-source filter state, use this\n callback to free that payload and release resources as required.
Initialize callback on merge driver
\n", - "comments": "Specified as driver.initialize, this is an optional callback invoked\n before a merge driver is first used. It will be called once at most\n per library lifetime.
If non-NULL, the merge driver's initialize callback will be invoked\n right before the first use of the driver, so you can defer expensive\n initialization operations (in case libgit2 is being used in a way that\n doesn't need the merge driver).
Shutdown callback on merge driver
\n", - "comments": "Specified as driver.shutdown, this is an optional callback invoked\n when the merge driver is unregistered or when libgit2 is shutting down.\n It will be called once at most and should release resources as needed.\n This may be called even if the initialize callback was not made.
Typically this function will free the git_merge_driver object itself.
Callback to perform the merge.
\n", - "comments": "Specified as driver.apply, this is the callback that actually does the\n merge. If it can successfully perform a merge, it should populate\n path_out with a pointer to the filename to accept, mode_out with\n the resultant mode, and merged_out with the buffer of the merged file\n and then return 0. If the driver returns GIT_PASSTHROUGH, then the\n default merge driver should instead be run. It can also return\n GIT_EMERGECONFLICT if the driver is not able to produce a merge result,\n and the file will remain conflicted. Any other errors will fail and\n return to the caller.
The filter_name contains the name of the filter that was invoked, as\n specified by the file's attributes.
The src contains the data about the file to be merged.
A function which creates a new subtransport for the smart transport
\n", - "comments": "" - }, "git_tag_foreach_cb": { "type": "callback", "file": "git2/tag.h", - "line": 321, - "lineto": 321, + "line": 330, + "lineto": 330, "args": [ { "name": "name", "type": "const char *", - "comment": null + "comment": "The tag name" }, { "name": "oid", "type": "git_oid *", - "comment": null + "comment": "The tag's OID" }, { "name": "payload", "type": "void *", - "comment": null + "comment": "Payload passed to git_tag_foreach" } ], "argline": "const char *name, git_oid *oid, void *payload", "sig": "const char *::git_oid *::void *", "return": { "type": "int", - "comment": null + "comment": " non-zero to terminate the iteration" }, - "description": "", + "description": "Callback used to iterate over tag names
\n", "comments": "" }, - "git_trace_callback": { + "git_trace_cb": { "type": "callback", "file": "git2/trace.h", "line": 52, @@ -28856,108 +25978,6 @@ "description": "Signature of a function which creates a transport
\n", "comments": "" }, - "git_cred_sign_callback": { - "type": "callback", - "file": "git2/transport.h", - "line": 168, - "lineto": 168, - "args": [ - { - "name": "session", - "type": "LIBSSH2_SESSION *", - "comment": null - }, - { - "name": "sig", - "type": "unsigned char **", - "comment": null - }, - { - "name": "sig_len", - "type": "size_t *", - "comment": null - }, - { - "name": "data", - "type": "const unsigned char *", - "comment": null - }, - { - "name": "data_len", - "type": "size_t", - "comment": null - }, - { - "name": "abstract", - "type": "void **", - "comment": null - } - ], - "argline": "LIBSSH2_SESSION *session, unsigned char **sig, size_t *sig_len, const unsigned char *data, size_t data_len, void **abstract", - "sig": "LIBSSH2_SESSION *::unsigned char **::size_t *::const unsigned char *::size_t::void **", - "return": { - "type": "int", - "comment": null - }, - "description": "", - "comments": "" - }, - "git_cred_ssh_interactive_callback": { - "type": "callback", - "file": "git2/transport.h", - "line": 169, - "lineto": 169, - "args": [ - { - "name": "name", - "type": "const char *", - "comment": null - }, - { - "name": "name_len", - "type": "int", - "comment": null - }, - { - "name": "instruction", - "type": "const char *", - "comment": null - }, - { - "name": "instruction_len", - "type": "int", - "comment": null - }, - { - "name": "num_prompts", - "type": "int", - "comment": null - }, - { - "name": "prompts", - "type": "const LIBSSH2_USERAUTH_KBDINT_PROMPT *", - "comment": null - }, - { - "name": "responses", - "type": "LIBSSH2_USERAUTH_KBDINT_RESPONSE *", - "comment": null - }, - { - "name": "abstract", - "type": "void **", - "comment": null - } - ], - "argline": "const char *name, int name_len, const char *instruction, int instruction_len, int num_prompts, const LIBSSH2_USERAUTH_KBDINT_PROMPT *prompts, LIBSSH2_USERAUTH_KBDINT_RESPONSE *responses, void **abstract", - "sig": "const char *::int::const char *::int::int::const LIBSSH2_USERAUTH_KBDINT_PROMPT *::LIBSSH2_USERAUTH_KBDINT_RESPONSE *::void **", - "return": { - "type": "void", - "comment": null - }, - "description": "", - "comments": "" - }, "git_cred_acquire_cb": { "type": "callback", "file": "git2/transport.h", @@ -29023,7 +26043,7 @@ "comment": null }, "description": "Callback for git_treebuilder_filter
\n", - "comments": "The return value is treated as a boolean, with zero indicating that the\n entry should be left alone and any non-zero value meaning that the\n entry should be removed from the treebuilder list (i.e. filtered out).
\n" + "comments": "The return value is treated as a boolean, with zero indicating that the entry should be left alone and any non-zero value meaning that the entry should be removed from the treebuilder list (i.e. filtered out).
\n" }, "git_treewalk_cb": { "type": "callback", @@ -29056,37 +26076,11 @@ "description": "Callback for the tree traversal method
\n", "comments": "" }, - "git_transfer_progress_cb": { - "type": "callback", - "file": "git2/types.h", - "line": 275, - "lineto": 275, - "args": [ - { - "name": "stats", - "type": "const git_transfer_progress *", - "comment": "Structure containing information about the state of the transfer" - }, - { - "name": "payload", - "type": "void *", - "comment": "Payload provided by caller" - } - ], - "argline": "const git_transfer_progress *stats, void *payload", - "sig": "const git_transfer_progress *::void *", - "return": { - "type": "int", - "comment": null - }, - "description": "Type for progress callbacks during indexing. Return a value less than zero\n to cancel the transfer.
\n", - "comments": "" - }, "git_transport_message_cb": { "type": "callback", "file": "git2/types.h", - "line": 285, - "lineto": 285, + "line": 255, + "lineto": 255, "args": [ { "name": "str", @@ -29116,8 +26110,8 @@ "git_transport_certificate_check_cb": { "type": "callback", "file": "git2/types.h", - "line": 338, - "lineto": 338, + "line": 308, + "lineto": 308, "args": [ { "name": "cert", @@ -29152,202 +26146,6 @@ }, "globals": {}, "types": [ - [ - "LIBSSH2_SESSION", - { - "decl": "LIBSSH2_SESSION", - "type": "struct", - "value": "LIBSSH2_SESSION", - "file": "git2/transport.h", - "line": 163, - "lineto": 163, - "tdef": "typedef", - "description": "", - "comments": "", - "used": { - "returns": [], - "needs": [ - "git_cred_sign_callback" - ] - } - } - ], - [ - "LIBSSH2_USERAUTH_KBDINT_PROMPT", - { - "decl": "LIBSSH2_USERAUTH_KBDINT_PROMPT", - "type": "struct", - "value": "LIBSSH2_USERAUTH_KBDINT_PROMPT", - "file": "git2/transport.h", - "line": 164, - "lineto": 164, - "tdef": "typedef", - "description": "", - "comments": "", - "used": { - "returns": [], - "needs": [ - "git_cred_ssh_interactive_callback" - ] - } - } - ], - [ - "LIBSSH2_USERAUTH_KBDINT_RESPONSE", - { - "decl": "LIBSSH2_USERAUTH_KBDINT_RESPONSE", - "type": "struct", - "value": "LIBSSH2_USERAUTH_KBDINT_RESPONSE", - "file": "git2/transport.h", - "line": 165, - "lineto": 165, - "tdef": "typedef", - "description": "", - "comments": "", - "used": { - "returns": [], - "needs": [ - "git_cred_ssh_interactive_callback" - ] - } - } - ], - [ - "_LIBSSH2_SESSION", - { - "decl": [], - "type": "struct", - "value": "_LIBSSH2_SESSION", - "file": "git2/transport.h", - "line": 163, - "lineto": 163, - "tdef": null, - "description": "", - "comments": "", - "fields": [], - "used": { - "returns": [], - "needs": [] - } - } - ], - [ - "_LIBSSH2_USERAUTH_KBDINT_PROMPT", - { - "decl": [], - "type": "struct", - "value": "_LIBSSH2_USERAUTH_KBDINT_PROMPT", - "file": "git2/transport.h", - "line": 164, - "lineto": 164, - "tdef": null, - "description": "", - "comments": "", - "fields": [], - "used": { - "returns": [], - "needs": [] - } - } - ], - [ - "_LIBSSH2_USERAUTH_KBDINT_RESPONSE", - { - "decl": [], - "type": "struct", - "value": "_LIBSSH2_USERAUTH_KBDINT_RESPONSE", - "file": "git2/transport.h", - "line": 165, - "lineto": 165, - "tdef": null, - "description": "", - "comments": "", - "fields": [], - "used": { - "returns": [], - "needs": [] - } - } - ], - [ - "git_allocator", - { - "decl": [ - "void *(*)(size_t, const char *, int) gmalloc", - "void *(*)(size_t, size_t, const char *, int) gcalloc", - "char *(*)(const char *, const char *, int) gstrdup", - "char *(*)(const char *, size_t, const char *, int) gstrndup", - "char *(*)(const char *, size_t, const char *, int) gsubstrdup", - "void *(*)(void *, size_t, const char *, int) grealloc", - "void *(*)(void *, size_t, size_t, const char *, int) greallocarray", - "void *(*)(size_t, size_t, const char *, int) gmallocarray", - "void (*)(void *) gfree" - ], - "type": "struct", - "value": "git_allocator", - "file": "git2/sys/alloc.h", - "line": 23, - "lineto": 73, - "block": "void *(*)(size_t, const char *, int) gmalloc\nvoid *(*)(size_t, size_t, const char *, int) gcalloc\nchar *(*)(const char *, const char *, int) gstrdup\nchar *(*)(const char *, size_t, const char *, int) gstrndup\nchar *(*)(const char *, size_t, const char *, int) gsubstrdup\nvoid *(*)(void *, size_t, const char *, int) grealloc\nvoid *(*)(void *, size_t, size_t, const char *, int) greallocarray\nvoid *(*)(size_t, size_t, const char *, int) gmallocarray\nvoid (*)(void *) gfree", - "tdef": "typedef", - "description": " An instance for a custom memory allocator", - "comments": "Setting the pointers of this structure allows the developer to implement\n custom memory allocators. The global memory allocator can be set by using\n "GIT_OPT_SET_ALLOCATOR" with the git_libgit2_opts function. Keep in mind\n that all fields need to be set to a proper function.
Initialize with GIT_APPLY_OPTIONS_INIT. Alternatively, you can\n use git_apply_init_options.
Initialize with GIT_APPLY_OPTIONS_INIT. Alternatively, you can use git_apply_options_init.
The attribute has been left unspecified
\n", "value": 0 }, { "type": "int", - "name": "GIT_ATTR_TRUE_T", + "name": "GIT_ATTR_VALUE_TRUE", "comments": "The attribute has been set
\n", "value": 1 }, { "type": "int", - "name": "GIT_ATTR_FALSE_T", + "name": "GIT_ATTR_VALUE_FALSE", "comments": "The attribute has been unset
\n", "value": 2 }, { "type": "int", - "name": "GIT_ATTR_VALUE_T", + "name": "GIT_ATTR_VALUE_STRING", "comments": "This attribute has a value
\n", "value": 3 } @@ -29538,7 +26335,6 @@ "tdef": "typedef", "description": " Opaque structure to hold blame results ", "comments": "", - "fields": [], "used": { "returns": [ "git_blame_get_hunk_byindex", @@ -29550,7 +26346,9 @@ "git_blame_free", "git_blame_get_hunk_byindex", "git_blame_get_hunk_byline", - "git_blame_init_options" + "git_blame_get_hunk_count", + "git_blame_init_options", + "git_blame_options_init" ] } } @@ -29647,7 +26445,7 @@ "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 hunkfinal_commit_id is the OID of the commit where this line was last\nchanged.final_start_line_number is the 1-based line number where this hunk\nbegins, in the final version of the filefinal_signature is the author of final_commit_id. If\nGIT_BLAME_USE_MAILMAP has been specified, it will contain the canonical\nreal name and email address.orig_commit_id is the OID of the commit where this hunk was found. This\nwill usually be the same as final_commit_id, except when\nGIT_BLAME_TRACK_COPIES_ANY_COMMIT_COPIES has been specified.orig_path is the path to the file where this hunk originated, as of the\ncommit specified by orig_commit_id.orig_start_line_number is the 1-based line number where this hunk begins\nin the file named by orig_path in the commit specified by\norig_commit_id.orig_signature is the author of orig_commit_id. If\nGIT_BLAME_USE_MAILMAP has been specified, it will contain the canonical\nreal name and email address.boundary is 1 iff the hunk has been tracked to a boundary commit (the\nroot, or the commit specified in git_blame_options.oldest_commit)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 - final_signature is the author of final_commit_id. If GIT_BLAME_USE_MAILMAP has been specified, it will contain the canonical real name and email address. - 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. - orig_signature is the author of orig_commit_id. If GIT_BLAME_USE_MAILMAP has been specified, it will contain the canonical real name and email address. - 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)Initialize with GIT_BLAME_OPTIONS_INIT. Alternatively, you can use git_blame_options_init.
Sometimes libgit2 wants to return an allocated data buffer to the\n caller and have the caller take responsibility for freeing that memory.\n This can be awkward if the caller does not have easy access to the same\n allocation functions that libgit2 is using. In those cases, libgit2\n will fill in a git_buf and the caller can use git_buf_dispose() to\n release it when they are done.
A git_buf may also be used for the caller to pass in a reference to\n a block of memory they hold. In this case, libgit2 will not resize or\n 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,\nthen the git_buf is considered empty and libgit2 will feel free\nto 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\nwas allocated by libgit2. It may be larger than size. If ptr\nwas not allocated by libgit2 and should not be resized and/or freed,\nthen asize will be set to zero.
Some APIs may occasionally do something slightly unusual with a buffer,\n such as setting ptr to a value that was passed in by the user. In\n those cases, the behavior will be clearly documented by the API.
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_dispose() 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.
Checkout will invoke an options notification callback (notify_cb) for\n certain cases - you pick which ones via notify_flags:
GIT_CHECKOUT_NOTIFY_CONFLICT invokes checkout on conflicting paths.
GIT_CHECKOUT_NOTIFY_DIRTY notifies about "dirty" files, i.e. those that\ndo not need an update but no longer match the baseline. Core git\ndisplays these files when checkout runs, but won't stop the checkout.
GIT_CHECKOUT_NOTIFY_UPDATED sends notification for any file changed.
GIT_CHECKOUT_NOTIFY_UNTRACKED notifies about untracked files.
GIT_CHECKOUT_NOTIFY_IGNORED notifies about ignored files.
Returning a non-zero value from this callback will cancel the checkout.\n The non-zero return value will be propagated back and returned by the\n git_checkout_... call.
\n\nNotification callbacks are made prior to modifying any files on disk,\n so canceling on any notification will still happen prior to any files\n being modified.
\n", + "comments": "Checkout will invoke an options notification callback (notify_cb) for certain cases - you pick which ones via notify_flags:
GIT_CHECKOUT_NOTIFY_CONFLICT invokes checkout on conflicting paths.
GIT_CHECKOUT_NOTIFY_DIRTY notifies about "dirty" files, i.e. those that do not need an update but no longer match the baseline. Core git displays these files when checkout runs, but won't stop the checkout.
GIT_CHECKOUT_NOTIFY_UPDATED sends notification for any file changed.
GIT_CHECKOUT_NOTIFY_UNTRACKED notifies about untracked files.
GIT_CHECKOUT_NOTIFY_IGNORED notifies about ignored files.
Returning a non-zero value from this callback will cancel the checkout. The non-zero return value will be propagated back and returned by the git_checkout_... call.
\n\nNotification callbacks are made prior to modifying any files on disk, so canceling on any notification will still happen prior to any files being modified.
\n", "fields": [ { "type": "int", @@ -30265,12 +27059,12 @@ "type": "struct", "value": "git_checkout_options", "file": "git2/checkout.h", - "line": 250, - "lineto": 294, + "line": 263, + "lineto": 307, "block": "unsigned int version\nunsigned int checkout_strategy\nint disable_filters\nunsigned int dir_mode\nunsigned int file_mode\nint file_open_flags\nunsigned int notify_flags\ngit_checkout_notify_cb notify_cb\nvoid * notify_payload\ngit_checkout_progress_cb progress_cb\nvoid * progress_payload\ngit_strarray paths\ngit_tree * baseline\ngit_index * baseline_index\nconst char * target_directory\nconst char * ancestor_label\nconst char * our_label\nconst char * their_label\ngit_checkout_perfdata_cb perfdata_cb\nvoid * perfdata_payload", "tdef": "typedef", "description": " Checkout options structure", - "comments": "Initialize with GIT_CHECKOUT_OPTIONS_INIT. Alternatively, you can\n use git_checkout_init_options.
Initialize with GIT_CHECKOUT_OPTIONS_INIT. Alternatively, you can use git_checkout_options_init.
In libgit2, checkout is used to update the working directory and index\n to match a target tree. Unlike git checkout, it does not move the HEAD\n commit for you - use git_repository_set_head or the like to do that.
Checkout looks at (up to) four things: the "target" tree you want to\n check out, the "baseline" tree of what was checked out previously, the\n working directory for actual files, and the index for staged changes.
\n\nYou give checkout one of three strategies for update:
\n\nGIT_CHECKOUT_NONE is a dry-run strategy that checks for conflicts,\netc., but doesn't make any actual changes.
GIT_CHECKOUT_FORCE is at the opposite extreme, taking any action to\nmake the working directory match the target (including potentially\ndiscarding modified files).
GIT_CHECKOUT_SAFE is between these two options, it will only make\nmodifications that will not lose changes.
| target == baseline | target != baseline |\n---------------------|-----------------------|----------------------|\n workdir == baseline | no action | create, update, or |\n | | delete file |\n---------------------|-----------------------|----------------------|\n workdir exists and | no action | conflict (notify |\n is != baseline | notify dirty MODIFIED | and cancel checkout) |\n---------------------|-----------------------|----------------------|\n workdir missing, | notify dirty DELETED | create file |\n baseline present | | |\n---------------------|-----------------------|----------------------|
To emulate git checkout, use GIT_CHECKOUT_SAFE with a checkout\n notification callback (see below) that displays information about dirty\n files. The default behavior will cancel checkout on conflicts.
To emulate git checkout-index, use GIT_CHECKOUT_SAFE with a\n notification callback that cancels the operation if a dirty-but-existing\n file is found in the working directory. This core git command isn't\n quite "force" but is sensitive about some types of changes.
To emulate git checkout -f, use GIT_CHECKOUT_FORCE.
There are some additional flags to modify the behavior of checkout:
\n\nGIT_CHECKOUT_ALLOW_CONFLICTS makes SAFE mode apply safe file updates\neven if there are conflicts (instead of cancelling the checkout).
GIT_CHECKOUT_REMOVE_UNTRACKED means remove untracked files (i.e. not\nin target, baseline, or index, and not ignored) from the working dir.
GIT_CHECKOUT_REMOVE_IGNORED means remove ignored files (that are also\nuntracked) from the working directory as well.
GIT_CHECKOUT_UPDATE_ONLY means to only update the content of files that\nalready exist. Files will not be created nor deleted. This just skips\napplying adds, deletes, and typechanges.
GIT_CHECKOUT_DONT_UPDATE_INDEX prevents checkout from writing the\nupdated files' information to the index.
Normally, checkout will reload the index and git attributes from disk\nbefore any operations. GIT_CHECKOUT_NO_REFRESH prevents this reload.
Unmerged index entries are conflicts. GIT_CHECKOUT_SKIP_UNMERGED skips\nfiles with unmerged index entries instead. GIT_CHECKOUT_USE_OURS and\nGIT_CHECKOUT_USE_THEIRS to proceed with the checkout using either the\nstage 2 ("ours") or stage 3 ("theirs") version of files in the index.
GIT_CHECKOUT_DONT_OVERWRITE_IGNORED prevents ignored files from being\noverwritten. Normally, files that are ignored in the working directory\nare not considered "precious" and may be overwritten if the checkout\ntarget contains that file.
GIT_CHECKOUT_DONT_REMOVE_EXISTING prevents checkout from removing\nfiles or folders that fold to the same name on case insensitive\nfilesystems. This can cause files to retain their existing names\nand write through existing symbolic links.
In libgit2, checkout is used to update the working directory and index to match a target tree. Unlike git checkout, it does not move the HEAD commit for you - use git_repository_set_head or the like to do that.
Checkout looks at (up to) four things: the "target" tree you want to check out, the "baseline" tree of what was checked out previously, the working directory for actual files, and the index for staged changes.
\n\nYou give checkout one of three strategies for update:
\n\nGIT_CHECKOUT_NONE is a dry-run strategy that checks for conflicts, etc., but doesn't make any actual changes.
GIT_CHECKOUT_FORCE is at the opposite extreme, taking any action to make the working directory match the target (including potentially discarding modified files).
GIT_CHECKOUT_SAFE is between these two options, it will only make modifications that will not lose changes.
| target == baseline | target != baseline | ---------------------|-----------------------|----------------------| workdir == baseline | no action | create, update, or | | | delete file | ---------------------|-----------------------|----------------------| workdir exists and | no action | conflict (notify | is != baseline | notify dirty MODIFIED | and cancel checkout) | ---------------------|-----------------------|----------------------| workdir missing, | notify dirty DELETED | create file | baseline present | | | ---------------------|-----------------------|----------------------|\nTo emulate git checkout, use GIT_CHECKOUT_SAFE with a checkout notification callback (see below) that displays information about dirty files. The default behavior will cancel checkout on conflicts.
To emulate git checkout-index, use GIT_CHECKOUT_SAFE with a notification callback that cancels the operation if a dirty-but-existing file is found in the working directory. This core git command isn't quite "force" but is sensitive about some types of changes.
To emulate git checkout -f, use GIT_CHECKOUT_FORCE.
There are some additional flags to modify the behavior of checkout:
\n\nGIT_CHECKOUT_ALLOW_CONFLICTS makes SAFE mode apply safe file updates even if there are conflicts (instead of cancelling the checkout).
GIT_CHECKOUT_REMOVE_UNTRACKED means remove untracked files (i.e. not in target, baseline, or index, and not ignored) from the working dir.
GIT_CHECKOUT_REMOVE_IGNORED means remove ignored files (that are also untracked) from the working directory as well.
GIT_CHECKOUT_UPDATE_ONLY means to only update the content of files that already exist. Files will not be created nor deleted. This just skips applying adds, deletes, and typechanges.
GIT_CHECKOUT_DONT_UPDATE_INDEX prevents checkout from writing the updated files' information to the index.
Normally, checkout will reload the index and git attributes from disk before any operations. GIT_CHECKOUT_NO_REFRESH prevents this reload.
Unmerged index entries are conflicts. GIT_CHECKOUT_SKIP_UNMERGED skips files with unmerged index entries instead. GIT_CHECKOUT_USE_OURS and GIT_CHECKOUT_USE_THEIRS to proceed with the checkout using either the stage 2 ("ours") or stage 3 ("theirs") version of files in the index.
GIT_CHECKOUT_DONT_OVERWRITE_IGNORED prevents ignored files from being overwritten. Normally, files that are ignored in the working directory are not considered "precious" and may be overwritten if the checkout target contains that file.
GIT_CHECKOUT_DONT_REMOVE_EXISTING prevents checkout from removing files or folders that fold to the same name on case insensitive filesystems. This can cause files to retain their existing names and write through existing symbolic links.
Allow safe updates that cannot overwrite uncommitted data
\n", + "comments": "Allow safe updates that cannot overwrite uncommitted data.\n If the uncommitted changes don't conflict with the checked out files,\n the checkout will still proceed, leaving the changes intact.
\n\nMutually exclusive with GIT_CHECKOUT_FORCE.\n GIT_CHECKOUT_FORCE takes precedence over GIT_CHECKOUT_SAFE.
\n", "value": 1 }, { "type": "int", "name": "GIT_CHECKOUT_FORCE", - "comments": "Allow all updates to force working directory to look like index
\n", + "comments": "Allow all updates to force working directory to look like index.
\n\nMutually exclusive with GIT_CHECKOUT_SAFE.\n GIT_CHECKOUT_FORCE takes precedence over GIT_CHECKOUT_SAFE.
\n", "value": 2 }, { @@ -30648,7 +27442,7 @@ "returns": [], "needs": [ "git_cherrypick", - "git_cherrypick_init_options" + "git_cherrypick_options_init" ] } } @@ -30725,7 +27519,7 @@ "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\n use git_clone_init_options.
Initialize with GIT_CLONE_OPTIONS_INIT. Alternatively, you can use git_clone_options_init.
git_config_open_default() and git_repository_config() honor those\n priority levels as well.
\n", + "comments": "git_config_open_default() and git_repository_config() honor those priority levels as well.
\n", "fields": [ { "type": "int", @@ -31178,7 +27869,6 @@ "used": { "returns": [], "needs": [ - "git_config_add_backend", "git_config_add_file_ondisk", "git_config_open_level" ] @@ -31188,13 +27878,16 @@ [ "git_cred", { - "decl": "git_cred", + "decl": [ + "git_credtype_t credtype", + "void (*)(git_cred *) free" + ], "type": "struct", "value": "git_cred", "file": "git2/transport.h", - "line": 140, - "lineto": 140, - "tdef": "typedef", + "line": 145, + "lineto": 148, + "tdef": null, "description": " The base structure for all credential types", "comments": "", "fields": [ @@ -31209,6 +27902,7 @@ "comments": "" } ], + "block": "git_credtype_t credtype\nvoid (*)(git_cred *) free", "used": { "returns": [], "needs": [ @@ -31223,8 +27917,7 @@ "git_cred_ssh_key_new", "git_cred_username_new", "git_cred_userpass", - "git_cred_userpass_plaintext_new", - "git_transport_smart_credentials" + "git_cred_userpass_plaintext_new" ] } } @@ -31255,7 +27948,7 @@ "char * username", "char * publickey", "size_t publickey_len", - "git_cred_sign_callback sign_callback", + "git_cred_sign_cb sign_callback", "void * payload" ], "type": "struct", @@ -31263,7 +27956,7 @@ "file": "git2/transport.h", "line": 195, "lineto": 202, - "block": "git_cred parent\nchar * username\nchar * publickey\nsize_t publickey_len\ngit_cred_sign_callback sign_callback\nvoid * payload", + "block": "git_cred parent\nchar * username\nchar * publickey\nsize_t publickey_len\ngit_cred_sign_cb sign_callback\nvoid * payload", "tdef": "typedef", "description": " A key with a custom signature function", "comments": "", @@ -31289,7 +27982,7 @@ "comments": "" }, { - "type": "git_cred_sign_callback", + "type": "git_cred_sign_cb", "name": "sign_callback", "comments": "" }, @@ -31311,7 +28004,7 @@ "decl": [ "git_cred parent", "char * username", - "git_cred_ssh_interactive_callback prompt_callback", + "git_cred_ssh_interactive_cb prompt_callback", "void * payload" ], "type": "struct", @@ -31319,7 +28012,7 @@ "file": "git2/transport.h", "line": 185, "lineto": 190, - "block": "git_cred parent\nchar * username\ngit_cred_ssh_interactive_callback prompt_callback\nvoid * payload", + "block": "git_cred parent\nchar * username\ngit_cred_ssh_interactive_cb prompt_callback\nvoid * payload", "tdef": "typedef", "description": " Keyboard-interactive based ssh authentication", "comments": "", @@ -31335,7 +28028,7 @@ "comments": "" }, { - "type": "git_cred_ssh_interactive_callback", + "type": "git_cred_ssh_interactive_cb", "name": "prompt_callback", "comments": "" }, @@ -31532,7 +28225,7 @@ "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": " Supported credential types", - "comments": "This represents the various types of authentication methods supported by\n the library.
\n", + "comments": "This represents the various types of authentication methods supported by the library.
\n", "fields": [ { "type": "int", @@ -31698,7 +28391,7 @@ "block": "GIT_DELTA_UNMODIFIED\nGIT_DELTA_ADDED\nGIT_DELTA_DELETED\nGIT_DELTA_MODIFIED\nGIT_DELTA_RENAMED\nGIT_DELTA_COPIED\nGIT_DELTA_IGNORED\nGIT_DELTA_UNTRACKED\nGIT_DELTA_TYPECHANGE\nGIT_DELTA_UNREADABLE\nGIT_DELTA_CONFLICTED", "tdef": "typedef", "description": " What type of change is described by a git_diff_delta?", - "comments": "GIT_DELTA_RENAMED and GIT_DELTA_COPIED will only show up if you run\n git_diff_find_similar() on the diff object.
GIT_DELTA_TYPECHANGE only shows up given GIT_DIFF_INCLUDE_TYPECHANGE\n in the option flags (otherwise type changes will be split into ADDED /\n DELETED pairs).
GIT_DELTA_RENAMED and GIT_DELTA_COPIED will only show up if you run git_diff_find_similar() on the diff object.
GIT_DELTA_TYPECHANGE only shows up given GIT_DIFF_INCLUDE_TYPECHANGE in the option flags (otherwise type changes will be split into ADDED / DELETED pairs).
Initialize with GIT_DESCRIBE_FORMAT_OPTIONS_INIT. Alternatively, you can\n use git_describe_format_init_options.
Initialize with GIT_DESCRIBE_FORMAT_OPTIONS_INIT. Alternatively, you can use git_describe_format_options_init.
Initialize with GIT_DESCRIBE_OPTIONS_INIT. Alternatively, you can\n use git_describe_init_options.
Initialize with GIT_DESCRIBE_OPTIONS_INIT. Alternatively, you can use git_describe_options_init.
These behave like the --tags and --all options to git-describe,\n namely they say to look for any reference in either refs/tags/ or\n refs/ respectively.
\n", + "comments": "These behave like the --tags and --all options to git-describe, namely they say to look for any reference in either refs/tags/ or refs/ respectively.
\n", "fields": [ { "type": "int", @@ -31964,8 +28656,7 @@ "lineto": 193, "tdef": "typedef", "description": " The diff object that contains all individual file deltas.", - "comments": "A diff represents the cumulative list of differences between two\n snapshots of a repository (possibly filtered by a set of file name\n patterns).
Calculating diffs is generally done in two phases: building a list of\n diffs then traversing it. This makes is easier to share logic across\n the various types of diffs (tree vs tree, workdir vs index, etc.), and\n also allows you to insert optional diff post-processing phases,\n such as rename detection, in between the steps. When you are done with\n a diff object, it must be freed.
\n\nThis is an opaque structure which will be allocated by one of the diff\n generator functions below (such as git_diff_tree_to_tree). You are\n responsible for releasing the object memory when done, using the\n git_diff_free() function.
A diff represents the cumulative list of differences between two snapshots of a repository (possibly filtered by a set of file name patterns).
Calculating diffs is generally done in two phases: building a list of diffs then traversing it. This makes is easier to share logic across the various types of diffs (tree vs tree, workdir vs index, etc.), and also allows you to insert optional diff post-processing phases, such as rename detection, in between the steps. When you are done with a diff object, it must be freed.
\n\nThis 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.
A binary file / delta is a file (or pair) for which no text diffs\n should be generated. A diff can contain delta entries that are\n binary, but no diff content will be output for those files. There is\n a base heuristic for binary detection and you can further tune the\n behavior with git attributes or diff flags and option settings.
A binary file / delta is a file (or pair) for which no text diffs should be generated. A diff can contain delta entries that are binary, but no diff content will be output for those files. There is a base heuristic for binary detection and you can further tune the behavior with git attributes or diff flags and option settings.
A delta is a file pair with an old and new revision. The old version may be absent if the file was just created and the new version may be absent if the file was deleted. A diff is mostly just a list of deltas.
When iterating over a diff, this will be passed to most callbacks and you can use the contents to understand exactly what has changed.
\n\nThe old_file represents the "from" side of the diff and the new_file represents to "to" side of the diff. What those means depend on the function that was used to generate the diff and will be documented below. You can also use the GIT_DIFF_REVERSE flag to flip it around.
Although the two sides of the delta are named "old_file" and "new_file", they actually may correspond to entries that represent a file, a symbolic link, a submodule commit id, or even a tree (if you are tracking type changes or ignored/untracked directories).
\n\nUnder some circumstances, in the name of efficiency, not all fields will be filled in, but we generally try to fill in as much as possible. One example is that the "flags" field may not have either the BINARY or the NOT_BINARY flag set to avoid examining file contents if you do not pass in hunk and/or line callbacks to the diff foreach iteration function. It will just use the git attributes for those files.
The similarity score is zero unless you call git_diff_find_similar() which does a similarity analysis of files in the diff. Use that function to do rename and copy detection, and to split heavily modified files in add/delete pairs. After that call, deltas with a status of GIT_DELTA_RENAMED or GIT_DELTA_COPIED will have a similarity score between 0 and 100 indicating how similar the old and new sides are.
If you ask git_diff_find_similar to find heavily modified files to break, but to not actually break the records, then GIT_DELTA_MODIFIED records may have a non-zero similarity score if the self-similarity is below the split threshold. To display this value like core Git, invert the score (a la printf("M%03d", 100 - delta->similarity)).
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.
These options mostly mimic parameters that can be passed to git-diff.
\n", "fields": [ { "type": "unsigned int", @@ -32331,29 +29016,29 @@ "comments": "" }, { - "type": "int", + "type": "uint32_t", "name": "flags", - "comments": "" + "comments": " Combination of git_diff_find_t values (default GIT_DIFF_FIND_BY_CONFIG).\n NOTE: if you don't explicitly set this, `diff.renames` could be set\n to false, resulting in `git_diff_find_similar` doing nothing." }, { - "type": "int", + "type": "uint16_t", "name": "rename_threshold", - "comments": "" + "comments": " Threshold above which similar files will be considered renames.\n This is equivalent to the -M option. Defaults to 50." }, { - "type": "int", + "type": "uint16_t", "name": "rename_from_rewrite_threshold", - "comments": "" + "comments": " Threshold below which similar files will be eligible to be a rename source.\n This is equivalent to the first part of the -B option. Defaults to 50." }, { - "type": "int", + "type": "uint16_t", "name": "copy_threshold", - "comments": "" + "comments": " Threshold above which similar files will be considered copies.\n This is equivalent to the -C option. Defaults to 50." }, { - "type": "int", + "type": "uint16_t", "name": "break_rewrite_threshold", - "comments": "" + "comments": " Treshold below which similar files will be split into a delete/add pair.\n This is equivalent to the last part of the -B option. Defaults to 60." }, { "type": "size_t", @@ -32369,7 +29054,7 @@ "used": { "returns": [], "needs": [ - "git_diff_find_init_options", + "git_diff_find_options_init", "git_diff_find_similar" ] } @@ -32524,7 +29209,7 @@ "block": "GIT_DIFF_FLAG_BINARY\nGIT_DIFF_FLAG_NOT_BINARY\nGIT_DIFF_FLAG_VALID_ID\nGIT_DIFF_FLAG_EXISTS", "tdef": "typedef", "description": " Flags for the delta object and the file objects on each side.", - "comments": "These flags are used for both the flags value of the git_diff_delta\n and the flags for the git_diff_file objects representing the old and\n new sides of the delta. Values outside of this public range should be\n considered reserved for internal or future use.
These flags are used for both the flags value of the git_diff_delta and the flags for the git_diff_file objects representing the old and new sides of the delta. Values outside of this public range should be considered reserved for internal or future use.
A hunk is a span of modified lines in a delta along with some stable\n surrounding context. You can configure the amount of context and other\n properties of how hunks are generated. Each hunk also comes with a\n header that described where it starts and ends in both the old and new\n versions in the delta.
A hunk is a span of modified lines in a delta along with some stable surrounding context. You can configure the amount of context and other properties of how hunks are generated. Each hunk also comes with a header that described where it starts and ends in both the old and new versions in the delta.
A line is a range of characters inside a hunk. It could be a context\n line (i.e. in both old and new versions), an added line (i.e. only in\n the new version), or a removed line (i.e. only in the old version).\n Unfortunately, we don't know anything about the encoding of data in the\n file being diffed, so we cannot tell you much about the line content.\n Line data will not be NUL-byte terminated, however, because it will be\n just a span of bytes inside the larger file.
A line is a range of characters inside a hunk. It could be a context line (i.e. in both old and new versions), an added line (i.e. only in the new version), or a removed line (i.e. only in the old version). Unfortunately, we don't know anything about the encoding of data in the file being diffed, so we cannot tell you much about the line content. Line data will not be NUL-byte terminated, however, because it will be just a span of bytes inside the larger file.
These values describe where a line came from and will be passed to\n the git_diff_line_cb when iterating over a diff. There are some\n special origin constants at the end that are used for the text\n output callbacks to demarcate lines that are actually part of\n the file or hunk headers.
\n", + "comments": "These values describe where a line came from and will be passed to the git_diff_line_cb when iterating over a diff. There are some special origin constants at the end that are used for the text output callbacks to demarcate lines that are actually part of the file or hunk headers.
\n", "fields": [ { "type": "int", @@ -33190,15 +29871,15 @@ { "decl": [ "unsigned int version", - "int flags", + "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", - "int context_lines", - "int interhunk_lines", - "int id_abbrev", + "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" @@ -33208,10 +29889,10 @@ "file": "git2/diff.h", "line": 361, "lineto": 433, - "block": "unsigned int version\nint flags\ngit_submodule_ignore_t ignore_submodules\ngit_strarray pathspec\ngit_diff_notify_cb notify_cb\ngit_diff_progress_cb progress_cb\nvoid * payload\nint context_lines\nint interhunk_lines\nint id_abbrev\ngit_off_t max_size\nconst char * old_prefix\nconst char * new_prefix", + "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": "", - "comments": "", + "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", "fields": [ { "type": "unsigned int", @@ -33219,9 +29900,9 @@ "comments": " version for the struct " }, { - "type": "int", + "type": "uint32_t", "name": "flags", - "comments": "" + "comments": " A combination of `git_diff_option_t` values above.\n Defaults to GIT_DIFF_NORMAL" }, { "type": "git_submodule_ignore_t", @@ -33249,19 +29930,19 @@ "comments": " The payload to pass to the callback functions. " }, { - "type": "int", + "type": "uint32_t", "name": "context_lines", - "comments": "" + "comments": " The number of unchanged lines that define the boundary of a hunk\n (and to display before and after). Defaults to 3." }, { - "type": "int", + "type": "uint32_t", "name": "interhunk_lines", - "comments": "" + "comments": " The maximum number of unchanged lines between hunk boundaries before\n the hunks will be merged into one. Defaults to 0." }, { - "type": "int", + "type": "uint16_t", "name": "id_abbrev", - "comments": "" + "comments": " The abbreviation length to use when formatting object ids.\n Defaults to the value of 'core.abbrev' from the config, or 7 if unset." }, { "type": "git_off_t", @@ -33288,7 +29969,7 @@ "git_diff_commit_as_email", "git_diff_index_to_index", "git_diff_index_to_workdir", - "git_diff_init_options", + "git_diff_options_init", "git_diff_tree_to_index", "git_diff_tree_to_tree", "git_diff_tree_to_workdir", @@ -33314,7 +29995,7 @@ "block": "unsigned int version", "tdef": "typedef", "description": " Patch ID options structure", - "comments": "Initialize with GIT_PATCHID_OPTIONS_INIT. Alternatively, you can\n use git_patchid_init_options.
Initialize with GIT_PATCHID_OPTIONS_INIT. Alternatively, you can use git_diff_patchid_options_init.
We need this because we need to know whether we should call\n git-upload-pack or git-receive-pack on the remote end when get_refs\n gets called.
\n", + "comments": "We need this because we need to know whether we should call git-upload-pack or git-receive-pack on the remote end when get_refs gets called.
\n", "fields": [ { "type": "int", @@ -33564,7 +30201,7 @@ "block": "char * message\nint klass", "tdef": "typedef", "description": " Structure to store extra details of the last error that occurred.", - "comments": "This is kept on a per-thread basis if GIT_THREADS was defined when the\n library was build, otherwise one is kept globally for the library
\n", + "comments": "This is kept on a per-thread basis if GIT_THREADS was defined when the library was build, otherwise one is kept globally for the library
\n", "fields": [ { "type": "char *", @@ -34087,8 +30724,8 @@ ], "type": "enum", "file": "git2/common.h", - "line": 130, - "lineto": 153, + "line": 127, + "lineto": 150, "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", @@ -34140,12 +30777,12 @@ "type": "struct", "value": "git_fetch_options", "file": "git2/remote.h", - "line": 629, - "lineto": 666, + "line": 651, + "lineto": 688, "block": "int version\ngit_remote_callbacks callbacks\ngit_fetch_prune_t prune\nint update_fetchhead\ngit_remote_autotag_option_t download_tags\ngit_proxy_options proxy_opts\ngit_strarray custom_headers", "tdef": "typedef", "description": " Fetch options structure.", - "comments": "Zero out for defaults. Initialize with GIT_FETCH_OPTIONS_INIT macro to\n correctly set the version field. E.g.
git_fetch_options opts = GIT_FETCH_OPTIONS_INIT;\nZero 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;\nThis represents a filter that can be used to transform or even replace\n file data. Libgit2 includes one built in filter and it is possible to\n write your own (see git2/sys/filter.h for information on that).
\n\nThe two builtin filters are:
\n\nThis represents a filter that can be used to transform or even replace file data. Libgit2 includes one built in filter and it is possible to write your own (see git2/sys/filter.h for information on that).
\n\nThe two builtin filters are:
\n\nThis represents a list of filters to be applied to a file / blob. You\n can build the list with one call, apply it with another, and dispose it\n with a third. In typical usage, there are not many occasions where a\n git_filter_list is needed directly since the library will generally\n handle conversions for you, but it can be convenient to be able to\n build and apply the list sometimes.
\n", - "fields": [], + "comments": "This represents a list of filters to be applied to a file / blob. You can build the list with one call, apply it with another, and dispose it with a third. In typical usage, there are not many occasions where a git_filter_list is needed directly since the library will generally handle conversions for you, but it can be convenient to be able to build and apply the list sometimes.
\n", "used": { "returns": [], "needs": [ @@ -34447,10 +31023,7 @@ "git_filter_list_apply_to_file", "git_filter_list_contains", "git_filter_list_free", - "git_filter_list_length", "git_filter_list_load", - "git_filter_list_new", - "git_filter_list_push", "git_filter_list_stream_blob", "git_filter_list_stream_data", "git_filter_list_stream_file" @@ -34502,12 +31075,9 @@ } ], "used": { - "returns": [ - "git_filter_source_mode" - ], + "returns": [], "needs": [ - "git_filter_list_load", - "git_filter_list_new" + "git_filter_list_load" ] } } @@ -34524,42 +31094,9 @@ "tdef": "typedef", "description": " A filter source represents a file/blob to be processed", "comments": "", - "fields": [], - "used": { - "returns": [], - "needs": [ - "git_filter_apply_fn", - "git_filter_check_fn", - "git_filter_source_id", - "git_filter_source_mode", - "git_filter_source_path", - "git_filter_source_repo", - "git_filter_stream_fn" - ] - } - } - ], - [ - "git_hashsig", - { - "decl": "git_hashsig", - "type": "struct", - "value": "git_hashsig", - "file": "git2/sys/hashsig.h", - "line": 17, - "lineto": 17, - "tdef": "typedef", - "description": " Similarity signature of arbitrary text content based on line hashes", - "comments": "", - "fields": [], "used": { "returns": [], - "needs": [ - "git_hashsig_compare", - "git_hashsig_create", - "git_hashsig_create_fromfile", - "git_hashsig_free" - ] + "needs": [] } } ], @@ -34579,7 +31116,7 @@ "block": "GIT_HASHSIG_NORMAL\nGIT_HASHSIG_IGNORE_WHITESPACE\nGIT_HASHSIG_SMART_WHITESPACE\nGIT_HASHSIG_ALLOW_SMALL_FILES", "tdef": "typedef", "description": " Options for hashsig computation", - "comments": "The options GIT_HASHSIG_NORMAL, GIT_HASHSIG_IGNORE_WHITESPACE,\n GIT_HASHSIG_SMART_WHITESPACE are exclusive and should not be combined.
\n", + "comments": "The options GIT_HASHSIG_NORMAL, GIT_HASHSIG_IGNORE_WHITESPACE, GIT_HASHSIG_SMART_WHITESPACE are exclusive and should not be combined.
\n", "fields": [ { "type": "int", @@ -34608,10 +31145,7 @@ ], "used": { "returns": [], - "needs": [ - "git_hashsig_create", - "git_hashsig_create_fromfile" - ] + "needs": [] } } ], @@ -34627,17 +31161,11 @@ "tdef": "typedef", "description": " Memory representation of an index file. ", "comments": "", - "fields": [], "used": { "returns": [ "git_index_get_byindex", "git_index_get_bypath", - "git_index_name_get_byindex", - "git_index_reuc_get_byindex", - "git_index_reuc_get_bypath", - "git_merge_driver_source_ancestor", - "git_merge_driver_source_ours", - "git_merge_driver_source_theirs" + "git_remote_stats" ], "needs": [ "git_apply_to_tree", @@ -34649,7 +31177,7 @@ "git_index_add", "git_index_add_all", "git_index_add_bypath", - "git_index_add_frombuffer", + "git_index_add_from_buffer", "git_index_caps", "git_index_checksum", "git_index_clear", @@ -34672,10 +31200,6 @@ "git_index_iterator_free", "git_index_iterator_new", "git_index_iterator_next", - "git_index_name_add", - "git_index_name_clear", - "git_index_name_entrycount", - "git_index_name_get_byindex", "git_index_new", "git_index_open", "git_index_owner", @@ -34686,13 +31210,6 @@ "git_index_remove_all", "git_index_remove_bypath", "git_index_remove_directory", - "git_index_reuc_add", - "git_index_reuc_clear", - "git_index_reuc_entrycount", - "git_index_reuc_find", - "git_index_reuc_get_byindex", - "git_index_reuc_get_bypath", - "git_index_reuc_remove", "git_index_set_caps", "git_index_set_version", "git_index_update_all", @@ -34704,15 +31221,17 @@ "git_indexer_commit", "git_indexer_free", "git_indexer_hash", - "git_indexer_init_options", "git_indexer_new", + "git_indexer_options_init", + "git_indexer_progress_cb", "git_merge_commits", "git_merge_file_from_index", "git_merge_trees", + "git_odb_write_pack", + "git_packbuilder_write", "git_pathspec_match_index", "git_rebase_inmemory_index", "git_repository_index", - "git_repository_set_index", "git_revert_commit" ] } @@ -34828,7 +31347,6 @@ "tdef": "typedef", "description": " An iterator for conflicts in the index. ", "comments": "", - "fields": [], "used": { "returns": [], "needs": [ @@ -34845,15 +31363,15 @@ "decl": [ "git_index_time ctime", "git_index_time mtime", - "int dev", - "int ino", - "int mode", - "int uid", - "int gid", - "int file_size", + "uint32_t dev", + "uint32_t ino", + "uint32_t mode", + "uint32_t uid", + "uint32_t gid", + "uint32_t file_size", "git_oid id", - "int flags", - "int flags_extended", + "uint16_t flags", + "uint16_t flags_extended", "const char * path" ], "type": "struct", @@ -34861,10 +31379,10 @@ "file": "git2/index.h", "line": 53, "lineto": 70, - "block": "git_index_time ctime\ngit_index_time mtime\nint dev\nint ino\nint mode\nint uid\nint gid\nint file_size\ngit_oid id\nint flags\nint flags_extended\nconst char * path", + "block": "git_index_time ctime\ngit_index_time mtime\nuint32_t dev\nuint32_t ino\nuint32_t mode\nuint32_t uid\nuint32_t gid\nuint32_t file_size\ngit_oid id\nuint16_t flags\nuint16_t flags_extended\nconst char * path", "tdef": "typedef", - "description": "", - "comments": "", + "description": " In-memory representation of a file entry in the index.", + "comments": "This is a public structure that represents a file entry in the index. The meaning of the fields corresponds to core Git's documentation (in "Documentation/technical/index-format.txt").
\n\nThe flags field consists of a number of bit fields which can be accessed via the first set of GIT_INDEX_ENTRY_... bitmasks below. These flags are all read from and persisted to disk.
The flags_extended field also has a number of bit fields which can be accessed via the later GIT_INDEX_ENTRY_... bitmasks below. Some of these flags are read from and written to disk, but some are set aside for in-memory only reference.
Note that the time and size fields are truncated to 32 bits. This is enough to detect changes, which is enough for the index to function as a cache, but it should not be taken as an authoritative source for that data.
\n", "fields": [ { "type": "git_index_time", @@ -34877,32 +31395,32 @@ "comments": "" }, { - "type": "int", + "type": "uint32_t", "name": "dev", "comments": "" }, { - "type": "int", + "type": "uint32_t", "name": "ino", "comments": "" }, { - "type": "int", + "type": "uint32_t", "name": "mode", "comments": "" }, { - "type": "int", + "type": "uint32_t", "name": "uid", "comments": "" }, { - "type": "int", + "type": "uint32_t", "name": "gid", "comments": "" }, { - "type": "int", + "type": "uint32_t", "name": "file_size", "comments": "" }, @@ -34912,12 +31430,12 @@ "comments": "" }, { - "type": "int", + "type": "uint16_t", "name": "flags", "comments": "" }, { - "type": "int", + "type": "uint16_t", "name": "flags_extended", "comments": "" }, @@ -34930,14 +31448,11 @@ "used": { "returns": [ "git_index_get_byindex", - "git_index_get_bypath", - "git_merge_driver_source_ancestor", - "git_merge_driver_source_ours", - "git_merge_driver_source_theirs" + "git_index_get_bypath" ], "needs": [ "git_index_add", - "git_index_add_frombuffer", + "git_index_add_from_buffer", "git_index_conflict_add", "git_index_conflict_get", "git_index_conflict_next", @@ -34965,7 +31480,7 @@ "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\n fields that are read from and written to disk, and other fields that\n in-memory only and used by libgit2. Only the flags in\n GIT_INDEX_ENTRY_EXTENDED_FLAGS will get saved on-disk.
Thee first three bitmasks match the three fields in the\n git_index_entry flags_extended value that belong on disk. You\n 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\n flags_extended value that are only used in-memory by libgit2.\n You can use them to interpret the data in the flags_extended.
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.
These are used to select which global option to set or get and are\n used in git_libgit2_opts().
These are used to select which global option to set or get and are used in git_libgit2_opts().
@\n{
\n", - "fields": [ - { - "type": "unsigned int", - "name": "version", - "comments": " The `version` should be set to `GIT_MERGE_DRIVER_VERSION`. " - }, - { - "type": "git_merge_driver_init_fn", - "name": "initialize", - "comments": " Called when the merge driver is first used for any file. " - }, - { - "type": "git_merge_driver_shutdown_fn", - "name": "shutdown", - "comments": " Called when the merge driver is unregistered from the system. " - }, - { - "type": "git_merge_driver_apply_fn", - "name": "apply", - "comments": " Called to merge the contents of a conflict. If this function\n returns `GIT_PASSTHROUGH` then the default (`text`) merge driver\n will instead be invoked. If this function returns\n `GIT_EMERGECONFLICT` then the file will remain conflicted." - } - ], - "used": { - "returns": [ - "git_merge_driver_lookup" - ], - "needs": [ - "git_merge_driver_apply_fn", - "git_merge_driver_init_fn", - "git_merge_driver_register", - "git_merge_driver_shutdown_fn", - "git_merge_driver_source_ancestor", - "git_merge_driver_source_file_options", - "git_merge_driver_source_ours", - "git_merge_driver_source_repo", - "git_merge_driver_source_theirs" - ] - } - } - ], [ "git_merge_driver_source", { @@ -35687,17 +32127,9 @@ "tdef": "typedef", "description": " A merge driver source represents the file to be merged", "comments": "", - "fields": [], "used": { "returns": [], - "needs": [ - "git_merge_driver_apply_fn", - "git_merge_driver_source_ancestor", - "git_merge_driver_source_file_options", - "git_merge_driver_source_ours", - "git_merge_driver_source_repo", - "git_merge_driver_source_theirs" - ] + "needs": [] } } ], @@ -35884,7 +32316,7 @@ "returns": [], "needs": [ "git_merge_file", - "git_merge_file_init_input" + "git_merge_file_input_init" ] } } @@ -35948,13 +32380,11 @@ } ], "used": { - "returns": [ - "git_merge_driver_source_file_options" - ], + "returns": [], "needs": [ "git_merge_file", "git_merge_file_from_index", - "git_merge_file_init_options" + "git_merge_file_options_init" ] } } @@ -35972,8 +32402,8 @@ "type": "struct", "value": "git_merge_file_result", "file": "git2/merge.h", - "line": 222, - "lineto": 243, + "line": 220, + "lineto": 241, "block": "unsigned int automergeable\nconst char * path\nunsigned int mode\nconst char * ptr\nsize_t len", "tdef": "typedef", "description": " Information about file-level merging", @@ -36081,8 +32511,8 @@ "type": "struct", "value": "git_merge_options", "file": "git2/merge.h", - "line": 248, - "lineto": 297, + "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", "tdef": "typedef", "description": " Merging options", @@ -36140,7 +32570,7 @@ "git_cherrypick_commit", "git_merge", "git_merge_commits", - "git_merge_init_options", + "git_merge_options_init", "git_merge_trees", "git_revert_commit" ] @@ -36157,8 +32587,8 @@ ], "type": "enum", "file": "git2/merge.h", - "line": 354, - "lineto": 372, + "line": 350, + "lineto": 368, "block": "GIT_MERGE_PREFERENCE_NONE\nGIT_MERGE_PREFERENCE_NO_FASTFORWARD\nGIT_MERGE_PREFERENCE_FASTFORWARD_ONLY", "tdef": "typedef", "description": " The user's stated preference for merges.", @@ -36245,7 +32675,7 @@ "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\n and should not be used by callers.
\n", + "comments": "Struct members under the private comment are private, subject to change and should not be used by callers.
\n", "fields": [ { "type": "git_message_trailer *", @@ -36284,7 +32714,6 @@ "tdef": "typedef", "description": " Representation of a git note ", "comments": "", - "fields": [], "used": { "returns": [], "needs": [ @@ -36339,7 +32768,6 @@ "tdef": "typedef", "description": " Representation of a generic object in a repository ", "comments": "", - "fields": [], "used": { "returns": [ "git_object_string2type", @@ -36351,7 +32779,6 @@ "needs": [ "git_checkout_tree", "git_describe_commit", - "git_object__size", "git_object_dup", "git_object_free", "git_object_id", @@ -36361,6 +32788,7 @@ "git_object_owner", "git_object_peel", "git_object_short_id", + "git_object_size", "git_object_type", "git_object_type2string", "git_object_typeisloose", @@ -36466,11 +32894,11 @@ "git_tree_entry_type" ], "needs": [ - "git_object__size", "git_object_lookup", "git_object_lookup_bypath", "git_object_lookup_prefix", "git_object_peel", + "git_object_size", "git_object_type2string", "git_object_typeisloose", "git_odb_hash", @@ -36497,19 +32925,14 @@ "tdef": "typedef", "description": " An open object database handle. ", "comments": "", - "fields": [], "used": { "returns": [], "needs": [ "git_indexer_new", - "git_mempack_dump", - "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_malloc", "git_odb_backend_one_pack", "git_odb_backend_pack", "git_odb_exists", @@ -36518,7 +32941,6 @@ "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", @@ -36541,7 +32963,6 @@ "git_odb_write", "git_odb_write_pack", "git_repository_odb", - "git_repository_set_odb", "git_repository_wrap_odb" ] } @@ -36556,101 +32977,18 @@ "file": "git2/types.h", "line": 85, "lineto": 85, - "block": "unsigned int version\ngit_odb * odb\nint (*)(void **, size_t *, git_object_t *, git_odb_backend *, const git_oid *) read\nint (*)(git_oid *, void **, size_t *, git_object_t *, git_odb_backend *, const git_oid *, size_t) read_prefix\nint (*)(size_t *, git_object_t *, git_odb_backend *, const git_oid *) read_header\nint (*)(git_odb_backend *, const git_oid *, const void *, size_t, git_object_t) write\nint (*)(git_odb_stream **, git_odb_backend *, git_off_t, git_object_t) writestream\nint (*)(git_odb_stream **, size_t *, git_object_t *, git_odb_backend *, const git_oid *) readstream\nint (*)(git_odb_backend *, const git_oid *) exists\nint (*)(git_oid *, git_odb_backend *, const git_oid *, size_t) exists_prefix\nint (*)(git_odb_backend *) refresh\nint (*)(git_odb_backend *, git_odb_foreach_cb, void *) foreach\nint (*)(git_odb_writepack **, git_odb_backend *, git_odb *, git_transfer_progress_cb, void *) writepack\nint (*)(git_odb_backend *, const git_oid *) freshen\nvoid (*)(git_odb_backend *) free", "tdef": "typedef", "description": " A custom backend in an ODB ", "comments": "", - "fields": [ - { - "type": "unsigned int", - "name": "version", - "comments": "" - }, - { - "type": "git_odb *", - "name": "odb", - "comments": "" - }, - { - "type": "int (*)(void **, size_t *, git_object_t *, git_odb_backend *, const git_oid *)", - "name": "read", - "comments": "" - }, - { - "type": "int (*)(git_oid *, void **, size_t *, git_object_t *, git_odb_backend *, const git_oid *, size_t)", - "name": "read_prefix", - "comments": "" - }, - { - "type": "int (*)(size_t *, git_object_t *, git_odb_backend *, const git_oid *)", - "name": "read_header", - "comments": "" - }, - { - "type": "int (*)(git_odb_backend *, const git_oid *, const void *, size_t, git_object_t)", - "name": "write", - "comments": "" - }, - { - "type": "int (*)(git_odb_stream **, git_odb_backend *, git_off_t, git_object_t)", - "name": "writestream", - "comments": "" - }, - { - "type": "int (*)(git_odb_stream **, size_t *, git_object_t *, git_odb_backend *, const git_oid *)", - "name": "readstream", - "comments": "" - }, - { - "type": "int (*)(git_odb_backend *, const git_oid *)", - "name": "exists", - "comments": "" - }, - { - "type": "int (*)(git_oid *, git_odb_backend *, const git_oid *, size_t)", - "name": "exists_prefix", - "comments": "" - }, - { - "type": "int (*)(git_odb_backend *)", - "name": "refresh", - "comments": "" - }, - { - "type": "int (*)(git_odb_backend *, git_odb_foreach_cb, void *)", - "name": "foreach", - "comments": "" - }, - { - "type": "int (*)(git_odb_writepack **, git_odb_backend *, git_odb *, git_transfer_progress_cb, void *)", - "name": "writepack", - "comments": "" - }, - { - "type": "int (*)(git_odb_backend *, const git_oid *)", - "name": "freshen", - "comments": "" - }, - { - "type": "void (*)(git_odb_backend *)", - "name": "free", - "comments": "" - } - ], "used": { "returns": [], "needs": [ - "git_mempack_dump", - "git_mempack_new", - "git_mempack_reset", "git_odb_add_alternate", "git_odb_add_backend", "git_odb_backend_loose", - "git_odb_backend_malloc", "git_odb_backend_one_pack", "git_odb_backend_pack", - "git_odb_get_backend", - "git_odb_init_backend" + "git_odb_get_backend" ] } } @@ -36666,8 +33004,8 @@ "type": "struct", "value": "git_odb_expand_id", "file": "git2/odb.h", - "line": 180, - "lineto": 195, + "line": 181, + "lineto": 196, "block": "git_oid id\nunsigned short length\ngit_object_t type", "tdef": "typedef", "description": " The information about object IDs to query in `git_odb_expand_ids`,\n which will be populated upon return.", @@ -36709,7 +33047,6 @@ "tdef": "typedef", "description": " An object read from the ODB ", "comments": "", - "fields": [], "used": { "returns": [], "needs": [ @@ -36808,8 +33145,8 @@ ], "type": "enum", "file": "git2/odb_backend.h", - "line": 70, - "lineto": 74, + "line": 71, + "lineto": 75, "block": "GIT_STREAM_RDONLY\nGIT_STREAM_WRONLY\nGIT_STREAM_RW", "tdef": "typedef", "description": " Streaming mode ", @@ -36849,7 +33186,7 @@ "file": "git2/types.h", "line": 94, "lineto": 94, - "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", + "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": "", @@ -36860,12 +33197,12 @@ "comments": "" }, { - "type": "int (*)(git_odb_writepack *, const void *, size_t, git_transfer_progress *)", + "type": "int (*)(git_odb_writepack *, const void *, size_t, git_indexer_progress *)", "name": "append", "comments": "" }, { - "type": "int (*)(git_odb_writepack *, git_transfer_progress *)", + "type": "int (*)(git_odb_writepack *, git_indexer_progress *)", "name": "commit", "comments": "" }, @@ -36912,7 +33249,6 @@ "git_commit_id", "git_commit_parent_id", "git_commit_tree_id", - "git_filter_source_id", "git_index_checksum", "git_indexer_hash", "git_note_id", @@ -36920,6 +33256,8 @@ "git_odb_object_id", "git_oid_shorten_new", "git_packbuilder_hash", + "git_rebase_onto_id", + "git_rebase_orig_head_id", "git_reference_target", "git_reference_target_peel", "git_reflog_entry_id_new", @@ -36935,16 +33273,15 @@ "needs": [ "git_annotated_commit_from_fetchhead", "git_annotated_commit_lookup", - "git_blob_create_frombuffer", - "git_blob_create_fromdisk", - "git_blob_create_fromstream_commit", + "git_blob_create_from_buffer", + "git_blob_create_from_disk", + "git_blob_create_from_stream_commit", + "git_blob_create_from_workdir", "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_from_ids", "git_commit_create_v", "git_commit_create_with_signature", "git_commit_extract_signature", @@ -36953,7 +33290,6 @@ "git_diff_patchid", "git_graph_ahead_behind", "git_graph_descendant_of", - "git_index_reuc_add", "git_index_write_tree", "git_index_write_tree_to", "git_merge_base", @@ -36990,6 +33326,7 @@ "git_oid_fromstr", "git_oid_fromstrn", "git_oid_fromstrp", + "git_oid_is_zero", "git_oid_iszero", "git_oid_ncmp", "git_oid_nfmt", @@ -37006,7 +33343,6 @@ "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", @@ -37024,7 +33360,7 @@ "git_stash_save", "git_tag_annotation_create", "git_tag_create", - "git_tag_create_frombuffer", + "git_tag_create_from_buffer", "git_tag_create_lightweight", "git_tag_foreach_cb", "git_tag_lookup", @@ -37053,7 +33389,6 @@ "tdef": "typedef", "description": " OID Shortener object", "comments": "", - "fields": [], "used": { "returns": [ "git_oid_shorten_new" @@ -37115,7 +33450,6 @@ "tdef": "typedef", "description": " Representation of a git packbuilder ", "comments": "", - "fields": [], "used": { "returns": [], "needs": [ @@ -37147,8 +33481,8 @@ ], "type": "enum", "file": "git2/pack.h", - "line": 51, - "lineto": 54, + "line": 52, + "lineto": 55, "block": "GIT_PACKBUILDER_ADDING_OBJECTS\nGIT_PACKBUILDER_DELTAFICATION", "tdef": "typedef", "description": " Stages that are reported by the packbuilder progress callback.", @@ -37184,8 +33518,7 @@ "lineto": 29, "tdef": "typedef", "description": " The diff patch is used to store all the text diffs for a delta.", - "comments": "You can easily loop over the content of patches and get information about\n them.
\n", - "fields": [], + "comments": "You can easily loop over the content of patches and get information about them.
\n", "used": { "returns": [], "needs": [ @@ -37245,53 +33578,7 @@ ], "used": { "returns": [], - "needs": [ - "git_path_is_gitfile" - ] - } - } - ], - [ - "git_path_gitfile", - { - "decl": [ - "GIT_PATH_GITFILE_GITIGNORE", - "GIT_PATH_GITFILE_GITMODULES", - "GIT_PATH_GITFILE_GITATTRIBUTES" - ], - "type": "enum", - "file": "git2/sys/path.h", - "line": 21, - "lineto": 28, - "block": "GIT_PATH_GITFILE_GITIGNORE\nGIT_PATH_GITFILE_GITMODULES\nGIT_PATH_GITFILE_GITATTRIBUTES", - "tdef": "typedef", - "description": " The kinds of git-specific files we know about.", - "comments": "The order needs to stay the same to not break the gitfiles\n array in path.c
Check for the .gitignore file
\n", - "value": 0 - }, - { - "type": "int", - "name": "GIT_PATH_GITFILE_GITMODULES", - "comments": "Check for the .gitmodules file
\n", - "value": 1 - }, - { - "type": "int", - "name": "GIT_PATH_GITFILE_GITATTRIBUTES", - "comments": "Check for the .gitattributes file
\n", - "value": 2 - } - ], - "used": { - "returns": [], - "needs": [ - "git_path_is_gitfile" - ] + "needs": [] } } ], @@ -37307,7 +33594,6 @@ "tdef": "typedef", "description": " Compiled pathspec", "comments": "", - "fields": [], "used": { "returns": [], "needs": [ @@ -37410,7 +33696,6 @@ "tdef": "typedef", "description": " List of filenames matching a pathspec", "comments": "", - "fields": [], "used": { "returns": [], "needs": [ @@ -37447,7 +33732,7 @@ "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\n and compilation options.
\n", + "comments": "Note that not all types may be supported, depending on the platform and compilation options.
\n", "fields": [ { "type": "unsigned int", @@ -37483,9 +33768,8 @@ "used": { "returns": [], "needs": [ - "git_proxy_init_options", - "git_remote_connect", - "git_transport_smart_proxy_options" + "git_proxy_options_init", + "git_remote_connect" ] } } @@ -37544,12 +33828,11 @@ "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": "", - "fields": [], "used": { "returns": [], "needs": [ - "git_push_init_options", "git_push_negotiation", + "git_push_options_init", "git_remote_push", "git_remote_upload" ] @@ -37569,8 +33852,8 @@ "type": "struct", "value": "git_push_options", "file": "git2/remote.h", - "line": 690, - "lineto": 717, + "line": 712, + "lineto": 739, "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.", @@ -37605,7 +33888,7 @@ "used": { "returns": [], "needs": [ - "git_push_init_options", + "git_push_options_init", "git_remote_push", "git_remote_upload" ] @@ -37624,8 +33907,8 @@ "type": "struct", "value": "git_push_update", "file": "git2/remote.h", - "line": 433, - "lineto": 450, + "line": 434, + "lineto": 451, "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", @@ -37672,7 +33955,6 @@ "tdef": "typedef", "description": " Representation of a rebase ", "comments": "", - "fields": [], "used": { "returns": [ "git_rebase_operation_byindex" @@ -37683,13 +33965,17 @@ "git_rebase_finish", "git_rebase_free", "git_rebase_init", - "git_rebase_init_options", "git_rebase_inmemory_index", "git_rebase_next", + "git_rebase_onto_id", + "git_rebase_onto_name", "git_rebase_open", "git_rebase_operation_byindex", "git_rebase_operation_current", - "git_rebase_operation_entrycount" + "git_rebase_operation_entrycount", + "git_rebase_options_init", + "git_rebase_orig_head_id", + "git_rebase_orig_head_name" ] } } @@ -37710,7 +33996,7 @@ "block": "git_rebase_operation_t type\nconst git_oid id\nconst char * exec", "tdef": "typedef", "description": " A rebase operation", - "comments": "Describes a single instruction/operation to be performed during the\n rebase.
\n", + "comments": "Describes a single instruction/operation to be performed during the rebase.
\n", "fields": [ { "type": "git_rebase_operation_t", @@ -37857,8 +34143,8 @@ "returns": [], "needs": [ "git_rebase_init", - "git_rebase_init_options", - "git_rebase_open" + "git_rebase_open", + "git_rebase_options_init" ] } } @@ -37875,19 +34161,14 @@ "tdef": "typedef", "description": " An open refs database handle. ", "comments": "", - "fields": [], "used": { "returns": [], "needs": [ - "git_refdb_backend_fs", "git_refdb_compress", "git_refdb_free", - "git_refdb_init_backend", "git_refdb_new", "git_refdb_open", - "git_refdb_set_backend", - "git_repository_refdb", - "git_repository_set_refdb" + "git_repository_refdb" ] } } @@ -37901,104 +34182,12 @@ "file": "git2/types.h", "line": 100, "lineto": 100, - "block": "unsigned int version\nint (*)(int *, git_refdb_backend *, const char *) exists\nint (*)(git_reference **, git_refdb_backend *, const char *) lookup\nint (*)(git_reference_iterator **, struct git_refdb_backend *, const char *) iterator\nint (*)(git_refdb_backend *, const git_reference *, int, const git_signature *, const char *, const git_oid *, const char *) write\nint (*)(git_reference **, git_refdb_backend *, const char *, const char *, int, const git_signature *, const char *) rename\nint (*)(git_refdb_backend *, const char *, const git_oid *, const char *) del\nint (*)(git_refdb_backend *) compress\nint (*)(git_refdb_backend *, const char *) has_log\nint (*)(git_refdb_backend *, const char *) ensure_log\nvoid (*)(git_refdb_backend *) free\nint (*)(git_reflog **, git_refdb_backend *, const char *) reflog_read\nint (*)(git_refdb_backend *, git_reflog *) reflog_write\nint (*)(git_refdb_backend *, const char *, const char *) reflog_rename\nint (*)(git_refdb_backend *, const char *) reflog_delete\nint (*)(void **, git_refdb_backend *, const char *) lock\nint (*)(git_refdb_backend *, void *, int, int, const git_reference *, const git_signature *, const char *) unlock", "tdef": "typedef", "description": " A custom backend for refs ", "comments": "", - "fields": [ - { - "type": "unsigned int", - "name": "version", - "comments": "" - }, - { - "type": "int (*)(int *, git_refdb_backend *, const char *)", - "name": "exists", - "comments": "" - }, - { - "type": "int (*)(git_reference **, git_refdb_backend *, const char *)", - "name": "lookup", - "comments": "" - }, - { - "type": "int (*)(git_reference_iterator **, struct git_refdb_backend *, const char *)", - "name": "iterator", - "comments": "" - }, - { - "type": "int (*)(git_refdb_backend *, const git_reference *, int, const git_signature *, const char *, const git_oid *, const char *)", - "name": "write", - "comments": "" - }, - { - "type": "int (*)(git_reference **, git_refdb_backend *, const char *, const char *, int, const git_signature *, const char *)", - "name": "rename", - "comments": "" - }, - { - "type": "int (*)(git_refdb_backend *, const char *, const git_oid *, const char *)", - "name": "del", - "comments": "" - }, - { - "type": "int (*)(git_refdb_backend *)", - "name": "compress", - "comments": "" - }, - { - "type": "int (*)(git_refdb_backend *, const char *)", - "name": "has_log", - "comments": "" - }, - { - "type": "int (*)(git_refdb_backend *, const char *)", - "name": "ensure_log", - "comments": "" - }, - { - "type": "void (*)(git_refdb_backend *)", - "name": "free", - "comments": "" - }, - { - "type": "int (*)(git_reflog **, git_refdb_backend *, const char *)", - "name": "reflog_read", - "comments": "" - }, - { - "type": "int (*)(git_refdb_backend *, git_reflog *)", - "name": "reflog_write", - "comments": "" - }, - { - "type": "int (*)(git_refdb_backend *, const char *, const char *)", - "name": "reflog_rename", - "comments": "" - }, - { - "type": "int (*)(git_refdb_backend *, const char *)", - "name": "reflog_delete", - "comments": "" - }, - { - "type": "int (*)(void **, git_refdb_backend *, const char *)", - "name": "lock", - "comments": "" - }, - { - "type": "int (*)(git_refdb_backend *, void *, int, int, const git_reference *, const git_signature *, const char *)", - "name": "unlock", - "comments": "" - } - ], "used": { "returns": [], - "needs": [ - "git_refdb_backend_fs", - "git_refdb_init_backend", - "git_refdb_set_backend" - ] + "needs": [] } } ], @@ -38014,11 +34203,8 @@ "tdef": "typedef", "description": " In-memory representation of a reference. ", "comments": "", - "fields": [], "used": { "returns": [ - "git_reference__alloc", - "git_reference__alloc_symbolic", "git_reference_type" ], "needs": [ @@ -38088,8 +34274,8 @@ ], "type": "enum", "file": "git2/refs.h", - "line": 639, - "lineto": 668, + "line": 658, + "lineto": 687, "block": "GIT_REFERENCE_FORMAT_NORMAL\nGIT_REFERENCE_FORMAT_ALLOW_ONELEVEL\nGIT_REFERENCE_FORMAT_REFSPEC_PATTERN\nGIT_REFERENCE_FORMAT_REFSPEC_SHORTHAND", "tdef": "typedef", "description": " Normalization options for reference lookup", @@ -38135,32 +34321,9 @@ "file": "git2/types.h", "line": 180, "lineto": 180, - "block": "git_refdb * db\nint (*)(git_reference **, git_reference_iterator *) next\nint (*)(const char **, git_reference_iterator *) next_name\nvoid (*)(git_reference_iterator *) free", "tdef": "typedef", "description": " Iterator for references ", "comments": "", - "fields": [ - { - "type": "git_refdb *", - "name": "db", - "comments": "" - }, - { - "type": "int (*)(git_reference **, git_reference_iterator *)", - "name": "next", - "comments": "" - }, - { - "type": "int (*)(const char **, git_reference_iterator *)", - "name": "next_name", - "comments": "" - }, - { - "type": "void (*)(git_reference_iterator *)", - "name": "free", - "comments": "" - } - ], "used": { "returns": [], "needs": [ @@ -38236,16 +34399,13 @@ "tdef": "typedef", "description": " Representation of a reference log ", "comments": "", - "fields": [], "used": { "returns": [ - "git_reflog_entry__alloc", "git_reflog_entry_byindex" ], "needs": [ "git_reflog_append", "git_reflog_drop", - "git_reflog_entry__free", "git_reflog_entry_byindex", "git_reflog_entry_committer", "git_reflog_entry_id_new", @@ -38272,14 +34432,11 @@ "tdef": "typedef", "description": " Representation of a reference log entry ", "comments": "", - "fields": [], "used": { "returns": [ - "git_reflog_entry__alloc", "git_reflog_entry_byindex" ], "needs": [ - "git_reflog_entry__free", "git_reflog_entry_committer", "git_reflog_entry_id_new", "git_reflog_entry_id_old", @@ -38300,7 +34457,6 @@ "tdef": "typedef", "description": " A refspec specifies the mapping between remote and local reference\n names when fetch or pushing.", "comments": "", - "fields": [], "used": { "returns": [ "git_remote_get_refspec" @@ -38333,7 +34489,6 @@ "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": "", - "fields": [], "used": { "returns": [ "git_remote_autotag" @@ -38347,7 +34502,7 @@ "git_remote_create_anonymous", "git_remote_create_cb", "git_remote_create_detached", - "git_remote_create_init_options", + "git_remote_create_options_init", "git_remote_create_with_fetchspec", "git_remote_create_with_opts", "git_remote_default_branch", @@ -38375,12 +34530,7 @@ "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_transport_cb" ] } } @@ -38396,8 +34546,8 @@ ], "type": "enum", "file": "git2/remote.h", - "line": 601, - "lineto": 619, + "line": 623, + "lineto": 641, "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", @@ -38442,16 +34592,31 @@ [ "git_remote_callbacks", { - "decl": "git_remote_callbacks", + "decl": [ + "unsigned int version", + "git_transport_message_cb sideband_progress", + "int (*)(git_remote_completion_t, void *) completion", + "git_cred_acquire_cb credentials", + "git_transport_certificate_check_cb certificate_check", + "git_indexer_progress_cb transfer_progress", + "int (*)(const char *, const git_oid *, const git_oid *, void *) update_tips", + "git_packbuilder_progress pack_progress", + "git_push_transfer_progress_cb push_transfer_progress", + "git_push_update_reference_cb push_update_reference", + "git_push_negotiation push_negotiation", + "git_transport_cb transport", + "void * payload", + "git_url_resolve_cb resolve_url" + ], "type": "struct", "value": "git_remote_callbacks", - "file": "git2/types.h", - "line": 245, - "lineto": 245, - "block": "unsigned int version\ngit_transport_message_cb sideband_progress\nint (*)(git_remote_completion_type, void *) completion\ngit_cred_acquire_cb credentials\ngit_transport_certificate_check_cb certificate_check\ngit_transfer_progress_cb transfer_progress\nint (*)(const char *, const git_oid *, const git_oid *, void *) update_tips\ngit_packbuilder_progress pack_progress\ngit_push_transfer_progress push_transfer_progress\ngit_push_update_reference_cb push_update_reference\ngit_push_negotiation push_negotiation\ngit_transport_cb transport\nvoid * payload", - "tdef": "typedef", - "description": "", - "comments": "", + "file": "git2/remote.h", + "line": 497, + "lineto": 585, + "block": "unsigned int version\ngit_transport_message_cb sideband_progress\nint (*)(git_remote_completion_t, void *) completion\ngit_cred_acquire_cb credentials\ngit_transport_certificate_check_cb certificate_check\ngit_indexer_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_cb push_transfer_progress\ngit_push_update_reference_cb push_update_reference\ngit_push_negotiation push_negotiation\ngit_transport_cb transport\nvoid * payload\ngit_url_resolve_cb resolve_url", + "tdef": null, + "description": " The callback settings structure", + "comments": "Set the callbacks to be called by the remote when informing the user about the progress of the network operations.
\n", "fields": [ { "type": "unsigned int", @@ -38464,7 +34629,7 @@ "comments": " Textual progress from the remote. Text send over the\n progress side-band will be passed to this function (this is\n the 'counting objects' output)." }, { - "type": "int (*)(git_remote_completion_type, void *)", + "type": "int (*)(git_remote_completion_t, void *)", "name": "completion", "comments": "" }, @@ -38479,7 +34644,7 @@ "comments": " If cert verification fails, this will be called to let the\n user make the final decision of whether to allow the\n connection to proceed. Returns 0 to allow the connection\n or a negative value to indicate an error." }, { - "type": "git_transfer_progress_cb", + "type": "git_indexer_progress_cb", "name": "transfer_progress", "comments": " During the download of new data, this will be regularly\n called with the current count of progress done by the\n indexer." }, @@ -38494,7 +34659,7 @@ "comments": " Function to call with progress information during pack\n building. Be aware that this is called inline with pack\n building operations, so performance may be affected." }, { - "type": "git_push_transfer_progress", + "type": "git_push_transfer_progress_cb", "name": "push_transfer_progress", "comments": " Function to call with progress information during the\n upload portion of a push. Be aware that this is called\n inline with pack building operations, so performance may be\n affected." }, @@ -38517,6 +34682,11 @@ "type": "void *", "name": "payload", "comments": " This will be passed to each of the callbacks in this struct\n as the last parameter." + }, + { + "type": "git_url_resolve_cb", + "name": "resolve_url", + "comments": " Resolve URL before connecting to remote.\n The returned URL will be used to connect to the remote instead." } ], "used": { @@ -38531,7 +34701,7 @@ } ], [ - "git_remote_completion_type", + "git_remote_completion_t", { "decl": [ "GIT_REMOTE_COMPLETION_DOWNLOAD", @@ -38625,7 +34795,7 @@ "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\n use git_remote_create_init_options.
Initialize with GIT_REMOTE_CREATE_OPTIONS_INIT. Alternatively, you can use git_remote_create_options_init.
These flags configure extra behaviors to git_repository_init_ext.\n In every case, the default behavior is the zero value (i.e. flag is\n not set). Just OR the flag values together for the flags parameter\n when initializing a new repo. Details of individual values are:
init.templatedir global config if not, or falling back on\n "/usr/share/git-core/templates" if it exists.These flags configure extra behaviors to git_repository_init_ext. In every case, the default behavior is the zero value (i.e. flag is not set). Just OR the flag values together for the flags parameter when initializing a new repo. Details of individual values are:
init.templatedir global config if not, or falling back on "/usr/share/git-core/templates" if it exists. * GIT_REPOSITORY_INIT_RELATIVE_GITLINK - If an alternate workdir is specified, use relative paths for the gitdir and core.worktree.Set the mode field of the git_repository_init_options structure\n either to the custom mode that you would like, or to one of the\n following modes:
Set the mode field of the git_repository_init_options structure either to the custom mode that you would like, or to one of the following modes:
This contains extra options for git_repository_init_ext that enable additional initialization features. The fields are:
These values represent possible states for the repository to be in,\n based on the current operation which is ongoing.
\n", + "comments": "These values represent possible states for the repository to be in, based on the current operation which is ongoing.
\n", "fields": [ { "type": "int", @@ -39529,7 +35687,7 @@ "returns": [], "needs": [ "git_revert", - "git_revert_init_options" + "git_revert_options_init" ] } } @@ -39630,7 +35788,6 @@ "tdef": "typedef", "description": " Representation of an in-progress walk through the commits in a repo ", "comments": "", - "fields": [], "used": { "returns": [], "needs": [ @@ -39705,8 +35862,6 @@ "git_commit_committer_with_mailmap", "git_commit_create", "git_commit_create_buffer", - "git_commit_create_from_callback", - "git_commit_create_from_ids", "git_commit_create_v", "git_mailmap_resolve_signature", "git_note_commit_create", @@ -39780,126 +35935,6 @@ } } ], - [ - "git_smart_subtransport", - { - "decl": "git_smart_subtransport", - "type": "struct", - "value": "git_smart_subtransport", - "file": "git2/sys/transport.h", - "line": 294, - "lineto": 294, - "tdef": "typedef", - "description": " An implementation of a subtransport which carries data for the\n smart transport", - "comments": "", - "fields": [ - { - "type": "int (*)(git_smart_subtransport_stream **, git_smart_subtransport *, const char *, git_smart_service_t)", - "name": "action", - "comments": "" - }, - { - "type": "int (*)(git_smart_subtransport *)", - "name": "close", - "comments": "" - }, - { - "type": "void (*)(git_smart_subtransport *)", - "name": "free", - "comments": "" - } - ], - "used": { - "returns": [], - "needs": [ - "git_smart_subtransport_cb", - "git_smart_subtransport_git", - "git_smart_subtransport_http", - "git_smart_subtransport_ssh" - ] - } - } - ], - [ - "git_smart_subtransport_definition", - { - "decl": [ - "git_smart_subtransport_cb callback", - "unsigned int rpc", - "void * param" - ], - "type": "struct", - "value": "git_smart_subtransport_definition", - "file": "git2/sys/transport.h", - "line": 383, - "lineto": 395, - "block": "git_smart_subtransport_cb callback\nunsigned int rpc\nvoid * param", - "tdef": "typedef", - "description": " Definition for a \"subtransport\"", - "comments": "The smart transport knows how to speak the git protocol, but it has no\n knowledge of how to establish a connection between it and another endpoint,\n or how to move data back and forth. For this, a subtransport interface is\n declared, and the smart transport delegates this work to the subtransports.
\n\nThree subtransports are provided by libgit2: ssh, git, http(s).
\n\nSubtransports can either be RPC = 0 (persistent connection) or RPC = 1\n (request/response). The smart transport handles the differences in its own\n logic. The git subtransport is RPC = 0, while http is RPC = 1.
\n", - "fields": [ - { - "type": "git_smart_subtransport_cb", - "name": "callback", - "comments": " The function to use to create the git_smart_subtransport " - }, - { - "type": "unsigned int", - "name": "rpc", - "comments": " True if the protocol is stateless; false otherwise. For example,\n http:// is stateless, but git:// is not." - }, - { - "type": "void *", - "name": "param", - "comments": " User-specified parameter passed to the callback " - } - ], - "used": { - "returns": [], - "needs": [] - } - } - ], - [ - "git_smart_subtransport_stream", - { - "decl": "git_smart_subtransport_stream", - "type": "struct", - "value": "git_smart_subtransport_stream", - "file": "git2/sys/transport.h", - "line": 295, - "lineto": 295, - "tdef": "typedef", - "description": " A stream used by the smart transport to read and write data\n from a subtransport.", - "comments": "This provides a customization point in case you need to\n support some other communication method.
\n", - "fields": [ - { - "type": "git_smart_subtransport *", - "name": "subtransport", - "comments": " The owning subtransport " - }, - { - "type": "int (*)(git_smart_subtransport_stream *, char *, size_t, size_t *)", - "name": "read", - "comments": "" - }, - { - "type": "int (*)(git_smart_subtransport_stream *, const char *, size_t)", - "name": "write", - "comments": "" - }, - { - "type": "void (*)(git_smart_subtransport_stream *)", - "name": "free", - "comments": "" - } - ], - "used": { - "returns": [], - "needs": [] - } - } - ], [ "git_sort_t", { @@ -40002,7 +36037,7 @@ "block": "unsigned int version\ngit_stash_apply_flags 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\n use git_stash_apply_init_options.
Initialize with GIT_STASH_APPLY_OPTIONS_INIT. Alternatively, you can use git_stash_apply_options_init.
The status value provides the status flags for this file.
The head_to_index value provides detailed information about the\n differences between the file in HEAD and the file in the index.
The index_to_workdir value provides detailed information about the\n differences between the file in the index and the file in the\n working directory.
The status value provides the status flags for this file.
The head_to_index value provides detailed information about the differences between the file in HEAD and the file in the index.
The index_to_workdir value provides detailed information about the differences between the file in the index and the file in the working directory.
git ls-files -o -i --exclude-standard with core git.Calling git_status_foreach() is like calling the extended version\n with: GIT_STATUS_OPT_INCLUDE_IGNORED, GIT_STATUS_OPT_INCLUDE_UNTRACKED,\n and GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS. Those options are bundled\n together as GIT_STATUS_OPT_DEFAULTS if you want them as a baseline.
git ls-files -o -i --exclude-standard with core git. - GIT_STATUS_OPT_RENAMES_HEAD_TO_INDEX indicates that rename detection should be processed between the head and the index and enables the GIT_STATUS_INDEX_RENAMED as a possible status flag. - GIT_STATUS_OPT_RENAMES_INDEX_TO_WORKDIR indicates that rename detection should be run between the index and the working directory and enabled GIT_STATUS_WT_RENAMED as a possible status flag. - GIT_STATUS_OPT_SORT_CASE_SENSITIVELY overrides the native case sensitivity for the file system and forces the output to be in case-sensitive order - GIT_STATUS_OPT_SORT_CASE_INSENSITIVELY overrides the native case sensitivity for the file system and forces the output to be in case-insensitive order - GIT_STATUS_OPT_RENAMES_FROM_REWRITES indicates that rename detection should include rewritten files - GIT_STATUS_OPT_NO_REFRESH bypasses the default status behavior of doing a "soft" index reload (i.e. reloading the index data if the file on disk has been modified outside libgit2). - GIT_STATUS_OPT_UPDATE_INDEX tells libgit2 to refresh the stat cache in the index for files that are unchanged but have out of date stat information in the index. It will result in less work being done on subsequent calls to get status. This is mutually exclusive with the NO_REFRESH option.Calling git_status_foreach() is like calling the extended version with: GIT_STATUS_OPT_INCLUDE_IGNORED, GIT_STATUS_OPT_INCLUDE_UNTRACKED, and GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS. Those options are bundled together as GIT_STATUS_OPT_DEFAULTS if you want them as a baseline.
This structure is set so that zeroing it out will give you relatively\n sane defaults.
\n\nThe show value is one of the git_status_show_t constants that\n control which files to scan and in what order.
The flags value is an OR'ed combination of the git_status_opt_t\n values above.
The pathspec is an array of path patterns to match (using\n fnmatch-style matching), or just an array of paths to match exactly if\n GIT_STATUS_OPT_DISABLE_PATHSPEC_MATCH is specified in the flags.
The baseline is the tree to be used for comparison to the working directory\n and index; defaults to HEAD.
This structure is set so that zeroing it out will give you relatively sane defaults.
\n\nThe show value is one of the git_status_show_t constants that control which files to scan and in what order.
The flags value is an OR'ed combination of the git_status_opt_t values above.
The pathspec is an array of path patterns to match (using fnmatch-style matching), or just an array of paths to match exactly if GIT_STATUS_OPT_DISABLE_PATHSPEC_MATCH is specified in the flags.
The baseline is the tree to be used for comparison to the working directory and index; defaults to HEAD.
With git_status_foreach_ext, this will control which changes get\n callbacks. With git_status_list_new, these will control which\n changes are included in the list.
git status --porcelain regarding which files are\nincluded and in what order.With git_status_foreach_ext, this will control which changes get callbacks. With git_status_list_new, these will control which changes are included in the list.
git status --porcelain regarding which files are included and in what order. - GIT_STATUS_SHOW_INDEX_ONLY only gives status based on HEAD to index comparison, not looking at working directory changes. - GIT_STATUS_SHOW_WORKDIR_ONLY only gives status based on index to working directory comparison, not comparing the index to the HEAD.A combination of these values will be returned to indicate the status of\n a file. Status compares the working directory, the index, and the\n current HEAD of the repository. The GIT_STATUS_INDEX set of flags\n represents the status of file in the index relative to the HEAD, and the\n GIT_STATUS_WT set of flags represent the status of the file in the\n working directory relative to the index.
A combination of these values will be returned to indicate the status of a file. Status compares the working directory, the index, and the current HEAD of the repository. The GIT_STATUS_INDEX set of flags represents the status of file in the index relative to the HEAD, and the GIT_STATUS_WT set of flags represent the status of the file in the working directory relative to the index.
These values represent settings for the submodule.$name.ignore\n configuration value which says how deeply to look at the working\n directory when getting submodule status.
You can override this value in memory on a per-submodule basis with\n git_submodule_set_ignore() and can write the changed value to disk\n with git_submodule_save(). If you have overwritten the value, you\n can revert to the on disk value by using GIT_SUBMODULE_IGNORE_RESET.
The values are:
\n\nThese values represent settings for the submodule.$name.ignore configuration value which says how deeply to look at the working directory when getting submodule status.
You can override this value in memory on a per-submodule basis with git_submodule_set_ignore() and can write the changed value to disk with git_submodule_save(). If you have overwritten the value, you can revert to the on disk value by using GIT_SUBMODULE_IGNORE_RESET.
The values are:
\n\nRepresent the value of submodule.$name.fetchRecurseSubmodules
Represent the value of submodule.$name.fetchRecurseSubmodules
A combination of these flags will be returned to describe the status of a\n submodule. Depending on the "ignore" property of the submodule, some of\n the flags may never be returned because they indicate changes that are\n supposed to be ignored.
\n\nSubmodule info is contained in 4 places: the HEAD tree, the index, config\n files (both .git/config and .gitmodules), and the working directory. Any\n or all of those places might be missing information about the submodule\n depending on what state the repo is in. We consider all four places to\n build the combination of status flags.
\n\nThere are four values that are not really status, but give basic info\n about what sources of submodule data are available. These will be\n returned even if ignore is set to "ALL".
\n\nThe following values will be returned so long as ignore is not "ALL".
\n\nThe following can only be returned if ignore is "NONE" or "UNTRACKED".
\n\nLastly, the following will only be returned for ignore "NONE".
\n\nA combination of these flags will be returned to describe the status of a submodule. Depending on the "ignore" property of the submodule, some of the flags may never be returned because they indicate changes that are supposed to be ignored.
\n\nSubmodule info is contained in 4 places: the HEAD tree, the index, config files (both .git/config and .gitmodules), and the working directory. Any or all of those places might be missing information about the submodule depending on what state the repo is in. We consider all four places to build the combination of status flags.
\n\nThere are four values that are not really status, but give basic info about what sources of submodule data are available. These will be returned even if ignore is set to "ALL".
\n\nThe following values will be returned so long as ignore is not "ALL".
\n\nThe following can only be returned if ignore is "NONE" or "UNTRACKED".
\n\nLastly, the following will only be returned for ignore "NONE".
\n\nInitialize with GIT_SUBMODULE_UPDATE_OPTIONS_INIT. Alternatively, you can\n use git_submodule_update_init_options.
Initialize with GIT_SUBMODULE_UPDATE_OPTIONS_INIT. Alternatively, you can use git_submodule_update_options_init.
These values represent settings for the submodule.$name.update\n configuration value which says how to handle git submodule update for\n this submodule. The value is usually set in the ".gitmodules" file and\n copied to ".git/config" when the submodule is initialized.
You can override this setting on a per-submodule basis with\n git_submodule_set_update() and write the changed value to disk using\n git_submodule_save(). If you have overwritten the value, you can\n revert it by passing GIT_SUBMODULE_UPDATE_RESET to the set function.
The values are:
\n\nThese values represent settings for the submodule.$name.update configuration value which says how to handle git submodule update for this submodule. The value is usually set in the ".gitmodules" file and copied to ".git/config" when the submodule is initialized.
You can override this setting on a per-submodule basis with git_submodule_set_update() and write the changed value to disk using git_submodule_save(). If you have overwritten the value, you can revert it by passing GIT_SUBMODULE_UPDATE_RESET to the set function.
The values are:
\n\nCurrently unused.
\n", - "fields": [ - { - "type": "int", - "name": "GIT_TRANSPORTFLAGS_NONE", - "comments": "", - "value": 0 - } - ], - "used": { - "returns": [], - "needs": [] - } - } - ], [ "git_tree", { @@ -41582,7 +37306,6 @@ "tdef": "typedef", "description": " Representation of a tree object. ", "comments": "", - "fields": [], "used": { "returns": [ "git_tree_entry_byid", @@ -41654,7 +37377,6 @@ "tdef": "typedef", "description": " Representation of each one of the entries in a tree object. ", "comments": "", - "fields": [], "used": { "returns": [ "git_tree_entry_byid", @@ -41775,7 +37497,6 @@ "tdef": "typedef", "description": " Constructor for in-memory trees ", "comments": "", - "fields": [], "used": { "returns": [], "needs": [ @@ -41842,13 +37563,12 @@ "tdef": "typedef", "description": " Representation of a working tree ", "comments": "", - "fields": [], "used": { "returns": [], "needs": [ "git_repository_open_from_worktree", "git_worktree_add", - "git_worktree_add_init_options", + "git_worktree_add_options_init", "git_worktree_free", "git_worktree_is_locked", "git_worktree_is_prunable", @@ -41858,7 +37578,7 @@ "git_worktree_open_from_repository", "git_worktree_path", "git_worktree_prune", - "git_worktree_prune_init_options", + "git_worktree_prune_options_init", "git_worktree_unlock", "git_worktree_validate" ] @@ -41881,7 +37601,7 @@ "block": "unsigned int version\nint lock\ngit_reference * ref", "tdef": "typedef", "description": " Worktree add options structure", - "comments": "Initialize with GIT_WORKTREE_ADD_OPTIONS_INIT. Alternatively, you can\n use git_worktree_add_init_options.
Initialize with GIT_WORKTREE_ADD_OPTIONS_INIT. Alternatively, you can use git_worktree_add_options_init.
Initialize with GIT_WORKTREE_PRUNE_OPTIONS_INIT. Alternatively, you can use git_worktree_prune_options_init.