Skip to content

Commit 2d10c16

Browse files
author
Documentation Site Generator
committed
Documentation update 2026-08-08
1 parent 3e51eec commit 2d10c16

9 files changed

Lines changed: 25145 additions & 24513 deletions

File tree

docs/api/main.json

Lines changed: 116 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"info": {
33
"version": "main",
4-
"commit": "db532f784b40b2fe55a37d8a9eac887b4718c473"
4+
"commit": "270074bc292a51af1dd38456ae4526d244c91cfe"
55
},
66
"groups": {
77
"sys/alloc": {
@@ -3798,6 +3798,7 @@
37983798
"git_filter_list_apply_to_buffer",
37993799
"git_filter_list_apply_to_file",
38003800
"git_filter_list_apply_to_blob",
3801+
"git_index_extension_lookup",
38013802
"git_message_prettify",
38023803
"git_note_default_ref",
38033804
"git_object_short_id",
@@ -24997,6 +24998,117 @@
2499724998
],
2499824999
"group": "index"
2499925000
},
25001+
"git_index_extension_lookup": {
25002+
"kind": "function",
25003+
"name": "git_index_extension_lookup",
25004+
"location": {
25005+
"file": "index.h",
25006+
"line": 951,
25007+
"column": 17
25008+
},
25009+
"returns": {
25010+
"type": "int",
25011+
"comment": "0 (no error), GIT_ENOTFOUND (extension not present),\n or an error code"
25012+
},
25013+
"params": [
25014+
{
25015+
"name": "out",
25016+
"type": "git_buf *",
25017+
"direction": "in",
25018+
"comment": "the extension's data (not including the header)"
25019+
},
25020+
{
25021+
"name": "index",
25022+
"type": "git_index *",
25023+
"direction": "in",
25024+
"comment": "an existing index object"
25025+
},
25026+
{
25027+
"name": "signature",
25028+
"type": "const char *",
25029+
"direction": "in",
25030+
"comment": "the 4 character signature of the desired extension"
25031+
}
25032+
],
25033+
"comment": [
25034+
"Look up an index extension by its signature"
25035+
],
25036+
"group": "index"
25037+
},
25038+
"git_index_extension_add": {
25039+
"kind": "function",
25040+
"name": "git_index_extension_add",
25041+
"location": {
25042+
"file": "index.h",
25043+
"line": 966,
25044+
"column": 17
25045+
},
25046+
"returns": {
25047+
"type": "int",
25048+
"comment": "0 (no error), GIT_EEXISTS (extension already present),\n or an error code"
25049+
},
25050+
"params": [
25051+
{
25052+
"name": "index",
25053+
"type": "git_index *",
25054+
"direction": "in",
25055+
"comment": "an existing index object"
25056+
},
25057+
{
25058+
"name": "signature",
25059+
"type": "const char *",
25060+
"direction": "in",
25061+
"comment": "the 4 character signature of the desired extension"
25062+
},
25063+
{
25064+
"name": "data",
25065+
"type": "const char *",
25066+
"direction": "in",
25067+
"comment": "the contents of the extension (not including the header)"
25068+
},
25069+
{
25070+
"name": "data_len",
25071+
"type": "size_t",
25072+
"direction": "in",
25073+
"comment": "the length of the data"
25074+
}
25075+
],
25076+
"comment": [
25077+
"Add an extension to the index"
25078+
],
25079+
"group": "index"
25080+
},
25081+
"git_index_extension_remove": {
25082+
"kind": "function",
25083+
"name": "git_index_extension_remove",
25084+
"location": {
25085+
"file": "index.h",
25086+
"line": 980,
25087+
"column": 17
25088+
},
25089+
"returns": {
25090+
"type": "int",
25091+
"comment": "0 (no error), GIT_ENOTFOUND (extension not present),\n or an error code"
25092+
},
25093+
"params": [
25094+
{
25095+
"name": "index",
25096+
"type": "git_index *",
25097+
"direction": "in",
25098+
"comment": "an existing index object"
25099+
},
25100+
{
25101+
"name": "signature",
25102+
"type": "const char *",
25103+
"direction": "in",
25104+
"comment": "the 4 character signature of the desired extension"
25105+
}
25106+
],
25107+
"comment": [
25108+
"Remove an index extension by its signature"
25109+
],
25110+
"group": "index"
25111+
},
2500025112
"git_index": {
2500125113
"kind": "struct",
2500225114
"name": "git_index",
@@ -25064,6 +25176,9 @@
2506425176
"git_index_conflict_cleanup",
2506525177
"git_index_has_conflicts",
2506625178
"git_index_conflict_iterator_new",
25179+
"git_index_extension_lookup",
25180+
"git_index_extension_add",
25181+
"git_index_extension_remove",
2506725182
"git_pathspec_match_index",
2506825183
"git_rebase_inmemory_index",
2506925184
"git_index_name_entrycount",

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": "db532f784b40b2fe55a37d8a9eac887b4718c473"
3+
"commit": "270074bc292a51af1dd38456ae4526d244c91cfe"
44
}

docs/reference/main/buffer/git_buf.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,9 @@ <h3 class="apiParameterToHeader structParameterToHeader">Parameter To</h3>
318318
<li>
319319
<a href="/docs/reference/main/filter/git_filter_list_apply_to_blob.html" className="apiLink functionLink">git_filter_list_apply_to_blob</a>
320320
</li>
321+
<li>
322+
<a href="/docs/reference/main/index/git_index_extension_lookup.html" className="apiLink functionLink">git_index_extension_lookup</a>
323+
</li>
321324
<li>
322325
<a href="/docs/reference/main/message/git_message_prettify.html" className="apiLink functionLink">git_message_prettify</a>
323326
</li>

docs/reference/main/index/git_index.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,15 @@ <h3 class="apiParameterToHeader objectParameterToHeader">Parameter To</h3>
322322
<li>
323323
<a href="/docs/reference/main/index/git_index_conflict_iterator_new.html" className="apiLink functionLink">git_index_conflict_iterator_new</a>
324324
</li>
325+
<li>
326+
<a href="/docs/reference/main/index/git_index_extension_lookup.html" className="apiLink functionLink">git_index_extension_lookup</a>
327+
</li>
328+
<li>
329+
<a href="/docs/reference/main/index/git_index_extension_add.html" className="apiLink functionLink">git_index_extension_add</a>
330+
</li>
331+
<li>
332+
<a href="/docs/reference/main/index/git_index_extension_remove.html" className="apiLink functionLink">git_index_extension_remove</a>
333+
</li>
325334
<li>
326335
<a href="/docs/reference/main/pathspec/git_pathspec_match_index.html" className="apiLink functionLink">git_pathspec_match_index</a>
327336
</li>
Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
---
2+
title: git_index_extension_add (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/index/index.html">index</a></li>
11+
</ul>
12+
</div>
13+
<div class="apiHeader functionHeader">
14+
<h2 class="apiName functionName">git_index_extension_add</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/index/git_index_extension_add.html" selected>main</option>
28+
</select>
29+
</div>
30+
</div>
31+
32+
33+
<div class="apiDescription functionDescription">
34+
<p>Add an extension to the index</p>
35+
36+
</div>
37+
38+
<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
39+
<div class="apiSignatureLink functionSignatureLink">
40+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/index.h#L966" target="_blank" rel="noopener">GitHub</a>
41+
</div>
42+
<div class="apiSignature functionSignature">
43+
int git_index_extension_add(<span class="apiSignatureParameter functionSignatureParameter">git_index *index</span>, <span class="apiSignatureParameter functionSignatureParameter">const char *signature</span>, <span class="apiSignatureParameter functionSignatureParameter">const char *data</span>, <span class="apiSignatureParameter functionSignatureParameter">size_t data_len</span>);
44+
</div>
45+
46+
<h3 class="apiParametersHeader functionParametersHeader">Parameters</h3>
47+
<div class="apiParameters functionParameters">
48+
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
49+
<div class="apiParameterType functionParameterType">
50+
<a href="/docs/reference/main/index/git_index.html" class="apiLink objectLink">git_index *</a>
51+
</div>
52+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
53+
In
54+
</div>
55+
<div class="apiParameterName functionParameterName">
56+
index
57+
</div>
58+
<div class="apiParameterDescription functionParameterDescription">
59+
<p>an existing index object</p>
60+
</div>
61+
</div>
62+
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
63+
<div class="apiParameterType functionParameterType">
64+
const char *
65+
</div>
66+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
67+
In
68+
</div>
69+
<div class="apiParameterName functionParameterName">
70+
signature
71+
</div>
72+
<div class="apiParameterDescription functionParameterDescription">
73+
<p>the 4 character signature of the desired extension</p>
74+
</div>
75+
</div>
76+
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
77+
<div class="apiParameterType functionParameterType">
78+
const char *
79+
</div>
80+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
81+
In
82+
</div>
83+
<div class="apiParameterName functionParameterName">
84+
data
85+
</div>
86+
<div class="apiParameterDescription functionParameterDescription">
87+
<p>the contents of the extension (not including the header)</p>
88+
</div>
89+
</div>
90+
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
91+
<div class="apiParameterType functionParameterType">
92+
size_t
93+
</div>
94+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
95+
In
96+
</div>
97+
<div class="apiParameterName functionParameterName">
98+
data_len
99+
</div>
100+
<div class="apiParameterDescription functionParameterDescription">
101+
<p>the length of the data</p>
102+
</div>
103+
</div>
104+
</div>
105+
106+
<h3 class="apiReturnHeader functionReturnHeader">Returns</h3>
107+
<div class="apiReturn functionReturn">
108+
<div class="apiReturnType functionReturnType">
109+
int
110+
</div>
111+
<div class="apiReturnDescription functionReturnDescription">
112+
<p>0 (no error), GIT_EEXISTS (extension already present), or an error code</p>
113+
</div>
114+
</div>
115+
<h3 class="apiVersionsHeader functionVersionsHeader">Versions</h3>
116+
<div class="apiVersions functionVersions">
117+
<ul>
118+
<li class="apiVersionDeltaIntroduced functionVersionDeltaIntroduced">
119+
<a href="/docs/reference/main/index/git_index_extension_add.html" class="apiVersionLink functionVersionLink">main</a>
120+
</li>
121+
</ul>
122+
</div>
123+
</div>

0 commit comments

Comments
 (0)