From 23d3e85dc3dc85db40ac310938084e19944f4db9 Mon Sep 17 00:00:00 2001 From: Alexander Moisseev Date: Thu, 18 Oct 2018 12:34:08 +0300 Subject: [PATCH] [Minor] Reformat Pod documents --- .tidyallrc | 6 +++--- utils/cgp_rspamd.pl | 11 ++++------- utils/classifier_test.pl | 5 ++--- utils/rspamd_stats.pl | 31 +++++++++++++++---------------- 4 files changed, 24 insertions(+), 29 deletions(-) diff --git a/.tidyallrc b/.tidyallrc index 4e8f5f7bfd..b909559388 100644 --- a/.tidyallrc +++ b/.tidyallrc @@ -17,9 +17,9 @@ select = **/*.{pl,pl.in,pm,pod} ;[PodSpell] ;select = **/*.{pl,pl.in,pm,pod} -;[PodTidy] -;select = **/*.{pl,pl.in,pm,pod} -;argv = --columns=120 +[PodTidy] +select = **/*.{pl,pl.in,pm,pod} +columns = 120 [Test::Vars] select = **/*.{pl,pl.in,pm,t} diff --git a/utils/cgp_rspamd.pl b/utils/cgp_rspamd.pl index 1d4d4406fc..0070cf4a5c 100644 --- a/utils/cgp_rspamd.pl +++ b/utils/cgp_rspamd.pl @@ -324,8 +324,7 @@ Specifies Rspamd host to use for scanning =item B<--header> -Specifies the header that should be added when Rspamd action is B -or B. +Specifies the header that should be added when Rspamd action is B or B. =item B<--reject-message> @@ -351,10 +350,8 @@ Prints the manual page and exits. =head1 DESCRIPTION -B is intended to scan messages processed with B MTA -on some Rspamd scanner. It reads standard input and parses CGP helpers -protocol. On scan requests, this filter can query Rspamd to process a message. -B can tell CGP to add header or reject SPAM messages depending on -Rspamd scan result. +B is intended to scan messages processed with B MTA on some Rspamd scanner. It reads +standard input and parses CGP helpers protocol. On scan requests, this filter can query Rspamd to process a message. +B can tell CGP to add header or reject SPAM messages depending on Rspamd scan result. =cut diff --git a/utils/classifier_test.pl b/utils/classifier_test.pl index 08febe2573..994ad8ce82 100644 --- a/utils/classifier_test.pl +++ b/utils/classifier_test.pl @@ -533,8 +533,7 @@ Prints the manual page and exits. =head1 DESCRIPTION -B is intended to test Rspamd classifier for false positives, -false negatives and other parameters. It uses half of the corpus for training -and half for cross-validation. +B is intended to test Rspamd classifier for false positives, false negatives and other parameters. +It uses half of the corpus for training and half for cross-validation. =cut diff --git a/utils/rspamd_stats.pl b/utils/rspamd_stats.pl index f97e351885..e8cee58e70 100755 --- a/utils/rspamd_stats.pl +++ b/utils/rspamd_stats.pl @@ -873,13 +873,11 @@ rspamd_stats [options] [--symbol=SYM1 [--symbol=SYM2...]] [--log file] =item B<--log> -Specifies log file or directory to read data from. -If a directory is specified B analyses files in the directory -including known compressed file types. Number of log files can be limited using -B<--num-logs> and B<--exclude-logs> options. This assumes that files in the log -directory have B- or B-like name format with numeric -indexes. Files without indexes (generally it is merely one file) are considered -the most recent and files with lower indexes are considered newer. +Specifies log file or directory to read data from. If a directory is specified B analyses files in the +directory including known compressed file types. Number of log files can be limited using B<--num-logs> and +B<--exclude-logs> options. This assumes that files in the log directory have B- or B-like +name format with numeric indexes. Files without indexes (generally it is merely one file) are considered the most +recent and files with lower indexes are considered newer. =item B<--reject-score> @@ -907,7 +905,8 @@ Number of latest logs to exclude (0 by default). =item B<--correlations> -Additionally print correlation rate for each symbol displayed. This routine calculates merely paired correlations between symbols. +Additionally print correlation rate for each symbol displayed. This routine calculates merely paired correlations +between symbols. =item B<--search-pattern> @@ -915,20 +914,19 @@ Do not process input unless finding the specified regular expression. Useful to =item B<--exclude> -Exclude log lines if certain symbols are fired (e.g. GTUBE). You may specify this option multiple time to skip multiple symbols. +Exclude log lines if certain symbols are fired (e.g. GTUBE). You may specify this option multiple time to skip multiple +symbols. =item B<--start> -Select log entries after this time. Format: C (can be -truncated to any desired accuracy). If used with B<--end> select entries between -B<--start> and B<--end>. The omitted date defaults to the current date if you +Select log entries after this time. Format: C (can be truncated to any desired accuracy). If used +with B<--end> select entries between B<--start> and B<--end>. The omitted date defaults to the current date if you supply the time. =item B<--end> -Select log entries before this time. Format: C (can be -truncated to any desired accuracy). If used with B<--start> select entries between -B<--start> and B<--end>. The omitted date defaults to the current date if you +Select log entries before this time. Format: C (can be truncated to any desired accuracy). If used +with B<--start> select entries between B<--start> and B<--end>. The omitted date defaults to the current date if you supply the time. =item B<--help> @@ -984,7 +982,8 @@ B: overall number of B messages =item 4. -B: percentage of number of hits with specified symbol in B messages divided by total number of B messages. +B: percentage of number of hits with specified symbol in B messages divided by total +number of B messages. =back -- 2.47.3