diff --git a/analysis/filter/StructureModifier/README.md b/analysis/filter/StructureModifier/README.md index 165b6bd231..5d3ee7ca62 100644 --- a/analysis/filter/StructureModifier/README.md +++ b/analysis/filter/StructureModifier/README.md @@ -7,6 +7,7 @@ The Structure Modifier is used to modify the structure of .cc.json files. It ena - Remove nodes from a project: The resulting project will not include these nodes and their children. - Declare a node as root: This means that the chosen node will become the root node of the resulting sub-project. - Move nodes within the project: All children of the source node will be transferred to the destination node. +- Rename the mcc metric to complexity or sonar_complexity (they have previously been renamed to mcc). - Print the hierarchy of the project: Prints the hierarchy into the console in a human-readable format. The edges and blacklist entries associated with moved/removed nodes will be altered as well, while all attribute types will be copied. @@ -23,14 +24,15 @@ The edges and blacklist entries associated with moved/removed nodes will be alte | `-o, --outputFile=` | output File (or empty for stdout) | | `-p, --print-levels=` | show first x layers of project hierarchy | | `-r, --remove=` | comma-separated list of nodes to be removed (when using powershell, the list either can't contain spaces or has to be in quotes) | -| `--recursive` | use recursive merging strategy (default) | +| `--rename-mcc[=]` | renames the mcc metric to complexity. Optionally specify 'sonar' for the metric to be renamed to sonar_complexity | | `-s, --set-root=` | path within project to be extracted as the new root | | `-t, --move-to=` | ... move nodes to destination folder (use paired with `--move-from` parameter) | ``` -Usage: ccsh modify [-h] [-f=] [-o=] - [-p=] [-s=] [-t=] - [-r=...]... [FILE] +Usage: ccsh modify [-h] [--rename-mcc[=]] [-f=] + [-o=] [-p=] [-s=] + [-t=] [-r=]... [FILE] + ``` ## Examples diff --git a/gh-pages/_docs/03-14-structuremodifier.md b/gh-pages/_docs/03-14-structuremodifier.md index 2324962f14..e8286cedca 100644 --- a/gh-pages/_docs/03-14-structuremodifier.md +++ b/gh-pages/_docs/03-14-structuremodifier.md @@ -14,6 +14,7 @@ The Structure Modifier is used to modify the structure of .cc.json files. It ena - Remove nodes from a project: The resulting project will not include these nodes and their children. - Declare a node as root: This means that the chosen node will become the root node of the resulting sub-project. - Move nodes within the project: All children of the source node will be transferred to the destination node. +- Rename the mcc metric to complexity or sonar_complexity (they have previously been renamed to mcc). - Print the hierarchy of the project: Prints the hierarchy into the console in a human-readable format. The edges and blacklist entries associated with moved/removed nodes will be altered as well, while all attribute types will be copied. @@ -30,14 +31,15 @@ The edges and blacklist entries associated with moved/removed nodes will be alte | `-o, --outputFile=` | output File (or empty for stdout) | | `-p, --print-levels=` | show first x layers of project hierarchy | | `-r, --remove=` | comma-separated list of nodes to be removed (when using powershell, the list either can't contain spaces or has to be in quotes) | -| `--recursive` | use recursive merging strategy (default) | +| `--rename-mcc[=]` | renames the mcc metric to complexity. Optionally specify 'sonar' for the metric to be renamed to sonar_complexity | | `-s, --set-root=` | path within project to be extracted as the new root | | `-t, --move-to=` | ... move nodes to destination folder (use paired with `--move-from` parameter) | ``` -Usage: ccsh modify [-h] [-f=] [-o=] - [-p=] [-s=] [-t=] - [-r=...]... [FILE] +Usage: ccsh modify [-h] [--rename-mcc[=]] [-f=] + [-o=] [-p=] [-s=] + [-t=] [-r=]... [FILE] + ``` ## Examples