diff options
| author | Michael Adam <obnox@samba.org> | 2013-05-20 23:30:14 +0200 |
|---|---|---|
| committer | Michael Adam <obnox@samba.org> | 2013-05-28 18:12:26 +0200 |
| commit | 57634fd87d7176a1f92281ad1b3e9a565b54cfc7 (patch) | |
| tree | 6d2373d5b7721d3f771734c42d3523965363e9e4 /lib/smbconf | |
| parent | 277831eaf140c06bb25a3549434bc4acd4f533ec (diff) | |
| download | samba-57634fd87d7176a1f92281ad1b3e9a565b54cfc7.tar.gz samba-57634fd87d7176a1f92281ad1b3e9a565b54cfc7.tar.bz2 samba-57634fd87d7176a1f92281ad1b3e9a565b54cfc7.zip | |
libsmbconf: fix documentation of transaction calls.
Signed-off-by: Michael Adam <obnox@samba.org>
Reviewed-by: David Disseldorp <ddiss@samba.org>
Diffstat (limited to 'lib/smbconf')
| -rw-r--r-- | lib/smbconf/smbconf.h | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index 7f62b06af4..fcb13882a9 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -447,7 +447,8 @@ sbcErr smbconf_delete_global_includes(struct smbconf_ctx *ctx); /** * @brief Start a transaction on the configuration backend. * - * This is to speed up writes to the registry based backend. + * Transactions are exposed in order to make it possible + * to create atomic compound writing commands. * * @param[in] ctx The smbconf context to start the transaction. * @@ -459,7 +460,8 @@ sbcErr smbconf_transaction_start(struct smbconf_ctx *ctx); /** * @brief Commit a transaction on the configuration backend. * - * This is to speed up writes to the registry based backend. + * Transactions are exposed in order to make it possible + * to create atomic compound writing commands. * * @param[in] ctx The smbconf context to commit the transaction. * @@ -473,6 +475,9 @@ sbcErr smbconf_transaction_commit(struct smbconf_ctx *ctx); /** * @brief Cancel a transaction on the configuration backend. * + * Transactions are exposed in order to make it possible + * to create atomic compound writing commands. + * * @param[in] ctx The smbconf context to cancel the transaction. * * @return SBC_ERR_OK on success, a corresponding sbcErr if an |