Skip to content

Commit 7170bc5

Browse files
author
Documentation Site Generator
committed
Documentation update 2026-06-01
1 parent c326171 commit 7170bc5

33 files changed

Lines changed: 42836 additions & 40298 deletions

‎docs/api/main.json‎

Lines changed: 548 additions & 74 deletions
Large diffs are not rendered by default.

‎docs/reference/main/.metadata‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"version": "main",
3-
"commit": "a7e1eb26382dfaad75cc160e73b9cc451b1e3b00"
3+
"commit": "353e7059dc5769054b030b993b5eb207d01c1aaa"
44
}

‎docs/reference/main/commit/GIT_COMMIT_CREATE_EXT_OPTIONS_INIT.html‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: GIT_COMMIT_CREATE_EXT_OPTIONS_INIT (libgit2 main)
3+
layout: default
4+
---
5+
6+
<div class="api macro">
7+
<div class="apiBreadcrumb macroBreadcrumb">
8+
<ul>
9+
<li><a href="/docs/reference/main/index.html">API Documentation</a></li>
10+
<li><a href="/docs/reference/main/commit/index.html">commit</a></li>
11+
</ul>
12+
</div>
13+
<div class="apiHeader macroHeader">
14+
<h2 class="apiName macroName">GIT_COMMIT_CREATE_EXT_OPTIONS_INIT</h2>
15+
16+
<script src="/js/minisearch.js"></script>
17+
<script src="/js/search.js"></script>
18+
<div class="headerSearchArea macroHeaderSearchArea" id="headersearcharea">
19+
<input class="headerSearchBox macroHeaderSearchBox" id="headersearchbox" placeholder="Search..." onInput="handleSearchSuggest({ version: 'main' })" onFocusIn="handleSearchSuggest({ version: 'main' })" onKeyUp="if (event.code === 'Enter') { submitSearch({ version: 'main' }); }"/>
20+
<div class="headerSearchResults macroHeaderSearchResults" id="headersearchresults">
21+
</div>
22+
</div>
23+
24+
<div class="apiHeaderVersionSelect macroHeaderVersionSelect">
25+
<span>Version:</span>
26+
<select onChange="window.location.href = this.value">
27+
<option value="/docs/reference/main/commit/GIT_COMMIT_CREATE_EXT_OPTIONS_INIT.html" selected>main</option>
28+
</select>
29+
</div>
30+
</div>
31+
32+
33+
<div class="apiDescription macroDescription">
34+
<p>Static constructor for <a href="/docs/reference/main/commit/git_commit_create_ext_options.html" class="apiLink structLink"><code><span class="codeWord">git_commit_create_ext_options</span></code></a></p>
35+
36+
</div>
37+
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
38+
<div class="apiSignatureLink macroSignatureLink">
39+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/commit.h#L457" target="_blank" rel="noopener">GitHub</a>
40+
</div>
41+
<div class="apiSignature macroSignature">
42+
#define GIT_COMMIT_CREATE_EXT_OPTIONS_INIT &#123; GIT_COMMIT_CREATE_EXT_OPTIONS_VERSION &#125; </div>
43+
<h3 class="apiVersionsHeader macroVersionsHeader">Versions</h3>
44+
<div class="apiVersions macroVersions">
45+
<ul>
46+
<li class="apiVersionDeltaIntroduced macroVersionDeltaIntroduced">
47+
<a href="/docs/reference/main/commit/GIT_COMMIT_CREATE_EXT_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">main</a>
48+
</li>
49+
</ul>
50+
</div>
51+
</div>

‎docs/reference/main/commit/GIT_COMMIT_CREATE_EXT_OPTIONS_VERSION.html‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: GIT_COMMIT_CREATE_EXT_OPTIONS_VERSION (libgit2 main)
3+
layout: default
4+
---
5+
6+
<div class="api macro">
7+
<div class="apiBreadcrumb macroBreadcrumb">
8+
<ul>
9+
<li><a href="/docs/reference/main/index.html">API Documentation</a></li>
10+
<li><a href="/docs/reference/main/commit/index.html">commit</a></li>
11+
</ul>
12+
</div>
13+
<div class="apiHeader macroHeader">
14+
<h2 class="apiName macroName">GIT_COMMIT_CREATE_EXT_OPTIONS_VERSION</h2>
15+
16+
<script src="/js/minisearch.js"></script>
17+
<script src="/js/search.js"></script>
18+
<div class="headerSearchArea macroHeaderSearchArea" id="headersearcharea">
19+
<input class="headerSearchBox macroHeaderSearchBox" id="headersearchbox" placeholder="Search..." onInput="handleSearchSuggest({ version: 'main' })" onFocusIn="handleSearchSuggest({ version: 'main' })" onKeyUp="if (event.code === 'Enter') { submitSearch({ version: 'main' }); }"/>
20+
<div class="headerSearchResults macroHeaderSearchResults" id="headersearchresults">
21+
</div>
22+
</div>
23+
24+
<div class="apiHeaderVersionSelect macroHeaderVersionSelect">
25+
<span>Version:</span>
26+
<select onChange="window.location.href = this.value">
27+
<option value="/docs/reference/main/commit/GIT_COMMIT_CREATE_EXT_OPTIONS_VERSION.html" selected>main</option>
28+
</select>
29+
</div>
30+
</div>
31+
32+
33+
<div class="apiDescription macroDescription">
34+
<p>Current version for the <a href="/docs/reference/main/commit/git_commit_create_ext_options.html" class="apiLink structLink"><code><span class="codeWord">git_commit_create_ext_options</span></code></a> structure</p>
35+
36+
</div>
37+
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
38+
<div class="apiSignatureLink macroSignatureLink">
39+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/commit.h#L454" target="_blank" rel="noopener">GitHub</a>
40+
</div>
41+
<div class="apiSignature macroSignature">
42+
#define GIT_COMMIT_CREATE_EXT_OPTIONS_VERSION 1 </div>
43+
<h3 class="apiVersionsHeader macroVersionsHeader">Versions</h3>
44+
<div class="apiVersions macroVersions">
45+
<ul>
46+
<li class="apiVersionDeltaIntroduced macroVersionDeltaIntroduced">
47+
<a href="/docs/reference/main/commit/GIT_COMMIT_CREATE_EXT_OPTIONS_VERSION.html" class="apiVersionLink macroVersionLink">main</a>
48+
</li>
49+
</ul>
50+
</div>
51+
</div>

‎docs/reference/main/commit/GIT_COMMIT_CREATE_OPTIONS_INIT.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ <h2 class="apiName macroName">GIT_COMMIT_CREATE_OPTIONS_INIT</h2>
4848
</div>
4949
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
5050
<div class="apiSignatureLink macroSignatureLink">
51-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/commit.h#L458" target="_blank" rel="noopener">GitHub</a>
51+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/commit.h#L402" target="_blank" rel="noopener">GitHub</a>
5252
</div>
5353
<div class="apiSignature macroSignature">
5454
#define GIT_COMMIT_CREATE_OPTIONS_INIT &#123; GIT_COMMIT_CREATE_OPTIONS_VERSION &#125; </div>

‎docs/reference/main/commit/GIT_COMMIT_CREATE_OPTIONS_VERSION.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ <h2 class="apiName macroName">GIT_COMMIT_CREATE_OPTIONS_VERSION</h2>
4848
</div>
4949
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
5050
<div class="apiSignatureLink macroSignatureLink">
51-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/commit.h#L455" target="_blank" rel="noopener">GitHub</a>
51+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/commit.h#L399" target="_blank" rel="noopener">GitHub</a>
5252
</div>
5353
<div class="apiSignature macroSignature">
5454
#define GIT_COMMIT_CREATE_OPTIONS_VERSION 1 </div>

‎docs/reference/main/commit/git_commit_amend.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ <h2 class="apiName functionName">git_commit_amend</h2>
157157

158158
<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
159159
<div class="apiSignatureLink functionSignatureLink">
160-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/commit.h#L528" target="_blank" rel="noopener">GitHub</a>
160+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/commit.h#L711" target="_blank" rel="noopener">GitHub</a>
161161
</div>
162162
<div class="apiSignature functionSignature">
163163
int git_commit_amend(<span class="apiSignatureParameter functionSignatureParameter">git_oid *id</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_commit *commit_to_amend</span>, <span class="apiSignatureParameter functionSignatureParameter">const char *update_ref</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_signature *author</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_signature *committer</span>, <span class="apiSignatureParameter functionSignatureParameter">const char *message_encoding</span>, <span class="apiSignatureParameter functionSignatureParameter">const char *message</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_tree *tree</span>);

‎docs/reference/main/commit/git_commit_amend_from_stage.html‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
---
2+
title: git_commit_amend_from_stage (libgit2 main)
3+
layout: default
4+
---
5+
6+
<div class="api function">
7+
<div class="apiBreadcrumb functionBreadcrumb">
8+
<ul>
9+
<li><a href="/docs/reference/main/index.html">API Documentation</a></li>
10+
<li><a href="/docs/reference/main/commit/index.html">commit</a></li>
11+
</ul>
12+
</div>
13+
<div class="apiHeader functionHeader">
14+
<h2 class="apiName functionName">git_commit_amend_from_stage</h2>
15+
16+
<script src="/js/minisearch.js"></script>
17+
<script src="/js/search.js"></script>
18+
<div class="headerSearchArea functionHeaderSearchArea" id="headersearcharea">
19+
<input class="headerSearchBox functionHeaderSearchBox" id="headersearchbox" placeholder="Search..." onInput="handleSearchSuggest({ version: 'main' })" onFocusIn="handleSearchSuggest({ version: 'main' })" onKeyUp="if (event.code === 'Enter') { submitSearch({ version: 'main' }); }"/>
20+
<div class="headerSearchResults functionHeaderSearchResults" id="headersearchresults">
21+
</div>
22+
</div>
23+
24+
<div class="apiHeaderVersionSelect functionHeaderVersionSelect">
25+
<span>Version:</span>
26+
<select onChange="window.location.href = this.value">
27+
<option value="/docs/reference/main/commit/git_commit_amend_from_stage.html" selected>main</option>
28+
</select>
29+
</div>
30+
</div>
31+
32+
33+
<div class="apiDescription functionDescription">
34+
<p>Amends the HEAD commit in the repository using the staged changes;
35+
this is a near analog to <code><span class="codeWord">git</span> <span class="codeWord">commit</span> <span class="codeWord">--amend</span> <span class="codeWord">-m</span> <span class="codeWord">message</span></code>.</p>
36+
37+
</div>
38+
39+
<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
40+
<div class="apiSignatureLink functionSignatureLink">
41+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/commit.h#L638" target="_blank" rel="noopener">GitHub</a>
42+
</div>
43+
<div class="apiSignature functionSignature">
44+
int git_commit_amend_from_stage(<span class="apiSignatureParameter functionSignatureParameter">git_oid *id</span>, <span class="apiSignatureParameter functionSignatureParameter">git_repository *repo</span>, <span class="apiSignatureParameter functionSignatureParameter">const char *message</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_commit_create_options *opts</span>);
45+
</div>
46+
47+
<h3 class="apiParametersHeader functionParametersHeader">Parameters</h3>
48+
<div class="apiParameters functionParameters">
49+
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
50+
<div class="apiParameterType functionParameterType">
51+
<a href="/docs/reference/main/oid/git_oid.html" class="apiLink structLink">git_oid *</a>
52+
</div>
53+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
54+
In
55+
</div>
56+
<div class="apiParameterName functionParameterName">
57+
id
58+
</div>
59+
<div class="apiParameterDescription functionParameterDescription">
60+
<p>pointer to store the new commit's object id</p>
61+
</div>
62+
</div>
63+
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
64+
<div class="apiParameterType functionParameterType">
65+
<a href="/docs/reference/main/repository/git_repository.html" class="apiLink objectLink">git_repository *</a>
66+
</div>
67+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
68+
In
69+
</div>
70+
<div class="apiParameterName functionParameterName">
71+
repo
72+
</div>
73+
<div class="apiParameterDescription functionParameterDescription">
74+
<p>repository to commit changes in</p>
75+
</div>
76+
</div>
77+
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
78+
<div class="apiParameterType functionParameterType">
79+
const char *
80+
</div>
81+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
82+
In
83+
</div>
84+
<div class="apiParameterName functionParameterName">
85+
message
86+
</div>
87+
<div class="apiParameterDescription functionParameterDescription">
88+
<p>the commit message</p>
89+
</div>
90+
</div>
91+
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
92+
<div class="apiParameterType functionParameterType">
93+
<a href="/docs/reference/main/commit/git_commit_create_options.html" class="apiLink structLink">const git_commit_create_options *</a>
94+
</div>
95+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
96+
In
97+
</div>
98+
<div class="apiParameterName functionParameterName">
99+
opts
100+
</div>
101+
<div class="apiParameterDescription functionParameterDescription">
102+
<p>options for creating the commit</p>
103+
</div>
104+
</div>
105+
</div>
106+
107+
<h3 class="apiReturnHeader functionReturnHeader">Returns</h3>
108+
<div class="apiReturn functionReturn">
109+
<div class="apiReturnType functionReturnType">
110+
int
111+
</div>
112+
<div class="apiReturnDescription functionReturnDescription">
113+
<p>0 on success or an error code</p>
114+
</div>
115+
</div>
116+
<h3 class="apiVersionsHeader functionVersionsHeader">Versions</h3>
117+
<div class="apiVersions functionVersions">
118+
<ul>
119+
<li class="apiVersionDeltaIntroduced functionVersionDeltaIntroduced">
120+
<a href="/docs/reference/main/commit/git_commit_amend_from_stage.html" class="apiVersionLink functionVersionLink">main</a>
121+
</li>
122+
</ul>
123+
</div>
124+
</div>

0 commit comments

Comments
 (0)