Update to 1.9.0

Author: todaysoftware

README.md

@@ -3,7 +3,7 @@
 Details
 -------
 
-Delphi / Free Pascal bindings for [libgit2](http://libgit2.github.com/) v1.8(.1).
+Delphi / Free Pascal bindings for [libgit2](https://www.libgit2.org/) v1.9(.0).
 
 Since I could not find anything very up to date in the Delphi/Pascal world for recent libgit2 versions I decided to do something myself with assistance from [CHelper](https://wiki.freepascal.org/Chelper).
 

src/git2/annotated_commit.inc

@@ -1,8 +1,15 @@
 (**
  * @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.
  * @{
   *)
 
@@ -11,7 +18,7 @@
  * 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
@@ -25,7 +32,7 @@ function git_annotated_commit_from_ref(out_: PPgit_annotated_commit; repo: Pgit_
  * 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
@@ -49,7 +56,7 @@ function git_annotated_commit_from_fetchhead(out_: PPgit_annotated_commit; repo:
  * 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
@@ -65,7 +72,7 @@ function git_annotated_commit_lookup(out_: PPgit_annotated_commit; repo: Pgit_re
  * 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

src/git2/apply.inc

@@ -1,8 +1,11 @@
 (**
  * @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.
  * @{
   *)
 
@@ -42,7 +45,15 @@ type
 type
   git_apply_hunk_cb = function(hunk: Pgit_diff_hunk; payload: Pointer): Integer; cdecl;
 
-  (** 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.
+   *)
 
 const
   (**
@@ -54,41 +65,50 @@ type
   git_apply_flags_t = Integer;
 
   (**
- * Apply options structure
- *
- * Initialize with `GIT_APPLY_OPTIONS_INIT`. Alternatively, you can
- * use `git_apply_options_init`.
- *
- * @see git_apply_to_tree, git_apply
-  *)
+   * 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
+   * @see git_apply
+   *)
 
   git_apply_options = record
     version: Cardinal; (**< The version  *)
     (** When applying a patch, callback that will be made per delta (file).  *)
     delta_cb: git_apply_delta_cb;
     (** When applying a patch, callback that will be made per hunk.  *)
     hunk_cb: git_apply_hunk_cb;
-    (** Payload passed to both delta_cb & hunk_cb.  *)
+    (** Payload passed to both `delta_cb` & `hunk_cb`.  *)
     payload: Pointer;
-    (** Bitmask of git_apply_flags_t  *)
+    (** Bitmask of `git_apply_flags_t`  *)
     flags: Cardinal;
   end;
   Pgit_apply_options = ^git_apply_options;
 
 const
+  (** Current version for the `git_apply_options` structure *)
   GIT_APPLY_OPTIONS_VERSION   = 1;
+  (** Static constructor for `git_apply_options` *)
   //GIT_APPLY_OPTIONS_INIT = { GIT_APPLY_OPTIONS_VERSION };
 
-(**
- * Initialize git_apply_options structure
- *
- * Initialize a `git_apply_options` with default values. Equivalent to creating
- * an instance with GIT_APPLY_OPTIONS_INIT.
- *
- * @param opts The `git_apply_options` struct to initialize.
- * @param version The struct version; pass `GIT_APPLY_OPTIONS_VERSION`
- * @return 0 on success or -1 on failure.
- *)
+  (**
+   * Initialize git_apply_options structure
+   *
+   * Initialize a `git_apply_options` with default values. Equivalent to creating
+   * an instance with GIT_APPLY_OPTIONS_INIT.
+   *
+   * @param opts The `git_apply_options` struct to initialize.
+   * @param version The struct version; pass `GIT_APPLY_OPTIONS_VERSION`
+   * @return 0 on success or -1 on failure.
+   *)
 
 function git_apply_options_init(opts: Pgit_apply_options; version: Cardinal)
   : Integer; cdecl; external libgit2_dll;
@@ -145,5 +165,3 @@ function git_apply(repo: Pgit_repository; diff: Pgit_diff; location: git_apply_l
 
 (** @}  *)
 
-
-

src/git2/attr.inc

@@ -1,8 +1,12 @@
 (**
  * @file git2/attr.h
- * @brief Git attribute management routines
+ * @brief Attribute management routines
  * @defgroup git_attr Git attribute management routines
  * @ingroup Git
+ *
+ * Attributes specify additional information about how git should
+ * handle particular paths - for example, they may indicate whether
+ * a particular filter is applied, like LFS or line ending conversions.
  * @{
   *)
 
@@ -110,10 +114,14 @@ function git_attr_value(attr: PAnsiChar): git_attr_value_t; cdecl; external libg
   *)
 
 const
+  (** Examine attribute in working directory, then index *)
   GIT_ATTR_CHECK_FILE_THEN_INDEX = 0;
+  (** Examine attribute in index, then working directory *)
   GIT_ATTR_CHECK_INDEX_THEN_FILE = 1;
+  (** Examine attributes only in the index *)
   GIT_ATTR_CHECK_INDEX_ONLY      = 2;
-  (**
+
+(**
  * Check attribute flags: controlling extended attribute behavior.
  *
  * Normally, attribute checks include looking in the /etc (or system
@@ -128,9 +136,13 @@ const
  * from a `.gitattributes` file in a specific commit.
   *)
 
+  (** Ignore system attributes *)
   GIT_ATTR_CHECK_NO_SYSTEM    = (1 shl 2);
+  (** Honor `.gitattributes` in the HEAD revision *)
   GIT_ATTR_CHECK_INCLUDE_HEAD = (1 shl 3);
+  (** Honor `.gitattributes` in a specific commit *)
   GIT_ATTR_CHECK_INCLUDE_COMMIT = (1 shl 4);
+
   (**
   * An options structure for querying attributes.
   *)
@@ -154,7 +166,9 @@ type
   Pgit_attr_options = ^git_attr_options;
 
 const
+  (** Current version for the `git_attr_options` structure *)
   GIT_ATTR_OPTIONS_VERSION    = 1;
+  (** Static constructor for `git_attr_options` *)
   //GIT_ATTR_OPTIONS_INIT {GIT_ATTR_OPTIONS_VERSION}
 
   (**