Skip to content

Commit

Permalink
Documentation update 2025-01-02
Browse files Browse the repository at this point in the history
  • Loading branch information
Documentation Site Generator committed Jan 2, 2025
1 parent 3496f2d commit 71f651b
Show file tree
Hide file tree
Showing 139 changed files with 25,437 additions and 24,532 deletions.
445 changes: 314 additions & 131 deletions docs/api/main.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/reference/main/.metadata
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"version": "main",
"commit": "c605f4281b0779d3749e8564ffbc9fff158e6520"
"commit": "270d8019cd436d4e425d05139977441470707a18"
}
6 changes: 3 additions & 3 deletions docs/reference/main/diff/GIT_DIFF_PARSE_OPTIONS_INIT.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,14 @@ <h2 class="apiName macroName">GIT_DIFF_PARSE_OPTIONS_INIT</h2>
</div>
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
<div class="apiSignatureLink macroSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1334" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1335" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature macroSignature">
#define GIT_DIFF_PARSE_OPTIONS_INIT &#123; GIT_DIFF_PARSE_OPTIONS_VERSION, GIT_OID_DEFAULT &#125; </div>
#define GIT_DIFF_PARSE_OPTIONS_INIT &#123; GIT_DIFF_PARSE_OPTIONS_VERSION &#125; </div>
<h3 class="apiVersionsHeader macroVersionsHeader">Versions</h3>
<div class="apiVersions macroVersions">
<ul>
<li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
<li class="apiVersionDeltaChanged macroVersionDeltaChanged">
<a href="/docs/reference/main/diff/GIT_DIFF_PARSE_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">main</a>
</li>
<li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ <h2 class="apiName macroName">GIT_DIFF_PARSE_OPTIONS_VERSION</h2>
</div>
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
<div class="apiSignatureLink macroSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1328" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1330" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature macroSignature">
#define GIT_DIFF_PARSE_OPTIONS_VERSION 1 </div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h2 class="apiName macroName">GIT_DIFF_PATCHID_OPTIONS_INIT</h2>
</div>
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
<div class="apiSignatureLink macroSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1467" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1497" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature macroSignature">
#define GIT_DIFF_PATCHID_OPTIONS_INIT &#123; GIT_DIFF_PATCHID_OPTIONS_VERSION &#125; </div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h2 class="apiName macroName">GIT_DIFF_PATCHID_OPTIONS_VERSION</h2>
</div>
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
<div class="apiSignatureLink macroSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1464" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1494" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature macroSignature">
#define GIT_DIFF_PATCHID_OPTIONS_VERSION 1 </div>
Expand Down
20 changes: 19 additions & 1 deletion docs/reference/main/diff/git_diff_from_buffer.html
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,27 @@ <h2 class="apiName functionName">git_diff_from_buffer</h2>

</div>

<h3 class="apiNotesHeader functionNotesHeader">Notes</h3>
<div class="apiNotes functionNotes">
<ul>
<li>
This API only supports SHA1 patch files
</li>
</ul>
</div>

<h3 class="apiSeeHeader functionSeeHeader">See</h3>
<div class="apiSee functionSee">
<ul>
<li>
git_diff_from_buffer_ext
</li>
</ul>
</div>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1355" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1359" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
int git_diff_from_buffer(<span class="apiSignatureParameter functionSignatureParameter">git_diff **out</span>, <span class="apiSignatureParameter functionSignatureParameter">const char *content</span>, <span class="apiSignatureParameter functionSignatureParameter">size_t content_len</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/diff/git_diff_get_stats.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h2 class="apiName functionName">git_diff_get_stats</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1398" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1428" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
int git_diff_get_stats(<span class="apiSignatureParameter functionSignatureParameter">git_diff_stats **out</span>, <span class="apiSignatureParameter functionSignatureParameter">git_diff *diff</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/diff/git_diff_parse_options.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ <h3 class="apiMembersHeader structMembersHeader">Members</h3>
oid_type
</div>
<div class="apiMemberDescription structMemberDescription">

<p>Object ID type used in the patch file.</p>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/diff/git_diff_patchid.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h2 class="apiName functionName">git_diff_patchid</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1502" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1532" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
int git_diff_patchid(<span class="apiSignatureParameter functionSignatureParameter">git_oid *out</span>, <span class="apiSignatureParameter functionSignatureParameter">git_diff *diff</span>, <span class="apiSignatureParameter functionSignatureParameter">git_diff_patchid_options *opts</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/diff/git_diff_patchid_options.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h2 class="apiName structName">git_diff_patchid_options</h2>

<h3 class="apiSignatureHeader structSignatureHeader">Signature</h3>
<div class="apiSignatureLink structSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1459" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1489" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature structSignature">
typedef struct git_diff_patchid_options {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ <h2 class="apiName functionName">git_diff_patchid_options_init</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1479" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1509" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
int git_diff_patchid_options_init(<span class="apiSignatureParameter functionSignatureParameter">git_diff_patchid_options *opts</span>, <span class="apiSignatureParameter functionSignatureParameter">unsigned int version</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/diff/git_diff_stats.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h2 class="apiName objectName">git_diff_stats</h2>

<h3 class="apiSignatureHeader objectSignatureHeader">Signature</h3>
<div class="apiSignatureLink objectSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1369" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1399" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature objectSignature">
typedef struct git_diff_stats git_diff_stats
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/diff/git_diff_stats_deletions.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h2 class="apiName functionName">git_diff_stats_deletions</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1426" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1456" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
size_t git_diff_stats_deletions(<span class="apiSignatureParameter functionSignatureParameter">const git_diff_stats *stats</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/diff/git_diff_stats_files_changed.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h2 class="apiName functionName">git_diff_stats_files_changed</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1408" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1438" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
size_t git_diff_stats_files_changed(<span class="apiSignatureParameter functionSignatureParameter">const git_diff_stats *stats</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/diff/git_diff_stats_format_t.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h2 class="apiName enumName">git_diff_stats_format_t</h2>

<h3 class="apiMembersHeader enumMembersHeader">Values</h3>
<div class="apiSignatureLink enumSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1374" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1404" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiMembers enumMembers">
<div class="apiMember enumMember">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/diff/git_diff_stats_free.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h2 class="apiName functionName">git_diff_stats_free</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1450" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1480" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
void git_diff_stats_free(<span class="apiSignatureParameter functionSignatureParameter">git_diff_stats *stats</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/diff/git_diff_stats_insertions.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h2 class="apiName functionName">git_diff_stats_insertions</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1417" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1447" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
size_t git_diff_stats_insertions(<span class="apiSignatureParameter functionSignatureParameter">const git_diff_stats *stats</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/diff/git_diff_stats_to_buf.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h2 class="apiName functionName">git_diff_stats_to_buf</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1438" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/diff.h#L1468" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
int git_diff_stats_to_buf(<span class="apiSignatureParameter functionSignatureParameter">git_buf *out</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_diff_stats *stats</span>, <span class="apiSignatureParameter functionSignatureParameter">git_diff_stats_format_t format</span>, <span class="apiSignatureParameter functionSignatureParameter">size_t width</span>);
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/main/index/GIT_INDEX_OPTIONS_INIT.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ <h2 class="apiName macroName">GIT_INDEX_OPTIONS_INIT</h2>


<div class="apiDescription macroDescription">
<p>Static constructor for <code><span class="codeWord">git_index_options</span></code></p>
<p>Static constructor for <a href="/docs/reference/main/index/git_index_options.html" class="apiLink structLink"><code><span class="codeWord">git_index_options</span></code></a></p>

</div>
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
<div class="apiSignatureLink macroSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L219" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L217" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature macroSignature">
#define GIT_INDEX_OPTIONS_INIT &#123; GIT_INDEX_OPTIONS_VERSION &#125; </div>
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/main/index/GIT_INDEX_OPTIONS_VERSION.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ <h2 class="apiName macroName">GIT_INDEX_OPTIONS_VERSION</h2>


<div class="apiDescription macroDescription">
<p>Current version for the <code><span class="codeWord">git_index_options</span></code> structure</p>
<p>Current version for the <a href="/docs/reference/main/index/git_index_options.html" class="apiLink structLink"><code><span class="codeWord">git_index_options</span></code></a> structure</p>

</div>
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
<div class="apiSignatureLink macroSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L216" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L214" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature macroSignature">
#define GIT_INDEX_OPTIONS_VERSION 1 </div>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/index/git_index_add.html
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ <h2 class="apiName functionName">git_index_add</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L550" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L562" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
int git_index_add(<span class="apiSignatureParameter functionSignatureParameter">git_index *index</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_index_entry *source_entry</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/index/git_index_add_all.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ <h2 class="apiName functionName">git_index_add_all</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L738" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L750" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
int git_index_add_all(<span class="apiSignatureParameter functionSignatureParameter">git_index *index</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_strarray *pathspec</span>, <span class="apiSignatureParameter functionSignatureParameter">unsigned int flags</span>, <span class="apiSignatureParameter functionSignatureParameter">git_index_matched_path_cb callback</span>, <span class="apiSignatureParameter functionSignatureParameter">void *payload</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/index/git_index_add_bypath.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h2 class="apiName functionName">git_index_add_bypath</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L643" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L655" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
int git_index_add_bypath(<span class="apiSignatureParameter functionSignatureParameter">git_index *index</span>, <span class="apiSignatureParameter functionSignatureParameter">const char *path</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/index/git_index_add_from_buffer.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ <h2 class="apiName functionName">git_index_add_from_buffer</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L671" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L683" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
int git_index_add_from_buffer(<span class="apiSignatureParameter functionSignatureParameter">git_index *index</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_index_entry *entry</span>, <span class="apiSignatureParameter functionSignatureParameter">const void *buffer</span>, <span class="apiSignatureParameter functionSignatureParameter">size_t len</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/index/git_index_caps.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ <h2 class="apiName functionName">git_index_caps</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L316" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L328" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
int git_index_caps(<span class="apiSignatureParameter functionSignatureParameter">const git_index *index</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/index/git_index_checksum.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3 class="apiDeprecationsHeader functionDeprecationsHeader">Deprecations</h3>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L404" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L416" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
const git_oid *git_index_checksum(<span class="apiSignatureParameter functionSignatureParameter">git_index *index</span>);
Expand Down
Loading

0 comments on commit 71f651b

Please sign in to comment.