proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-05-11 07:53:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

API updates for signature.h

Browse Source
This commit is contained in:
Ben Straub 2012-11-27 14:03:53 -08:00
parent 44d9f2cb60
commit ff6b5ac97d
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
include/git2/signature.h
View File

@ -26,31 +26,32 @@ GIT_BEGIN_DECL
* Note: angle brackets ('<' and '>') characters are not allowed * Note: angle brackets ('<' and '>') characters are not allowed
* to be used in either the `name` or the `email` parameter. * to be used in either the `name` or the `email` parameter.
* *
* @param sig_out new signature, in case of error NULL * @param out new signature, in case of error NULL
* @param name name of the person * @param name name of the person
* @param email email of the person * @param email email of the person
* @param time time when the action happened * @param time time when the action happened
* @param offset timezone offset in minutes for the time * @param offset timezone offset in minutes for the time
* @return 0 or an error code * @return 0 or an error code
*/ */
GIT_EXTERN(int) git_signature_new(git_signature **sig_out, const char *name, const char *email, git_time_t time, int offset); 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'. The * Create a new action signature with a timestamp of 'now'. The
* signature must be freed manually or using git_signature_free * signature must be freed manually or using git_signature_free
* *
* @param sig_out new signature, in case of error NULL * @param out new signature, in case of error NULL
* @param name name of the person * @param name name of the person
* @param email email of the person * @param email email of the person
* @return 0 or an error code * @return 0 or an error code
*/ */
GIT_EXTERN(int) git_signature_now(git_signature **sig_out, const char *name, const char *email); GIT_EXTERN(int) git_signature_now(git_signature **out, const char *name, const char *email);
/** /**
* Create a copy of an existing signature. * Create a copy of an existing signature. All internal strings are also duplicated.
* The caller is responsible for freeing this structure with
* git_signature_free.
* *
* All internal strings are also duplicated.
* @param sig signature to duplicated * @param sig signature to duplicated
* @return a copy of sig, NULL on out of memory * @return a copy of sig, NULL on out of memory
*/ */