FilesExpand file tree

development

/

signature.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

90 lines (82 loc) · 2.64 KB

development

/

signature.h

Copy path

Top

File metadata and controls

• Code
• Blame

90 lines (82 loc) · 2.64 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

/*

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

#define INCLUDE_git_signature_h__

#include "common.h"

#include "types.h"

/**

* @file git2/signature.h

* @brief Git signature creation

* @defgroup git_signature Git signature creation

* @ingroup Git

* @{

*/

GIT_BEGIN_DECL

/**

* Create a new action signature.

*

* Call `git_signature_free()` to free the data.

*

* Note: angle brackets ('<' and '>') characters are not allowed

* to be used in either the `name` or the `email` parameter.

*

* @param out new signature, in case of error NULL

* @param name name of the person

* @param email email of the person

* @param time time when the action happened

* @param offset timezone offset in minutes for the time

* @return 0 or an error code

*/

GIT_EXTERN(int) git_signature_new(git_signature **out, const char *name, const char *email, git_time_t time, int offset);

/**

* Create a new action signature with a timestamp of 'now'.

*

* Call `git_signature_free()` to free the data.

*

* @param out new signature, in case of error NULL

* @param name name of the person

* @param email email of the person

* @return 0 or an error code

*/

GIT_EXTERN(int) git_signature_now(git_signature **out, const char *name, const char *email);

/**

* Create a new action signature with default user and now timestamp.

*

* This looks up the user.name and user.email from the configuration and

* uses the current time as the timestamp, and creates a new signature

* based on that information. It will return GIT_ENOTFOUND if either the

* user.name or user.email are not set.

*

* @param out new signature

* @param repo repository pointer

* @return 0 on success, GIT_ENOTFOUND if config is missing, or error code

*/

GIT_EXTERN(int) git_signature_default(git_signature **out, git_repository *repo);

/**

* Create a copy of an existing signature. All internal strings are also

* duplicated.

*

* Call `git_signature_free()` to free the data.

*

* @param dest pointer where to store the copy

* @param entry signature to duplicate

* @return 0 or an error code

*/

GIT_EXTERN(int) git_signature_dup(git_signature **dest, const git_signature *sig);

/**

* Free an existing signature.

*

* Because the signature is not an opaque structure, it is legal to free it

* manually, but be sure to free the "name" and "email" strings in addition

* to the structure itself.

*

* @param sig signature to free

*/

GIT_EXTERN(void) git_signature_free(git_signature *sig);

/** @} */

GIT_END_DECL

#endif