]>
git.proxmox.com Git - libgit2.git/blob - include/git2/commit.h
2 * Copyright (C) the libgit2 contributors. All rights reserved.
4 * This file is part of libgit2, distributed under the GNU GPL v2 with
5 * a Linking Exception. For full terms see the included COPYING file.
7 #ifndef INCLUDE_git_commit_h__
8 #define INCLUDE_git_commit_h__
17 * @brief Git commit parsing, formatting routines
18 * @defgroup git_commit Git commit parsing, formatting routines
25 * Lookup a commit object from a repository.
27 * @param commit pointer to the looked up commit
28 * @param repo the repo to use when locating the commit.
29 * @param id identity of the commit to locate. If the object is
30 * an annotated tag it will be peeled back to the commit.
31 * @return 0 or an error code
33 GIT_EXTERN(int) git_commit_lookup(git_commit
**commit
, git_repository
*repo
, const git_oid
*id
);
36 * Lookup a commit object from a repository,
37 * given a prefix of its identifier (short id).
39 * @see git_object_lookup_prefix
41 * @param commit pointer to the looked up commit
42 * @param repo the repo to use when locating the commit.
43 * @param id identity of the commit to locate. If the object is
44 * an annotated tag it will be peeled back to the commit.
45 * @param len the length of the short identifier
46 * @return 0 or an error code
48 GIT_EXTERN(int) git_commit_lookup_prefix(git_commit
**commit
, git_repository
*repo
, const git_oid
*id
, size_t len
);
51 * Close an open commit
53 * This is a wrapper around git_object_free()
56 * It *is* necessary to call this method when you stop
57 * using a commit. Failure to do so will cause a memory leak.
59 * @param commit the commit to close
62 GIT_EXTERN(void) git_commit_free(git_commit
*commit
);
65 * Get the id of a commit.
67 * @param commit a previously loaded commit.
68 * @return object identity for the commit.
70 GIT_EXTERN(const git_oid
*) git_commit_id(const git_commit
*commit
);
73 * Get the repository that contains the commit.
75 * @param commit A previously loaded commit.
76 * @return Repository that contains this commit.
78 GIT_EXTERN(git_repository
*) git_commit_owner(const git_commit
*commit
);
81 * Get the encoding for the message of a commit,
82 * as a string representing a standard encoding name.
84 * The encoding may be NULL if the `encoding` header
85 * in the commit is missing; in that case UTF-8 is assumed.
87 * @param commit a previously loaded commit.
88 * @return NULL, or the encoding
90 GIT_EXTERN(const char *) git_commit_message_encoding(const git_commit
*commit
);
93 * Get the full message of a commit.
95 * @param commit a previously loaded commit.
96 * @return the message of a commit
98 GIT_EXTERN(const char *) git_commit_message(const git_commit
*commit
);
101 * Get the commit time (i.e. committer time) of a commit.
103 * @param commit a previously loaded commit.
104 * @return the time of a commit
106 GIT_EXTERN(git_time_t
) git_commit_time(const git_commit
*commit
);
109 * Get the commit timezone offset (i.e. committer's preferred timezone) of a commit.
111 * @param commit a previously loaded commit.
112 * @return positive or negative timezone offset, in minutes from UTC
114 GIT_EXTERN(int) git_commit_time_offset(const git_commit
*commit
);
117 * Get the committer of a commit.
119 * @param commit a previously loaded commit.
120 * @return the committer of a commit
122 GIT_EXTERN(const git_signature
*) git_commit_committer(const git_commit
*commit
);
125 * Get the author of a commit.
127 * @param commit a previously loaded commit.
128 * @return the author of a commit
130 GIT_EXTERN(const git_signature
*) git_commit_author(const git_commit
*commit
);
133 * Get the tree pointed to by a commit.
135 * @param tree_out pointer where to store the tree object
136 * @param commit a previously loaded commit.
137 * @return 0 or an error code
139 GIT_EXTERN(int) git_commit_tree(git_tree
**tree_out
, const git_commit
*commit
);
142 * Get the id of the tree pointed to by a commit. This differs from
143 * `git_commit_tree` in that no attempts are made to fetch an object
146 * @param commit a previously loaded commit.
147 * @return the id of tree pointed to by commit.
149 GIT_EXTERN(const git_oid
*) git_commit_tree_id(const git_commit
*commit
);
152 * Get the number of parents of this commit
154 * @param commit a previously loaded commit.
155 * @return integer of count of parents
157 GIT_EXTERN(unsigned int) git_commit_parentcount(const git_commit
*commit
);
160 * Get the specified parent of the commit.
162 * @param out Pointer where to store the parent commit
163 * @param commit a previously loaded commit.
164 * @param n the position of the parent (from 0 to `parentcount`)
165 * @return 0 or an error code
167 GIT_EXTERN(int) git_commit_parent(
169 const git_commit
*commit
,
173 * Get the oid of a specified parent for a commit. This is different from
174 * `git_commit_parent`, which will attempt to load the parent commit from
177 * @param commit a previously loaded commit.
178 * @param n the position of the parent (from 0 to `parentcount`)
179 * @return the id of the parent, NULL on error.
181 GIT_EXTERN(const git_oid
*) git_commit_parent_id(
182 const git_commit
*commit
,
186 * Get the commit object that is the <n>th generation ancestor
187 * of the named commit object, following only the first parents.
188 * The returned commit has to be freed by the caller.
190 * Passing `0` as the generation number returns another instance of the
191 * base commit itself.
193 * @param ancestor Pointer where to store the ancestor commit
194 * @param commit a previously loaded commit.
195 * @param n the requested generation
196 * @return 0 on success; GIT_ENOTFOUND if no matching ancestor exists
199 GIT_EXTERN(int) git_commit_nth_gen_ancestor(
200 git_commit
**ancestor
,
201 const git_commit
*commit
,
205 * Create new commit in the repository from a list of `git_object` pointers
207 * The message will not be cleaned up automatically. You can do that with
208 * the `git_message_prettify()` function.
210 * @param id Pointer in which to store the OID of the newly created commit
212 * @param repo Repository where to store the commit
214 * @param update_ref If not NULL, name of the reference that
215 * will be updated to point to this commit. If the reference
216 * is not direct, it will be resolved to a direct reference.
217 * Use "HEAD" to update the HEAD of the current branch and
218 * make it point to this commit. If the reference doesn't
219 * exist yet, it will be created.
221 * @param author Signature with author and author time of commit
223 * @param committer Signature with committer and * commit time of commit
225 * @param message_encoding The encoding for the message in the
226 * commit, represented with a standard encoding name.
227 * E.g. "UTF-8". If NULL, no encoding header is written and
230 * @param message Full message for this commit
232 * @param tree An instance of a `git_tree` object that will
233 * be used as the tree for the commit. This tree object must
234 * also be owned by the given `repo`.
236 * @param parent_count Number of parents for this commit
238 * @param parents Array of `parent_count` pointers to `git_commit`
239 * objects that will be used as the parents for this commit. This
240 * array may be NULL if `parent_count` is 0 (root commit). All the
241 * given commits must be owned by the `repo`.
243 * @return 0 or an error code
244 * The created commit will be written to the Object Database and
245 * the given reference will be updated to point to it
247 GIT_EXTERN(int) git_commit_create(
249 git_repository
*repo
,
250 const char *update_ref
,
251 const git_signature
*author
,
252 const git_signature
*committer
,
253 const char *message_encoding
,
255 const git_tree
*tree
,
257 const git_commit
*parents
[]);
260 * Create new commit in the repository using a variable argument list.
262 * The message will be cleaned up from excess whitespace and it will be made
263 * sure that the last line ends with a '\n'.
265 * The parents for the commit are specified as a variable list of pointers
266 * to `const git_commit *`. Note that this is a convenience method which may
267 * not be safe to export for certain languages or compilers
269 * All other parameters remain the same at `git_commit_create()`.
271 * @see git_commit_create
273 GIT_EXTERN(int) git_commit_create_v(
275 git_repository
*repo
,
276 const char *update_ref
,
277 const git_signature
*author
,
278 const git_signature
*committer
,
279 const char *message_encoding
,
281 const git_tree
*tree
,