From bbba4805e742a81c27ede476cae897ad04af40e4 Mon Sep 17 00:00:00 2001 From: Erik Aigner Date: Mon, 25 Mar 2019 20:45:58 +0100 Subject: docs: clarify relation of safe and forced checkout strategy --- include/git2/checkout.h | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/include/git2/checkout.h b/include/git2/checkout.h index 3fb3fc127..e49111c5d 100644 --- a/include/git2/checkout.h +++ b/include/git2/checkout.h @@ -106,10 +106,22 @@ GIT_BEGIN_DECL typedef enum { GIT_CHECKOUT_NONE = 0, /**< default is a dry run, no actual updates */ - /** Allow safe updates that cannot overwrite uncommitted data */ + /** + * Allow safe updates that cannot overwrite uncommitted data. + * If the uncommitted changes don't conflict with the checked out files, + * the checkout will still proceed, leaving the changes intact. + * + * Mutually exclusive with GIT_CHECKOUT_FORCE. + * GIT_CHECKOUT_FORCE takes precedence over GIT_CHECKOUT_SAFE. + */ GIT_CHECKOUT_SAFE = (1u << 0), - /** Allow all updates to force working directory to look like index */ + /** + * Allow all updates to force working directory to look like index. + * + * Mutually exclusive with GIT_CHECKOUT_SAFE. + * GIT_CHECKOUT_FORCE takes precedence over GIT_CHECKOUT_SAFE. + */ GIT_CHECKOUT_FORCE = (1u << 1), -- cgit v1.2.1