Merge branch 'libgit2:main' into main

Author: bmarques1995

.github/release.yml

@@ -15,6 +15,9 @@ changelog:
   - title: Code cleanups
     labels:
     - cleanup
+  - title: Benchmarks
+    labels:
+    - benchmarks
   - title: Build and CI improvements
     labels:
     - build

.github/workflows/documentation.yml

@@ -0,0 +1,78 @@
+# Update the www.libgit2.org reference documentation
+name: Generate Documentation
+
+on:
+  push:
+    branches: [ main, maint/* ]
+  release:
+  workflow_dispatch:
+    inputs:
+      force:
+        description: 'Force rebuild'
+        type: boolean
+        required: true
+
+concurrency:
+  group: documentation
+
+permissions:
+  contents: read
+
+jobs:
+  documentation:
+    name: "Generate documentation"
+    runs-on: "ubuntu-latest"
+    steps:
+    - name: Check out source repository
+      uses: actions/checkout@v4
+      with:
+        path: source
+        fetch-depth: 0
+    - name: Check out documentation repository
+      uses: actions/checkout@v4
+      with:
+        repository: libgit2/www.libgit2.org
+        path: www
+        fetch-depth: 0
+        ssh-key: ${{ secrets.DOCS_PUBLISH_KEY }}
+    - name: Prepare branches
+      run: |
+        if [ "$(git rev-parse --abbrev-ref HEAD)" != "main" ]; then
+          git branch --track main origin/main
+        fi
+
+        for a in $(git branch -r --list 'origin/maint/*' | sed -e "s/^  origin\///"); do
+          git branch --track "$a" "origin/$a"
+        done
+      working-directory: source
+    - name: Generate documentation
+      run: |
+        args=""
+
+        if [ "${{ inputs.force }}" = "true" ]; then
+          args="--force"
+        fi
+
+        npm install
+        ./generate --verbose $args ../.. ../../../www/docs
+      working-directory: source/script/api-docs
+    - name: Examine changes
+      run: |
+        if [ -n "$(git diff --name-only)" ]; then
+           echo "changes=true" >> $GITHUB_OUTPUT
+        else
+           echo "changes=false" >> $GITHUB_OUTPUT
+        fi
+      id: check
+      working-directory: www
+    - name: Publish documentation
+      run: |
+        DATE=$(date +"%Y-%m-%d")
+
+        git config user.name 'Documentation Site Generator'
+        git config user.email '[email protected]'
+        git add .
+        git commit -m"Documentation update ${DATE}"
+        git push origin main
+      if: steps.check.outputs.changes == 'true'
+      working-directory: www

.github/workflows/main.yml

@@ -233,6 +233,17 @@ jobs:
         name: test-results-${{ matrix.platform.id }}
         path: build/results_*.xml
 
+  documentation:
+    name: Validate documentation
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v4
+    - name: Validate documentation
+      run: |
+        (cd script/api-docs && npm install)
+        script/api-docs/api-generator.js --validate-only --strict --deprecate-hard  .
+
   test_results:
     name: Test results
     needs: [ build ]
@@ -245,52 +256,3 @@ jobs:
       uses: test-summary/action@v2
       with:
         paths: 'test-results-*/*.xml'
-
-
-  # Generate documentation using docurium.  We'll upload the documentation
-  # as a build artifact so that it can be reviewed as part of a pull
-  # request or in a forked build.  For CI builds in the main repository's
-  # main branch, we'll push the gh-pages branch back up so that it is
-  # published to our documentation site.
-  documentation:
-    name: Generate documentation
-    if: success() || failure()
-    runs-on: ubuntu-latest
-    steps:
-    - name: Check out repository
-      uses: actions/checkout@v4
-      with:
-        path: source
-        fetch-depth: 0
-    - name: Set up container
-      uses: ./source/.github/actions/download-or-build-container
-      with:
-        registry: ${{ env.docker-registry }}
-        config-path: ${{ env.docker-config-path }}
-        container: docurium
-        github_token: ${{ secrets.github_token }}
-        dockerfile: ${{ matrix.platform.container.dockerfile }}
-    - name: Generate documentation
-      working-directory: source
-      run: |
-        git config user.name 'Documentation Generation'
-        git config user.email '[email protected]'
-        git branch gh-pages origin/gh-pages
-        docker login https://${{ env.docker-registry }} -u ${{ github.actor }} -p ${{ github.token }}
-        docker run \
-            --rm \
-            -v "$(pwd):/home/libgit2" \
-            -w /home/libgit2 \
-            ${{ env.docker-registry }}/${{ github.repository }}/docurium:latest \
-            cm doc api.docurium
-        git checkout gh-pages
-        zip --exclude .git/\* --exclude .gitignore --exclude .gitattributes -r api-documentation.zip .
-    - uses: actions/upload-artifact@v4
-      name: Upload artifact
-      with:
-        name: api-documentation
-        path: source/api-documentation.zip
-    - name: Push documentation branch
-      working-directory: source
-      run: git push origin gh-pages
-      if: github.event_name == 'push' && github.repository == 'libgit2/libgit2'

cmake/SelectZlib.cmake

@@ -4,6 +4,7 @@ include(SanitizeBool)
 SanitizeBool(USE_BUNDLED_ZLIB)
 if(USE_BUNDLED_ZLIB STREQUAL ON)
 	set(USE_BUNDLED_ZLIB "Bundled")
+	set(GIT_COMPRESSION_BUILTIN)
 endif()
 
 if(USE_BUNDLED_ZLIB STREQUAL "OFF")
@@ -17,6 +18,7 @@ if(USE_BUNDLED_ZLIB STREQUAL "OFF")
 			list(APPEND LIBGIT2_PC_REQUIRES "zlib")
 		endif()
 		add_feature_info(zlib ON "using system zlib")
+		set(GIT_COMPRESSION_ZLIB 1)
 	else()
 		message(STATUS "zlib was not found; using bundled 3rd-party sources." )
 	endif()
@@ -26,9 +28,11 @@ if(USE_BUNDLED_ZLIB STREQUAL "Chromium")
 	list(APPEND LIBGIT2_DEPENDENCY_INCLUDES "${PROJECT_SOURCE_DIR}/deps/chromium-zlib")
 	list(APPEND LIBGIT2_DEPENDENCY_OBJECTS $<TARGET_OBJECTS:chromium_zlib>)
 	add_feature_info(zlib ON "using (Chromium) bundled zlib")
+	set(GIT_COMPRESSION_BUILTIN 1)
 elseif(USE_BUNDLED_ZLIB OR NOT ZLIB_FOUND)
 	add_subdirectory("${PROJECT_SOURCE_DIR}/deps/zlib" "${PROJECT_BINARY_DIR}/deps/zlib")
 	list(APPEND LIBGIT2_DEPENDENCY_INCLUDES "${PROJECT_SOURCE_DIR}/deps/zlib")
 	list(APPEND LIBGIT2_DEPENDENCY_OBJECTS $<TARGET_OBJECTS:zlib>)
 	add_feature_info(zlib ON "using bundled zlib")
+	set(GIT_COMPRESSION_BUILTIN 1)
 endif()

docs/changelog.md

@@ -1,3 +1,31 @@
+v1.8.4
+------
+
+We erroneously shipped v1.8.3 without actually including the change
+in v1.8.2. This release re-re-introduces the pre-v1.8.0 `commit`
+constness behavior.
+
+## What's Changed
+
+### Bug fixes
+
+* Fix constness issue introduced in #6716 by @ethomson in https://github.com/libgit2/libgit2/pull/6829
+
+**Full Changelog**: https://github.com/libgit2/libgit2/compare/v1.8.3...v1.8.4
+
+v1.8.3
+------
+
+This release fixes a bug introduced in v1.8.1 for users of the legacy
+[Node.js http-parser](https://github.com/nodejs/http-parser)
+dependency.
+
+## What's Changed
+
+### Bug fixes
+
+* http: Backport on_status initialize fix for http-parser by @ethomson in https://github.com/libgit2/libgit2/pull/6931
+
 v1.8.2
 ------
 

examples/index-pack.c

@@ -29,7 +29,7 @@ int lg2_index_pack(git_repository *repo, int argc, char **argv)
 	}
 
 #ifdef GIT_EXPERIMENTAL_SHA256
-	error = git_indexer_new(&idx, ".", git_repository_oid_type(repo), NULL);
+	error = git_indexer_new(&idx, ".", NULL);
 #else
 	error = git_indexer_new(&idx, ".", 0, NULL, NULL);
 #endif

examples/show-index.c

@@ -31,7 +31,7 @@ int lg2_show_index(git_repository *repo, int argc, char **argv)
 	dirlen = strlen(dir);
 	if (dirlen > 5 && strcmp(dir + dirlen - 5, "index") == 0) {
 #ifdef GIT_EXPERIMENTAL_SHA256
-		check_lg2(git_index_open(&index, dir, GIT_OID_SHA1), "could not open index", dir);
+		check_lg2(git_index_open(&index, dir, NULL), "could not open index", dir);
 #else
 		check_lg2(git_index_open(&index, dir), "could not open index", dir);
 #endif

fuzzers/packfile_fuzzer.c

@@ -84,7 +84,7 @@ int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size)
 	}
 
 #ifdef GIT_EXPERIMENTAL_SHA256
-	error = git_indexer_new(&indexer, ".", GIT_OID_SHA1, NULL);
+	error = git_indexer_new(&indexer, ".", NULL);
 #else
 	error = git_indexer_new(&indexer, ".", 0, odb, NULL);
 #endif

include/git2/annotated_commit.h

@@ -13,9 +13,16 @@
 
 /**
  * @file git2/annotated_commit.h
- * @brief Git annotated commit routines
+ * @brief A commit and information about how it was looked up by the user.
  * @defgroup git_annotated_commit Git annotated commit routines
  * @ingroup Git
+ *
+ * An "annotated commit" is a commit that contains information about
+ * how the commit was resolved, which can be used for maintaining the
+ * user's "intent" through commands like merge and rebase. For example,
+ * if a user wants to "merge HEAD" then an annotated commit is used to
+ * both contain the HEAD commit _and_ the fact that it was resolved as
+ * the HEAD ref.
  * @{
  */
 GIT_BEGIN_DECL
@@ -25,7 +32,7 @@ GIT_BEGIN_DECL
  * The resulting git_annotated_commit must be freed with
  * `git_annotated_commit_free`.
  *
- * @param out pointer to store the git_annotated_commit result in
+ * @param[out] out pointer to store the git_annotated_commit result in
  * @param repo repository that contains the given reference
  * @param ref reference to use to lookup the git_annotated_commit
  * @return 0 on success or error code
@@ -40,7 +47,7 @@ GIT_EXTERN(int) git_annotated_commit_from_ref(
  * The resulting git_annotated_commit must be freed with
  * `git_annotated_commit_free`.
  *
- * @param out pointer to store the git_annotated_commit result in
+ * @param[out] out pointer to store the git_annotated_commit result in
  * @param repo repository that contains the given commit
  * @param branch_name name of the (remote) branch
  * @param remote_url url of the remote
@@ -67,7 +74,7 @@ GIT_EXTERN(int) git_annotated_commit_from_fetchhead(
  * most specific function (eg `git_annotated_commit_from_ref`)
  * instead of this one when that data is known.
  *
- * @param out pointer to store the git_annotated_commit result in
+ * @param[out] out pointer to store the git_annotated_commit result in
  * @param repo repository that contains the given commit
  * @param id the commit object id to lookup
  * @return 0 on success or error code
@@ -84,7 +91,7 @@ GIT_EXTERN(int) git_annotated_commit_lookup(
  * http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for
  * information on the syntax accepted.
  *
- * @param out pointer to store the git_annotated_commit result in
+ * @param[out] out pointer to store the git_annotated_commit result in
  * @param repo repository that contains the given commit
  * @param revspec the extended sha syntax string to use to lookup the commit
  * @return 0 on success or error code

include/git2/apply.h

@@ -14,9 +14,12 @@
 
 /**
  * @file git2/apply.h
- * @brief Git patch application routines
+ * @brief Apply patches to the working directory or index
  * @defgroup git_apply Git patch application routines
  * @ingroup Git
+ *
+ * Mechanisms to apply a patch to the index, the working directory,
+ * or both.
  * @{
  */
 GIT_BEGIN_DECL
@@ -57,7 +60,15 @@ typedef int GIT_CALLBACK(git_apply_hunk_cb)(
 	const git_diff_hunk *hunk,
 	void *payload);
 
-/** Flags controlling the behavior of git_apply */
+/**
+ * Flags controlling the behavior of `git_apply`.
+ *
+ * When the callback:
+ * - returns < 0, the apply process will be aborted.
+ * - returns > 0, the hunk will not be applied, but the apply process
+ *      continues
+ * - returns 0, the hunk is applied, and the apply process continues.
+ */
 typedef enum {
 	/**
 	 * Don't actually make changes, just test that the patch applies.
@@ -67,12 +78,19 @@ typedef enum {
 } git_apply_flags_t;
 
 /**
- * Apply options structure
+ * Apply options structure.
+ *
+ * When the callback:
+ * - returns < 0, the apply process will be aborted.
+ * - returns > 0, the hunk will not be applied, but the apply process
+ *      continues
+ * - returns 0, the hunk is applied, and the apply process continues.
  *
  * Initialize with `GIT_APPLY_OPTIONS_INIT`. Alternatively, you can
  * use `git_apply_options_init`.
  *
- * @see git_apply_to_tree, git_apply
+ * @see git_apply_to_tree
+ * @see git_apply
  */
 typedef struct {
 	unsigned int version; /**< The version */
@@ -83,14 +101,17 @@ typedef struct {
 	/** When applying a patch, callback that will be made per hunk. */
 	git_apply_hunk_cb hunk_cb;
 
-	/** Payload passed to both delta_cb & hunk_cb. */
+	/** Payload passed to both `delta_cb` & `hunk_cb`. */
 	void *payload;
 
-	/** Bitmask of git_apply_flags_t */
+	/** Bitmask of `git_apply_flags_t` */
 	unsigned int flags;
 } git_apply_options;
 
+/** Current version for the `git_apply_options` structure */
 #define GIT_APPLY_OPTIONS_VERSION 1
+
+/** Static constructor for `git_apply_options` */
 #define GIT_APPLY_OPTIONS_INIT {GIT_APPLY_OPTIONS_VERSION}
 
 /**