FilesExpand file tree

development

/

stash.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

121 lines (109 loc) · 2.97 KB

development

/

stash.h

Copy path

Top

File metadata and controls

• Code
• Blame

121 lines (109 loc) · 2.97 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

/*

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

#define INCLUDE_git_stash_h__

#include "common.h"

#include "types.h"

/**

* @file git2/stash.h

* @brief Git stash management routines

* @ingroup Git

* @{

*/

GIT_BEGIN_DECL

typedef enum {

GIT_STASH_DEFAULT = 0,

/* All changes already added to the index

* are left intact in the working directory

*/

GIT_STASH_KEEP_INDEX = (1 << 0),

/* All untracked files are also stashed and then

* cleaned up from the working directory

*/

GIT_STASH_INCLUDE_UNTRACKED = (1 << 1),

/* All ignored files are also stashed and then

* cleaned up from the working directory

*/

GIT_STASH_INCLUDE_IGNORED = (1 << 2),

} git_stash_flags;

/**

* Save the local modifications to a new stash.

*

* @param out Object id of the commit containing the stashed state.

* This commit is also the target of the direct reference refs/stash.

*

* @param repo The owning repository.

*

* @param stasher The identity of the person performing the stashing.

*

* @param message Optional description along with the stashed state.

*

* @param flags Flags to control the stashing process. (see GIT_STASH_* above)

*

* @return 0 on success, GIT_ENOTFOUND where there's nothing to stash,

* or error code.

*/

GIT_EXTERN(int) git_stash_save(

git_oid *out,

git_repository *repo,

const git_signature *stasher,

const char *message,

unsigned int flags);

/**

* When iterating over all the stashed states, callback that will be

* issued per entry.

*

* @param index The position within the stash list. 0 points to the

* most recent stashed state.

*

* @param message The stash message.

*

* @param stash_id The commit oid of the stashed state.

*

* @param payload Extra parameter to callback function.

*

* @return 0 on success, GIT_EUSER on non-zero callback, or error code

*/

typedef int (*git_stash_cb)(

size_t index,

const char* message,

const git_oid *stash_id,

void *payload);

/**

* Loop over all the stashed states and issue a callback for each one.

*

* If the callback returns a non-zero value, this will stop looping.

*

* @param repo Repository where to find the stash.

*

* @param callback Callback to invoke per found stashed state. The most recent

* stash state will be enumerated first.

*

* @param payload Extra parameter to callback function.

*

* @return 0 on success, GIT_EUSER on non-zero callback, or error code

*/

GIT_EXTERN(int) git_stash_foreach(

git_repository *repo,

git_stash_cb callback,

void *payload);

/**

* Remove a single stashed state from the stash list.

*

* @param repo The owning repository.

*

* @param index The position within the stash list. 0 points to the

* most recent stashed state.

*

* @return 0 on success, or error code

*/

GIT_EXTERN(int) git_stash_drop(

git_repository *repo,

size_t index);

/** @} */

GIT_END_DECL

#endif