aboutsummaryrefslogtreecommitdiffstats
path: root/src/fuzzy_storage.c
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@highsecure.ru>2015-12-29 18:06:25 +0000
committerVsevolod Stakhov <vsevolod@highsecure.ru>2015-12-29 18:06:25 +0000
commit49df9c2db6ec9b211cbcc651c98024a702f7d25b (patch)
tree97ef9d796079d5fbee6c0426e16a7161215da4c5 /src/fuzzy_storage.c
parentd80d4e366703ed35b87c30e554781058b296095b (diff)
downloadrspamd-49df9c2db6ec9b211cbcc651c98024a702f7d25b.tar.gz
rspamd-49df9c2db6ec9b211cbcc651c98024a702f7d25b.zip
Add documentation for all workers' options
Diffstat (limited to 'src/fuzzy_storage.c')
-rw-r--r--src/fuzzy_storage.c23
1 files changed, 13 insertions, 10 deletions
diff --git a/src/fuzzy_storage.c b/src/fuzzy_storage.c
index 8e84ddea7..4404f0b82 100644
--- a/src/fuzzy_storage.c
+++ b/src/fuzzy_storage.c
@@ -1143,7 +1143,7 @@ init_fuzzy (struct rspamd_config *cfg)
ctx,
G_STRUCT_OFFSET (struct rspamd_fuzzy_storage_ctx, hashfile),
0,
- NULL);
+ "Path to fuzzy database");
rspamd_rcl_register_worker_option (cfg,
type,
@@ -1152,7 +1152,7 @@ init_fuzzy (struct rspamd_config *cfg)
ctx,
G_STRUCT_OFFSET (struct rspamd_fuzzy_storage_ctx, hashfile),
0,
- NULL);
+ "Path to fuzzy database (alias for hashfile)");
rspamd_rcl_register_worker_option (cfg,
type,
@@ -1161,7 +1161,7 @@ init_fuzzy (struct rspamd_config *cfg)
ctx,
G_STRUCT_OFFSET (struct rspamd_fuzzy_storage_ctx, hashfile),
0,
- NULL);
+ "Path to fuzzy database (alias for hashfile)");
rspamd_rcl_register_worker_option (cfg,
type,
@@ -1170,7 +1170,7 @@ init_fuzzy (struct rspamd_config *cfg)
ctx,
G_STRUCT_OFFSET (struct rspamd_fuzzy_storage_ctx, hashfile),
0,
- NULL);
+ "Path to fuzzy database (alias for hashfile)");
rspamd_rcl_register_worker_option (cfg,
type,
@@ -1180,7 +1180,8 @@ init_fuzzy (struct rspamd_config *cfg)
G_STRUCT_OFFSET (struct rspamd_fuzzy_storage_ctx,
sync_timeout),
RSPAMD_CL_FLAG_TIME_FLOAT,
- NULL);
+ "Time to perform database sync, default: "
+ G_STRINGIFY (DEFAULT_SYNC_TIMEOUT) " seconds");
rspamd_rcl_register_worker_option (cfg,
type,
@@ -1190,7 +1191,8 @@ init_fuzzy (struct rspamd_config *cfg)
G_STRUCT_OFFSET (struct rspamd_fuzzy_storage_ctx,
expire),
RSPAMD_CL_FLAG_TIME_FLOAT,
- NULL);
+ "Default expire time for hashes, default: "
+ G_STRINGIFY (DEFAULT_EXPIRE) " seconds");
rspamd_rcl_register_worker_option (cfg,
type,
@@ -1199,7 +1201,7 @@ init_fuzzy (struct rspamd_config *cfg)
ctx,
G_STRUCT_OFFSET (struct rspamd_fuzzy_storage_ctx, update_map),
0,
- NULL);
+ "Allow modifications from the following IP addresses");
rspamd_rcl_register_worker_option (cfg,
type,
@@ -1208,7 +1210,7 @@ init_fuzzy (struct rspamd_config *cfg)
ctx,
0,
RSPAMD_CL_FLAG_MULTIPLE,
- NULL);
+ "Encryption keypair (can be repeated for different keys)");
rspamd_rcl_register_worker_option (cfg,
type,
@@ -1218,7 +1220,8 @@ init_fuzzy (struct rspamd_config *cfg)
G_STRUCT_OFFSET (struct rspamd_fuzzy_storage_ctx,
keypair_cache_size),
RSPAMD_CL_FLAG_UINT,
- NULL);
+ "Size of keypairs cache, default: "
+ G_STRINGIFY (DEFAULT_KEYPAIR_CACHE_SIZE));
rspamd_rcl_register_worker_option (cfg,
type,
@@ -1227,7 +1230,7 @@ init_fuzzy (struct rspamd_config *cfg)
ctx,
G_STRUCT_OFFSET (struct rspamd_fuzzy_storage_ctx, encrypted_only),
0,
- NULL);
+ "Allow encrypted requests only (and forbid all unknown keys or plaintext requests)");
return ctx;