Skip to content

Commit 05f2115

Browse files
authored
Merge pull request libgit2#6322 from libgit2/ethomson/stat
status: update documentation for default options
2 parents 70a182c + fb68f18 commit 05f2115

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

include/git2/status.h

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -227,13 +227,16 @@ typedef struct {
227227

228228
/**
229229
* The `show` value is one of the `git_status_show_t` constants that
230-
* control which files to scan and in what order.
230+
* control which files to scan and in what order. The default is
231+
* `GIT_STATUS_SHOW_INDEX_AND_WORKDIR`.
231232
*/
232233
git_status_show_t show;
233234

234235
/**
235236
* The `flags` value is an OR'ed combination of the
236-
* `git_status_opt_t` values above.
237+
* `git_status_opt_t` values above. The default is
238+
* `GIT_STATUS_OPT_DEFAULTS`, which matches git's default
239+
* behavior.
237240
*/
238241
unsigned int flags;
239242

0 commit comments

Comments
 (0)