Skip to content

Commit

Permalink
Documentation update 2024-12-09
Browse files Browse the repository at this point in the history
  • Loading branch information
Documentation Site Generator committed Dec 9, 2024
1 parent 3516885 commit 1f8dee4
Show file tree
Hide file tree
Showing 6 changed files with 20,227 additions and 20,049 deletions.
34 changes: 33 additions & 1 deletion docs/api/main.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"info": {
"version": "main",
"commit": "2b74d4be1a2ccc0697dbe1d2a64eb65ef9d8b620"
"commit": "4282cbd6d8859b11b2241685612c26f4cf3a7c66"
},
"groups": {
"sys/alloc": {
Expand Down Expand Up @@ -24916,6 +24916,37 @@
"Alternatively, call `reset` without a previous dump to \"undo\"\n all the recently written objects, giving transaction-like\n semantics to the Git repository."
],
"group": "sys/mempack"
},
"git_mempack_object_count": {
"kind": "function",
"name": "git_mempack_object_count",
"location": {
"file": "sys/mempack.h",
"line": 112,
"column": 17
},
"returns": {
"type": "int",
"comment": "0 on success, or -1 on error"
},
"params": [
{
"name": "count",
"type": "size_t *",
"direction": "in",
"comment": "The count of objects in the mempack"
},
{
"name": "backend",
"type": "git_odb_backend *",
"direction": "in",
"comment": "The mempack backend"
}
],
"comment": [
"Get the total number of objects in mempack"
],
"group": "sys/mempack"
}
},
"info": {
Expand Down Expand Up @@ -30598,6 +30629,7 @@
"git_mempack_write_thin_pack",
"git_mempack_dump",
"git_mempack_reset",
"git_mempack_object_count",
"git_odb_init_backend",
"git_odb_backend_data_alloc",
"git_odb_backend_data_free",
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/main/.metadata
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"version": "main",
"commit": "2b74d4be1a2ccc0697dbe1d2a64eb65ef9d8b620"
"commit": "4282cbd6d8859b11b2241685612c26f4cf3a7c66"
}
95 changes: 95 additions & 0 deletions docs/reference/main/sys/mempack/git_mempack_object_count.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
title: git_mempack_object_count (libgit2 main)
layout: default
---

<div class="api function">
<div class="apiBreadcrumb functionBreadcrumb">
<ul>
<li><a href="/docs/reference/main/index.html">API Documentation</a></li>
<li><a href="/docs/reference/main/sys/mempack/index.html">mempack (advanced)</a></li>
</ul>
</div>
<div class="apiHeader functionHeader">
<h2 class="apiName functionName">git_mempack_object_count</h2>

<script src="/js/minisearch.js"></script>
<script src="/js/search.js"></script>
<div class="headerSearchArea functionHeaderSearchArea" id="headersearcharea">
<input class="headerSearchBox functionHeaderSearchBox" id="headersearchbox" placeholder="Search..." onInput="handleSearchSuggest({ version: 'main' })" onFocusIn="handleSearchSuggest({ version: 'main' })" onKeyUp="if (event.code === 'Enter') { submitSearch({ version: 'main' }); }"/>
<div class="headerSearchResults functionHeaderSearchResults" id="headersearchresults">
</div>
</div>

<div class="apiHeaderVersionSelect functionHeaderVersionSelect">
<span>Version:</span>
<select onChange="window.location.href = this.value">
<option value="/docs/reference/main/sys/mempack/git_mempack_object_count.html" selected>main</option>
</select>
</div>
</div>


<div class="apiDescription functionDescription">
<p>Get the total number of objects in mempack</p>

</div>

<h3 class="apiSignatureHeader functionSignatureHeader">Signature</h3>
<div class="apiSignatureLink functionSignatureLink">
<a href="https://github.com/libgit2/libgit2/blob/main/include/git2/sys/mempack.h#L112" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="apiSignature functionSignature">
int git_mempack_object_count(<span class="apiSignatureParameter functionSignatureParameter">size_t *count</span>, <span class="apiSignatureParameter functionSignatureParameter">git_odb_backend *backend</span>);
</div>

<h3 class="apiParametersHeader functionParametersHeader">Parameters</h3>
<div class="apiParameters functionParameters">
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
<div class="apiParameterType functionParameterType">
size_t *
</div>
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
In
</div>
<div class="apiParameterName functionParameterName">
count
</div>
<div class="apiParameterDescription functionParameterDescription">
<p>The count of objects in the mempack</p>
</div>
</div>
<div class="apiParameter functionParameter apiParameterIn functionParameterIn">
<div class="apiParameterType functionParameterType">
<a href="/docs/reference/main/sys/odb_backend/git_odb_backend.html" class="apiLink structLink">git_odb_backend *</a>
</div>
<div class="apiParameterDirection functionParameterDirection apiParameterDirectionIn functionParameterDirectionIn">
In
</div>
<div class="apiParameterName functionParameterName">
backend
</div>
<div class="apiParameterDescription functionParameterDescription">
<p>The mempack backend</p>
</div>
</div>
</div>

<h3 class="apiReturnHeader functionReturnHeader">Returns</h3>
<div class="apiReturn functionReturn">
<div class="apiReturnType functionReturnType">
int
</div>
<div class="apiReturnDescription functionReturnDescription">
<p>0 on success, or -1 on error</p>
</div>
</div>
<h3 class="apiVersionsHeader functionVersionsHeader">Versions</h3>
<div class="apiVersions functionVersions">
<ul>
<li class="apiVersionDeltaIntroduced functionVersionDeltaIntroduced">
<a href="/docs/reference/main/sys/mempack/git_mempack_object_count.html" class="apiVersionLink functionVersionLink">main</a>
</li>
</ul>
</div>
</div>
10 changes: 10 additions & 0 deletions docs/reference/main/sys/mempack/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -171,5 +171,15 @@ <h3 class="apiListHeader functionListHeader">Functions</h3>
<p>Reset the memory packer by clearing all the queued objects</p>
</div>
</div>
<div class="apiListItem functionListItem">
<div class="apiListName functionListName">
<a href="/docs/reference/main/sys/mempack/git_mempack_object_count.html">
git_mempack_object_count
</a>
</div>
<div class="apiListItemDescription functionListItemDescription">
<p>Get the total number of objects in mempack</p>
</div>
</div>
</div>
</div>
3 changes: 3 additions & 0 deletions docs/reference/main/sys/odb_backend/git_odb_backend.html
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,9 @@ <h3 class="apiParameterToHeader structParameterToHeader">Parameter To</h3>
<li>
<a href="/docs/reference/main/sys/mempack/git_mempack_reset.html" className="apiLink functionLink">git_mempack_reset</a>
</li>
<li>
<a href="/docs/reference/main/sys/mempack/git_mempack_object_count.html" className="apiLink functionLink">git_mempack_object_count</a>
</li>
<li>
<a href="/docs/reference/main/sys/odb_backend/git_odb_init_backend.html" className="apiLink functionLink">git_odb_init_backend</a>
</li>
Expand Down
Loading

0 comments on commit 1f8dee4

Please sign in to comment.