Skip to content

Commit

Permalink
Update docs #3685
Browse files Browse the repository at this point in the history
  • Loading branch information
Nereboss committed Sep 11, 2024
1 parent 3e4309a commit 5b1f600
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
10 changes: 6 additions & 4 deletions analysis/filter/StructureModifier/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -23,14 +24,15 @@ The edges and blacklist entries associated with moved/removed nodes will be alte
| `-o, --outputFile=<outputFile>` | output File (or empty for stdout) |
| `-p, --print-levels=<printLevels>` | show first x layers of project hierarchy |
| `-r, --remove=<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[=<renameMcc>]` | renames the mcc metric to complexity. Optionally specify 'sonar' for the metric to be renamed to sonar_complexity |
| `-s, --set-root=<setRoot>` | path within project to be extracted as the new root |
| `-t, --move-to=<moveTo>` | ... move nodes to destination folder (use paired with `--move-from` parameter) |

```
Usage: ccsh modify [-h] [-f=<moveFrom>] [-o=<outputFile>]
[-p=<printLevels>] [-s=<setRoot>] [-t=<moveTo>]
[-r=<remove>...]... [FILE]
Usage: ccsh modify [-h] [--rename-mcc[=<renameMcc>]] [-f=<moveFrom>]
[-o=<outputFile>] [-p=<printLevels>] [-s=<setRoot>]
[-t=<moveTo>] [-r=<remove>]... [FILE]
```

## Examples
Expand Down
10 changes: 6 additions & 4 deletions gh-pages/_docs/03-14-structuremodifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -30,14 +31,15 @@ The edges and blacklist entries associated with moved/removed nodes will be alte
| `-o, --outputFile=<outputFile>` | output File (or empty for stdout) |
| `-p, --print-levels=<printLevels>` | show first x layers of project hierarchy |
| `-r, --remove=<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[=<renameMcc>]` | renames the mcc metric to complexity. Optionally specify 'sonar' for the metric to be renamed to sonar_complexity |
| `-s, --set-root=<setRoot>` | path within project to be extracted as the new root |
| `-t, --move-to=<moveTo>` | ... move nodes to destination folder (use paired with `--move-from` parameter) |

```
Usage: ccsh modify [-h] [-f=<moveFrom>] [-o=<outputFile>]
[-p=<printLevels>] [-s=<setRoot>] [-t=<moveTo>]
[-r=<remove>...]... [FILE]
Usage: ccsh modify [-h] [--rename-mcc[=<renameMcc>]] [-f=<moveFrom>]
[-o=<outputFile>] [-p=<printLevels>] [-s=<setRoot>]
[-t=<moveTo>] [-r=<remove>]... [FILE]
```

## Examples
Expand Down

0 comments on commit 5b1f600

Please sign in to comment.