FilesExpand file tree

master

/

reset.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

111 lines (104 loc) · 3.29 KB

master

/

reset.h

Copy path

Top

File metadata and controls

• Code
• Blame

111 lines (104 loc) · 3.29 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

/*

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

#define INCLUDE_git_reset_h__

#include "common.h"

#include "types.h"

#include "strarray.h"

#include "checkout.h"

/**

* @file git2/reset.h

* @brief Git reset management routines

* @ingroup Git

* @{

*/

GIT_BEGIN_DECL

/**

* Kinds of reset operation

*/

typedef enum {

GIT_RESET_SOFT = 1, /**< Move the head to the given commit */

GIT_RESET_MIXED = 2, /**< SOFT plus reset index to the commit */

GIT_RESET_HARD = 3, /**< MIXED plus changes in working tree discarded */

} git_reset_t;

/**

* Sets the current head to the specified commit oid and optionally

* resets the index and working tree to match.

*

* SOFT reset means the Head will be moved to the commit.

*

* MIXED reset will trigger a SOFT reset, plus the index will be replaced

* with the content of the commit tree.

*

* HARD reset will trigger a MIXED reset and the working directory will be

* replaced with the content of the index. (Untracked and ignored files

* will be left alone, however.)

*

* TODO: Implement remaining kinds of resets.

*

* @param repo Repository where to perform the reset operation.

*

* @param target Committish to which the Head should be moved to. This object

* must belong to the given `repo` and can either be a git_commit or a

* git_tag. When a git_tag is being passed, it should be dereferencable

* to a git_commit which oid will be used as the target of the branch.

*

* @param reset_type Kind of reset operation to perform.

*

* @param checkout_opts Optional checkout options to be used for a HARD reset.

* The checkout_strategy field will be overridden (based on reset_type).

* This parameter can be used to propagate notify and progress callbacks.

*

* @return 0 on success or an error code

*/

GIT_EXTERN(int) git_reset(

git_repository *repo,

git_object *target,

git_reset_t reset_type,

const git_checkout_options *checkout_opts);

/**

* Sets the current head to the specified commit oid and optionally

* resets the index and working tree to match.

*

* This behaves like `git_reset()` but takes an annotated commit,

* which lets you specify which extended sha syntax string was

* specified by a user, allowing for more exact reflog messages.

*

* See the documentation for `git_reset()`.

*

* @see git_reset

*/

GIT_EXTERN(int) git_reset_from_annotated(

git_repository *repo,

git_annotated_commit *commit,

git_reset_t reset_type,

const git_checkout_options *checkout_opts);

/**

* Updates some entries in the index from the target commit tree.

*

* The scope of the updated entries is determined by the paths

* being passed in the `pathspec` parameters.

*

* Passing a NULL `target` will result in removing

* entries in the index matching the provided pathspecs.

*

* @param repo Repository where to perform the reset operation.

*

* @param target The committish which content will be used to reset the content

* of the index.

*

* @param pathspecs List of pathspecs to operate on.

*

* @return 0 on success or an error code < 0

*/

GIT_EXTERN(int) git_reset_default(

git_repository *repo,

git_object *target,

git_strarray* pathspecs);

/** @} */

GIT_END_DECL

#endif