summaryrefslogtreecommitdiff
path: root/include/git2/checkout.h
diff options
context:
space:
mode:
authorBen Straub <bstraub@github.com>2012-06-21 11:13:19 -0700
committerBen Straub <bstraub@github.com>2012-06-21 11:13:19 -0700
commit14741d62d9a8ae79774cf891a7ed665d8d650188 (patch)
treea896a5e1e65c52d75b50aece56ec057cba54f32d /include/git2/checkout.h
parent941611153a497ddfe454e07c48584b7e23bf484a (diff)
downloadlibgit2-14741d62d9a8ae79774cf891a7ed665d8d650188.tar.gz
Clone: new home for git_checkout_force.
Diffstat (limited to 'include/git2/checkout.h')
-rw-r--r--include/git2/checkout.h38
1 files changed, 38 insertions, 0 deletions
diff --git a/include/git2/checkout.h b/include/git2/checkout.h
new file mode 100644
index 000000000..9dec5b93d
--- /dev/null
+++ b/include/git2/checkout.h
@@ -0,0 +1,38 @@
+/*
+ * Copyright (C) 2012 the libgit2 contributors
+ *
+ * This file is part of libgit2, distributed under the GNU GPL v2 with
+ * a Linking Exception. For full terms see the included COPYING file.
+ */
+#ifndef INCLUDE_git_checkout_h__
+#define INCLUDE_git_checkout_h__
+
+#include "common.h"
+#include "types.h"
+#include "indexer.h"
+
+
+/**
+ * @file git2/checkout.h
+ * @brief Git checkout routines
+ * @defgroup git_checkout Git checkout routines
+ * @ingroup Git
+ * @{
+ */
+GIT_BEGIN_DECL
+
+/**
+ * Updates files in the working tree to match the version in the index
+ * or HEAD.
+ *
+ * @param repo repository to check out (must be non-bare)
+ * @param origin_url repository to clone from
+ * @param workdir_path local directory to clone to
+ * @param stats pointer to structure that receives progress information (may be NULL)
+ * @return 0 on success, GIT_ERROR otherwise (use git_error_last for information about the error)
+ */
+GIT_EXTERN(int) git_checkout_force(git_repository *repo, git_indexer_stats *stats);
+
+/** @} */
+GIT_END_DECL
+#endif