Skip to content

Commit c06e21c

Browse files
author
Documentation Site Generator
committed
Documentation update 2025-02-03
1 parent e51da38 commit c06e21c

File tree

6 files changed

+34360
-34014
lines changed

6 files changed

+34360
-34014
lines changed

‎docs/api/main.json

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"info": {
33
"version": "main",
4-
"commit": "bad4a0785fce2a256d3a3bb8e18ac1fa91fcdf78"
4+
"commit": "1cd6872e8f446aecc13ab80af5c925fbaecc41d3"
55
},
66
"groups": {
77
"sys/alloc": {
@@ -8190,6 +8190,64 @@
81908190
"opts(GIT_OPT_SET_SERVER_TIMEOUT, int timeout)\n > Sets the timeout (in milliseconds) for reading from and writing\n > to a remote server. Set to 0 to use the system default."
81918191
],
81928192
"group": "common"
8193+
},
8194+
"git_buildinfo_t": {
8195+
"kind": "enum",
8196+
"name": "git_buildinfo_t",
8197+
"referenceName": "git_buildinfo_t",
8198+
"members": [
8199+
{
8200+
"name": "GIT_BUILDINFO_CPU",
8201+
"value": "1",
8202+
"comment": [
8203+
"The CPU type that libgit2 was built for."
8204+
]
8205+
},
8206+
{
8207+
"name": "GIT_BUILDINFO_COMMIT",
8208+
"comment": [
8209+
"The commit that libgit2 was built from."
8210+
]
8211+
}
8212+
],
8213+
"comment": [
8214+
"Build information items to query. This is the information type\n passed to `git_libgit2_buildinfo` to get particular information\n about the libgit2 build."
8215+
],
8216+
"location": {
8217+
"file": "common.h",
8218+
"line": 576,
8219+
"column": 9
8220+
},
8221+
"group": "common",
8222+
"parameterTo": [
8223+
"git_libgit2_buildinfo"
8224+
]
8225+
},
8226+
"git_libgit2_buildinfo": {
8227+
"kind": "function",
8228+
"name": "git_libgit2_buildinfo",
8229+
"location": {
8230+
"file": "common.h",
8231+
"line": 591,
8232+
"column": 26
8233+
},
8234+
"returns": {
8235+
"type": "const char *",
8236+
"comment": "the requested information, or `NULL` on error"
8237+
},
8238+
"params": [
8239+
{
8240+
"name": "info",
8241+
"type": "git_buildinfo_t",
8242+
"direction": "in",
8243+
"comment": "the build information to query",
8244+
"referenceType": "enum git_buildinfo_t"
8245+
}
8246+
],
8247+
"comment": [
8248+
"Query information about the compile-time information about\n libgit2."
8249+
],
8250+
"group": "common"
81938251
}
81948252
},
81958253
"info": {

‎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": "bad4a0785fce2a256d3a3bb8e18ac1fa91fcdf78"
3+
"commit": "1cd6872e8f446aecc13ab80af5c925fbaecc41d3"
44
}

‎docs/reference/main/common/git_buildinfo_t.html

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: git_buildinfo_t (libgit2 main)
3+
layout: default
4+
---
5+
6+
<div class="api enum">
7+
<div class="apiBreadcrumb enumBreadcrumb">
8+
<ul>
9+
<li><a href="/docs/reference/main/index.html">API Documentation</a></li>
10+
<li><a href="/docs/reference/main/common/index.html">common</a></li>
11+
</ul>
12+
</div>
13+
<div class="apiHeader enumHeader">
14+
<h2 class="apiName enumName">git_buildinfo_t</h2>
15+
16+
<script src="/js/minisearch.js"></script>
17+
<script src="/js/search.js"></script>
18+
<div class="headerSearchArea enumHeaderSearchArea" id="headersearcharea">
19+
<input class="headerSearchBox enumHeaderSearchBox" id="headersearchbox" placeholder="Search..." onInput="handleSearchSuggest({ version: 'main' })" onFocusIn="handleSearchSuggest({ version: 'main' })" onKeyUp="if (event.code === 'Enter') { submitSearch({ version: 'main' }); }"/>
20+
<div class="headerSearchResults enumHeaderSearchResults" id="headersearchresults">
21+
</div>
22+
</div>
23+
24+
<div class="apiHeaderVersionSelect enumHeaderVersionSelect">
25+
<span>Version:</span>
26+
<select onChange="window.location.href = this.value">
27+
<option value="/docs/reference/main/common/git_buildinfo_t.html" selected>main</option>
28+
</select>
29+
</div>
30+
</div>
31+
32+
33+
<div class="apiDescription enumDescription">
34+
<p>Build information items to query. This is the information type
35+
passed to <a href="/docs/reference/main/common/git_libgit2_buildinfo.html" class="apiLink functionLink"><code><span class="codeWord">git_libgit2_buildinfo</span></code></a> to get particular information
36+
about the libgit2 build.</p>
37+
38+
</div>
39+
40+
<h3 class="apiMembersHeader enumMembersHeader">Values</h3>
41+
<div class="apiSignatureLink enumSignatureLink">
42+
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/common.h#L576" target="_blank" rel="noopener">GitHub</a>
43+
</div>
44+
<div class="apiMembers enumMembers">
45+
<div class="apiMember enumMember">
46+
<div class="apiMemberName enumMemberName">
47+
GIT_BUILDINFO_CPU
48+
</div>
49+
<div class="apiMemberValue enumMemberValue">
50+
1
51+
</div>
52+
<div class="apiMemberDescription enumMemberDescription">
53+
<p>The CPU type that libgit2 was built for.</p>
54+
</div>
55+
</div>
56+
<div class="apiMember enumMember">
57+
<div class="apiMemberName enumMemberName">
58+
GIT_BUILDINFO_COMMIT
59+
</div>
60+
<div class="apiMemberValue enumMemberValue">
61+
2
62+
</div>
63+
<div class="apiMemberDescription enumMemberDescription">
64+
<p>The commit that libgit2 was built from.</p>
65+
</div>
66+
</div>
67+
</div>
68+
69+
<h3 class="apiParameterToHeader enumParameterToHeader">Parameter To</h3>
70+
<div class="apiParameterTo enumParameterTo">
71+
<ul>
72+
<li>
73+
<a href="/docs/reference/main/common/git_libgit2_buildinfo.html" className="apiLink functionLink">git_libgit2_buildinfo</a>
74+
</li>
75+
</ul>
76+
</div>
77+
<h3 class="apiVersionsHeader enumVersionsHeader">Versions</h3>
78+
<div class="apiVersions enumVersions">
79+
<ul>
80+
<li class="apiVersionDeltaIntroduced enumVersionDeltaIntroduced">
81+
<a href="/docs/reference/main/common/git_buildinfo_t.html" class="apiVersionLink enumVersionLink">main</a>
82+
</li>
83+
</ul>
84+
</div>
85+
</div>

‎docs/reference/main/common/git_libgit2_buildinfo.html

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: git_libgit2_buildinfo (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/common/index.html">common</a></li>
11+
</ul>
12+
</div>
13+
<div class="apiHeader functionHeader">
14+
<h2 class="apiName functionName">git_libgit2_buildinfo</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/common/git_libgit2_buildinfo.html" selected>main</option>
28+
</select>
29+
</div>
30+
</div>
31+
32+
33+
<div class="apiDescription functionDescription">
34+
<p>Query information about the compile-time information about
35+
libgit2.</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/common.h#L591" target="_blank" rel="noopener">GitHub</a>
42+
</div>
43+
<div class="apiSignature functionSignature">
44+
const char *git_libgit2_buildinfo(<span class="apiSignatureParameter functionSignatureParameter">git_buildinfo_t info</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/common/git_buildinfo_t.html" class="apiLink enumLink">git_buildinfo_t</a>
52+
</div>
53+
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
54+
In
55+
</div>
56+
<div class="apiParameterName functionParameterName">
57+
info
58+
</div>
59+
<div class="apiParameterDescription functionParameterDescription">
60+
<p>the build information to query</p>
61+
</div>
62+
</div>
63+
</div>
64+
65+
<h3 class="apiReturnHeader functionReturnHeader">Returns</h3>
66+
<div class="apiReturn functionReturn">
67+
<div class="apiReturnType functionReturnType">
68+
const char *
69+
</div>
70+
<div class="apiReturnDescription functionReturnDescription">
71+
<p>the requested information, or <code><span class="codeWord">NULL</span></code> on error</p>
72+
</div>
73+
</div>
74+
<h3 class="apiVersionsHeader functionVersionsHeader">Versions</h3>
75+
<div class="apiVersions functionVersions">
76+
<ul>
77+
<li class="apiVersionDeltaIntroduced functionVersionDeltaIntroduced">
78+
<a href="/docs/reference/main/common/git_libgit2_buildinfo.html" class="apiVersionLink functionVersionLink">main</a>
79+
</li>
80+
</ul>
81+
</div>
82+
</div>

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,16 @@ <h3 class="apiListHeader enumListHeader">Enums</h3>
234234
<p>Global library options</p>
235235
</div>
236236
</div>
237+
<div class="apiListItem enumListItem">
238+
<div class="apiListName enumListName">
239+
<a href="/docs/reference/main/common/git_buildinfo_t.html">
240+
git_buildinfo_t
241+
</a>
242+
</div>
243+
<div class="apiListItemDescription enumListItemDescription">
244+
<p>Build information items to query passed to <a href="/docs/reference/main/common/git_libgit2_buildinfo.html" class="apiLink functionLink"><code><span class="codeWord">git_libgit2_buildinfo</span></code></a> to get particular information about the libgit2 build.</p>
245+
</div>
246+
</div>
237247
</div>
238248

239249
<h3 class="apiListHeader functionListHeader">Functions</h3>
@@ -288,5 +298,15 @@ <h3 class="apiListHeader functionListHeader">Functions</h3>
288298
<p>Set or query a library global option</p>
289299
</div>
290300
</div>
301+
<div class="apiListItem functionListItem">
302+
<div class="apiListName functionListName">
303+
<a href="/docs/reference/main/common/git_libgit2_buildinfo.html">
304+
git_libgit2_buildinfo
305+
</a>
306+
</div>
307+
<div class="apiListItemDescription functionListItemDescription">
308+
<p>Query information about the compile-time information about libgit2</p>
309+
</div>
310+
</div>
291311
</div>
292312
</div>

0 commit comments

Comments
 (0)