DragonNest/Common/SVNLib/doc/group__Commit.html
2024-12-19 09:48:26 +08:00

302 lines
20 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Subversion: Commit local modifications to the repository.</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
</div>
<div class="contents">
<h1>Commit local modifications to the repository.<br>
<small>
[<a class="el" href="group__clnt__wc.html">Client working copy management</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__error__t.html">svn_error_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Commit.html#gda07a12e2a42d0892881401242a45bdf">svn_client_commit4</a> (<a class="el" href="structsvn__commit__info__t.html">svn_commit_info_t</a> **commit_info_p, const apr_array_header_t *targets, <a class="el" href="svn__types_8h.html#21dd8b080111fa6fb5d59156299f3a2c">svn_depth_t</a> depth, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> keep_locks, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> keep_changelists, const apr_array_header_t *changelists, const apr_hash_t *revprop_table, <a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *ctx, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Commit files or directories into repository, authenticating with the authentication baton cached in <em>ctx</em>, and using <em>ctx-&gt;log_msg_func3/<em>ctx-&gt;log_msg_baton3</em> to</em> obtain the log message. <a href="#gda07a12e2a42d0892881401242a45bdf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__error__t.html">svn_error_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Commit.html#g4b02fbcc90bf6beab2a6222b438f966d">svn_client_commit3</a> (<a class="el" href="structsvn__commit__info__t.html">svn_commit_info_t</a> **commit_info_p, const apr_array_header_t *targets, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> recurse, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> keep_locks, <a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *ctx, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Similar to <a class="el" href="group__Commit.html#gda07a12e2a42d0892881401242a45bdf" title="Commit files or directories into repository, authenticating with the authentication...">svn_client_commit4()</a>, but always with NULL for <em>changelist_name</em>, FALSE for <em>keep_changelist</em>, NULL for <em>revprop_table</em>, and <em>depth</em> set according to <em>recurse:</em> if <em>recurse</em> is TRUE, use <code>svn_depth_infinity</code>, else <code>svn_depth_files</code>. <a href="#g4b02fbcc90bf6beab2a6222b438f966d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__error__t.html">svn_error_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Commit.html#g4a74d62bcd0f25a3337a9b19be2cdf98">svn_client_commit2</a> (<a class="el" href="structsvn__client__commit__info__t.html">svn_client_commit_info_t</a> **commit_info_p, const apr_array_header_t *targets, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> recurse, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> keep_locks, <a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *ctx, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Similar to <a class="el" href="group__Commit.html#g4b02fbcc90bf6beab2a6222b438f966d" title="Similar to svn_client_commit4(), but always with NULL for changelist_name, FALSE...">svn_client_commit3()</a>, but uses <code><a class="el" href="structsvn__client__commit__info__t.html" title="Information about commits passed back to client from this module.">svn_client_commit_info_t</a></code> for <em>commit_info_p</em>. <a href="#g4a74d62bcd0f25a3337a9b19be2cdf98"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__error__t.html">svn_error_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Commit.html#ge0445b6839201c1b4ad9470daa2685f4">svn_client_commit</a> (<a class="el" href="structsvn__client__commit__info__t.html">svn_client_commit_info_t</a> **commit_info_p, const apr_array_header_t *targets, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> nonrecursive, <a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *ctx, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Similar to <a class="el" href="group__Commit.html#g4a74d62bcd0f25a3337a9b19be2cdf98" title="Similar to svn_client_commit3(), but uses svn_client_commit_info_t for commit_info_p...">svn_client_commit2()</a>, but with <em>keep_locks</em> set to TRUE and <em>nonrecursive</em> instead of <em>recurse</em>. <a href="#ge0445b6839201c1b4ad9470daa2685f4"></a><br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ge0445b6839201c1b4ad9470daa2685f4"></a><!-- doxytag: member="svn_client.h::svn_client_commit" ref="ge0445b6839201c1b4ad9470daa2685f4" args="(svn_client_commit_info_t **commit_info_p, const apr_array_header_t *targets, svn_boolean_t nonrecursive, svn_client_ctx_t *ctx, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__error__t.html">svn_error_t</a>* svn_client_commit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsvn__client__commit__info__t.html">svn_client_commit_info_t</a> **&nbsp;</td>
<td class="paramname"> <em>commit_info_p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const apr_array_header_t *&nbsp;</td>
<td class="paramname"> <em>targets</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td>
<td class="paramname"> <em>nonrecursive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *&nbsp;</td>
<td class="paramname"> <em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Similar to <a class="el" href="group__Commit.html#g4a74d62bcd0f25a3337a9b19be2cdf98" title="Similar to svn_client_commit3(), but uses svn_client_commit_info_t for commit_info_p...">svn_client_commit2()</a>, but with <em>keep_locks</em> set to TRUE and <em>nonrecursive</em> instead of <em>recurse</em>.
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000038">Deprecated:</a></b></dt><dd>Provided for backward compatibility with the 1.1 API. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g4a74d62bcd0f25a3337a9b19be2cdf98"></a><!-- doxytag: member="svn_client.h::svn_client_commit2" ref="g4a74d62bcd0f25a3337a9b19be2cdf98" args="(svn_client_commit_info_t **commit_info_p, const apr_array_header_t *targets, svn_boolean_t recurse, svn_boolean_t keep_locks, svn_client_ctx_t *ctx, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__error__t.html">svn_error_t</a>* svn_client_commit2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsvn__client__commit__info__t.html">svn_client_commit_info_t</a> **&nbsp;</td>
<td class="paramname"> <em>commit_info_p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const apr_array_header_t *&nbsp;</td>
<td class="paramname"> <em>targets</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td>
<td class="paramname"> <em>recurse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td>
<td class="paramname"> <em>keep_locks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *&nbsp;</td>
<td class="paramname"> <em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Similar to <a class="el" href="group__Commit.html#g4b02fbcc90bf6beab2a6222b438f966d" title="Similar to svn_client_commit4(), but always with NULL for changelist_name, FALSE...">svn_client_commit3()</a>, but uses <code><a class="el" href="structsvn__client__commit__info__t.html" title="Information about commits passed back to client from this module.">svn_client_commit_info_t</a></code> for <em>commit_info_p</em>.
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000037">Deprecated:</a></b></dt><dd>Provided for backward compatibility with the 1.2 API.</dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.2. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g4b02fbcc90bf6beab2a6222b438f966d"></a><!-- doxytag: member="svn_client.h::svn_client_commit3" ref="g4b02fbcc90bf6beab2a6222b438f966d" args="(svn_commit_info_t **commit_info_p, const apr_array_header_t *targets, svn_boolean_t recurse, svn_boolean_t keep_locks, svn_client_ctx_t *ctx, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__error__t.html">svn_error_t</a>* svn_client_commit3 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsvn__commit__info__t.html">svn_commit_info_t</a> **&nbsp;</td>
<td class="paramname"> <em>commit_info_p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const apr_array_header_t *&nbsp;</td>
<td class="paramname"> <em>targets</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td>
<td class="paramname"> <em>recurse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td>
<td class="paramname"> <em>keep_locks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *&nbsp;</td>
<td class="paramname"> <em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Similar to <a class="el" href="group__Commit.html#gda07a12e2a42d0892881401242a45bdf" title="Commit files or directories into repository, authenticating with the authentication...">svn_client_commit4()</a>, but always with NULL for <em>changelist_name</em>, FALSE for <em>keep_changelist</em>, NULL for <em>revprop_table</em>, and <em>depth</em> set according to <em>recurse:</em> if <em>recurse</em> is TRUE, use <code>svn_depth_infinity</code>, else <code>svn_depth_files</code>.
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000036">Deprecated:</a></b></dt><dd>Provided for backward compatibility with the 1.4 API.</dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.3. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gda07a12e2a42d0892881401242a45bdf"></a><!-- doxytag: member="svn_client.h::svn_client_commit4" ref="gda07a12e2a42d0892881401242a45bdf" args="(svn_commit_info_t **commit_info_p, const apr_array_header_t *targets, svn_depth_t depth, svn_boolean_t keep_locks, svn_boolean_t keep_changelists, const apr_array_header_t *changelists, const apr_hash_t *revprop_table, svn_client_ctx_t *ctx, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__error__t.html">svn_error_t</a>* svn_client_commit4 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsvn__commit__info__t.html">svn_commit_info_t</a> **&nbsp;</td>
<td class="paramname"> <em>commit_info_p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const apr_array_header_t *&nbsp;</td>
<td class="paramname"> <em>targets</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#21dd8b080111fa6fb5d59156299f3a2c">svn_depth_t</a>&nbsp;</td>
<td class="paramname"> <em>depth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td>
<td class="paramname"> <em>keep_locks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td>
<td class="paramname"> <em>keep_changelists</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const apr_array_header_t *&nbsp;</td>
<td class="paramname"> <em>changelists</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const apr_hash_t *&nbsp;</td>
<td class="paramname"> <em>revprop_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *&nbsp;</td>
<td class="paramname"> <em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Commit files or directories into repository, authenticating with the authentication baton cached in <em>ctx</em>, and using <em>ctx-&gt;log_msg_func3/<em>ctx-&gt;log_msg_baton3</em> to</em> obtain the log message.
<p>
Set <em>*commit_info_p</em> to the results of the commit, allocated in <em>pool</em>.<p>
<em>targets</em> is an array of <code>const char *</code> paths to commit. They need not be canonicalized nor condensed; this function will take care of that. If <em>targets</em> has zero elements, then do nothing and return immediately without error.<p>
If non-NULL, <em>revprop_table</em> is a hash table holding additional, custom revision properties (<code>const char *</code> names mapped to <code><a class="el" href="structsvn__string__t.html" title="A simple counted string.">svn_string_t</a> *</code> values) to be set on the new revision. This table cannot contain any standard Subversion properties.<p>
If <em>ctx-&gt;notify_func2</em> is non-NULL, then call <em>ctx-&gt;notify_func2</em> with <em>ctx-&gt;notify_baton2</em> as the commit progresses, with any of the following actions: <code>svn_wc_notify_commit_modified</code>, <code>svn_wc_notify_commit_added</code>, <code>svn_wc_notify_commit_deleted</code>, <code>svn_wc_notify_commit_replaced</code>, <code>svn_wc_notify_commit_postfix_txdelta</code>.<p>
If <em>depth</em> is <code>svn_depth_infinity</code>, commit all changes to and below named targets. If <em>depth</em> is <code>svn_depth_empty</code>, commit only named targets (that is, only property changes on named directory targets, and property and content changes for named file targets). If <em>depth</em> is <code>svn_depth_files</code>, behave as above for named file targets, and for named directory targets, commit property changes on a named directory and all changes to files directly inside that directory. If <code>svn_depth_immediates</code>, behave as for <code>svn_depth_files</code>, and for subdirectories of any named directory target commit as though for <code>svn_depth_empty</code>.<p>
Unlock paths in the repository, unless <em>keep_locks</em> is TRUE.<p>
<em>changelists</em> is an array of <code>const char *</code> changelist names, used as a restrictive filter on items that are committed; that is, don't commit anything unless it's a member of one of those changelists. After the commit completes successfully, remove changelist associations from the targets, unless <em>keep_changelists</em> is set. If <em>changelists</em> is empty (or altogether <code>NULL</code>), no changelist filtering occurs.<p>
Use <em>pool</em> for any temporary allocations.<p>
If no error is returned and <em></em>(*commit_info_p)-&gt;revision is set to <code>SVN_INVALID_REVNUM</code>, then the commit was a no-op; nothing needed to be committed.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.5. </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 24 16:18:29 2008 for Subversion by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>