mirror of
https://github.com/libgit2/libgit2.git
synced 2026-06-22 06:26:26 +00:00
714 lines
38 KiB
HTML
714 lines
38 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<title>libgit2: Git tag management</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body onload='searchBox.OnSelectItem(0);'>
|
|
<!-- Generated by Doxygen 1.7.4 -->
|
|
<script type="text/javascript"><!--
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
--></script>
|
|
<div id="top">
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">libgit2</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li id="searchli">
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Git tag management</div> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#gae8dcd68a5c5d0ff57ce289d53a7095ff">git_tag_lookup</a> (<a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> **tag, <a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, const <a class="el" href="structgit__oid.html">git_oid</a> *id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lookup a tag object from the repository. <a href="#gae8dcd68a5c5d0ff57ce289d53a7095ff"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#ga8a513564edad4e4377b4146626cd5373">git_tag_close</a> (<a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> *tag)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close an open tag. <a href="#ga8a513564edad4e4377b4146626cd5373"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structgit__oid.html">git_oid</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#ga5efa1875b68f73ed78cfeceb394ecefd">git_tag_id</a> (<a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> *tag)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the id of a tag. <a href="#ga5efa1875b68f73ed78cfeceb394ecefd"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#ga09f4c4df178a85c6a9a089b9177ca014">git_tag_target</a> (<a class="el" href="types_8h.html#a855e48de855be1ccb0b752295caf374e">git_object</a> **target, <a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> *t)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the tagged object of a tag. <a href="#ga09f4c4df178a85c6a9a089b9177ca014"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structgit__oid.html">git_oid</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#gaadb613022f0c752e08984999dc7e3765">git_tag_target_oid</a> (<a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> *t)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the OID of the tagged object of a tag. <a href="#gaadb613022f0c752e08984999dc7e3765"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a5c9a2783d4fc110bc6a4f5355d20fedb">git_otype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#gaa502d76b8f6907cf8d6e0ec14da4adcb">git_tag_type</a> (<a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> *t)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of a tag's tagged object. <a href="#gaa502d76b8f6907cf8d6e0ec14da4adcb"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#ga3bb69a7b4c2d24e031bb7a2d618f57e7">git_tag_name</a> (<a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> *t)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of a tag. <a href="#ga3bb69a7b4c2d24e031bb7a2d618f57e7"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structgit__signature.html">git_signature</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#ga5d04cd8d3d5832e38fe35223d8ef02db">git_tag_tagger</a> (<a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> *t)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the tagger (author) of a tag. <a href="#ga5d04cd8d3d5832e38fe35223d8ef02db"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#ga01c79f7c12667ee6757ccdfa9aff84c6">git_tag_message</a> (<a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> *t)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the message of a tag. <a href="#ga01c79f7c12667ee6757ccdfa9aff84c6"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#ga5a193c1103d195ccbe7ed94f27310682">git_tag_create</a> (<a class="el" href="structgit__oid.html">git_oid</a> *oid, <a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, const char *tag_name, const <a class="el" href="structgit__oid.html">git_oid</a> *target, <a class="el" href="types_8h.html#a5c9a2783d4fc110bc6a4f5355d20fedb">git_otype</a> target_type, const <a class="el" href="structgit__signature.html">git_signature</a> *tagger, const char *message)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new tag in the repository from an OID. <a href="#ga5a193c1103d195ccbe7ed94f27310682"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#ga2c092fb33a207e819ac2044c408944d2">git_tag_create_o</a> (<a class="el" href="structgit__oid.html">git_oid</a> *oid, <a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, const char *tag_name, const <a class="el" href="types_8h.html#a855e48de855be1ccb0b752295caf374e">git_object</a> *target, const <a class="el" href="structgit__signature.html">git_signature</a> *tagger, const char *message)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new tag in the repository from an existing `git_object` instance. <a href="#ga2c092fb33a207e819ac2044c408944d2"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#ga596aadf32b1e499fb0841662b3932c5f">git_tag_create_frombuffer</a> (<a class="el" href="structgit__oid.html">git_oid</a> *oid, <a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, const char *buffer)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new tag in the repository from a buffer. <a href="#ga596aadf32b1e499fb0841662b3932c5f"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#ga870978f3703f6bb4caebc88c1c385feb">git_tag_create_f</a> (<a class="el" href="structgit__oid.html">git_oid</a> *oid, <a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, const char *tag_name, const <a class="el" href="structgit__oid.html">git_oid</a> *target, <a class="el" href="types_8h.html#a5c9a2783d4fc110bc6a4f5355d20fedb">git_otype</a> target_type, const <a class="el" href="structgit__signature.html">git_signature</a> *tagger, const char *message)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new tag in the repository from an OID and overwrite an already existing tag reference, if any. <a href="#ga870978f3703f6bb4caebc88c1c385feb"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#ga86e4545fb58716c7f4047569b322ea1f">git_tag_create_fo</a> (<a class="el" href="structgit__oid.html">git_oid</a> *oid, <a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, const char *tag_name, const <a class="el" href="types_8h.html#a855e48de855be1ccb0b752295caf374e">git_object</a> *target, const <a class="el" href="structgit__signature.html">git_signature</a> *tagger, const char *message)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new tag in the repository from an existing `git_object` instance and overwrite an already existing tag reference, if any. <a href="#ga86e4545fb58716c7f4047569b322ea1f"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__tag.html#ga457ca74728a1c3ca0faf8c2855558fa0">git_tag_delete</a> (<a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, const char *tag_name)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete an existing tag reference. <a href="#ga457ca74728a1c3ca0faf8c2855558fa0"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="ga8a513564edad4e4377b4146626cd5373"></a><!-- doxytag: member="tag.h::git_tag_close" ref="ga8a513564edad4e4377b4146626cd5373" args="(git_tag *tag)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void git_tag_close </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Close an open tag. </p>
|
|
<p>This is a wrapper around <a class="el" href="group__git__object.html#ga3daccfd1b2370d009f2b718aa11a558a" title="Close an open object.">git_object_close()</a></p>
|
|
<p>IMPORTANT: It *is* necessary to call this method when you stop using a tag. Failure to do so will cause a memory leak.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">tag</td><td>the tag to close </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5a193c1103d195ccbe7ed94f27310682"></a><!-- doxytag: member="tag.h::git_tag_create" ref="ga5a193c1103d195ccbe7ed94f27310682" args="(git_oid *oid, git_repository *repo, const char *tag_name, const git_oid *target, git_otype target_type, const git_signature *tagger, const char *message)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int git_tag_create </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structgit__oid.html">git_oid</a> * </td>
|
|
<td class="paramname"><em>oid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> * </td>
|
|
<td class="paramname"><em>repo</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>tag_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structgit__oid.html">git_oid</a> * </td>
|
|
<td class="paramname"><em>target</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a5c9a2783d4fc110bc6a4f5355d20fedb">git_otype</a> </td>
|
|
<td class="paramname"><em>target_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structgit__signature.html">git_signature</a> * </td>
|
|
<td class="paramname"><em>tagger</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>message</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Create a new tag in the repository from an OID. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">oid</td><td>Pointer where to store the OID of the newly created tag</td></tr>
|
|
<tr><td class="paramname">repo</td><td>Repository where to store the tag</td></tr>
|
|
<tr><td class="paramname">tag_name</td><td>Name for the tag; this name is validated for consistency. It should also not conflict with an already existing tag name</td></tr>
|
|
<tr><td class="paramname">target</td><td>OID to which this tag points; note that no validation is done on this OID. Use the _o version of this method to assure a proper object is being tagged</td></tr>
|
|
<tr><td class="paramname">target_type</td><td>Type of the tagged OID; note that no validation is performed here either</td></tr>
|
|
<tr><td class="paramname">tagger</td><td>Signature of the tagger for this tag, and of the tagging time</td></tr>
|
|
<tr><td class="paramname">message</td><td>Full message for this tag</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise. A tag object is written to the ODB, and a proper reference is written in the /refs/tags folder, pointing to it </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga870978f3703f6bb4caebc88c1c385feb"></a><!-- doxytag: member="tag.h::git_tag_create_f" ref="ga870978f3703f6bb4caebc88c1c385feb" args="(git_oid *oid, git_repository *repo, const char *tag_name, const git_oid *target, git_otype target_type, const git_signature *tagger, const char *message)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int git_tag_create_f </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structgit__oid.html">git_oid</a> * </td>
|
|
<td class="paramname"><em>oid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> * </td>
|
|
<td class="paramname"><em>repo</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>tag_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structgit__oid.html">git_oid</a> * </td>
|
|
<td class="paramname"><em>target</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a5c9a2783d4fc110bc6a4f5355d20fedb">git_otype</a> </td>
|
|
<td class="paramname"><em>target_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structgit__signature.html">git_signature</a> * </td>
|
|
<td class="paramname"><em>tagger</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>message</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Create a new tag in the repository from an OID and overwrite an already existing tag reference, if any. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">oid</td><td>Pointer where to store the OID of the newly created tag</td></tr>
|
|
<tr><td class="paramname">repo</td><td>Repository where to store the tag</td></tr>
|
|
<tr><td class="paramname">tag_name</td><td>Name for the tag; this name is validated for consistency.</td></tr>
|
|
<tr><td class="paramname">target</td><td>OID to which this tag points; note that no validation is done on this OID. Use the _fo version of this method to assure a proper object is being tagged</td></tr>
|
|
<tr><td class="paramname">target_type</td><td>Type of the tagged OID; note that no validation is performed here either</td></tr>
|
|
<tr><td class="paramname">tagger</td><td>Signature of the tagger for this tag, and of the tagging time</td></tr>
|
|
<tr><td class="paramname">message</td><td>Full message for this tag</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise. A tag object is written to the ODB, and a proper reference is written in the /refs/tags folder, pointing to it </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga86e4545fb58716c7f4047569b322ea1f"></a><!-- doxytag: member="tag.h::git_tag_create_fo" ref="ga86e4545fb58716c7f4047569b322ea1f" args="(git_oid *oid, git_repository *repo, const char *tag_name, const git_object *target, const git_signature *tagger, const char *message)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int git_tag_create_fo </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structgit__oid.html">git_oid</a> * </td>
|
|
<td class="paramname"><em>oid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> * </td>
|
|
<td class="paramname"><em>repo</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>tag_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="types_8h.html#a855e48de855be1ccb0b752295caf374e">git_object</a> * </td>
|
|
<td class="paramname"><em>target</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structgit__signature.html">git_signature</a> * </td>
|
|
<td class="paramname"><em>tagger</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>message</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Create a new tag in the repository from an existing `git_object` instance and overwrite an already existing tag reference, if any. </p>
|
|
<p>This method replaces the `target` and `target_type` paremeters of `git_tag_create_f` by a single instance of a `const git_object *`, which is assured to be a proper object in the ODB and hence will create a valid tag</p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__git__tag.html#ga870978f3703f6bb4caebc88c1c385feb" title="Create a new tag in the repository from an OID and overwrite an already existing tag reference...">git_tag_create_f</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga596aadf32b1e499fb0841662b3932c5f"></a><!-- doxytag: member="tag.h::git_tag_create_frombuffer" ref="ga596aadf32b1e499fb0841662b3932c5f" args="(git_oid *oid, git_repository *repo, const char *buffer)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int git_tag_create_frombuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structgit__oid.html">git_oid</a> * </td>
|
|
<td class="paramname"><em>oid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> * </td>
|
|
<td class="paramname"><em>repo</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>buffer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Create a new tag in the repository from a buffer. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">oid</td><td>Pointer where to store the OID of the newly created tag</td></tr>
|
|
<tr><td class="paramname">repo</td><td>Repository where to store the tag</td></tr>
|
|
<tr><td class="paramname">buffer</td><td>Raw tag data </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2c092fb33a207e819ac2044c408944d2"></a><!-- doxytag: member="tag.h::git_tag_create_o" ref="ga2c092fb33a207e819ac2044c408944d2" args="(git_oid *oid, git_repository *repo, const char *tag_name, const git_object *target, const git_signature *tagger, const char *message)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int git_tag_create_o </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structgit__oid.html">git_oid</a> * </td>
|
|
<td class="paramname"><em>oid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> * </td>
|
|
<td class="paramname"><em>repo</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>tag_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="types_8h.html#a855e48de855be1ccb0b752295caf374e">git_object</a> * </td>
|
|
<td class="paramname"><em>target</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structgit__signature.html">git_signature</a> * </td>
|
|
<td class="paramname"><em>tagger</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>message</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Create a new tag in the repository from an existing `git_object` instance. </p>
|
|
<p>This method replaces the `target` and `target_type` paremeters of `git_tag_create` by a single instance of a `const git_object *`, which is assured to be a proper object in the ODB and hence will create a valid tag</p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__git__tag.html#ga5a193c1103d195ccbe7ed94f27310682" title="Create a new tag in the repository from an OID.">git_tag_create</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga457ca74728a1c3ca0faf8c2855558fa0"></a><!-- doxytag: member="tag.h::git_tag_delete" ref="ga457ca74728a1c3ca0faf8c2855558fa0" args="(git_repository *repo, const char *tag_name)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int git_tag_delete </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> * </td>
|
|
<td class="paramname"><em>repo</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>tag_name</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Delete an existing tag reference. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">repo</td><td>Repository where lives the tag</td></tr>
|
|
<tr><td class="paramname">tag_name</td><td>Name of the tag to be deleted; this name is validated for consistency.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5efa1875b68f73ed78cfeceb394ecefd"></a><!-- doxytag: member="tag.h::git_tag_id" ref="ga5efa1875b68f73ed78cfeceb394ecefd" args="(git_tag *tag)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="structgit__oid.html">git_oid</a>* git_tag_id </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Get the id of a tag. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">tag</td><td>a previously loaded tag. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>object identity for the tag. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae8dcd68a5c5d0ff57ce289d53a7095ff"></a><!-- doxytag: member="tag.h::git_tag_lookup" ref="gae8dcd68a5c5d0ff57ce289d53a7095ff" args="(git_tag **tag, git_repository *repo, const git_oid *id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int git_tag_lookup </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> ** </td>
|
|
<td class="paramname"><em>tag</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> * </td>
|
|
<td class="paramname"><em>repo</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structgit__oid.html">git_oid</a> * </td>
|
|
<td class="paramname"><em>id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Lookup a tag object from the repository. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">tag</td><td>pointer to the looked up tag </td></tr>
|
|
<tr><td class="paramname">repo</td><td>the repo to use when locating the tag. </td></tr>
|
|
<tr><td class="paramname">id</td><td>identity of the tag to locate. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga01c79f7c12667ee6757ccdfa9aff84c6"></a><!-- doxytag: member="tag.h::git_tag_message" ref="ga01c79f7c12667ee6757ccdfa9aff84c6" args="(git_tag *t)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* git_tag_message </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> * </td>
|
|
<td class="paramname"><em>t</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Get the message of a tag. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">tag</td><td>a previously loaded tag. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>message of the tag </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3bb69a7b4c2d24e031bb7a2d618f57e7"></a><!-- doxytag: member="tag.h::git_tag_name" ref="ga3bb69a7b4c2d24e031bb7a2d618f57e7" args="(git_tag *t)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* git_tag_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> * </td>
|
|
<td class="paramname"><em>t</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Get the name of a tag. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">tag</td><td>a previously loaded tag. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>name of the tag </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5d04cd8d3d5832e38fe35223d8ef02db"></a><!-- doxytag: member="tag.h::git_tag_tagger" ref="ga5d04cd8d3d5832e38fe35223d8ef02db" args="(git_tag *t)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="structgit__signature.html">git_signature</a>* git_tag_tagger </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> * </td>
|
|
<td class="paramname"><em>t</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Get the tagger (author) of a tag. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">tag</td><td>a previously loaded tag. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to the tag's author </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga09f4c4df178a85c6a9a089b9177ca014"></a><!-- doxytag: member="tag.h::git_tag_target" ref="ga09f4c4df178a85c6a9a089b9177ca014" args="(git_object **target, git_tag *t)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int git_tag_target </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a855e48de855be1ccb0b752295caf374e">git_object</a> ** </td>
|
|
<td class="paramname"><em>target</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> * </td>
|
|
<td class="paramname"><em>t</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Get the tagged object of a tag. </p>
|
|
<p>This method performs a repository lookup for the given object and returns it</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">target</td><td>pointer where to store the target </td></tr>
|
|
<tr><td class="paramname">tag</td><td>a previously loaded tag. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaadb613022f0c752e08984999dc7e3765"></a><!-- doxytag: member="tag.h::git_tag_target_oid" ref="gaadb613022f0c752e08984999dc7e3765" args="(git_tag *t)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="structgit__oid.html">git_oid</a>* git_tag_target_oid </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> * </td>
|
|
<td class="paramname"><em>t</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Get the OID of the tagged object of a tag. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">tag</td><td>a previously loaded tag. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the OID </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa502d76b8f6907cf8d6e0ec14da4adcb"></a><!-- doxytag: member="tag.h::git_tag_type" ref="gaa502d76b8f6907cf8d6e0ec14da4adcb" args="(git_tag *t)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#a5c9a2783d4fc110bc6a4f5355d20fedb">git_otype</a> git_tag_type </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ac5c4eec78898ea6d3dfbc5a7a92d3915">git_tag</a> * </td>
|
|
<td class="paramname"><em>t</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Get the type of a tag's tagged object. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">tag</td><td>a previously loaded tag. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>type of the tagged object </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<hr class="footer"/><address class="footer"><small>Generated on Thu Apr 7 2011 13:27:55 for libgit2 by 
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
|
|
</body>
|
|
</html>
|