From 959b2e910fbc55519cb1a62110def78fb7a40b8e Mon Sep 17 00:00:00 2001 From: Steve Hancock Date: Mon, 19 Jul 2021 19:18:26 -0700 Subject: [PATCH] reword docs for kgbs --- bin/perltidy | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/bin/perltidy b/bin/perltidy index ddb082f2..606f879b 100755 --- a/bin/perltidy +++ b/bin/perltidy @@ -3711,20 +3711,25 @@ space separated list of keywords. The default set is B, but any list of keywords may be used. Comment lines may also be included in a keyword group, even though they are not keywords. To include ordinary block comments, include the symbol B. To include static block comments (which normally begin with '##'), include the symbol B. B<-kgbs=s> or B<--keyword-group-blanks-size=s>, where B is a string -describing the number of consecutive keyword statements forming a group. If -B is an integer then it is the minimum number required for a group. A -maximum value may also be given with the format B, where B is -the minimum number and B is the maximum number, and the min and max values -are separated by one or more dots. No groups will be found if the maximum is -less than the minimum. The maximum is unlimited if not given. The default is -B. Some examples: +describing the number of consecutive keyword statements forming a group (Note: +statements separated by blank lines in the input file are considered +consecutive for purposes of this count). If B is an integer then it is the +minimum number required for a group. A maximum value may also be given with +the format B, where B is the minimum number and B is the +maximum number, and the min and max values are separated by one or more dots. +No groups will be found if the maximum is less than the minimum. The maximum +is unlimited if not given. The default is B. Some examples: s min max number for group 3 3 unlimited 3 or more 1.1 1 1 1 1..3 1 3 1 to 3 1.0 1 0 (no match) - + +There is no really good default value for this parameter. If it is set too +small, then an excessive number of blank lines may be generated. However, some +users may prefer reducing the value somewhat below the default, perhaps to +B. B<-kgbb=n> or B<--keyword-group-blanks-before=n> specifies whether a blank should appear before the first line of the group, as follows: -- 2.39.5