FilesExpand file tree

main

/

clone.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

225 lines (203 loc) · 6.48 KB

main

/

clone.h

Copy path

Top

File metadata and controls

• Code
• Blame

225 lines (203 loc) · 6.48 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

/*

* Copyright (C) the libgit2 contributors. All rights reserved.

*

* 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_clone_h__

#define INCLUDE_git_clone_h__

#include "common.h"

#include "types.h"

#include "indexer.h"

#include "checkout.h"

#include "remote.h"

#include "transport.h"

/**

* @file git2/clone.h

* @brief Clone a remote repository to the local disk

* @defgroup git_clone Git cloning routines

* @ingroup Git

*

* Clone will take a remote repository - located on a remote server

* accessible by HTTPS or SSH, or a repository located elsewhere on

* the local disk - and place a copy in the given local path.

* @{

*/

GIT_BEGIN_DECL

/**

* Options for bypassing the git-aware transport on clone. Bypassing

* it means that instead of a fetch, libgit2 will copy the object

* database directory instead of figuring out what it needs, which is

* faster. If possible, it will hardlink the files to save space.

*/

typedef enum {

/**

* Auto-detect (default), libgit2 will bypass the git-aware

* transport for local paths, but use a normal fetch for

* `file://` urls.

*/

GIT_CLONE_LOCAL_AUTO,

/**

* Bypass the git-aware transport even for a `file://` url.

*/

GIT_CLONE_LOCAL,

/**

* Do no bypass the git-aware transport

*/

GIT_CLONE_NO_LOCAL,

/**

* Bypass the git-aware transport, but do not try to use

* hardlinks.

*/

GIT_CLONE_LOCAL_NO_LINKS

} git_clone_local_t;

/**

* The signature of a function matching git_remote_create, with an additional

* void* as a callback payload.

*

* Callers of git_clone may provide a function matching this signature to override

* the remote creation and customization process during a clone operation.

*

* @param[out] out the resulting remote

* @param repo the repository in which to create the remote

* @param name the remote's name

* @param url the remote's url

* @param payload an opaque payload

* @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code

*/

typedef int GIT_CALLBACK(git_remote_create_cb)(

git_remote **out,

git_repository *repo,

const char *name,

const char *url,

void *payload);

/**

* The signature of a function matching git_repository_init, with an

* additional void * as callback payload.

*

* Callers of git_clone my provide a function matching this signature

* to override the repository creation and customization process

* during a clone operation.

*

* @param[out] out the resulting repository

* @param path path in which to create the repository

* @param bare whether the repository is bare. This is the value from the clone options

* @param payload payload specified by the options

* @return 0, or a negative value to indicate error

*/

typedef int GIT_CALLBACK(git_repository_create_cb)(

git_repository **out,

const char *path,

int bare,

void *payload);

/**

* Clone options structure

*

* Initialize with `GIT_CLONE_OPTIONS_INIT`. Alternatively, you can

* use `git_clone_options_init`.

*

* @options[version] GIT_CLONE_OPTIONS_VERSION

* @options[init_macro] GIT_CLONE_OPTIONS_INIT

* @options[init_function] git_clone_options_init

*/

typedef struct git_clone_options {

unsigned int version;

/**

* These options are passed to the checkout step. To disable

* checkout, set the `checkout_strategy` to `GIT_CHECKOUT_NONE`

* or `GIT_CHECKOUT_DRY_RUN`.

*/

git_checkout_options checkout_opts;

/**

* Options which control the fetch, including callbacks.

*

* The callbacks are used for reporting fetch progress, and for acquiring

* credentials in the event they are needed.

*/

git_fetch_options fetch_opts;

/**

* Set to zero (false) to create a standard repo, or non-zero

* for a bare repo

*/

int bare;

/**

* Whether to use a fetch or copy the object database.

*/

git_clone_local_t local;

/**

* The name of the branch to checkout. NULL means use the

* remote's default branch.

*/

const char *checkout_branch;

/**

* A callback used to create the new repository into which to

* clone. If NULL, the 'bare' field will be used to determine

* whether to create a bare repository.

*/

git_repository_create_cb repository_cb;

/**

* An opaque payload to pass to the git_repository creation callback.

* This parameter is ignored unless repository_cb is non-NULL.

*/

void *repository_cb_payload;

/**

* A callback used to create the git_remote, prior to its being

* used to perform the clone operation. See the documentation for

* git_remote_create_cb for details. This parameter may be NULL,

* indicating that git_clone should provide default behavior.

*/

git_remote_create_cb remote_cb;

/**

* An opaque payload to pass to the git_remote creation callback.

* This parameter is ignored unless remote_cb is non-NULL.

*/

void *remote_cb_payload;

} git_clone_options;

/** Current version for the `git_clone_options` structure */

#define GIT_CLONE_OPTIONS_VERSION 1

/** Static constructor for `git_clone_options` */

#define GIT_CLONE_OPTIONS_INIT \

{ GIT_CLONE_OPTIONS_VERSION, \

GIT_CHECKOUT_OPTIONS_INIT, \

GIT_FETCH_OPTIONS_INIT }

/**

* Initialize git_clone_options structure

*

* Initializes a `git_clone_options` with default values. Equivalent to creating

* an instance with GIT_CLONE_OPTIONS_INIT.

*

* @param opts The `git_clone_options` struct to initialize.

* @param version The struct version; pass `GIT_CLONE_OPTIONS_VERSION`.

* @return Zero on success; -1 on failure.

*/

GIT_EXTERN(int) git_clone_options_init(

git_clone_options *opts,

unsigned int version);

/**

* Clone a remote repository.

*

* By default this creates its repository and initial remote to match

* git's defaults. You can use the options in the callback to

* customize how these are created.

*

* Note that the libgit2 library _must_ be initialized using

* `git_libgit2_init` before any APIs can be called, including

* this one.

*

* @param[out] out pointer that will receive the resulting repository object

* @param url the remote repository to clone

* @param local_path local directory to clone to

* @param options configuration options for the clone. If NULL, the

* function works as though GIT_OPTIONS_INIT were passed.

* @return 0 on success, any non-zero return value from a callback

* function, or a negative value to indicate an error (use

* `git_error_last` for a detailed error message)

*/

GIT_EXTERN(int) git_clone(

git_repository **out,

const char *url,

const char *local_path,

const git_clone_options *options);

/** @} */

GIT_END_DECL

#endif