style(help): added doc for SUBPROJECT aggregation mode
@@ -341,7 +341,13 @@ public class DetectProperties {
new DetectProperty<>(new EnumProperty<>("detect.bom.aggregate.remediation.mode", AggregateMode.TRANSITIVE, AggregateMode.class))
.setInfo("BDIO Aggregate Remediation Mode", DetectPropertyFromVersion.VERSION_6_1_0)
.setHelp(
- "If an aggregate BDIO file is being generated and this property is set to DIRECT, the aggregate BDIO file will exclude code location nodes from the top layer of the dependency tree to preserve the correct identification of direct dependencies in the resulting Black Duck BOM. When this property is set to TRANSITIVE (the default), component source information is preserved by including code location nodes at the top of the dependency tree, but all components will appear as TRANSITIVE in the BOM.")
+ "If an aggregate BDIO file is being generated and this property is set to DIRECT, the aggregate BDIO file will exclude code location nodes " +
+ "from the top layer of the dependency tree to preserve the correct identification of direct dependencies in the resulting Black Duck BOM. " +
+ "When this property is set to TRANSITIVE (the default), component source information is preserved by including code location nodes at the " +
+ "top of the dependency tree, but all components will appear as TRANSITIVE in the BOM. " +
+ "SUBPROJECT mode provides both component source information and correct identification of direct and transitive dependencies by " +
+ "encoding code location nodes as subprojects in the graph. SUBPROJECT mode must only be used with Black Duck 2021.8.0 or later, " +
+ "and has no effect (is equivalent to TRANSITIVE mode) when detect.bdio2.enabled is set to false.")
.setGroups(DetectGroup.PROJECT, DetectGroup.PROJECT_SETTING)
.setCategory(DetectCategory.Advanced);
