diff options
| author | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2015-12-29 18:06:25 +0000 |
|---|---|---|
| committer | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2015-12-29 18:06:25 +0000 |
| commit | 49df9c2db6ec9b211cbcc651c98024a702f7d25b (patch) | |
| tree | 97ef9d796079d5fbee6c0426e16a7161215da4c5 /src/worker.c | |
| parent | d80d4e366703ed35b87c30e554781058b296095b (diff) | |
| download | rspamd-49df9c2db6ec9b211cbcc651c98024a702f7d25b.tar.gz rspamd-49df9c2db6ec9b211cbcc651c98024a702f7d25b.zip | |
Add documentation for all workers' options
Diffstat (limited to 'src/worker.c')
| -rw-r--r-- | src/worker.c | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/src/worker.c b/src/worker.c index 982274f49..493707ebc 100644 --- a/src/worker.c +++ b/src/worker.c @@ -330,7 +330,7 @@ init_worker (struct rspamd_config *cfg) ctx, G_STRUCT_OFFSET (struct rspamd_worker_ctx, is_mime), 0, - NULL); + "Set to `false` if this worker is intended to work with non-MIME messages"); rspamd_rcl_register_worker_option (cfg, type, @@ -339,7 +339,7 @@ init_worker (struct rspamd_config *cfg) ctx, G_STRUCT_OFFSET (struct rspamd_worker_ctx, is_http), 0, - NULL); + "Deprecated: always true now"); rspamd_rcl_register_worker_option (cfg, type, @@ -348,7 +348,7 @@ init_worker (struct rspamd_config *cfg) ctx, G_STRUCT_OFFSET (struct rspamd_worker_ctx, is_json), 0, - NULL); + "Deprecated: always true now"); rspamd_rcl_register_worker_option (cfg, type, @@ -357,7 +357,7 @@ init_worker (struct rspamd_config *cfg) ctx, G_STRUCT_OFFSET (struct rspamd_worker_ctx, allow_learn), 0, - NULL); + "Deprecated: disabled and forgotten"); rspamd_rcl_register_worker_option (cfg, type, @@ -367,7 +367,7 @@ init_worker (struct rspamd_config *cfg) G_STRUCT_OFFSET (struct rspamd_worker_ctx, timeout), RSPAMD_CL_FLAG_TIME_INTEGER, - NULL); + "Protocol IO timeout"); rspamd_rcl_register_worker_option (cfg, type, @@ -377,7 +377,9 @@ init_worker (struct rspamd_config *cfg) G_STRUCT_OFFSET (struct rspamd_worker_ctx, task_timeout), RSPAMD_CL_FLAG_TIME_FLOAT, - NULL); + "Maximum task processing time, default: " + G_STRINGIFY(DEFAULT_TASK_TIMEOUT) + " seconds"); rspamd_rcl_register_worker_option (cfg, type, @@ -387,7 +389,7 @@ init_worker (struct rspamd_config *cfg) G_STRUCT_OFFSET (struct rspamd_worker_ctx, max_tasks), RSPAMD_CL_FLAG_INT_32, - NULL); + "Maximum count of parallel tasks processed by a single worker process"); rspamd_rcl_register_worker_option (cfg, type, @@ -397,7 +399,7 @@ init_worker (struct rspamd_config *cfg) G_STRUCT_OFFSET (struct rspamd_worker_ctx, key), 0, - NULL); + "Encryption keypair"); return ctx; } |