Renamed the MessageStore interface truncateInit parameter to a more generic name. Changed the language of the description to match. This is a tidy-up only, there should be no code implications.

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@999473 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 9 insertions, 7 deletions

diff --git a/cpp/src/qpid/broker/MessageStore.h b/cpp/src/qpid/broker/MessageStore.h
index 143e860ec7..ab0225ef6b 100644
--- a/cpp/src/qpid/broker/MessageStore.h
+++ b/cpp/src/qpid/broker/MessageStore.h
@@ -47,15 +47,17 @@ class MessageStore : public TransactionalStore, public Recoverable {
 
     /**
      * If called after initialization but before recovery, will discard the database
-     * and reinitialize using an empty store dir. If the parameter pushDownStoreFiles
-     * is true, the content of the store dir will be moved to a backup dir inside the
-     * store dir. This is used when cluster nodes recover and must get thier content
-     * from a cluster sync rather than directly fromt the store.
+     * content and reinitialize as though it were a new installation. If the parameter
+     * saveStoreContent is true, the content of the store will be saved in such a way
+     * that the truncate can be reversed. This is used when cluster nodes recover and
+     *  must get their content from a cluster sync rather than directly from the store.
      *
-     * @param pushDownStoreFiles If true, will move content of the store dir into a
-     *                           subdir, leaving the store dir otherwise empty.
+     * @param saveStoreContent If true, will move content of the store to a backup
+     *                         location where they may be restored later if needed. It is
+     *                         not necessary to save more than one prior version of the
+     *                         store.
      */
-    virtual void truncateInit(const bool pushDownStoreFiles = false) = 0;
+    virtual void truncateInit(const bool saveStoreContent = false) = 0;
 
     /**
      * Record the existence of a durable queue