summaryrefslogtreecommitdiff
path: root/include/git2/checkout.h
blob: ff1c4132a1547dc8d79021eb13c8e31fd4938741 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
 * 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


#define GIT_CHECKOUT_OVERWRITE_EXISTING 0
#define GIT_CHECKOUT_SKIP_EXISTING 1


typedef struct git_checkout_opts {
	git_indexer_stats stats;
	int existing_file_action;
	int apply_filters;
	int dir_mode;
	int file_open_mode;
} git_checkout_opts;

#define GIT_CHECKOUT_DEFAULT_OPTS {  \
	{0},                              \
	GIT_CHECKOUT_OVERWRITE_EXISTING,  \
	true,                             \
	GIT_DIR_MODE,                     \
	O_CREAT|O_TRUNC|O_WRONLY          \
}

/**
 * Updates files in the working tree to match the index.
 *
 * @param repo repository to check out (must be non-bare)
 * @param opts specifies checkout options (may be NULL)
 * @return 0 on success, GIT_ERROR otherwise (use git_error_last for information about the error)
 */
GIT_EXTERN(int) git_checkout_index(git_repository *repo, git_checkout_opts *opts);

/**
 * Updates files in the working tree to match the commit pointed to by HEAD.
 *
 * @param repo repository to check out (must be non-bare)
 * @param opts specifies checkout options (may be NULL)
 * @return 0 on success, GIT_ERROR otherwise (use git_error_last for information about the error)
 */
GIT_EXTERN(int) git_checkout_head(git_repository *repo, git_checkout_opts *opts);

/** @} */
GIT_END_DECL
#endif