summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@github.com>2021-08-29 21:49:26 -0400
committerGitHub <noreply@github.com>2021-08-29 21:49:26 -0400
commitaebdee8e3d2871ef4606f1feb0f46a82cfca1373 (patch)
tree816aefebc70fd716d2bc140c7564475da759efc9 /include
parent958205a33d9e9d078f41a9a3ac04dc7c657840c7 (diff)
downloadlibgit2-aebdee8e3d2871ef4606f1feb0f46a82cfca1373.tar.gz
Update include/git2/checkout.h
Diffstat (limited to 'include')
-rw-r--r--include/git2/checkout.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/include/git2/checkout.h b/include/git2/checkout.h
index d4c1cfa0b..e0069b661 100644
--- a/include/git2/checkout.h
+++ b/include/git2/checkout.h
@@ -177,7 +177,10 @@ typedef enum {
/** Normally checkout writes the index upon completion; this prevents that. */
GIT_CHECKOUT_DONT_WRITE_INDEX = (1u << 23),
- /** Stop checkout after the notifications happend but before the working directory is touched. */
+ /**
+ * Show what would be done by a checkout. Stop after sending
+ * notifications; don't update the working directory or index.
+ */
GIT_CHECKOUT_DRY_RUN = (1u << 24),
/**