summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@edwardthomson.com>2022-06-13 21:44:05 -0400
committerEdward Thomson <ethomson@edwardthomson.com>2022-06-13 21:44:05 -0400
commitfb68f1807139fcfe4938fd020f4b1de68252335e (patch)
treef514ea5b71778876f1b002b3c8f9da04f99dd15a
parent70a182c6d0d691fd6b58706e300152af8a0ef032 (diff)
downloadlibgit2-fb68f1807139fcfe4938fd020f4b1de68252335e.tar.gz
status: update documentation for default options
-rw-r--r--include/git2/status.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/include/git2/status.h b/include/git2/status.h
index d8f9663b4..bb28e875b 100644
--- 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;