fix(help): Clarified each non-deprecated use of the term "pattern".
@@ -92,6 +92,7 @@ public enum DetectProperty {
@HelpGroup(primary = GROUP_PROXY, additional = { SEARCH_GROUP_BLACKDUCK, DEFAULT_HELP })
@HelpDescription("A comma separated list of host patterns that should not use the proxy.")
+ @HelpDetailed("These patterns must adhere to Java regular expressions: https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html")
BLACKDUCK_PROXY_IGNORED_HOSTS("blackduck.proxy.ignored.hosts", "Bypass Proxy Hosts", "4.2.0", PropertyType.STRING, PropertyAuthority.None),
@HelpGroup(primary = GROUP_PROXY, additional = { SEARCH_GROUP_BLACKDUCK, DEFAULT_HELP })
@@ -179,7 +180,7 @@ public enum DetectProperty {
@HelpGroup(primary = GROUP_SIGNATURE_SCANNER, additional = { GROUP_SOURCE_SCAN })
@HelpDescription("A comma-separated list of directory name patterns for which Detect searches and adds to the signature scanner --exclude flag values.")
- @HelpDetailed("Detect will recursively search within the scan targets for files/directories that match these file name patterns and will create the corresponding exclusion patterns for the signature scanner.\r\nThese patterns will be added to the patterns provided by detect.blackduck.signature.scanner.exclusion.patterns.")
+ @HelpDetailed("Detect will recursively search within the scan targets for files/directories that match these file name patterns and will create the corresponding exclusion patterns for the signature scanner.\r\nThese patterns will be added to the patterns provided by detect.blackduck.signature.scanner.exclusion.patterns.\r\nThese patterns are file system glob patterns ('?' is a wildcard for a single character, '*' is a wildcard for zero or more characters).")
DETECT_BLACKDUCK_SIGNATURE_SCANNER_EXCLUSION_NAME_PATTERNS("detect.blackduck.signature.scanner.exclusion.name.patterns", "Directory Name Exclusion Patterns", "4.2.0", PropertyType.STRING_ARRAY, PropertyAuthority.None, "node_modules"),
@HelpGroup(primary = GROUP_SIGNATURE_SCANNER, additional = { GROUP_SOURCE_SCAN })
@@ -188,6 +189,7 @@ public enum DetectProperty {
@HelpGroup(primary = GROUP_SIGNATURE_SCANNER, additional = { GROUP_SOURCE_SCAN })
@HelpDescription("A comma-separated list of values to be used with the Signature Scanner --exclude flag.")
+ @HelpDetailed("Each patterns is passed to the Black Duck scan CLI as a value for an --exclude option. An exclusion pattern must start and end with a forward slash (/) and may not contain double asterisks (**).")
DETECT_BLACKDUCK_SIGNATURE_SCANNER_EXCLUSION_PATTERNS("detect.blackduck.signature.scanner.exclusion.patterns", "Exclusion Patterns", "4.2.0", PropertyType.STRING_ARRAY, PropertyAuthority.None),
@HelpGroup(primary = GROUP_SIGNATURE_SCANNER, additional = { SEARCH_GROUP_GLOBAL })
@@ -288,7 +290,7 @@ public enum DetectProperty {
@HelpGroup(primary = GROUP_PATHS, additional = { GROUP_DETECTOR, SEARCH_GROUP_GLOBAL, GROUP_SOURCE_SCAN })
@HelpDescription("A comma-separated list of directory name patterns to exclude from detector search.")
- @HelpDetailed("While searching the source directory to determine which detectors to run, subdirectories whose name match a pattern in this list will not be searched.")
+ @HelpDetailed("While searching the source directory to determine which detectors to run, subdirectories whose name match a pattern in this list will not be searched.\n\rThese patterns are file system glob patterns ('?' is a wildcard for a single character, '*' is a wildcard for zero or more characters).")
DETECT_DETECTOR_SEARCH_EXCLUSION_PATTERNS("detect.detector.search.exclusion.patterns", " Detector Directory Patterns Exclusions", "3.2.0", PropertyType.STRING_ARRAY, PropertyAuthority.None),
@HelpGroup(primary = GROUP_PATHS, additional = { GROUP_DETECTOR, SEARCH_GROUP_GLOBAL, GROUP_SOURCE_SCAN })
