Skip to content

Commit

Permalink
Documentation update 2024-11-26
Browse files Browse the repository at this point in the history
  • Loading branch information
Documentation Site Generator committed Nov 26, 2024
1 parent 137a2a0 commit 4a2dd0f
Show file tree
Hide file tree
Showing 1,408 changed files with 7,737 additions and 4,665 deletions.
5,174 changes: 3,034 additions & 2,140 deletions docs/api/main.json
View file

Large diffs are not rendered by default.

171 changes: 95 additions & 76 deletions docs/reference/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/reference/main/.metadata
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"version": "main",
"commit": "e74b9c64a1ff0c88132ee50fc176aaa6210bacd2"
"commit": "b8ad17faf56bcfb2081092604c998005b6c31861"
}
23 changes: 19 additions & 4 deletions docs/reference/main/annotated_commit/git_annotated_commit.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,20 +112,29 @@ <h2 class="apiName objectName">git_annotated_commit</h2>


<div class="apiDescription objectDescription">
<p>Annotated commits, the input to merge and rebase.</p>
<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>

<p>For example, if a user wants to conceptually &quot;merge <code><span class="codeWord">HEAD</span></code>&quot;, then the
commit portion of an annotated commit will point to the <code><span class="codeWord">HEAD</span></code> commit,
but the <em>annotation</em> will denote the ref <code><span class="codeWord">HEAD</span></code>. This allows git to
perform the internal bookkeeping so that the system knows both the
content of what is being merged but also how the content was looked up
so that it can be recorded in the reflog appropriately.</p>

</div>

<h3 class="apiSignatureHeader objectSignatureHeader">Signature</h3>
<div class="apiSignatureLink objectSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/types.h#L198" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/types.h#L214" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature objectSignature">
typedef struct git_annotated_commit git_annotated_commit
</div>

<h3 class="apiParameterToHeader objectParameterToHeader">Parameter To</h3>
<div class="apiParameterTo objectParameterTo">
<h3 class="apiReturnedByHeader objectReturnedByHeader">Returned By</h3>
<div class="apiReturnedBy objectReturnedBy">
<ul>
<li>
<a href="/docs/reference/main/annotated_commit/git_annotated_commit_from_ref.html" className="apiLink functionLink">git_annotated_commit_from_ref</a>
Expand All @@ -139,6 +148,12 @@ <h3 class="apiParameterToHeader objectParameterToHeader">Parameter To</h3>
<li>
<a href="/docs/reference/main/annotated_commit/git_annotated_commit_from_revspec.html" className="apiLink functionLink">git_annotated_commit_from_revspec</a>
</li>
</ul>
</div>

<h3 class="apiParameterToHeader objectParameterToHeader">Parameter To</h3>
<div class="apiParameterTo objectParameterTo">
<ul>
<li>
<a href="/docs/reference/main/annotated_commit/git_annotated_commit_id.html" className="apiLink functionLink">git_annotated_commit_id</a>
</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/annotated_commit/git_annotated_commit_free.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h2 class="apiName functionName">git_annotated_commit_free</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L120" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L127" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
void git_annotated_commit_free(<span class="apiSignatureParameter functionSignatureParameter">git_annotated_commit *commit</span>);
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/main/annotated_commit/git_annotated_commit_from_fetchhead.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,20 +120,20 @@ <h2 class="apiName functionName">git_annotated_commit_from_fetchhead</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L50" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L57" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
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>);
</div>

<h3 class="apiParametersHeader functionParametersHeader">Parameters</h3>
<div class="apiParameters functionParameters">
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
<div class="apiParameter functionParameter apiParameterOut functionParameterOut">
<div class="apiParameterType functionParameterType">
<a href="/docs/reference/main/annotated_commit/git_annotated_commit.html" class="apiLink objectLink">git_annotated_commit **</a>
</div>
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
In
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionOut functionParameterDirectionOut">
Out
</div>
<div class="apiParameterName functionParameterName">
out
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/main/annotated_commit/git_annotated_commit_from_ref.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,20 +120,20 @@ <h2 class="apiName functionName">git_annotated_commit_from_ref</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L33" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L40" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
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>);
</div>

<h3 class="apiParametersHeader functionParametersHeader">Parameters</h3>
<div class="apiParameters functionParameters">
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
<div class="apiParameter functionParameter apiParameterOut functionParameterOut">
<div class="apiParameterType functionParameterType">
<a href="/docs/reference/main/annotated_commit/git_annotated_commit.html" class="apiLink objectLink">git_annotated_commit **</a>
</div>
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
In
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionOut functionParameterDirectionOut">
Out
</div>
<div class="apiParameterName functionParameterName">
out
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/main/annotated_commit/git_annotated_commit_from_revspec.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,20 +116,20 @@ <h2 class="apiName functionName">git_annotated_commit_from_revspec</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L92" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L99" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
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>);
</div>

<h3 class="apiParametersHeader functionParametersHeader">Parameters</h3>
<div class="apiParameters functionParameters">
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
<div class="apiParameter functionParameter apiParameterOut functionParameterOut">
<div class="apiParameterType functionParameterType">
<a href="/docs/reference/main/annotated_commit/git_annotated_commit.html" class="apiLink objectLink">git_annotated_commit **</a>
</div>
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
In
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionOut functionParameterDirectionOut">
Out
</div>
<div class="apiParameterName functionParameterName">
out
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/annotated_commit/git_annotated_commit_id.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h2 class="apiName functionName">git_annotated_commit_id</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L103" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L110" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
const git_oid *git_annotated_commit_id(<span class="apiSignatureParameter functionSignatureParameter">const git_annotated_commit *commit</span>);
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/main/annotated_commit/git_annotated_commit_lookup.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,20 +128,20 @@ <h2 class="apiName functionName">git_annotated_commit_lookup</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L75" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L82" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
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>);
</div>

<h3 class="apiParametersHeader functionParametersHeader">Parameters</h3>
<div class="apiParameters functionParameters">
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
<div class="apiParameter functionParameter apiParameterOut functionParameterOut">
<div class="apiParameterType functionParameterType">
<a href="/docs/reference/main/annotated_commit/git_annotated_commit.html" class="apiLink objectLink">git_annotated_commit **</a>
</div>
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
In
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionOut functionParameterDirectionOut">
Out
</div>
<div class="apiParameterName functionParameterName">
out
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/annotated_commit/git_annotated_commit_ref.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ <h2 class="apiName functionName">git_annotated_commit_ref</h2>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L112" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/annotated_commit.h#L119" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
const char *git_annotated_commit_ref(<span class="apiSignatureParameter functionSignatureParameter">const git_annotated_commit *commit</span>);
Expand Down
10 changes: 8 additions & 2 deletions docs/reference/main/annotated_commit/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,13 @@ <h2 class="groupName">annotated_commit</h2>
</div>
</div>
<div class="groupIndexDetails">
Git annotated commit routines
<p>An &quot;annotated commit&quot; is a commit that contains information about
how the commit was resolved, which can be used for maintaining the
user's &quot;intent&quot; through commands like merge and rebase. For example,
if a user wants to &quot;merge HEAD&quot; then an annotated commit is used to
both contain the HEAD commit <em>and</em> the fact that it was resolved as
the HEAD ref.</p>

</div>

<h3 class="apiListHeader objectListHeader">Objects</h3>
Expand All @@ -121,7 +127,7 @@ <h3 class="apiListHeader objectListHeader">Objects</h3>
</a>
</div>
<div class="apiListItemDescription objectListItemDescription">
<p>Annotated commits, the input to merge and rebase</p>
<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>
</div>
</div>
</div>
Expand Down
7 changes: 6 additions & 1 deletion docs/reference/main/apply/GIT_APPLY_OPTIONS_INIT.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,14 @@ <h2 class="apiName macroName">GIT_APPLY_OPTIONS_INIT</h2>
</div>
</div>


<div class="apiDescription macroDescription">
<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>

</div>
<h3 class="apiSignatureHeader macroSignatureHeader">Signature</h3>
<div class="apiSignatureLink macroSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L94" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L115" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature macroSignature">
#define GIT_APPLY_OPTIONS_INIT &#123;GIT_APPLY_OPTIONS_VERSION&#125; </div>
Expand Down
7 changes: 6 additions & 1 deletion docs/reference/main/apply/GIT_APPLY_OPTIONS_VERSION.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,14 @@ <h2 class="apiName macroName">GIT_APPLY_OPTIONS_VERSION</h2>
</div>
</div>


<div class="apiDescription macroDescription">
<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>

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

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L157" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L178" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
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>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/apply/git_apply_delta_cb.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ <h2 class="apiName callbackName">git_apply_delta_cb</h2>

<h3 class="apiSignatureHeader callbackSignatureHeader">Signature</h3>
<div class="apiSignatureLink callbackSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L38" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L41" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature callbackSignature">
typedef int git_apply_delta_cb(<span class="apiSignatureParameter callbackSignatureParameter">const git_diff_delta *delta</span>, <span class="apiSignatureParameter callbackSignatureParameter">void *payload</span>);
Expand Down
14 changes: 12 additions & 2 deletions docs/reference/main/apply/git_apply_flags_t.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,23 @@ <h2 class="apiName enumName">git_apply_flags_t</h2>


<div class="apiDescription enumDescription">
<p>Flags controlling the behavior of git_apply</p>
<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>

<p>When the callback:</p>
<ul>
<li>returns
&lt;
0, the apply process will be aborted.</li>
<li>returns &gt; 0, the hunk will not be applied, but the apply process
continues</li>
<li>returns 0, the hunk is applied, and the apply process continues.</li>
</ul>

</div>

<h3 class="apiMembersHeader enumMembersHeader">Values</h3>
<div class="apiSignatureLink enumSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L61" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L72" 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/apply/git_apply_hunk_cb.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ <h2 class="apiName callbackName">git_apply_hunk_cb</h2>

<h3 class="apiSignatureHeader callbackSignatureHeader">Signature</h3>
<div class="apiSignatureLink callbackSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L56" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L59" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature callbackSignature">
typedef int git_apply_hunk_cb(<span class="apiSignatureParameter callbackSignatureParameter">const git_diff_hunk *hunk</span>, <span class="apiSignatureParameter callbackSignatureParameter">void *payload</span>);
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/apply/git_apply_location_t.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ <h2 class="apiName enumName">git_apply_location_t</h2>

<h3 class="apiMembersHeader enumMembersHeader">Values</h3>
<div class="apiSignatureLink enumSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L127" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/apply.h#L148" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiMembers enumMembers">
<div class="apiMember enumMember">
Expand Down
Loading

0 comments on commit 4a2dd0f

Please sign in to comment.