Merge https://salsa.debian.org/debian/libgit2 into proxmox/bullseye

[libgit2.git] / include / git2 / status.h

diff --git a/include/git2/status.h b/include/git2/status.h
index d8f9663b42a368997944bfe859a7b0e978c93c0e..bb28e875b005db64ef7c2dca1abd09d015a59d6d 100644 (file)
--- a/include/git2/status.h
+++ b/include/git2/status.h
@@ -227,13 +227,16 @@ typedef struct {
 
        /**
         * The `show` value is one of the `git_status_show_t` constants that
-        * control which files to scan and in what order.
+        * control which files to scan and in what order. The default is
+        * `GIT_STATUS_SHOW_INDEX_AND_WORKDIR`.
         */
        git_status_show_t show;
 
        /**
         * The `flags` value is an OR'ed combination of the
-        * `git_status_opt_t` values above.
+        * `git_status_opt_t` values above. The default is
+        * `GIT_STATUS_OPT_DEFAULTS`, which matches git's default
+        * behavior.
         */
        unsigned int      flags;