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

317 lines
22 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: Client commit subsystem</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>Client commit subsystem<br>
<small>
[<a class="el" href="group__clnt__support.html">Client supporting subsystem</a>]</small>
</h1>Commit operations.
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__client__proplist__item__t.html">svn_client_proplist_item_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This is a structure which stores a filename and a hash of property names and values. <a href="structsvn__client__proplist__item__t.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__client__commit__info__t.html">svn_client_commit_info_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Information about commits passed back to client from this module. <a href="structsvn__client__commit__info__t.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__client__commit__item3__t.html">svn_client_commit_item3_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The commit candidate structure. <a href="structsvn__client__commit__item3__t.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__client__commit__item2__t.html">svn_client_commit_item2_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The commit candidate structure. <a href="structsvn__client__commit__item2__t.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__client__commit__item__t.html">svn_client_commit_item_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The commit candidate structure. <a href="structsvn__client__commit__item__t.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structsvn__error__t.html">svn_error_t</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clnt__commit.html#g880d237c32626991c259e6fbced459d2">svn_proplist_receiver_t</a> )(void *baton, const char *path, apr_hash_t *prop_hash, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The callback invoked by <a class="el" href="group__svn__client__prop__funcs.html#g6a7566fa1adf53579caf96c584b419ff" title="Invoke receiver with receiver_baton to return the regular properies of target, a...">svn_client_proplist3()</a>. <a href="#g880d237c32626991c259e6fbced459d2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structsvn__error__t.html">svn_error_t</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clnt__commit.html#gd8d9c386fe79564a1b8b66e2a7d67d60">svn_client_get_commit_log3_t</a> )(const char **log_msg, const char **tmp_file, const apr_array_header_t *commit_items, void *baton, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Callback type used by commit-y operations to get a commit log message from the caller. <a href="#gd8d9c386fe79564a1b8b66e2a7d67d60"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structsvn__error__t.html">svn_error_t</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clnt__commit.html#ga1d88be008d4568af150f0256ed792e2">svn_client_get_commit_log2_t</a> )(const char **log_msg, const char **tmp_file, const apr_array_header_t *commit_items, void *baton, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Callback type used by commit-y operations to get a commit log message from the caller. <a href="#ga1d88be008d4568af150f0256ed792e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structsvn__error__t.html">svn_error_t</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clnt__commit.html#g39899194e67568bec4a3ef6fba817c1f">svn_client_get_commit_log_t</a> )(const char **log_msg, const char **tmp_file, apr_array_header_t *commit_items, void *baton, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Callback type used by commit-y operations to get a commit log message from the caller. <a href="#g39899194e67568bec4a3ef6fba817c1f"></a><br></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__client__proplist__item__t.html">svn_client_proplist_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clnt__commit.html#gead02178801b0393e696d411327b6599">svn_client_proplist_item_dup</a> (const <a class="el" href="structsvn__client__proplist__item__t.html">svn_client_proplist_item_t</a> *item, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a duplicate of <em>item</em>, allocated in <em>pool</em>. <a href="#gead02178801b0393e696d411327b6599"></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__clnt__commit.html#gbff86875919045f00b9092db26d13e2e">svn_client_commit_item_create</a> (const <a class="el" href="structsvn__client__commit__item3__t.html">svn_client_commit_item3_t</a> **item, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize a commit item. <a href="#gbff86875919045f00b9092db26d13e2e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__client__commit__item3__t.html">svn_client_commit_item3_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clnt__commit.html#ge231a020c76ea69d21a0bbd3f6f1894e">svn_client_commit_item3_dup</a> (const <a class="el" href="structsvn__client__commit__item3__t.html">svn_client_commit_item3_t</a> *item, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a duplicate of <em>item</em>, allocated in <em>pool</em>. <a href="#ge231a020c76ea69d21a0bbd3f6f1894e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__client__commit__item2__t.html">svn_client_commit_item2_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clnt__commit.html#g422f000cdf8f33a59ba1a4df8666892b">svn_client_commit_item2_dup</a> (const <a class="el" href="structsvn__client__commit__item2__t.html">svn_client_commit_item2_t</a> *item, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a duplicate of <em>item</em>, allocated in <em>pool</em>. <a href="#g422f000cdf8f33a59ba1a4df8666892b"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Commit operations.
<p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="ga1d88be008d4568af150f0256ed792e2"></a><!-- doxytag: member="svn_client.h::svn_client_get_commit_log2_t" ref="ga1d88be008d4568af150f0256ed792e2" args=")(const char **log_msg, const char **tmp_file, const apr_array_header_t *commit_items, void *baton, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structsvn__error__t.html">svn_error_t</a>*(* <a class="el" href="group__clnt__commit.html#ga1d88be008d4568af150f0256ed792e2">svn_client_get_commit_log2_t</a>)(const char **log_msg, const char **tmp_file, const apr_array_header_t *commit_items, void *baton, apr_pool_t *pool) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Callback type used by commit-y operations to get a commit log message from the caller.
<p>
Set <em>*log_msg</em> to the log message for the commit, allocated in <em>pool</em>, or <code>NULL</code> if wish to abort the commit process. Set <em>*tmp_file</em> to the path of any temporary file which might be holding that log message, or <code>NULL</code> if no such file exists (though, if <em>*log_msg</em> is <code>NULL</code>, this value is undefined). The log message MUST be a UTF8 string with LF line separators.<p>
<em>commit_items</em> is a read-only array of <code><a class="el" href="structsvn__client__commit__item2__t.html" title="The commit candidate structure.">svn_client_commit_item2_t</a></code> structures, which may be fully or only partially filled-in, depending on the type of commit operation.<p>
<em>baton</em> is provided along with the callback for use by the handler.<p>
All allocations should be performed in <em>pool</em>.<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000019">Deprecated:</a></b></dt><dd>Provided for backward compatibility with the 1.3 API. </dd></dl>
<p>Definition at line <a class="el" href="svn__client_8h-source.html#l00587">587</a> of file <a class="el" href="svn__client_8h-source.html">svn_client.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="gd8d9c386fe79564a1b8b66e2a7d67d60"></a><!-- doxytag: member="svn_client.h::svn_client_get_commit_log3_t" ref="gd8d9c386fe79564a1b8b66e2a7d67d60" args=")(const char **log_msg, const char **tmp_file, const apr_array_header_t *commit_items, void *baton, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structsvn__error__t.html">svn_error_t</a>*(* <a class="el" href="group__clnt__commit.html#gd8d9c386fe79564a1b8b66e2a7d67d60">svn_client_get_commit_log3_t</a>)(const char **log_msg, const char **tmp_file, const apr_array_header_t *commit_items, void *baton, apr_pool_t *pool) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Callback type used by commit-y operations to get a commit log message from the caller.
<p>
Set <em>*log_msg</em> to the log message for the commit, allocated in <em>pool</em>, or <code>NULL</code> if wish to abort the commit process. Set <em>*tmp_file</em> to the path of any temporary file which might be holding that log message, or <code>NULL</code> if no such file exists (though, if <em>*log_msg</em> is <code>NULL</code>, this value is undefined). The log message MUST be a UTF8 string with LF line separators.<p>
<em>commit_items</em> is a read-only array of <code><a class="el" href="structsvn__client__commit__item3__t.html" title="The commit candidate structure.">svn_client_commit_item3_t</a></code> structures, which may be fully or only partially filled-in, depending on the type of commit operation.<p>
<em>baton</em> is provided along with the callback for use by the handler.<p>
All allocations should be performed in <em>pool</em>.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.5. </dd></dl>
<p>Definition at line <a class="el" href="svn__client_8h-source.html#l00560">560</a> of file <a class="el" href="svn__client_8h-source.html">svn_client.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="g39899194e67568bec4a3ef6fba817c1f"></a><!-- doxytag: member="svn_client.h::svn_client_get_commit_log_t" ref="g39899194e67568bec4a3ef6fba817c1f" args=")(const char **log_msg, const char **tmp_file, apr_array_header_t *commit_items, void *baton, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structsvn__error__t.html">svn_error_t</a>*(* <a class="el" href="group__clnt__commit.html#g39899194e67568bec4a3ef6fba817c1f">svn_client_get_commit_log_t</a>)(const char **log_msg, const char **tmp_file, apr_array_header_t *commit_items, void *baton, apr_pool_t *pool) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Callback type used by commit-y operations to get a commit log message from the caller.
<p>
Set <em>*log_msg</em> to the log message for the commit, allocated in <em>pool</em>, or <code>NULL</code> if wish to abort the commit process. Set <em>*tmp_file</em> to the path of any temporary file which might be holding that log message, or <code>NULL</code> if no such file exists (though, if <em>*log_msg</em> is <code>NULL</code>, this value is undefined). The log message MUST be a UTF8 string with LF line separators.<p>
<em>commit_items</em> is a read-only array of <code><a class="el" href="structsvn__client__commit__item__t.html" title="The commit candidate structure.">svn_client_commit_item_t</a></code> structures, which may be fully or only partially filled-in, depending on the type of commit operation.<p>
<em>baton</em> is provided along with the callback for use by the handler.<p>
All allocations should be performed in <em>pool</em>.<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000020">Deprecated:</a></b></dt><dd>Provided for backward compatibility with the 1.2 API. </dd></dl>
<p>Definition at line <a class="el" href="svn__client_8h-source.html#l00614">614</a> of file <a class="el" href="svn__client_8h-source.html">svn_client.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="g880d237c32626991c259e6fbced459d2"></a><!-- doxytag: member="svn_client.h::svn_proplist_receiver_t" ref="g880d237c32626991c259e6fbced459d2" args=")(void *baton, const char *path, apr_hash_t *prop_hash, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structsvn__error__t.html">svn_error_t</a>*(* <a class="el" href="group__clnt__commit.html#g880d237c32626991c259e6fbced459d2">svn_proplist_receiver_t</a>)(void *baton, const char *path, apr_hash_t *prop_hash, apr_pool_t *pool) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The callback invoked by <a class="el" href="group__svn__client__prop__funcs.html#g6a7566fa1adf53579caf96c584b419ff" title="Invoke receiver with receiver_baton to return the regular properies of target, a...">svn_client_proplist3()</a>.
<p>
Each invocation describes the property specified by <em>item</em>. Use <em>pool</em> for all temporary allocation.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.5. </dd></dl>
<p>Definition at line <a class="el" href="svn__client_8h-source.html#l00330">330</a> of file <a class="el" href="svn__client_8h-source.html">svn_client.h</a>.</p>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g422f000cdf8f33a59ba1a4df8666892b"></a><!-- doxytag: member="svn_client.h::svn_client_commit_item2_dup" ref="g422f000cdf8f33a59ba1a4df8666892b" args="(const svn_client_commit_item2_t *item, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__client__commit__item2__t.html">svn_client_commit_item2_t</a>* svn_client_commit_item2_dup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structsvn__client__commit__item2__t.html">svn_client_commit_item2_t</a> *&nbsp;</td>
<td class="paramname"> <em>item</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>
Return a duplicate of <em>item</em>, allocated in <em>pool</em>.
<p>
No part of the new structure will be shared with <em>item</em>.<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000018">Deprecated:</a></b></dt><dd>Provided for backward compatibility with the 1.3 API. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ge231a020c76ea69d21a0bbd3f6f1894e"></a><!-- doxytag: member="svn_client.h::svn_client_commit_item3_dup" ref="ge231a020c76ea69d21a0bbd3f6f1894e" args="(const svn_client_commit_item3_t *item, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__client__commit__item3__t.html">svn_client_commit_item3_t</a>* svn_client_commit_item3_dup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structsvn__client__commit__item3__t.html">svn_client_commit_item3_t</a> *&nbsp;</td>
<td class="paramname"> <em>item</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>
Return a duplicate of <em>item</em>, allocated in <em>pool</em>.
<p>
No part of the new structure will be shared with <em>item</em>.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.5. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gbff86875919045f00b9092db26d13e2e"></a><!-- doxytag: member="svn_client.h::svn_client_commit_item_create" ref="gbff86875919045f00b9092db26d13e2e" args="(const svn_client_commit_item3_t **item, 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_item_create </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structsvn__client__commit__item3__t.html">svn_client_commit_item3_t</a> **&nbsp;</td>
<td class="paramname"> <em>item</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>
Initialize a commit item.
<p>
Set <em>*item</em> to a commit item object, allocated in <em>pool</em>.<p>
In order to avoid backwards compatibility problems, this function is used to intialize and allocate the <code><a class="el" href="structsvn__client__commit__item3__t.html" title="The commit candidate structure.">svn_client_commit_item3_t</a></code> structure rather than doing so explicitly, as the size of this structure may change in the future.<p>
The current implementation never returns error, but callers should still check for error, for compatibility with future versions.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.5. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gead02178801b0393e696d411327b6599"></a><!-- doxytag: member="svn_client.h::svn_client_proplist_item_dup" ref="gead02178801b0393e696d411327b6599" args="(const svn_client_proplist_item_t *item, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__client__proplist__item__t.html">svn_client_proplist_item_t</a>* svn_client_proplist_item_dup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structsvn__client__proplist__item__t.html">svn_client_proplist_item_t</a> *&nbsp;</td>
<td class="paramname"> <em>item</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>
Return a duplicate of <em>item</em>, allocated in <em>pool</em>.
<p>
No part of the new structure will be shared with <em>item</em>.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.3.</dd></dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000014">Deprecated:</a></b></dt><dd>Provided for backward compatibility with the 1.4 API. </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>