Skip to content

Commit 4a2dd0f

Browse files
author
Documentation Site Generator
committed
Documentation update 2024-11-26
1 parent 137a2a0 commit 4a2dd0f

File tree

1,408 files changed

+7737
-4665
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,408 files changed

+7737
-4665
lines changed

‎docs/api/main.json

Lines changed: 3034 additions & 2140 deletions
Large diffs are not rendered by default.

‎docs/reference/index.html

Lines changed: 95 additions & 76 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": "e74b9c64a1ff0c88132ee50fc176aaa6210bacd2"
3+
"commit": "b8ad17faf56bcfb2081092604c998005b6c31861"
44
}

‎docs/reference/main/annotated_commit/git_annotated_commit.html

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,20 +112,29 @@ <h2 class="apiName objectName">git_annotated_commit</h2>
112112

113113

114114
<div class="apiDescription objectDescription">
115-
<p>Annotated commits, the input to merge and rebase.</p>
115+
<p>Annotated commits are commits with additional metadata about how the
116+
commit was resolved, which can be used for maintaining the user's
117+
&quot;intent&quot; through commands like merge and rebase.</p>
118+
119+
<p>For example, if a user wants to conceptually &quot;merge <code><span class="codeWord">HEAD</span></code>&quot;, then the
120+
commit portion of an annotated commit will point to the <code><span class="codeWord">HEAD</span></code> commit,
121+
but the <em>annotation</em> will denote the ref <code><span class="codeWord">HEAD</span></code>. This allows git to
122+
perform the internal bookkeeping so that the system knows both the
123+
content of what is being merged but also how the content was looked up
124+
so that it can be recorded in the reflog appropriately.</p>
116125

117126
</div>
118127

119128
<h3 class="apiSignatureHeader objectSignatureHeader">Signature</h3>
120129
<div class="apiSignatureLink objectSignatureLink">
121-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/types.h#L198" target="_blank" rel="noopener">GitHub</a>
130+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/types.h#L214" target="_blank" rel="noopener">GitHub</a>
122131
</div>
123132
<div class="apiSignature objectSignature">
124133
typedef struct git_annotated_commit git_annotated_commit
125134
</div>
126135

127-
<h3 class="apiParameterToHeader objectParameterToHeader">Parameter To</h3>
128-
<div class="apiParameterTo objectParameterTo">
136+
<h3 class="apiReturnedByHeader objectReturnedByHeader">Returned By</h3>
137+
<div class="apiReturnedBy objectReturnedBy">
129138
<ul>
130139
<li>
131140
<a href="/docs/reference/main/annotated_commit/git_annotated_commit_from_ref.html" className="apiLink functionLink">git_annotated_commit_from_ref</a>
@@ -139,6 +148,12 @@ <h3 class="apiParameterToHeader objectParameterToHeader">Parameter To</h3>
139148
<li>
140149
<a href="/docs/reference/main/annotated_commit/git_annotated_commit_from_revspec.html" className="apiLink functionLink">git_annotated_commit_from_revspec</a>
141150
</li>
151+
</ul>
152+
</div>
153+
154+
<h3 class="apiParameterToHeader objectParameterToHeader">Parameter To</h3>
155+
<div class="apiParameterTo objectParameterTo">
156+
<ul>
142157
<li>
143158
<a href="/docs/reference/main/annotated_commit/git_annotated_commit_id.html" className="apiLink functionLink">git_annotated_commit_id</a>
144159
</li>

‎docs/reference/main/annotated_commit/git_annotated_commit_free.html

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

119119
<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
120120
<div class="apiSignatureLink functionSignatureLink">
121-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L120" target="_blank" rel="noopener">GitHub</a>
121+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L127" target="_blank" rel="noopener">GitHub</a>
122122
</div>
123123
<div class="apiSignature functionSignature">
124124
void git_annotated_commit_free(<span class="apiSignatureParameter functionSignatureParameter">git_annotated_commit *commit</span>);

‎docs/reference/main/annotated_commit/git_annotated_commit_from_fetchhead.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,20 +120,20 @@ <h2 class="apiName functionName">git_annotated_commit_from_fetchhead</h2>
120120

121121
<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
122122
<div class="apiSignatureLink functionSignatureLink">
123-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L50" target="_blank" rel="noopener">GitHub</a>
123+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L57" target="_blank" rel="noopener">GitHub</a>
124124
</div>
125125
<div class="apiSignature functionSignature">
126126
int git_annotated_commit_from_fetchhead(<span class="apiSignatureParameter functionSignatureParameter">git_annotated_commit **out</span>, <span class="apiSignatureParameter functionSignatureParameter">git_repository *repo</span>, <span class="apiSignatureParameter functionSignatureParameter">const char *branch_name</span>, <span class="apiSignatureParameter functionSignatureParameter">const char *remote_url</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_oid *id</span>);
127127
</div>
128128

129129
<h3 class="apiParametersHeader functionParametersHeader">Parameters</h3>
130130
<div class="apiParameters functionParameters">
131-
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
131+
<div class="apiParameter functionParameter apiParameterOut functionParameterOut">
132132
<div class="apiParameterType functionParameterType">
133133
<a href="/docs/reference/main/annotated_commit/git_annotated_commit.html" class="apiLink objectLink">git_annotated_commit **</a>
134134
</div>
135-
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
136-
In
135+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionOut functionParameterDirectionOut">
136+
Out
137137
</div>
138138
<div class="apiParameterName functionParameterName">
139139
out

‎docs/reference/main/annotated_commit/git_annotated_commit_from_ref.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,20 +120,20 @@ <h2 class="apiName functionName">git_annotated_commit_from_ref</h2>
120120

121121
<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
122122
<div class="apiSignatureLink functionSignatureLink">
123-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L33" target="_blank" rel="noopener">GitHub</a>
123+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L40" target="_blank" rel="noopener">GitHub</a>
124124
</div>
125125
<div class="apiSignature functionSignature">
126126
int git_annotated_commit_from_ref(<span class="apiSignatureParameter functionSignatureParameter">git_annotated_commit **out</span>, <span class="apiSignatureParameter functionSignatureParameter">git_repository *repo</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_reference *ref</span>);
127127
</div>
128128

129129
<h3 class="apiParametersHeader functionParametersHeader">Parameters</h3>
130130
<div class="apiParameters functionParameters">
131-
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
131+
<div class="apiParameter functionParameter apiParameterOut functionParameterOut">
132132
<div class="apiParameterType functionParameterType">
133133
<a href="/docs/reference/main/annotated_commit/git_annotated_commit.html" class="apiLink objectLink">git_annotated_commit **</a>
134134
</div>
135-
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
136-
In
135+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionOut functionParameterDirectionOut">
136+
Out
137137
</div>
138138
<div class="apiParameterName functionParameterName">
139139
out

‎docs/reference/main/annotated_commit/git_annotated_commit_from_revspec.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,20 +116,20 @@ <h2 class="apiName functionName">git_annotated_commit_from_revspec</h2>
116116

117117
<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
118118
<div class="apiSignatureLink functionSignatureLink">
119-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L92" target="_blank" rel="noopener">GitHub</a>
119+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L99" target="_blank" rel="noopener">GitHub</a>
120120
</div>
121121
<div class="apiSignature functionSignature">
122122
int git_annotated_commit_from_revspec(<span class="apiSignatureParameter functionSignatureParameter">git_annotated_commit **out</span>, <span class="apiSignatureParameter functionSignatureParameter">git_repository *repo</span>, <span class="apiSignatureParameter functionSignatureParameter">const char *revspec</span>);
123123
</div>
124124

125125
<h3 class="apiParametersHeader functionParametersHeader">Parameters</h3>
126126
<div class="apiParameters functionParameters">
127-
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
127+
<div class="apiParameter functionParameter apiParameterOut functionParameterOut">
128128
<div class="apiParameterType functionParameterType">
129129
<a href="/docs/reference/main/annotated_commit/git_annotated_commit.html" class="apiLink objectLink">git_annotated_commit **</a>
130130
</div>
131-
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
132-
In
131+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionOut functionParameterDirectionOut">
132+
Out
133133
</div>
134134
<div class="apiParameterName functionParameterName">
135135
out

‎docs/reference/main/annotated_commit/git_annotated_commit_id.html

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

119119
<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
120120
<div class="apiSignatureLink functionSignatureLink">
121-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L103" target="_blank" rel="noopener">GitHub</a>
121+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L110" target="_blank" rel="noopener">GitHub</a>
122122
</div>
123123
<div class="apiSignature functionSignature">
124124
const git_oid *git_annotated_commit_id(<span class="apiSignatureParameter functionSignatureParameter">const git_annotated_commit *commit</span>);

‎docs/reference/main/annotated_commit/git_annotated_commit_lookup.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,20 +128,20 @@ <h2 class="apiName functionName">git_annotated_commit_lookup</h2>
128128

129129
<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
130130
<div class="apiSignatureLink functionSignatureLink">
131-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L75" target="_blank" rel="noopener">GitHub</a>
131+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L82" target="_blank" rel="noopener">GitHub</a>
132132
</div>
133133
<div class="apiSignature functionSignature">
134134
int git_annotated_commit_lookup(<span class="apiSignatureParameter functionSignatureParameter">git_annotated_commit **out</span>, <span class="apiSignatureParameter functionSignatureParameter">git_repository *repo</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_oid *id</span>);
135135
</div>
136136

137137
<h3 class="apiParametersHeader functionParametersHeader">Parameters</h3>
138138
<div class="apiParameters functionParameters">
139-
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
139+
<div class="apiParameter functionParameter apiParameterOut functionParameterOut">
140140
<div class="apiParameterType functionParameterType">
141141
<a href="/docs/reference/main/annotated_commit/git_annotated_commit.html" class="apiLink objectLink">git_annotated_commit **</a>
142142
</div>
143-
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
144-
In
143+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionOut functionParameterDirectionOut">
144+
Out
145145
</div>
146146
<div class="apiParameterName functionParameterName">
147147
out

‎docs/reference/main/annotated_commit/git_annotated_commit_ref.html

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

6969
<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
7070
<div class="apiSignatureLink functionSignatureLink">
71-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L112" target="_blank" rel="noopener">GitHub</a>
71+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L119" target="_blank" rel="noopener">GitHub</a>
7272
</div>
7373
<div class="apiSignature functionSignature">
7474
const char *git_annotated_commit_ref(<span class="apiSignatureParameter functionSignatureParameter">const git_annotated_commit *commit</span>);

‎docs/reference/main/annotated_commit/index.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,13 @@ <h2 class="groupName">annotated_commit</h2>
109109
</div>
110110
</div>
111111
<div class="groupIndexDetails">
112-
Git annotated commit routines
112+
<p>An &quot;annotated commit&quot; is a commit that contains information about
113+
how the commit was resolved, which can be used for maintaining the
114+
user's &quot;intent&quot; through commands like merge and rebase. For example,
115+
if a user wants to &quot;merge HEAD&quot; then an annotated commit is used to
116+
both contain the HEAD commit <em>and</em> the fact that it was resolved as
117+
the HEAD ref.</p>
118+
113119
</div>
114120

115121
<h3 class="apiListHeader objectListHeader">Objects</h3>
@@ -121,7 +127,7 @@ <h3 class="apiListHeader objectListHeader">Objects</h3>
121127
</a>
122128
</div>
123129
<div class="apiListItemDescription objectListItemDescription">
124-
<p>Annotated commits, the input to merge and rebase</p>
130+
<p>Annotated commits are commits with additional metadata about how the commit was resolved, which can be used for maintaining the user's &quot;intent&quot; through commands like merge and rebase</p>
125131
</div>
126132
</div>
127133
</div>

‎docs/reference/main/apply/GIT_APPLY_OPTIONS_INIT.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,14 @@ <h2 class="apiName macroName">GIT_APPLY_OPTIONS_INIT</h2>
6060
</div>
6161
</div>
6262

63+
64+
<div class="apiDescription macroDescription">
65+
<p>Static constructor for <a href="/docs/reference/main/apply/git_apply_options.html" class="apiLink structLink"><code><span class="codeWord">git_apply_options</span></code></a></p>
66+
67+
</div>
6368
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
6469
<div class="apiSignatureLink macroSignatureLink">
65-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L94" target="_blank" rel="noopener">GitHub</a>
70+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L115" target="_blank" rel="noopener">GitHub</a>
6671
</div>
6772
<div class="apiSignature macroSignature">
6873
#define GIT_APPLY_OPTIONS_INIT &#123;GIT_APPLY_OPTIONS_VERSION&#125; </div>

‎docs/reference/main/apply/GIT_APPLY_OPTIONS_VERSION.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,14 @@ <h2 class="apiName macroName">GIT_APPLY_OPTIONS_VERSION</h2>
6060
</div>
6161
</div>
6262

63+
64+
<div class="apiDescription macroDescription">
65+
<p>Current version for the <a href="/docs/reference/main/apply/git_apply_options.html" class="apiLink structLink"><code><span class="codeWord">git_apply_options</span></code></a> structure</p>
66+
67+
</div>
6368
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
6469
<div class="apiSignatureLink macroSignatureLink">
65-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L93" target="_blank" rel="noopener">GitHub</a>
70+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L112" target="_blank" rel="noopener">GitHub</a>
6671
</div>
6772
<div class="apiSignature macroSignature">
6873
#define GIT_APPLY_OPTIONS_VERSION 1 </div>

‎docs/reference/main/apply/git_apply.html

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

7070
<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
7171
<div class="apiSignatureLink functionSignatureLink">
72-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L157" target="_blank" rel="noopener">GitHub</a>
72+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L178" target="_blank" rel="noopener">GitHub</a>
7373
</div>
7474
<div class="apiSignature functionSignature">
7575
int git_apply(<span class="apiSignatureParameter functionSignatureParameter">git_repository *repo</span>, <span class="apiSignatureParameter functionSignatureParameter">git_diff *diff</span>, <span class="apiSignatureParameter functionSignatureParameter">git_apply_location_t location</span>, <span class="apiSignatureParameter functionSignatureParameter">const git_apply_options *options</span>);

‎docs/reference/main/apply/git_apply_delta_cb.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h2 class="apiName callbackName">git_apply_delta_cb</h2>
7878

7979
<h3 class="apiSignatureHeader callbackSignatureHeader">Signature</h3>
8080
<div class="apiSignatureLink callbackSignatureLink">
81-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L38" target="_blank" rel="noopener">GitHub</a>
81+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L41" target="_blank" rel="noopener">GitHub</a>
8282
</div>
8383
<div class="apiSignature callbackSignature">
8484
typedef int git_apply_delta_cb(<span class="apiSignatureParameter callbackSignatureParameter">const git_diff_delta *delta</span>, <span class="apiSignatureParameter callbackSignatureParameter">void *payload</span>);

‎docs/reference/main/apply/git_apply_flags_t.html

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,23 @@ <h2 class="apiName enumName">git_apply_flags_t</h2>
5555

5656

5757
<div class="apiDescription enumDescription">
58-
<p>Flags controlling the behavior of git_apply</p>
58+
<p>Flags controlling the behavior of <a href="/docs/reference/main/apply/git_apply.html" class="apiLink functionLink"><code><span class="codeWord">git_apply</span></code></a>.</p>
59+
60+
<p>When the callback:</p>
61+
<ul>
62+
<li>returns
63+
&lt;
64+
0, the apply process will be aborted.</li>
65+
<li>returns &gt; 0, the hunk will not be applied, but the apply process
66+
continues</li>
67+
<li>returns 0, the hunk is applied, and the apply process continues.</li>
68+
</ul>
5969

6070
</div>
6171

6272
<h3 class="apiMembersHeader enumMembersHeader">Values</h3>
6373
<div class="apiSignatureLink enumSignatureLink">
64-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L61" target="_blank" rel="noopener">GitHub</a>
74+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L72" target="_blank" rel="noopener">GitHub</a>
6575
</div>
6676
<div class="apiMembers enumMembers">
6777
<div class="apiMember enumMember">

‎docs/reference/main/apply/git_apply_hunk_cb.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h2 class="apiName callbackName">git_apply_hunk_cb</h2>
7878

7979
<h3 class="apiSignatureHeader callbackSignatureHeader">Signature</h3>
8080
<div class="apiSignatureLink callbackSignatureLink">
81-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L56" target="_blank" rel="noopener">GitHub</a>
81+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L59" target="_blank" rel="noopener">GitHub</a>
8282
</div>
8383
<div class="apiSignature callbackSignature">
8484
typedef int git_apply_hunk_cb(<span class="apiSignatureParameter callbackSignatureParameter">const git_diff_hunk *hunk</span>, <span class="apiSignatureParameter callbackSignatureParameter">void *payload</span>);

‎docs/reference/main/apply/git_apply_location_t.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ <h2 class="apiName enumName">git_apply_location_t</h2>
6868

6969
<h3 class="apiMembersHeader enumMembersHeader">Values</h3>
7070
<div class="apiSignatureLink enumSignatureLink">
71-
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L127" target="_blank" rel="noopener">GitHub</a>
71+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L148" target="_blank" rel="noopener">GitHub</a>
7272
</div>
7373
<div class="apiMembers enumMembers">
7474
<div class="apiMember enumMember">

0 commit comments

Comments
 (0)