libsmbconf: fix documentation of transaction calls.

[samba.git] / lib / smbconf / smbconf.h

diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 7f62b06af45bd809a2cf7a7cbba48645fa569382..fcb13882a946ca5f90962a3f09a6313d601b1424 100644 (file)
--- 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