diff options
author | Edward Thomson <ethomson@microsoft.com> | 2015-05-11 14:10:24 -0400 |
---|---|---|
committer | Edward Thomson <ethomson@microsoft.com> | 2015-05-11 14:13:31 -0400 |
commit | 1f1f5c639e7e7df3f0c65dbdbcc6b884041a8647 (patch) | |
tree | 0c41536f61ef7d421008982c7475ef1937c23d7c /include/git2 | |
parent | 15fdf0548f1c7a2783e1ac84383536065c1a50ae (diff) | |
download | libgit2-1f1f5c639e7e7df3f0c65dbdbcc6b884041a8647.tar.gz |
checkout: better document the `baseline_index` opt
Diffstat (limited to 'include/git2')
-rw-r--r-- | include/git2/checkout.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/include/git2/checkout.h b/include/git2/checkout.h index 58f190719..6cf9ed8bd 100644 --- a/include/git2/checkout.h +++ b/include/git2/checkout.h @@ -272,7 +272,15 @@ typedef struct git_checkout_options { */ git_strarray paths; - git_tree *baseline; /**< expected content of workdir, defaults to HEAD */ + /** The expected content of the working directory; defaults to HEAD. + * If the working directory does not match this baseline information, + * that will produce a checkout conflict. + */ + git_tree *baseline; + + /** Like `baseline` above, though expressed as an index. This + * option overrides `baseline`. + */ git_index *baseline_index; /**< expected content of workdir, expressed as an index. */ const char *target_directory; /**< alternative checkout path to workdir */ |