Documentation update 2024-11-25

libgit2 · Nov 25, 2024 · 46ec687 · 46ec687
1 parent ece2d72
commit 46ec687
Show file tree

Hide file tree

Showing 79 changed files with 17,794 additions and 10,642 deletions.
diff --git a/docs/api/main.json b/docs/api/main.json
@@ -1,7 +1,6 @@
 {
   "info": {
-    "version": "main",
-    "commit": "c6111ec06cc0b0126cd67bdab78f8091e4cfaa10"
+    "commit": "4f0def867e4df60a19e54ece3ed1e5dc45dd6ce8"
   },
   "groups": {
     "sys/alloc": {
@@ -25316,7 +25315,7 @@
           "name": "git_merge_bases_many",
           "location": {
             "file": "merge.h",
-            "line": 480,
+            "line": 511,
             "column": 17
           },
           "returns": {
@@ -25350,7 +25349,13 @@
             }
           ],
           "comment": [
-            "Find all merge bases given a list of commits"
+            "Find all merge bases given a list of commits",
+            "This behaves similar to [`git merge-base`](https://git-scm.com/docs/git-merge-base#_discussion).",
+            "Given three commits `a`, `b`, and `c`, `merge_base_many`\n will compute a hypothetical commit `m`, which is a merge between `b`\n and `c`.",
+            "For example, with the following topology:\n ```text\n        o---o---o---o---C\n       /\n      /   o---o---o---B\n     /   /\n ---2---1---o---o---o---A\n ```",
+            "the result of `merge_base_many` given `a`, `b`, and `c` is 1. This is\n because the equivalent topology with the imaginary merge commit `m`\n between `b` and `c` is:\n ```text\n        o---o---o---o---o\n       /                 \n\\\n      /   o---o---o---o---M\n     /   /\n ---2---1---o---o---o---A\n ```",
+            "and the result of `merge_base_many` given `a` and `m` is 1.",
+            "If you're looking to recieve the common ancestor between all the\n given commits, use `merge_base_octopus`."
           ],
           "group": "merge"
         },
@@ -25359,7 +25364,7 @@
           "name": "git_merge_base_octopus",
           "location": {
             "file": "merge.h",
-            "line": 495,
+            "line": 526,
             "column": 17
           },
           "returns": {
@@ -25402,7 +25407,7 @@
           "name": "git_merge_file",
           "location": {
             "file": "merge.h",
-            "line": 517,
+            "line": 548,
             "column": 17
           },
           "returns": {
@@ -25452,7 +25457,7 @@
           "name": "git_merge_file_from_index",
           "location": {
             "file": "merge.h",
-            "line": 538,
+            "line": 569,
             "column": 17
           },
           "returns": {
@@ -25507,7 +25512,7 @@
           "name": "git_merge_file_result_free",
           "location": {
             "file": "merge.h",
-            "line": 551,
+            "line": 582,
             "column": 18
           },
           "returns": {
@@ -25531,7 +25536,7 @@
           "name": "git_merge_trees",
           "location": {
             "file": "merge.h",
-            "line": 569,
+            "line": 600,
             "column": 17
           },
           "returns": {
@@ -25587,7 +25592,7 @@
           "name": "git_merge_commits",
           "location": {
             "file": "merge.h",
-            "line": 592,
+            "line": 623,
             "column": 17
           },
           "returns": {
@@ -25637,7 +25642,7 @@
           "name": "git_merge",
           "location": {
             "file": "merge.h",
-            "line": 617,
+            "line": 648,
             "column": 17
           },
           "returns": {

diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/main/.metadata b/docs/reference/main/.metadata
@@ -1,4 +1,3 @@
 {
-  "version": "main",
-  "commit": "c6111ec06cc0b0126cd67bdab78f8091e4cfaa10"
+  "commit": "4f0def867e4df60a19e54ece3ed1e5dc45dd6ce8"
 }
diff --git a/docs/reference/main/apply/GIT_APPLY_OPTIONS_INIT.html b/docs/reference/main/apply/GIT_APPLY_OPTIONS_INIT.html
@@ -0,0 +1,197 @@
+---
+title: GIT_APPLY_OPTIONS_INIT (libgit2 main)
+layout: default
+---
+
+      <div class="api macro">
+        <div class="apiBreadcrumb macroBreadcrumb">
+          <ul>
+            <li><a href="/docs/reference/main/index.html">API Documentation</a></li>
+            <li><a href="/docs/reference/main/apply/index.html">apply</a></li>
+          </ul>
+        </div>
+        <div class="apiHeader macroHeader">
+          <h2 class="apiName macroName">GIT_APPLY_OPTIONS_INIT</h2>
+          <div class="apiHeaderVersionSelect macroHeaderVersionSelect">
+            <span>Version:</span>
+            <select onChange="window.location.href = this.value">
+              <option value="/docs/reference/main/apply/GIT_APPLY_OPTIONS_INIT.html" selected>main</option>
+              <option value="/docs/reference/v1.8.4/apply/GIT_APPLY_OPTIONS_INIT.html">v1.8.4</option>
+              <option value="/docs/reference/v1.8.3/apply/GIT_APPLY_OPTIONS_INIT.html">v1.8.3</option>
+              <option value="/docs/reference/v1.8.2/apply/GIT_APPLY_OPTIONS_INIT.html">v1.8.2</option>
+              <option value="/docs/reference/v1.8.2-rc1/apply/GIT_APPLY_OPTIONS_INIT.html">v1.8.2-rc1</option>
+              <option value="/docs/reference/v1.8.1/apply/GIT_APPLY_OPTIONS_INIT.html">v1.8.1</option>
+              <option value="/docs/reference/v1.8.0/apply/GIT_APPLY_OPTIONS_INIT.html">v1.8.0</option>
+              <option value="/docs/reference/v1.7.2/apply/GIT_APPLY_OPTIONS_INIT.html">v1.7.2</option>
+              <option value="/docs/reference/v1.7.1/apply/GIT_APPLY_OPTIONS_INIT.html">v1.7.1</option>
+              <option value="/docs/reference/v1.7.0/apply/GIT_APPLY_OPTIONS_INIT.html">v1.7.0</option>
+              <option value="/docs/reference/v1.6.5/apply/GIT_APPLY_OPTIONS_INIT.html">v1.6.5</option>
+              <option value="/docs/reference/v1.6.4/apply/GIT_APPLY_OPTIONS_INIT.html">v1.6.4</option>
+              <option value="/docs/reference/v1.6.3/apply/GIT_APPLY_OPTIONS_INIT.html">v1.6.3</option>
+              <option value="/docs/reference/v1.6.2/apply/GIT_APPLY_OPTIONS_INIT.html">v1.6.2</option>
+              <option value="/docs/reference/v1.6.1/apply/GIT_APPLY_OPTIONS_INIT.html">v1.6.1</option>
+              <option value="/docs/reference/v1.5.2/apply/GIT_APPLY_OPTIONS_INIT.html">v1.5.2</option>
+              <option value="/docs/reference/v1.5.1/apply/GIT_APPLY_OPTIONS_INIT.html">v1.5.1</option>
+              <option value="/docs/reference/v1.5.0/apply/GIT_APPLY_OPTIONS_INIT.html">v1.5.0</option>
+              <option value="/docs/reference/v1.4.6/apply/GIT_APPLY_OPTIONS_INIT.html">v1.4.6</option>
+              <option value="/docs/reference/v1.4.5/apply/GIT_APPLY_OPTIONS_INIT.html">v1.4.5</option>
+              <option value="/docs/reference/v1.4.4/apply/GIT_APPLY_OPTIONS_INIT.html">v1.4.4</option>
+              <option value="/docs/reference/v1.4.3/apply/GIT_APPLY_OPTIONS_INIT.html">v1.4.3</option>
+              <option value="/docs/reference/v1.4.2/apply/GIT_APPLY_OPTIONS_INIT.html">v1.4.2</option>
+              <option value="/docs/reference/v1.4.1/apply/GIT_APPLY_OPTIONS_INIT.html">v1.4.1</option>
+              <option value="/docs/reference/v1.4.0/apply/GIT_APPLY_OPTIONS_INIT.html">v1.4.0</option>
+              <option value="/docs/reference/v1.3.2/apply/GIT_APPLY_OPTIONS_INIT.html">v1.3.2</option>
+              <option value="/docs/reference/v1.3.1/apply/GIT_APPLY_OPTIONS_INIT.html">v1.3.1</option>
+              <option value="/docs/reference/v1.3.0/apply/GIT_APPLY_OPTIONS_INIT.html">v1.3.0</option>
+              <option value="/docs/reference/v1.2.0/apply/GIT_APPLY_OPTIONS_INIT.html">v1.2.0</option>
+              <option value="/docs/reference/v1.1.1/apply/GIT_APPLY_OPTIONS_INIT.html">v1.1.1</option>
+              <option value="/docs/reference/v1.1.0/apply/GIT_APPLY_OPTIONS_INIT.html">v1.1.0</option>
+              <option value="/docs/reference/v1.0.1/apply/GIT_APPLY_OPTIONS_INIT.html">v1.0.1</option>
+              <option value="/docs/reference/v1.0.0/apply/GIT_APPLY_OPTIONS_INIT.html">v1.0.0</option>
+              <option value="/docs/reference/v0.99.0/apply/GIT_APPLY_OPTIONS_INIT.html">v0.99.0</option>
+              <option value="/docs/reference/v0.28.5/apply/GIT_APPLY_OPTIONS_INIT.html">v0.28.5</option>
+              <option value="/docs/reference/v0.28.4/apply/GIT_APPLY_OPTIONS_INIT.html">v0.28.4</option>
+              <option value="/docs/reference/v0.28.3/apply/GIT_APPLY_OPTIONS_INIT.html">v0.28.3</option>
+              <option value="/docs/reference/v0.28.2/apply/GIT_APPLY_OPTIONS_INIT.html">v0.28.2</option>
+              <option value="/docs/reference/v0.28.1/apply/GIT_APPLY_OPTIONS_INIT.html">v0.28.1</option>
+              <option value="/docs/reference/v0.28.0/apply/GIT_APPLY_OPTIONS_INIT.html">v0.28.0</option>
+              <option value="/docs/reference/v0.28.0-rc1/apply/GIT_APPLY_OPTIONS_INIT.html">v0.28.0-rc1</option>
+            </select>
+          </div>
+        </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>
+        </div>
+        <div class="apiSignature macroSignature">
+          #define GIT_APPLY_OPTIONS_INIT &#123;GIT_APPLY_OPTIONS_VERSION&#125;        </div>
+        <h3 class="apiVersionsHeader macroVersionsHeader">Versions</h3>
+        <div class="apiVersions macroVersions">
+          <ul>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/main/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">main</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.8.4/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.8.4</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.8.3/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.8.3</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.8.2/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.8.2</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.8.2-rc1/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.8.2-rc1</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.8.1/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.8.1</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.8.0/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.8.0</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.7.2/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.7.2</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.7.1/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.7.1</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.7.0/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.7.0</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.6.5/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.6.5</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.6.4/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.6.4</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.6.3/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.6.3</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.6.2/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.6.2</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.6.1/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.6.1</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.5.2/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.5.2</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.5.1/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.5.1</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.5.0/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.5.0</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.4.6/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.4.6</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.4.5/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.4.5</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.4.4/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.4.4</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.4.3/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.4.3</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.4.2/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.4.2</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.4.1/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.4.1</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.4.0/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.4.0</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.3.2/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.3.2</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.3.1/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.3.1</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.3.0/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.3.0</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.2.0/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.2.0</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.1.1/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.1.1</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.1.0/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.1.0</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.0.1/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.0.1</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v1.0.0/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v1.0.0</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v0.99.0/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v0.99.0</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v0.28.5/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v0.28.5</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v0.28.4/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v0.28.4</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v0.28.3/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v0.28.3</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v0.28.2/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v0.28.2</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v0.28.1/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v0.28.1</a>
+          </li>
+          <li class="apiVersionDeltaUnchanged macroVersionDeltaUnchanged">
+            <a href="/docs/reference/v0.28.0/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v0.28.0</a>
+          </li>
+          <li class="apiVersionDeltaIntroduced macroVersionDeltaIntroduced">
+            <a href="/docs/reference/v0.28.0-rc1/apply/GIT_APPLY_OPTIONS_INIT.html" class="apiVersionLink macroVersionLink">v0.28.0-rc1</a>
+          </li>
+          </ul>
+        </div>
+      </div>