This is an automated email from the ASF dual-hosted git repository.
wangdan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pegasus.git
The following commit(s) were added to refs/heads/master by this push:
new da54c5881 chore: remove personal comments in file header (#1696)
da54c5881 is described below
commit da54c5881d89d9d0c8b049f9e8f8bb4b7b5b865f
Author: Yingchun Lai <[email protected]>
AuthorDate: Tue Nov 28 11:59:17 2023 +0800
chore: remove personal comments in file header (#1696)
There is no functional changes in this patch, just remove the comments at
the
head of file, the comments look like:
```
/*
* Description:
* What is this file about?
*
* Revision history:
* xxxx-xx-xx, author, first version
* xxxx-xx-xx, author, fix bug about xxx
*/
```
The description which are meaningful has been moved closer to the class
declaration
it describes.
This patch also updates some links, for example, from
`github.com/XiaoMi/pegasus/wiki`
to `pegasus.apache.org`, `github.com/XiaoMi/pegasus/issues` to
`github.com/apache/incubator-pegasus/issues`.
---
src/common/fs_manager.cpp | 8 ---
src/common/fs_manager.h | 1 +
src/common/gpid.h | 1 +
src/common/json_helper.h | 1 +
src/common/replication_other_types.h | 8 ---
src/failure_detector/failure_detector.h | 58 +++++++++-------------
.../failure_detector_multimaster.cpp | 9 ----
src/failure_detector/fd.client.h | 9 ----
src/failure_detector/fd.server.h | 9 ----
src/meta/distributed_lock_service_simple.cpp | 9 ----
src/meta/distributed_lock_service_simple.h | 13 ++---
src/meta/greedy_load_balancer.h | 9 +---
src/meta/meta_data.cpp | 8 ---
src/meta/meta_data.h | 8 ---
src/meta/meta_options.cpp | 8 ---
src/meta/meta_options.h | 9 +---
src/meta/meta_service.h | 10 +---
src/meta/meta_service_app.h | 1 +
src/meta/meta_state_service.h | 19 +------
src/meta/meta_state_service_simple.h | 12 +----
src/meta/meta_state_service_zookeeper.h | 8 ---
src/meta/server_load_balancer.h | 12 +----
src/meta/server_state.cpp | 9 ----
src/meta/server_state.h | 9 ----
src/meta/test/meta_state/main.cpp | 9 ----
src/nfs/nfs_code_definition.h | 8 ---
src/nfs/nfs_node_simple.cpp | 9 ----
src/nfs/nfs_node_simple.h | 8 ---
src/perf_counter/test/perf_counter_test.cpp | 9 ----
src/perf_counter/test/perf_counters_test.cpp | 9 ----
src/replica/disk_cleaner.h | 1 +
src/replica/mutation.cpp | 9 ----
src/replica/mutation.h | 9 ----
src/replica/replica.h | 21 ++------
src/replica/replica_check.cpp | 12 ++---
src/replica/replica_chkpt.cpp | 11 +---
src/replica/replica_config.cpp | 11 +---
src/replica/replica_context.cpp | 9 ----
src/replica/replica_context.h | 4 ++
src/replica/replica_failover.cpp | 11 +---
src/replica/replica_learn.cpp | 11 +---
src/replica/replica_stub.cpp | 9 ----
src/replica/replica_stub.h | 8 +--
.../storage/simple_kv/simple_kv.app.example.h | 9 ----
.../storage/simple_kv/simple_kv.code.definition.h | 9 ----
src/replica/storage/simple_kv/simple_kv.main.cpp | 9 ----
src/replica/storage/simple_kv/simple_kv.server.h | 9 ----
.../storage/simple_kv/simple_kv.server.impl.cpp | 9 ----
.../storage/simple_kv/simple_kv.server.impl.h | 9 ----
src/replica/storage/simple_kv/test/case.cpp | 9 ----
src/replica/storage/simple_kv/test/case.h | 9 ----
src/replica/storage/simple_kv/test/checker.cpp | 9 ----
src/replica/storage/simple_kv/test/checker.h | 9 ----
src/replica/storage/simple_kv/test/client.cpp | 9 ----
src/replica/storage/simple_kv/test/client.h | 9 ----
src/replica/storage/simple_kv/test/common.cpp | 9 ----
src/replica/storage/simple_kv/test/common.h | 9 ----
src/replica/storage/simple_kv/test/injector.cpp | 9 ----
src/replica/storage/simple_kv/test/injector.h | 9 ----
.../storage/simple_kv/test/simple_kv.main.cpp | 9 ----
.../simple_kv/test/simple_kv.server.impl.cpp | 1 +
.../storage/simple_kv/test/simple_kv.server.impl.h | 1 +
src/reporter/pegasus_counter_reporter.h | 2 +-
src/runtime/env.sim.cpp | 9 ----
src/runtime/env.sim.h | 9 ----
src/runtime/fault_injector.cpp | 11 +---
src/runtime/global_config.cpp | 9 ----
src/runtime/global_config.h | 9 ----
src/runtime/nativerun.cpp | 9 ----
src/runtime/nativerun.h | 10 +---
src/runtime/providers.common.cpp | 9 ----
src/runtime/rpc/dsn_message_parser.cpp | 9 ----
src/runtime/rpc/dsn_message_parser.h | 10 +---
src/runtime/rpc/message_parser.cpp | 9 ----
src/runtime/rpc/message_parser_manager.h | 9 ----
src/runtime/rpc/network.sim.cpp | 9 ----
src/runtime/rpc/raw_message_parser.cpp | 7 ---
src/runtime/rpc/raw_message_parser.h | 9 +---
src/runtime/rpc/rpc_message.h | 9 ----
src/runtime/scheduler.cpp | 9 ----
src/runtime/scheduler.h | 9 ----
src/runtime/serverlet.h | 1 +
src/runtime/service_app.h | 11 +---
src/runtime/service_engine.h | 9 ----
src/runtime/simulator.cpp | 9 ----
src/runtime/task/future_types.h | 1 +
src/runtime/task/task_engine.h | 9 ----
src/runtime/task/task_engine.sim.cpp | 9 ----
src/runtime/task/task_engine.sim.h | 9 ----
src/runtime/task/task_spec.h | 10 +---
src/runtime/task/task_worker.h | 10 +---
src/runtime/test/async_call.cpp | 9 ----
src/runtime/test/lpc.cpp | 9 ----
src/runtime/test/main.cpp | 9 ----
src/runtime/test/netprovider.cpp | 9 ----
src/runtime/test/rpc_message.cpp | 9 ----
src/runtime/test/service_api_c.cpp | 9 ----
src/runtime/test/sim_lock.cpp | 9 ----
src/runtime/test/task_engine.cpp | 9 ----
src/runtime/test/test_utils.h | 9 ----
src/runtime/tool_api.cpp | 9 ----
src/runtime/tool_api.h | 16 ++----
src/runtime/zlocks.cpp | 9 ----
src/server/pegasus_scan_context.h | 2 +-
src/server/pegasus_server_impl_init.cpp | 2 +-
src/server/pegasus_write_service.h | 2 +-
src/tools/mutation_log_tool.h | 9 ----
src/utils/autoref_ptr.h | 9 ----
src/utils/config_api.h | 1 +
src/utils/configuration.cpp | 9 ----
src/utils/coredump.h | 9 ----
src/utils/distributed_lock_service.h | 16 +-----
src/utils/enum_helper.h | 9 ----
src/utils/error_code.cpp | 1 +
src/utils/exp_delay.h | 10 +---
src/utils/extensible_object.h | 10 +---
src/utils/factory_store.h | 10 +---
src/utils/filesystem.cpp | 9 ----
src/utils/fixed_size_buffer_pool.h | 1 +
src/utils/gpid.cpp | 1 +
src/utils/link.h | 11 +---
src/utils/lockp.std.h | 9 ----
src/utils/priority_queue.h | 9 ----
src/utils/shared_io_service.h | 9 ----
src/utils/singleton_store.h | 9 ----
src/utils/synchronize.h | 1 +
src/utils/test/env.cpp | 9 ----
src/utils/test/logging.cpp | 9 ----
src/utils/test/priority_queue.cpp | 9 ----
src/utils/test/sema.cpp | 9 ----
src/utils/test/utils.cpp | 9 ----
src/utils/thread_access_checker.h | 1 +
src/utils/threadpool_spec.h | 1 +
src/utils/time_utils.h | 1 +
src/utils/utils.cpp | 9 ----
src/utils/work_queue.h | 10 +---
.../distributed_lock_service_zookeeper.cpp | 7 ---
src/zookeeper/distributed_lock_service_zookeeper.h | 7 ---
src/zookeeper/lock_struct.cpp | 8 ---
src/zookeeper/lock_struct.h | 7 ---
src/zookeeper/lock_types.h | 7 ---
src/zookeeper/zookeeper_error.cpp | 8 ---
src/zookeeper/zookeeper_error.h | 7 ---
src/zookeeper/zookeeper_session.cpp | 8 ---
src/zookeeper/zookeeper_session.h | 9 +---
src/zookeeper/zookeeper_session_mgr.cpp | 8 ---
src/zookeeper/zookeeper_session_mgr.h | 11 +---
147 files changed, 100 insertions(+), 1152 deletions(-)
diff --git a/src/common/fs_manager.cpp b/src/common/fs_manager.cpp
index f1e9a1181..636e50bb0 100644
--- a/src/common/fs_manager.cpp
+++ b/src/common/fs_manager.cpp
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * fs_manager's implement: used to track the disk position for all the
allocated replicas
- *
- * Revision history:
- * 2017-08-08: [email protected], first draft
- */
-
#include "fs_manager.h"
#include <algorithm>
diff --git a/src/common/fs_manager.h b/src/common/fs_manager.h
index 7b7f03f51..875d0bdbe 100644
--- a/src/common/fs_manager.h
+++ b/src/common/fs_manager.h
@@ -84,6 +84,7 @@ public:
void update_disk_stat();
};
+// Track the data directories and replicas.
class fs_manager
{
public:
diff --git a/src/common/gpid.h b/src/common/gpid.h
index ba2f9ee5b..183aae40d 100644
--- a/src/common/gpid.h
+++ b/src/common/gpid.h
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#pragma once
#include <cstdint>
diff --git a/src/common/json_helper.h b/src/common/json_helper.h
index bbead87a2..3c5bed8ea 100644
--- a/src/common/json_helper.h
+++ b/src/common/json_helper.h
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#pragma once
#include <cctype>
diff --git a/src/common/replication_other_types.h
b/src/common/replication_other_types.h
index 557d97ecb..b5f62205c 100644
--- a/src/common/replication_other_types.h
+++ b/src/common/replication_other_types.h
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
#ifndef replication_OTHER_TYPES_H
#define replication_OTHER_TYPES_H
diff --git a/src/failure_detector/failure_detector.h
b/src/failure_detector/failure_detector.h
index 85186ac65..0520cc4b4 100644
--- a/src/failure_detector/failure_detector.h
+++ b/src/failure_detector/failure_detector.h
@@ -24,41 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * interface for a perfect failure detector
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * Dec., 2015, @shengofsun (Weijie Sun), make zlock preoteced,
- * give the subClasses flexibility
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
-/*
- * Notes on the failure detector:
- *
- * 1. Due to the fact that we can only check the liveness inside
check-all-records call,
- * which happens every "check_interval_seconds" seconds, worker may
disconnect from master
- * in the period earlier than the lease_seconds to ensure the perfect FD.
- * In the worst case, workers may disconnect themselves
- * after "lease"-"check_interval_seconds" seconds;
- *
- * Similarily, master may claim a worker dead more slowly even the workers
are dead
- * for longer than grace_seconds. In the worst case, it will be
- * "grace"+"check_interval_seconds" seconds.
- *
- * 2. In practice, your should set check_interval_seconds a small value for a
fine-grained FD.
- * For client, you may set it as 2 second as it usually connect to a small
number of masters.
- * For master, you may set it as 5 or 10 seconds.
- *
- * 3. We should always use dedicated thread pools for THREAD_POOL_FD,
- * and set thread priority to being highest so as to minimize the
performance
- * interference with other workloads.
- *
- * 4. The lease_periods must be less than the grace_periods, as required by
prefect FD.
- *
- */
#pragma once
#include <stdint.h>
@@ -106,6 +71,29 @@ public:
virtual void on_worker_connected(::dsn::rpc_address node) = 0;
};
+// The interface for a perfect failure detector.
+//
+// Notes on the failure detector:
+//
+// 1. Due to the fact that we can only check the liveness inside
check-all-records call,
+// which happens every "check_interval_seconds" seconds, worker may
disconnect from master
+// in the period earlier than the lease_seconds to ensure the perfect FD.
+// In the worst case, workers may disconnect themselves
+// after "lease"-"check_interval_seconds" seconds;
+//
+// Similarily, master may claim a worker dead more slowly even the workers
are dead
+// for longer than grace_seconds. In the worst case, it will be
+// "grace"+"check_interval_seconds" seconds.
+//
+// 2. In practice, your should set check_interval_seconds a small value for a
fine-grained FD.
+// For client, you may set it as 2 second as it usually connect to a small
number of masters.
+// For master, you may set it as 5 or 10 seconds.
+//
+// 3. We should always use dedicated thread pools for THREAD_POOL_FD,
+// and set thread priority to being highest so as to minimize the
performance
+// interference with other workloads.
+//
+// 4. The lease_periods must be less than the grace_periods, as required by
prefect FD.
class failure_detector : public failure_detector_service,
public failure_detector_client,
public failure_detector_callback
diff --git a/src/failure_detector/failure_detector_multimaster.cpp
b/src/failure_detector/failure_detector_multimaster.cpp
index 42fc7ba2b..66b5d190e 100644
--- a/src/failure_detector/failure_detector_multimaster.cpp
+++ b/src/failure_detector/failure_detector_multimaster.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <stdint.h>
#include <utility>
diff --git a/src/failure_detector/fd.client.h b/src/failure_detector/fd.client.h
index 586a9dc72..96fde50fe 100644
--- a/src/failure_detector/fd.client.h
+++ b/src/failure_detector/fd.client.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "fd.code.definition.h"
#include <iostream>
diff --git a/src/failure_detector/fd.server.h b/src/failure_detector/fd.server.h
index 6ba37b448..e518b8c47 100644
--- a/src/failure_detector/fd.server.h
+++ b/src/failure_detector/fd.server.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "fd.code.definition.h"
#include <iostream>
diff --git a/src/meta/distributed_lock_service_simple.cpp
b/src/meta/distributed_lock_service_simple.cpp
index 2fc25bf35..cc9528785 100644
--- a/src/meta/distributed_lock_service_simple.cpp
+++ b/src/meta/distributed_lock_service_simple.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * a simple version of distributed lock service for development
- *
- * Revision history:
- * 2015-11-04, @imzhenyu ([email protected]), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <chrono>
#include "common/replication.codes.h"
diff --git a/src/meta/distributed_lock_service_simple.h
b/src/meta/distributed_lock_service_simple.h
index 59b2bde5e..fe43a950d 100644
--- a/src/meta/distributed_lock_service_simple.h
+++ b/src/meta/distributed_lock_service_simple.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * a simple version of distributed lock service for development
- *
- * Revision history:
- * 2015-11-04, @imzhenyu ([email protected]), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <stdint.h>
@@ -53,7 +44,9 @@
namespace dsn {
namespace dist {
-// Only for test purpose.
+
+// A simple version of distributed lock service.
+// NOTE: Only for test purpose.
class distributed_lock_service_simple : public distributed_lock_service
{
public:
diff --git a/src/meta/greedy_load_balancer.h b/src/meta/greedy_load_balancer.h
index 862a29c19..14243c2da 100644
--- a/src/meta/greedy_load_balancer.h
+++ b/src/meta/greedy_load_balancer.h
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * A greedy load balancer based on Dijkstra & Ford-Fulkerson
- *
- * Revision history:
- * 2016-02-03, Weijie Sun, first version
- */
-
#pragma once
#include <memory>
@@ -51,6 +43,7 @@ namespace replication {
class load_balance_policy;
class meta_service;
+// A greedy load balancer based on Dijkstra & Ford-Fulkerson.
class greedy_load_balancer : public server_load_balancer
{
public:
diff --git a/src/meta/meta_data.cpp b/src/meta/meta_data.cpp
index 23dba0c92..a44180d4a 100644
--- a/src/meta/meta_data.cpp
+++ b/src/meta/meta_data.cpp
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * the meta server's date structure, impl file
- *
- * Revision history:
- * 2016-04-25, Weijie Sun(sunweijie at xiaomi.com), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
#include <boost/lexical_cast.hpp>
#include <cstdint>
diff --git a/src/meta/meta_data.h b/src/meta/meta_data.h
index cf8acf5ba..ea236fa5c 100644
--- a/src/meta/meta_data.h
+++ b/src/meta/meta_data.h
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * the meta server's date structure
- *
- * Revision history:
- * 2016-04-25, Weijie Sun(sunweijie at xiaomi.com), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
#pragma once
#include <stdint.h>
diff --git a/src/meta/meta_options.cpp b/src/meta/meta_options.cpp
index ebc39ee59..7956ff35e 100644
--- a/src/meta/meta_options.cpp
+++ b/src/meta/meta_options.cpp
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * the meta server's options, impl file
- *
- * Revision history:
- * 2016-04-25, Weijie Sun(sunweijie at xiaomi.com), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
#include "meta_options.h"
#include <stddef.h>
diff --git a/src/meta/meta_options.h b/src/meta/meta_options.h
index 880dc4664..f33d83174 100644
--- a/src/meta/meta_options.h
+++ b/src/meta/meta_options.h
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * the meta server's options
- *
- * Revision history:
- * 2016-04-25, Weijie Sun(sunweijie at xiaomi.com), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
#pragma once
#include <string>
@@ -49,6 +41,7 @@ public:
std::vector<std::string> distributed_lock_service_args;
};
+// The meta server's options.
class meta_options
{
public:
diff --git a/src/meta/meta_service.h b/src/meta/meta_service.h
index 58f5a902a..435d0a0ac 100644
--- a/src/meta/meta_service.h
+++ b/src/meta/meta_service.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * meta server service for EON (rDSN layer 2)
- *
- * Revision history:
- * 2015-03-09, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <fmt/core.h>
@@ -132,6 +123,7 @@ enum class meta_leader_state : int
kNotLeaderAndCannotForwardRpc, // meta isn't leader, and rpc-msg can't
forward to others
};
+// Meta server service for EON (rDSN layer 2).
class meta_service : public serverlet<meta_service>
{
public:
diff --git a/src/meta/meta_service_app.h b/src/meta/meta_service_app.h
index a321bfa57..4c56062a2 100644
--- a/src/meta/meta_service_app.h
+++ b/src/meta/meta_service_app.h
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#pragma once
#include <memory>
diff --git a/src/meta/meta_state_service.h b/src/meta/meta_state_service.h
index e8c14fec8..d79f1b365 100644
--- a/src/meta/meta_state_service.h
+++ b/src/meta/meta_state_service.h
@@ -24,23 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * interface of the reliable meta state service
- * it is usually for storing meta state of dist systems, such as membership
- *
- * Revision history:
- * 2015-10-28, Weijie Sun, first version
- * 2015-11-05, @imzhenyu (Zhenyu Guo), adjust the interface, so that
- * (1) return task_ptr/tracker for callers to cancel or wait;
- * (2) add factory for provider registration;
- * (3) add cb_code parameter, then users can specify where the
callback
- * should be executed
- * 2015-11-06, @imzhenyu (Zhenyu Guo), add watch/unwatch API
- * 2015-12-28, @shengofsun (Weijie SUn), add transaction api
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <functional>
@@ -68,6 +51,8 @@ typedef std::function<void(error_code ec, const
std::vector<std::string> &ret_st
typedef future_task<error_code, std::vector<std::string>> err_stringv_future;
typedef dsn::ref_ptr<err_stringv_future> err_stringv_future_ptr;
+// The interface of the reliable meta state service.
+// It is usually for storing meta state of dist systems, such as membership.
class meta_state_service
{
public:
diff --git a/src/meta/meta_state_service_simple.h
b/src/meta/meta_state_service_simple.h
index 697b5b159..6a415531f 100644
--- a/src/meta/meta_state_service_simple.h
+++ b/src/meta/meta_state_service_simple.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * a simple version of meta state service for development
- *
- * Revision history:
- * 2015-11-03, @imzhenyu ([email protected]), setup the sketch
- * 2015-11-11, Tianyi WANG, first version done
- */
-
#include <stddef.h>
#include <stdint.h>
#include <functional>
@@ -66,7 +57,8 @@ DEFINE_TASK_CODE_AIO(LPC_META_STATE_SERVICE_SIMPLE_INTERNAL,
TASK_PRIORITY_HIGH,
THREAD_POOL_DEFAULT);
-// Only for test purpose.
+// A simple version of meta state service.
+// NOTE: Only for test purpose.
class meta_state_service_simple : public meta_state_service
{
public:
diff --git a/src/meta/meta_state_service_zookeeper.h
b/src/meta/meta_state_service_zookeeper.h
index 1187e5af9..9c450f543 100644
--- a/src/meta/meta_state_service_zookeeper.h
+++ b/src/meta/meta_state_service_zookeeper.h
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * meta state service implemented with zookeeper
- *
- * Revision history:
- * 2015-12-04, @shengofsun ([email protected])
- */
-
#pragma once
#include <stdint.h>
diff --git a/src/meta/server_load_balancer.h b/src/meta/server_load_balancer.h
index 6becef055..774b7bb86 100644
--- a/src/meta/server_load_balancer.h
+++ b/src/meta/server_load_balancer.h
@@ -24,16 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * base interface of the server load balancer which defines the scheduling
- * policy of how to place the partition replica to the nodes
- *
- * Revision history:
- * 2015-12-29, @imzhenyu (Zhenyu Guo), first draft
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <cstdint>
@@ -95,6 +85,8 @@ public:
typedef dsn::object_extension_helper<newly_partitions, node_state>
newly_partitions_ext;
newly_partitions *get_newly_partitions(node_mapper &mapper, const
dsn::rpc_address &addr);
+// The interface of the server load balancer which defines the scheduling
policy of how to
+// place the partition replica to the nodes.
class server_load_balancer
{
public:
diff --git a/src/meta/server_state.cpp b/src/meta/server_state.cpp
index 2b6c6d910..4d6e12754 100644
--- a/src/meta/server_state.cpp
+++ b/src/meta/server_state.cpp
@@ -25,15 +25,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * the meta server's server_state, impl file
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * 2016-04-25, Weijie Sun(sunweijie at xiaomi.com), refactor
- */
-
// IWYU pragma: no_include <boost/detail/basic_pointerbuf.hpp>
#include <boost/lexical_cast.hpp>
// IWYU pragma: no_include <ext/alloc_traits.h>
diff --git a/src/meta/server_state.h b/src/meta/server_state.h
index a3feb28f9..ec1205d02 100644
--- a/src/meta/server_state.h
+++ b/src/meta/server_state.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * the meta server's server_state, definition file
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * 2016-04-25, Weijie Sun(sunweijie at xiaomi.com), refactor
- */
-
#pragma once
// IWYU pragma: no_include <boost/detail/basic_pointerbuf.hpp>
diff --git a/src/meta/test/meta_state/main.cpp
b/src/meta/test/meta_state/main.cpp
index 08818e59f..decf35f13 100644
--- a/src/meta/test/meta_state/main.cpp
+++ b/src/meta/test/meta_state/main.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <gtest/gtest.h>
#include <chrono>
#include <memory>
diff --git a/src/nfs/nfs_code_definition.h b/src/nfs/nfs_code_definition.h
index 6cd1c0881..a517d6c98 100644
--- a/src/nfs/nfs_code_definition.h
+++ b/src/nfs/nfs_code_definition.h
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
#pragma once
namespace dsn {
diff --git a/src/nfs/nfs_node_simple.cpp b/src/nfs/nfs_node_simple.cpp
index bb334a508..1b51b379f 100644
--- a/src/nfs/nfs_node_simple.cpp
+++ b/src/nfs/nfs_node_simple.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <memory>
#include "nfs/nfs_node.h"
diff --git a/src/nfs/nfs_node_simple.h b/src/nfs/nfs_node_simple.h
index 15e234416..d34c75348 100644
--- a/src/nfs/nfs_node_simple.h
+++ b/src/nfs/nfs_node_simple.h
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
#pragma once
#include <memory>
diff --git a/src/perf_counter/test/perf_counter_test.cpp
b/src/perf_counter/test/perf_counter_test.cpp
index a95dc29df..748f29e61 100644
--- a/src/perf_counter/test/perf_counter_test.cpp
+++ b/src/perf_counter/test/perf_counter_test.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Unit-test for perf counter.
- *
- * Revision history:
- * Nov., 2015, @shengofsun (Weijie Sun), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
// IWYU pragma: no_include <ext/alloc_traits.h>
#include <stdlib.h>
#include <chrono>
diff --git a/src/perf_counter/test/perf_counters_test.cpp
b/src/perf_counter/test/perf_counters_test.cpp
index 4dfcd008e..b830d63ba 100644
--- a/src/perf_counter/test/perf_counters_test.cpp
+++ b/src/perf_counter/test/perf_counters_test.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Unit-test for perf_counters.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "perf_counter/perf_counters.h"
#include <stdio.h>
diff --git a/src/replica/disk_cleaner.h b/src/replica/disk_cleaner.h
index 9e2edb752..54e37db49 100644
--- a/src/replica/disk_cleaner.h
+++ b/src/replica/disk_cleaner.h
@@ -16,6 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
+
#pragma once
#include <memory>
diff --git a/src/replica/mutation.cpp b/src/replica/mutation.cpp
index cb1a74bbe..7814bf299 100644
--- a/src/replica/mutation.cpp
+++ b/src/replica/mutation.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "mutation.h"
#include <inttypes.h>
diff --git a/src/replica/mutation.h b/src/replica/mutation.h
index 6eec440ea..d5b7f238a 100644
--- a/src/replica/mutation.h
+++ b/src/replica/mutation.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <stdint.h>
diff --git a/src/replica/replica.h b/src/replica/replica.h
index dece64595..68965a7d8 100644
--- a/src/replica/replica.h
+++ b/src/replica/replica.h
@@ -24,24 +24,8 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * replica interface, the base object which rdsn replicates
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
-//
-// a replica is a replication partition of a serivce,
-// which handles all replication related issues
-// and on_request the app messages to replication_app_base
-// which is binded to this replication partition
-//
-
#include <gtest/gtest_prod.h>
#include <stddef.h>
#include <stdint.h>
@@ -169,6 +153,11 @@ struct deny_client
}
};
+// The replica interface, the base object which rdsn replicates.
+//
+// A replica is a replication partition of a serivce, which handles all
replication related
+// issues and on_request the app messages to replication_app_base which is
binded to this
+// replication partition.
class replica : public serverlet<replica>, public ref_counter, public
replica_base
{
public:
diff --git a/src/replica/replica_check.cpp b/src/replica/replica_check.cpp
index 1565e55d9..ee3ac9046 100644
--- a/src/replica/replica_check.cpp
+++ b/src/replica/replica_check.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * replica membership state periodical checking
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <atomic>
#include <chrono>
#include <memory>
@@ -72,6 +63,9 @@
namespace dsn {
namespace replication {
+
+// The replica membership state periodical checking part of replica.
+
DSN_DEFINE_bool(replication, group_check_disabled, false, "whether group check
is disabled");
DSN_DEFINE_int32(replication,
group_check_interval_ms,
diff --git a/src/replica/replica_chkpt.cpp b/src/replica/replica_chkpt.cpp
index b24f11157..cf123af10 100644
--- a/src/replica/replica_chkpt.cpp
+++ b/src/replica/replica_chkpt.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * checkpoint the replicated app
- *
- * Revision history:
- * Nov., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <fmt/core.h>
#include <stdint.h>
#include <atomic>
@@ -75,6 +66,8 @@
namespace dsn {
namespace replication {
+// The checkpoint of the replicated app part of replica.
+
DSN_DEFINE_int32(replication,
checkpoint_max_interval_hours,
2,
diff --git a/src/replica/replica_config.cpp b/src/replica/replica_config.cpp
index ed438636f..de14a2d12 100644
--- a/src/replica/replica_config.cpp
+++ b/src/replica/replica_config.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * replica configuration management
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
// IWYU pragma: no_include <boost/detail/basic_pointerbuf.hpp>
#include <boost/lexical_cast.hpp>
#include <fmt/format.h>
@@ -86,6 +77,8 @@
namespace dsn {
namespace replication {
+// The configuration management part of replica.
+
bool get_bool_envs(const std::map<std::string, std::string> &envs,
const std::string &name,
bool &value)
diff --git a/src/replica/replica_context.cpp b/src/replica/replica_context.cpp
index 67833799e..5c882d153 100644
--- a/src/replica/replica_context.cpp
+++ b/src/replica/replica_context.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * context for replica with different roles
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <algorithm>
#include <atomic>
#include <vector>
diff --git a/src/replica/replica_context.h b/src/replica/replica_context.h
index 472492616..32da41d38 100644
--- a/src/replica/replica_context.h
+++ b/src/replica/replica_context.h
@@ -85,6 +85,7 @@ typedef std::unordered_map<::dsn::rpc_address,
remote_learner_state> learner_map
}
\
}
+// Context of the primary replica.
class primary_context
{
public:
@@ -189,6 +190,7 @@ public:
std::unordered_map<rpc_address, disk_status::type> secondary_disk_status;
};
+// Context of the secondary replica.
class secondary_context
{
public:
@@ -203,6 +205,7 @@ public:
::dsn::task_ptr catchup_with_private_log_task;
};
+// Context of the potential secondary replica.
class potential_secondary_context
{
public:
@@ -251,6 +254,7 @@ public:
::dsn::task_ptr completion_notify_task;
};
+// Context of the partition split replica.
class partition_split_context
{
public:
diff --git a/src/replica/replica_failover.cpp b/src/replica/replica_failover.cpp
index c465c221d..90f88c098 100644
--- a/src/replica/replica_failover.cpp
+++ b/src/replica/replica_failover.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * failure handling in replica
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <atomic>
#include <string>
@@ -52,6 +43,8 @@
namespace dsn {
namespace replication {
+// The failure handling part of replica.
+
void replica::handle_local_failure(error_code error)
{
LOG_INFO_PREFIX("handle local failure error {}, status = {}", error,
enum_to_string(status()));
diff --git a/src/replica/replica_learn.cpp b/src/replica/replica_learn.cpp
index 3fc23ed73..ed1c8050d 100644
--- a/src/replica/replica_learn.cpp
+++ b/src/replica/replica_learn.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * replication learning process
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <inttypes.h>
#include <stdio.h>
#include <algorithm>
@@ -86,6 +77,8 @@
namespace dsn {
namespace replication {
+// The replication learning process part of replica.
+
DSN_DEFINE_int32(replication,
learn_app_max_concurrent_count,
5,
diff --git a/src/replica/replica_stub.cpp b/src/replica/replica_stub.cpp
index dc5a30899..e48a2e15e 100644
--- a/src/replica/replica_stub.cpp
+++ b/src/replica/replica_stub.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * replica container - replica stub
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <boost/algorithm/string/replace.hpp>
// IWYU pragma: no_include <ext/alloc_traits.h>
#include <fmt/core.h>
diff --git a/src/replica/replica_stub.h b/src/replica/replica_stub.h
index e257028db..03a6333aa 100644
--- a/src/replica/replica_stub.h
+++ b/src/replica/replica_stub.h
@@ -26,12 +26,6 @@
#pragma once
-//
-// the replica_stub is the *singleton* entry to
-// access all replica managed in the same process
-// replica_stub(singleton) --> replica --> replication_app_base
-//
-
#include <gtest/gtest_prod.h>
#include <stddef.h>
#include <stdint.h>
@@ -129,6 +123,8 @@ typedef dsn::ref_ptr<replica_stub> replica_stub_ptr;
class duplication_sync_timer;
class replica_backup_server;
+// The replica_stub is the *singleton* entry to access all replica managed in
the same process
+// replica_stub(singleton) --> replica --> replication_app_base
class replica_stub : public serverlet<replica_stub>, public ref_counter
{
public:
diff --git a/src/replica/storage/simple_kv/simple_kv.app.example.h
b/src/replica/storage/simple_kv/simple_kv.app.example.h
index d2a8e7956..578a623ad 100644
--- a/src/replica/storage/simple_kv/simple_kv.app.example.h
+++ b/src/replica/storage/simple_kv/simple_kv.app.example.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "simple_kv.client.h"
#include "simple_kv.server.h"
diff --git a/src/replica/storage/simple_kv/simple_kv.code.definition.h
b/src/replica/storage/simple_kv/simple_kv.code.definition.h
index ef56ab767..b668f3a95 100644
--- a/src/replica/storage/simple_kv/simple_kv.code.definition.h
+++ b/src/replica/storage/simple_kv/simple_kv.code.definition.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "common/replication.codes.h"
diff --git a/src/replica/storage/simple_kv/simple_kv.main.cpp
b/src/replica/storage/simple_kv/simple_kv.main.cpp
index 444757916..5b2ac4ff9 100644
--- a/src/replica/storage/simple_kv/simple_kv.main.cpp
+++ b/src/replica/storage/simple_kv/simple_kv.main.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "http/http_server.h"
// framework specific tools
#include "meta/meta_service_app.h"
diff --git a/src/replica/storage/simple_kv/simple_kv.server.h
b/src/replica/storage/simple_kv/simple_kv.server.h
index a3a614a4d..84d6ab2c8 100644
--- a/src/replica/storage/simple_kv/simple_kv.server.h
+++ b/src/replica/storage/simple_kv/simple_kv.server.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <iostream>
diff --git a/src/replica/storage/simple_kv/simple_kv.server.impl.cpp
b/src/replica/storage/simple_kv/simple_kv.server.impl.cpp
index 323836696..a0002bc54 100644
--- a/src/replica/storage/simple_kv/simple_kv.server.impl.cpp
+++ b/src/replica/storage/simple_kv/simple_kv.server.impl.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "simple_kv.server.impl.h"
#include <fmt/core.h>
diff --git a/src/replica/storage/simple_kv/simple_kv.server.impl.h
b/src/replica/storage/simple_kv/simple_kv.server.impl.h
index 2cfd6bc76..240ed8789 100644
--- a/src/replica/storage/simple_kv/simple_kv.server.impl.h
+++ b/src/replica/storage/simple_kv/simple_kv.server.impl.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <stdint.h>
diff --git a/src/replica/storage/simple_kv/test/case.cpp
b/src/replica/storage/simple_kv/test/case.cpp
index 94962e65f..a69e3129a 100644
--- a/src/replica/storage/simple_kv/test/case.cpp
+++ b/src/replica/storage/simple_kv/test/case.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Replication testing framework.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "case.h"
#include <boost/algorithm/string/case_conv.hpp>
diff --git a/src/replica/storage/simple_kv/test/case.h
b/src/replica/storage/simple_kv/test/case.h
index 565119808..4450b9134 100644
--- a/src/replica/storage/simple_kv/test/case.h
+++ b/src/replica/storage/simple_kv/test/case.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Replication testing framework.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <stddef.h>
diff --git a/src/replica/storage/simple_kv/test/checker.cpp
b/src/replica/storage/simple_kv/test/checker.cpp
index cd02519c1..427126ad3 100644
--- a/src/replica/storage/simple_kv/test/checker.cpp
+++ b/src/replica/storage/simple_kv/test/checker.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Replication testing framework.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <boost/lexical_cast.hpp>
// IWYU pragma: no_include <ext/alloc_traits.h>
#include <atomic>
diff --git a/src/replica/storage/simple_kv/test/checker.h
b/src/replica/storage/simple_kv/test/checker.h
index 0047e5053..0578ac133 100644
--- a/src/replica/storage/simple_kv/test/checker.h
+++ b/src/replica/storage/simple_kv/test/checker.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Replication testing framework.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <algorithm>
diff --git a/src/replica/storage/simple_kv/test/client.cpp
b/src/replica/storage/simple_kv/test/client.cpp
index 905cdb080..f93dffe1b 100644
--- a/src/replica/storage/simple_kv/test/client.cpp
+++ b/src/replica/storage/simple_kv/test/client.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Replication testing framework.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "client.h"
#include <stdint.h>
diff --git a/src/replica/storage/simple_kv/test/client.h
b/src/replica/storage/simple_kv/test/client.h
index 8864cf2c5..66f71d5aa 100644
--- a/src/replica/storage/simple_kv/test/client.h
+++ b/src/replica/storage/simple_kv/test/client.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Replication testing framework.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <memory>
diff --git a/src/replica/storage/simple_kv/test/common.cpp
b/src/replica/storage/simple_kv/test/common.cpp
index 18d359471..cdc3ed115 100644
--- a/src/replica/storage/simple_kv/test/common.cpp
+++ b/src/replica/storage/simple_kv/test/common.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Replication testing framework.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "common.h"
#include <boost/cstdint.hpp>
diff --git a/src/replica/storage/simple_kv/test/common.h
b/src/replica/storage/simple_kv/test/common.h
index 533dadc7e..f042d2b21 100644
--- a/src/replica/storage/simple_kv/test/common.h
+++ b/src/replica/storage/simple_kv/test/common.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Replication testing framework.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <stdint.h>
diff --git a/src/replica/storage/simple_kv/test/injector.cpp
b/src/replica/storage/simple_kv/test/injector.cpp
index 978c6ec44..0b3f856ba 100644
--- a/src/replica/storage/simple_kv/test/injector.cpp
+++ b/src/replica/storage/simple_kv/test/injector.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Replication testing framework.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "injector.h"
#include <stdint.h>
diff --git a/src/replica/storage/simple_kv/test/injector.h
b/src/replica/storage/simple_kv/test/injector.h
index 5b404b5e7..b1fc30ff0 100644
--- a/src/replica/storage/simple_kv/test/injector.h
+++ b/src/replica/storage/simple_kv/test/injector.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Replication testing framework.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "runtime/tool_api.h"
diff --git a/src/replica/storage/simple_kv/test/simple_kv.main.cpp
b/src/replica/storage/simple_kv/test/simple_kv.main.cpp
index ce4866b39..3ea189a20 100644
--- a/src/replica/storage/simple_kv/test/simple_kv.main.cpp
+++ b/src/replica/storage/simple_kv/test/simple_kv.main.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Replication testing framework.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <chrono>
#include <iostream>
#include <string>
diff --git a/src/replica/storage/simple_kv/test/simple_kv.server.impl.cpp
b/src/replica/storage/simple_kv/test/simple_kv.server.impl.cpp
index 31338567d..baf66a755 100644
--- a/src/replica/storage/simple_kv/test/simple_kv.server.impl.cpp
+++ b/src/replica/storage/simple_kv/test/simple_kv.server.impl.cpp
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#include "simple_kv.server.impl.h"
#include <fmt/core.h>
diff --git a/src/replica/storage/simple_kv/test/simple_kv.server.impl.h
b/src/replica/storage/simple_kv/test/simple_kv.server.impl.h
index 83e351574..1235cdbc6 100644
--- a/src/replica/storage/simple_kv/test/simple_kv.server.impl.h
+++ b/src/replica/storage/simple_kv/test/simple_kv.server.impl.h
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#pragma once
#include <stdint.h>
diff --git a/src/reporter/pegasus_counter_reporter.h
b/src/reporter/pegasus_counter_reporter.h
index cc95eac7f..4a1e97ea0 100644
--- a/src/reporter/pegasus_counter_reporter.h
+++ b/src/reporter/pegasus_counter_reporter.h
@@ -48,7 +48,7 @@ namespace pegasus {
namespace server {
// Falcon field description:
-// http://git.n.xiaomi.com/falcon/doc/wikis/instance_monitor
+// https://book.open-falcon.org/zh/philosophy/data-model.html
struct falcon_metric
{
std::string endpoint; // metric host
diff --git a/src/runtime/env.sim.cpp b/src/runtime/env.sim.cpp
index 7c274f449..25135e32b 100644
--- a/src/runtime/env.sim.cpp
+++ b/src/runtime/env.sim.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "env.sim.h"
#include <random>
diff --git a/src/runtime/env.sim.h b/src/runtime/env.sim.h
index b6f056818..2785bb102 100644
--- a/src/runtime/env.sim.h
+++ b/src/runtime/env.sim.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "runtime/env_provider.h"
diff --git a/src/runtime/fault_injector.cpp b/src/runtime/fault_injector.cpp
index a06eca131..b47f7d04f 100644
--- a/src/runtime/fault_injector.cpp
+++ b/src/runtime/fault_injector.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * inject failure through join points to mimic all network/disk/slow
execution etc. failures
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "runtime/fault_injector.h"
#include <chrono>
@@ -60,6 +51,8 @@ struct service_spec;
namespace tools {
+// Inject failure through join points to mimic all network/disk/slow execution
etc. failures.
+
struct fj_opt
{
bool fault_injection_enabled;
diff --git a/src/runtime/global_config.cpp b/src/runtime/global_config.cpp
index 71e7bcc47..7b7aafc40 100644
--- a/src/runtime/global_config.cpp
+++ b/src/runtime/global_config.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * configuration of rDSN
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
diff --git a/src/runtime/global_config.h b/src/runtime/global_config.h
index b7333ccba..ca18df919 100644
--- a/src/runtime/global_config.h
+++ b/src/runtime/global_config.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * rdsn configurations
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
/// Attention: There are some types which are defined in dsn_runtime being
used in this file,
/// so this file is coupled with dsn_runtime. If you want to add some
variables/types here or
/// include this file, please make sure whether you want to couple with
dsn_runtime or not.
diff --git a/src/runtime/nativerun.cpp b/src/runtime/nativerun.cpp
index d488b890a..ea629dfec 100644
--- a/src/runtime/nativerun.cpp
+++ b/src/runtime/nativerun.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "runtime/nativerun.h"
#include <map>
diff --git a/src/runtime/nativerun.h b/src/runtime/nativerun.h
index b354ced69..2acdae6cc 100644
--- a/src/runtime/nativerun.h
+++ b/src/runtime/nativerun.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * the nativerun tool which is a simple but runnable deployment runtime
for zion
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "runtime/tool_api.h"
@@ -42,6 +33,7 @@ struct service_spec;
namespace tools {
+// The nativerun tool which is a simple but runnable deployment runtime for
zion.
class nativerun : public tool_app
{
public:
diff --git a/src/runtime/providers.common.cpp b/src/runtime/providers.common.cpp
index b3fc67668..966ecf3e8 100644
--- a/src/runtime/providers.common.cpp
+++ b/src/runtime/providers.common.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <string>
#include "runtime/env_provider.h"
diff --git a/src/runtime/rpc/dsn_message_parser.cpp
b/src/runtime/rpc/dsn_message_parser.cpp
index afb8d2000..6c72a0651 100644
--- a/src/runtime/rpc/dsn_message_parser.cpp
+++ b/src/runtime/rpc/dsn_message_parser.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * Jun. 2016, Zuoyan Qin, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "dsn_message_parser.h"
#include <stddef.h>
diff --git a/src/runtime/rpc/dsn_message_parser.h
b/src/runtime/rpc/dsn_message_parser.h
index cb6ddf45c..bdc16672d 100644
--- a/src/runtime/rpc/dsn_message_parser.h
+++ b/src/runtime/rpc/dsn_message_parser.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
-* Description:
-* message parser for browser-generated http request
-*
-* Revision history:
-* Jun. 2016, Zuoyan Qin, first version
-* xxxx-xx-xx, author, fix bug about xxx
-*/
-
#pragma once
#include "runtime/rpc/message_parser.h"
@@ -40,6 +31,7 @@
namespace dsn {
class message_ex;
+// Message parser for browser-generated http request.
class dsn_message_parser : public message_parser
{
public:
diff --git a/src/runtime/rpc/message_parser.cpp
b/src/runtime/rpc/message_parser.cpp
index 33dbac772..e9c0da964 100644
--- a/src/runtime/rpc/message_parser.cpp
+++ b/src/runtime/rpc/message_parser.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <ctype.h>
#include <stdio.h>
#include <string.h>
diff --git a/src/runtime/rpc/message_parser_manager.h
b/src/runtime/rpc/message_parser_manager.h
index 31d16818b..b3fc7fa4c 100644
--- a/src/runtime/rpc/message_parser_manager.h
+++ b/src/runtime/rpc/message_parser_manager.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * message parser manager
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "runtime/rpc/message_parser.h"
diff --git a/src/runtime/rpc/network.sim.cpp b/src/runtime/rpc/network.sim.cpp
index d5d62a230..a2c185dbc 100644
--- a/src/runtime/rpc/network.sim.cpp
+++ b/src/runtime/rpc/network.sim.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <string.h>
#include <functional>
#include <memory>
diff --git a/src/runtime/rpc/raw_message_parser.cpp
b/src/runtime/rpc/raw_message_parser.cpp
index bf68f6232..53cde8de6 100644
--- a/src/runtime/rpc/raw_message_parser.cpp
+++ b/src/runtime/rpc/raw_message_parser.cpp
@@ -24,13 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, fix bug about xxx
- */
#include "raw_message_parser.h"
#include <string.h>
diff --git a/src/runtime/rpc/raw_message_parser.h
b/src/runtime/rpc/raw_message_parser.h
index f1c0fb43c..1b39a4176 100644
--- a/src/runtime/rpc/raw_message_parser.h
+++ b/src/runtime/rpc/raw_message_parser.h
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
-* Description:
-* message parser for user customed request
-*
-* Revision history:
-* xxxx-xx-xx, author, fix bug about xxx
-*/
-
#ifndef RAW_MESSAGE_PARSER_H
#define RAW_MESSAGE_PARSER_H
@@ -46,6 +38,7 @@ DEFINE_CUSTOMIZED_ID(network_header_format, NET_HDR_RAW)
class rpc_session;
+// Message parser for user customed request.
class raw_message_parser : public message_parser
{
private:
diff --git a/src/runtime/rpc/rpc_message.h b/src/runtime/rpc/rpc_message.h
index 51c8e4940..d07cb0c5b 100644
--- a/src/runtime/rpc/rpc_message.h
+++ b/src/runtime/rpc/rpc_message.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <stddef.h>
diff --git a/src/runtime/scheduler.cpp b/src/runtime/scheduler.cpp
index 458dde716..cfb605188 100644
--- a/src/runtime/scheduler.cpp
+++ b/src/runtime/scheduler.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <stddef.h>
#include <algorithm>
#include <chrono>
diff --git a/src/runtime/scheduler.h b/src/runtime/scheduler.h
index b039586dc..422690f2a 100644
--- a/src/runtime/scheduler.h
+++ b/src/runtime/scheduler.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <cstdint>
diff --git a/src/runtime/serverlet.h b/src/runtime/serverlet.h
index 8aeeebefa..347d5f384 100644
--- a/src/runtime/serverlet.h
+++ b/src/runtime/serverlet.h
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#pragma once
#include "runtime/service_app.h"
diff --git a/src/runtime/service_app.h b/src/runtime/service_app.h
index 31b6382b0..0e6e2cfc8 100644
--- a/src/runtime/service_app.h
+++ b/src/runtime/service_app.h
@@ -24,22 +24,12 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * application model atop zion in c++
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "runtime/api_task.h"
#include "runtime/api_layer1.h"
#include "runtime/app_model.h"
#include "utils/api_utilities.h"
-
#include "utils/error_code.h"
#include "utils/threadpool_code.h"
#include "runtime/task/task_code.h"
@@ -66,6 +56,7 @@ struct service_app_info
std::string data_dir;
};
+// The application model atop zion in C++.
class service_app
{
public:
diff --git a/src/runtime/service_engine.h b/src/runtime/service_engine.h
index a4f7b599f..1e6528f0f 100644
--- a/src/runtime/service_engine.h
+++ b/src/runtime/service_engine.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <map>
diff --git a/src/runtime/simulator.cpp b/src/runtime/simulator.cpp
index 8ebb5ee0d..87c242c90 100644
--- a/src/runtime/simulator.cpp
+++ b/src/runtime/simulator.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "runtime/simulator.h"
#include <map>
diff --git a/src/runtime/task/future_types.h b/src/runtime/task/future_types.h
index e1eea51f4..1a88c8d42 100644
--- a/src/runtime/task/future_types.h
+++ b/src/runtime/task/future_types.h
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#pragma once
#include <functional>
diff --git a/src/runtime/task/task_engine.h b/src/runtime/task/task_engine.h
index 31e922652..cbff4e351 100644
--- a/src/runtime/task/task_engine.h
+++ b/src/runtime/task/task_engine.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <iosfwd>
diff --git a/src/runtime/task/task_engine.sim.cpp
b/src/runtime/task/task_engine.sim.cpp
index 45412d114..142458522 100644
--- a/src/runtime/task/task_engine.sim.cpp
+++ b/src/runtime/task/task_engine.sim.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <cstdint>
#include <utility>
diff --git a/src/runtime/task/task_engine.sim.h
b/src/runtime/task/task_engine.sim.h
index fc12e16e6..85ded58ea 100644
--- a/src/runtime/task/task_engine.sim.h
+++ b/src/runtime/task/task_engine.sim.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <stdint.h>
diff --git a/src/runtime/task/task_spec.h b/src/runtime/task/task_spec.h
index ea3b18ea5..9ce31bd22 100644
--- a/src/runtime/task/task_spec.h
+++ b/src/runtime/task/task_spec.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * specification for the labeled tasks (task kinds)
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <stdint.h>
@@ -147,6 +138,7 @@ class task;
std::set<dsn::task_code> &get_storage_rpc_req_codes();
+// Specification for the labeled tasks (task kinds).
class task_spec : public extensible_object<task_spec, 4>
{
public:
diff --git a/src/runtime/task/task_worker.h b/src/runtime/task/task_worker.h
index 26ce2f75a..426491508 100644
--- a/src/runtime/task/task_worker.h
+++ b/src/runtime/task/task_worker.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * task worker (thread) abstraction
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <stdint.h>
@@ -56,6 +47,7 @@ class task_worker_pool;
/*!
task worker processes the input tasks from the bound task queue
*/
+// The task worker (a.k.a. thread) abstraction class.
class task_worker : public extensible_object<task_worker, 4>
{
public:
diff --git a/src/runtime/test/async_call.cpp b/src/runtime/test/async_call.cpp
index 7c96ee377..0b55f2e78 100644
--- a/src/runtime/test/async_call.cpp
+++ b/src/runtime/test/async_call.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Unit-test for clientlet.
- *
- * Revision history:
- * Nov., 2015, @shengofsun (Weijie Sun), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <fmt/format.h>
#include <atomic>
#include <chrono>
diff --git a/src/runtime/test/lpc.cpp b/src/runtime/test/lpc.cpp
index bcbc10281..286cf1c48 100644
--- a/src/runtime/test/lpc.cpp
+++ b/src/runtime/test/lpc.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <functional>
#include <string>
diff --git a/src/runtime/test/main.cpp b/src/runtime/test/main.cpp
index 00ad6981f..0e0400eb6 100644
--- a/src/runtime/test/main.cpp
+++ b/src/runtime/test/main.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <chrono>
#include <iostream>
#include <thread>
diff --git a/src/runtime/test/netprovider.cpp b/src/runtime/test/netprovider.cpp
index b6ab3932b..f0b568300 100644
--- a/src/runtime/test/netprovider.cpp
+++ b/src/runtime/test/netprovider.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Unit-test for net provider.
- *
- * Revision history:
- * Nov., 2015, @shengofsun (Weijie Sun), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <string.h>
#include <chrono>
#include <functional>
diff --git a/src/runtime/test/rpc_message.cpp b/src/runtime/test/rpc_message.cpp
index 22f87275b..a596b2cd2 100644
--- a/src/runtime/test/rpc_message.cpp
+++ b/src/runtime/test/rpc_message.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Unit-test for rpc_message.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <stdint.h>
#include <string.h>
#include <memory>
diff --git a/src/runtime/test/service_api_c.cpp
b/src/runtime/test/service_api_c.cpp
index 77c1db85c..263063f22 100644
--- a/src/runtime/test/service_api_c.cpp
+++ b/src/runtime/test/service_api_c.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Unit-test for c service api.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <stdint.h>
#include <chrono>
#include <map>
diff --git a/src/runtime/test/sim_lock.cpp b/src/runtime/test/sim_lock.cpp
index 772548a80..7bde41bf2 100644
--- a/src/runtime/test/sim_lock.cpp
+++ b/src/runtime/test/sim_lock.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Unit-test for sim lock.
- *
- * Revision history:
- * Nov., 2015, @xiaotz (Xiaotong Zhang), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <functional>
#include <string>
diff --git a/src/runtime/test/task_engine.cpp b/src/runtime/test/task_engine.cpp
index 9e9c033ae..573e931ec 100644
--- a/src/runtime/test/task_engine.cpp
+++ b/src/runtime/test/task_engine.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Unit-test for task engine.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "runtime/task/task_engine.h"
#include <stdio.h>
diff --git a/src/runtime/test/test_utils.h b/src/runtime/test/test_utils.h
index 5e8dd67fa..29520eee9 100644
--- a/src/runtime/test/test_utils.h
+++ b/src/runtime/test/test_utils.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "runtime/api_task.h"
diff --git a/src/runtime/tool_api.cpp b/src/runtime/tool_api.cpp
index 4a28a0db9..fa9bff154 100644
--- a/src/runtime/tool_api.cpp
+++ b/src/runtime/tool_api.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "runtime/tool_api.h"
#include <algorithm>
diff --git a/src/runtime/tool_api.h b/src/runtime/tool_api.h
index 492033328..c9e145a43 100644
--- a/src/runtime/tool_api.h
+++ b/src/runtime/tool_api.h
@@ -24,18 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * define the interface for implementing and plug-in the tools &
- * runtime components into rDSN.
- * In rDSN, both developement tools and runtime libraries
- * (e.g., high performance components) are considered tools.
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
/*!
@defgroup tool-api-hooks Join Points
@ingroup tool-api
@@ -72,6 +60,10 @@ struct service_spec;
namespace tools {
+// Define the interface for implementing and plug-in the tools & runtime
components into rDSN.
+// In rDSN, both developement tools and runtime libraries (e.g., high
performance components) are
+// considered tools.
+
/*!
@addtogroup tool-api-providers
@{
diff --git a/src/runtime/zlocks.cpp b/src/runtime/zlocks.cpp
index 98becc645..bf2c7f1a4 100644
--- a/src/runtime/zlocks.cpp
+++ b/src/runtime/zlocks.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <algorithm>
#include <atomic>
#include <string>
diff --git a/src/server/pegasus_scan_context.h
b/src/server/pegasus_scan_context.h
index 9f363924c..7c256df0d 100644
--- a/src/server/pegasus_scan_context.h
+++ b/src/server/pegasus_scan_context.h
@@ -97,7 +97,7 @@ public:
// 3. we should keep context id positive, as negtive value have
specical meanings.
//
// a more detailed description on the context id confliction is here:
- // https://github.com/XiaoMi/pegasus/issues/156
+ // https://github.com/apache/incubator-pegasus/issues/156
//
// however, currently the implementation is not 100% correct.
//
diff --git a/src/server/pegasus_server_impl_init.cpp
b/src/server/pegasus_server_impl_init.cpp
index 855d6c671..23c61b50d 100644
--- a/src/server/pegasus_server_impl_init.cpp
+++ b/src/server/pegasus_server_impl_init.cpp
@@ -202,7 +202,7 @@ DSN_DEFINE_bool(pegasus.server,
// treated as 4, a value of 19 will be treated as 16.
//
// Default: 0 (disabled)
-// see
https://github.com/XiaoMi/pegasus-rocksdb/blob/v6.6.4-compatible/include/rocksdb/table.h#L247
+// see
https://github.com/facebook/rocksdb/blob/v6.6.4/include/rocksdb/table.h#L247
DSN_DEFINE_int32(pegasus.server,
read_amp_bytes_per_bit,
0,
diff --git a/src/server/pegasus_write_service.h
b/src/server/pegasus_write_service.h
index 9fb854ffd..6f6380f1c 100644
--- a/src/server/pegasus_write_service.h
+++ b/src/server/pegasus_write_service.h
@@ -133,7 +133,7 @@ public:
~pegasus_write_service();
// Write empty record.
- // See this document
(https://github.com/XiaoMi/pegasus/wiki/last_flushed_decree)
+ // See this document
(https://pegasus.apache.org/zh/2018/03/07/last_flushed_decree.html)
// to know why we must have empty write.
int empty_put(int64_t decree);
diff --git a/src/tools/mutation_log_tool.h b/src/tools/mutation_log_tool.h
index 08480f18d..d313bdc4a 100644
--- a/src/tools/mutation_log_tool.h
+++ b/src/tools/mutation_log_tool.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <stdint.h>
diff --git a/src/utils/autoref_ptr.h b/src/utils/autoref_ptr.h
index a3a7dfd2b..501698f85 100644
--- a/src/utils/autoref_ptr.h
+++ b/src/utils/autoref_ptr.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <atomic>
diff --git a/src/utils/config_api.h b/src/utils/config_api.h
index 4e0cf69fb..62b0ec651 100644
--- a/src/utils/config_api.h
+++ b/src/utils/config_api.h
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#pragma once
#include <cstdint>
diff --git a/src/utils/configuration.cpp b/src/utils/configuration.cpp
index c69a556d2..d9d4c1ac6 100644
--- a/src/utils/configuration.cpp
+++ b/src/utils/configuration.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <fmt/core.h>
#include <rocksdb/env.h>
#include <rocksdb/status.h>
diff --git a/src/utils/coredump.h b/src/utils/coredump.h
index 2e57ad45b..f97c7eab4 100644
--- a/src/utils/coredump.h
+++ b/src/utils/coredump.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <string>
diff --git a/src/utils/distributed_lock_service.h
b/src/utils/distributed_lock_service.h
index 87c1fee8e..0a8749021 100644
--- a/src/utils/distributed_lock_service.h
+++ b/src/utils/distributed_lock_service.h
@@ -24,21 +24,6 @@
* THE SOFTWARE.
*/
-/*
-* Description:
-* interface of the reliable distributed lock service
-*
-* Revision history:
-* 2015-10-28, Weijie Sun, first version
-* 2015-11-5, @imzhenyu (Zhenyu Guo), remove create and destroy API as they
are
-* unnecessary, adjust the interface, so that
-* (1) return task_ptr for callers to cancel or wait;
-* (2) add factory for provider registration;
-* (3) add cb_code parameter, then users can specify where the
callback
-* should be executed
-* xxxx-xx-xx, author, fix bug about xxx
-*/
-
#pragma once
#include "runtime/api_task.h"
@@ -68,6 +53,7 @@ typedef std::function<void(error_code ec, const std::string
&owner_id, uint64_t
typedef future_task<error_code, std::string, uint64_t> lock_future;
typedef dsn::ref_ptr<lock_future> lock_future_ptr;
+// The interface of the reliable distributed lock service.
class distributed_lock_service
{
public:
diff --git a/src/utils/enum_helper.h b/src/utils/enum_helper.h
index 25d78b909..003de4621 100644
--- a/src/utils/enum_helper.h
+++ b/src/utils/enum_helper.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <map>
diff --git a/src/utils/error_code.cpp b/src/utils/error_code.cpp
index cfeff52d1..4b26fcc57 100644
--- a/src/utils/error_code.cpp
+++ b/src/utils/error_code.cpp
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#include "utils/error_code.h"
#include "utils/customizable_id.h"
diff --git a/src/utils/exp_delay.h b/src/utils/exp_delay.h
index d3d950eba..09b538934 100644
--- a/src/utils/exp_delay.h
+++ b/src/utils/exp_delay.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * delay for admission control
- *
- * Revision history:
- * Nov., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "utils/singleton.h"
@@ -44,6 +35,7 @@ namespace dsn {
const double s_default_delay_points[DELAY_COUNT] = {1.0, 1.2, 1.4, 1.6, 1.8,
2.0};
const int s_default_delay[DELAY_COUNT] = {0, 0, 1, 2, 5, 10}; // millieseconds
+// Delay for admission control.
class exp_delay
{
public:
diff --git a/src/utils/extensible_object.h b/src/utils/extensible_object.h
index 56d25bd9c..ffdf4241f 100644
--- a/src/utils/extensible_object.h
+++ b/src/utils/extensible_object.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * state extension for cpp objects
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "utils/utils.h"
@@ -49,6 +40,7 @@ namespace dsn {
typedef void (*extension_deletor)(void *);
typedef void *(*extension_creator)(void *);
+// State extension for cpp objects.
class extensible
{
public:
diff --git a/src/utils/factory_store.h b/src/utils/factory_store.h
index 561cedca2..72d203e0c 100644
--- a/src/utils/factory_store.h
+++ b/src/utils/factory_store.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * factory registry for object creation
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "utils/singleton_store.h"
@@ -47,6 +38,7 @@ enum provider_type
namespace utils {
+// Factory registry for object creation.
template <typename TResult>
class factory_store
{
diff --git a/src/utils/filesystem.cpp b/src/utils/filesystem.cpp
index 9f3d77380..0ebe07ef7 100644
--- a/src/utils/filesystem.cpp
+++ b/src/utils/filesystem.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * File system utility functions.
- *
- * Revision history:
- * 2015-08-24, HX Lin([email protected]), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <boost/filesystem/operations.hpp>
#include <boost/system/error_code.hpp>
#include <errno.h>
diff --git a/src/utils/fixed_size_buffer_pool.h
b/src/utils/fixed_size_buffer_pool.h
index d2b05b42e..ab0ed4f4d 100644
--- a/src/utils/fixed_size_buffer_pool.h
+++ b/src/utils/fixed_size_buffer_pool.h
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#pragma once
///
diff --git a/src/utils/gpid.cpp b/src/utils/gpid.cpp
index 7dd34a23c..1d3bb3e27 100644
--- a/src/utils/gpid.cpp
+++ b/src/utils/gpid.cpp
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#include <stdio.h>
#include "common/gpid.h"
diff --git a/src/utils/link.h b/src/utils/link.h
index 00cdc27b7..96cd5071f 100644
--- a/src/utils/link.h
+++ b/src/utils/link.h
@@ -24,19 +24,11 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * single and double linked list
- *
- * Revision history:
- * Mar., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <cassert>
+// single linked list.
//
// assuming public T::T* next; exists and inited to nullptr in T::T(...)
//
@@ -116,6 +108,7 @@ public:
T *_last;
};
+// double linked list.
class dlink
{
public:
diff --git a/src/utils/lockp.std.h b/src/utils/lockp.std.h
index e797e2423..b61b6f093 100644
--- a/src/utils/lockp.std.h
+++ b/src/utils/lockp.std.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "utils/synchronize.h"
diff --git a/src/utils/priority_queue.h b/src/utils/priority_queue.h
index 56de0cf91..1c46d11bc 100644
--- a/src/utils/priority_queue.h
+++ b/src/utils/priority_queue.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <stdint.h>
diff --git a/src/utils/shared_io_service.h b/src/utils/shared_io_service.h
index b22bffc7f..b4bad9579 100644
--- a/src/utils/shared_io_service.h
+++ b/src/utils/shared_io_service.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include <boost/asio/io_service.hpp>
diff --git a/src/utils/singleton_store.h b/src/utils/singleton_store.h
index bd680b5d6..1db4bb008 100644
--- a/src/utils/singleton_store.h
+++ b/src/utils/singleton_store.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "utils/singleton.h"
diff --git a/src/utils/synchronize.h b/src/utils/synchronize.h
index 80a51a6f6..8f1a66cd2 100644
--- a/src/utils/synchronize.h
+++ b/src/utils/synchronize.h
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#pragma once
#include "utils/ports.h"
diff --git a/src/utils/test/env.cpp b/src/utils/test/env.cpp
index ab3763c27..7aff1f8ab 100644
--- a/src/utils/test/env.cpp
+++ b/src/utils/test/env.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Unit-test for rpc_address.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <fmt/core.h>
#include <rocksdb/env.h>
#include <rocksdb/slice.h>
diff --git a/src/utils/test/logging.cpp b/src/utils/test/logging.cpp
index eb3170d2a..9ac1d3235 100644
--- a/src/utils/test/logging.cpp
+++ b/src/utils/test/logging.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Unit-test for logging.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <gtest/gtest.h>
#include <iostream>
#include <string>
diff --git a/src/utils/test/priority_queue.cpp
b/src/utils/test/priority_queue.cpp
index ebe985e92..239d7e060 100644
--- a/src/utils/test/priority_queue.cpp
+++ b/src/utils/test/priority_queue.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Unit-test for priority_queue.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "utils/priority_queue.h"
#include <algorithm>
diff --git a/src/utils/test/sema.cpp b/src/utils/test/sema.cpp
index 2da4df61d..e16318d8b 100644
--- a/src/utils/test/sema.cpp
+++ b/src/utils/test/sema.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * Unit-test for semaphore.
- *
- * Revision history:
- * Nov., 2015, @qinzuoyan (Zuoyan Qin), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "utils/hpc_locks/sema.h"
#include <chrono>
diff --git a/src/utils/test/utils.cpp b/src/utils/test/utils.cpp
index 5ca301047..e9fc83f81 100644
--- a/src/utils/test/utils.cpp
+++ b/src/utils/test/utils.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include <stddef.h>
#include <list>
#include <map>
diff --git a/src/utils/thread_access_checker.h
b/src/utils/thread_access_checker.h
index f5414ca49..623dfc0f8 100644
--- a/src/utils/thread_access_checker.h
+++ b/src/utils/thread_access_checker.h
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#pragma once
namespace dsn {
diff --git a/src/utils/threadpool_spec.h b/src/utils/threadpool_spec.h
index f9bd082a1..90df20a9d 100644
--- a/src/utils/threadpool_spec.h
+++ b/src/utils/threadpool_spec.h
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#pragma once
#include <string>
diff --git a/src/utils/time_utils.h b/src/utils/time_utils.h
index 5a0a2eb68..0e4d50f70 100644
--- a/src/utils/time_utils.h
+++ b/src/utils/time_utils.h
@@ -23,6 +23,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
+
#pragma once
// IWYU pragma: no_include <bits/types/struct_tm.h>
diff --git a/src/utils/utils.cpp b/src/utils/utils.cpp
index 65520af92..c3ebb8c9f 100644
--- a/src/utils/utils.cpp
+++ b/src/utils/utils.cpp
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * What is this file about?
- *
- * Revision history:
- * xxxx-xx-xx, author, first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#include "utils/utils.h"
#include <arpa/inet.h>
diff --git a/src/utils/work_queue.h b/src/utils/work_queue.h
index 62ecdba25..72f2a6157 100644
--- a/src/utils/work_queue.h
+++ b/src/utils/work_queue.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * the work queue abstraction
- *
- * Revision history:
- * Oct., 2015, @imzhenyu (Zhenyu Guo), first version
- * xxxx-xx-xx, author, fix bug about xxx
- */
-
#pragma once
#include "utils/synchronize.h"
@@ -41,6 +32,7 @@
namespace dsn {
+// The work queue abstraction class.
template <typename T>
class work_queue
{
diff --git a/src/zookeeper/distributed_lock_service_zookeeper.cpp
b/src/zookeeper/distributed_lock_service_zookeeper.cpp
index 6ea7e9b23..6d57ef4bd 100644
--- a/src/zookeeper/distributed_lock_service_zookeeper.cpp
+++ b/src/zookeeper/distributed_lock_service_zookeeper.cpp
@@ -34,13 +34,6 @@
#include "lock_struct.h"
#include "lock_types.h"
#include "runtime/service_app.h"
-/*
- * Description:
- * distributed lock service implemented with zookeeper
- *
- * Revision history:
- * 2015-12-04, @shengofsun ([email protected])
- */
#include "runtime/task/async_calls.h"
#include "utils/flags.h"
#include "utils/fmt_logging.h"
diff --git a/src/zookeeper/distributed_lock_service_zookeeper.h
b/src/zookeeper/distributed_lock_service_zookeeper.h
index facddd189..206e73459 100644
--- a/src/zookeeper/distributed_lock_service_zookeeper.h
+++ b/src/zookeeper/distributed_lock_service_zookeeper.h
@@ -24,13 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * distributed lock service implemented with zookeeper
- *
- * Revision history:
- * 2015-12-04, @shengofsun ([email protected])
- */
#pragma once
#include <cstddef>
diff --git a/src/zookeeper/lock_struct.cpp b/src/zookeeper/lock_struct.cpp
index 514416643..56b0fd33b 100644
--- a/src/zookeeper/lock_struct.cpp
+++ b/src/zookeeper/lock_struct.cpp
@@ -26,14 +26,6 @@
#include <ctype.h>
#include <chrono>
-/*
- * Description:
- * distributed lock service implemented with zookeeper, the implementation
- * of lock_structure
- *
- * Revision history:
- * 2015-12-04, @shengofsun ([email protected])
- */
#include <functional>
#include <memory>
#include <string>
diff --git a/src/zookeeper/lock_struct.h b/src/zookeeper/lock_struct.h
index eca2696ad..fa10f9439 100644
--- a/src/zookeeper/lock_struct.h
+++ b/src/zookeeper/lock_struct.h
@@ -24,13 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * distributed lock service implemented with zookeeper, the definition of
each lock structure
- *
- * Revision history:
- * 2015-12-04, @shengofsun ([email protected])
- */
#pragma once
#include <stdint.h>
diff --git a/src/zookeeper/lock_types.h b/src/zookeeper/lock_types.h
index 01035e422..d368fc514 100644
--- a/src/zookeeper/lock_types.h
+++ b/src/zookeeper/lock_types.h
@@ -24,13 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * distributed lock service implemented with zookeeper, some types
definition
- *
- * Revision history:
- * 2015-12-04, @shengofsun ([email protected])
- */
#pragma once
#include "utils/autoref_ptr.h"
diff --git a/src/zookeeper/zookeeper_error.cpp
b/src/zookeeper/zookeeper_error.cpp
index 03a53a1ad..3504990a5 100644
--- a/src/zookeeper/zookeeper_error.cpp
+++ b/src/zookeeper/zookeeper_error.cpp
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * transform zookeeper error code to dsn error code, implementation
- *
- * Revision history:
- * 2015-12-04, @shengofsun ([email protected])
- */
-
#include <zookeeper/zookeeper.h>
#include "utils/error_code.h"
diff --git a/src/zookeeper/zookeeper_error.h b/src/zookeeper/zookeeper_error.h
index fa51ff87f..a78f41be2 100644
--- a/src/zookeeper/zookeeper_error.h
+++ b/src/zookeeper/zookeeper_error.h
@@ -24,13 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * transform zookeeper error code to dsn error code, header
- *
- * Revision history:
- * 2015-12-04, @shengofsun ([email protected])
- */
#pragma once
#include "utils/error_code.h"
diff --git a/src/zookeeper/zookeeper_session.cpp
b/src/zookeeper/zookeeper_session.cpp
index bfa7bed7a..9a467b64c 100644
--- a/src/zookeeper/zookeeper_session.cpp
+++ b/src/zookeeper/zookeeper_session.cpp
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * a C++ wrapper of zookeeper c async api, implementation
- *
- * Revision history:
- * 2015-12-04, @shengofsun ([email protected])
- */
-
#include <stdlib.h>
#include <zookeeper/zookeeper.h>
#include <algorithm>
diff --git a/src/zookeeper/zookeeper_session.h
b/src/zookeeper/zookeeper_session.h
index 41323fccf..b359f867b 100644
--- a/src/zookeeper/zookeeper_session.h
+++ b/src/zookeeper/zookeeper_session.h
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * a C++ wrapper of zookeeper c async api, header
- *
- * Revision history:
- * 2015-12-04, @shengofsun ([email protected])
- */
-
#include <stdint.h>
#include <string.h>
#include <zookeeper/zookeeper.h>
@@ -52,6 +44,7 @@ struct String_vector;
namespace dsn {
namespace dist {
+// A C++ wrapper of zookeeper c async APIs.
class zookeeper_session
{
public:
diff --git a/src/zookeeper/zookeeper_session_mgr.cpp
b/src/zookeeper/zookeeper_session_mgr.cpp
index 60ddb43d7..8f4750df8 100644
--- a/src/zookeeper/zookeeper_session_mgr.cpp
+++ b/src/zookeeper/zookeeper_session_mgr.cpp
@@ -24,14 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * a singleton to manager all zookeeper sessions, so that each zookeeper
session
- * can be shared by all threads in one service-node. The implementation
file.
- *
- * Revision history:
- * 2015-12-04, @shengofsun ([email protected])
- */
#include "zookeeper_session_mgr.h"
#include <stdio.h>
diff --git a/src/zookeeper/zookeeper_session_mgr.h
b/src/zookeeper/zookeeper_session_mgr.h
index eaa0843f1..ada6bc4f7 100644
--- a/src/zookeeper/zookeeper_session_mgr.h
+++ b/src/zookeeper/zookeeper_session_mgr.h
@@ -24,15 +24,6 @@
* THE SOFTWARE.
*/
-/*
- * Description:
- * a singleton to manager all zookeeper sessions, so that each zookeeper
session
- * can be shared by all threads in one service-node. The Header file.
- *
- * Revision history:
- * 2015-12-04, @shengofsun ([email protected])
- */
-
#include "utils/singleton.h"
#pragma once
@@ -44,6 +35,8 @@ namespace dist {
class zookeeper_session;
+// A singleton to manage all zookeeper sessions, so that each zookeeper session
+// can be shared by all threads in one service-node.
class zookeeper_session_mgr : public utils::singleton<zookeeper_session_mgr>
{
public:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
