Skip to content

Commit 4c40df1

Browse files
committed
[#68] Integrate Model Orphans Reporting
Improving documentation in README.md
1 parent ec36929 commit 4c40df1

File tree

4 files changed

+26
-1
lines changed

4 files changed

+26
-1
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -354,3 +354,6 @@ src/Models/GPUCache/data_2
354354
src/Models/GPUCache/data_3
355355
src/Models/GPUCache/index
356356
*.ldb
357+
/.obsidian/appearance.json
358+
/.obsidian/core-plugins.json
359+
/.obsidian/workspace.json

.obsidian/app.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,27 @@ https://nexus.lieberlieber.com/#browse/browse:lemontree-pipeline-tools
77
Used to check Models for LemonTree Readiness.
88
https://nexus.lieberlieber.com/repository/lemontree-pipeline-tools/LemonTree.Pipeline.Tools.ModelCheck.exe
99

10+
### Commandline Reference
11+
12+
```
13+
--Out File to output .md e.g.: 'out.md'
14+
15+
--NoCompact If set the Checks that compact the Model are not run!
16+
17+
--FailOnErrors If set the Exitcode will be 2 if there is at least on Check of Status Error!
18+
19+
--FailOnWarnings If set the Exitcode will be 1 if there is at least on Check of Status Warning!
20+
21+
--TableSize If set the size of the tables in the database will be reported!
22+
23+
--Orphans If set Model Orphans will be reported!
24+
25+
--Model Required. The 'Model' used for the operation.
26+
27+
--help Display this help screen.
28+
29+
--version Display version information.
30+
```
1031

1132
### Powershell Example:
1233
```

src/LemonTree.Pipeline.Tools.ModelCheck/CommandLineOptions/ModelCheckOptions.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ internal class ModelCheckOptions:BaseOptions
2020
[Option("TableSize", Required = false, HelpText = "If set the size of the tables in the database will be reported!")]
2121
public bool TableSize { get; set; }
2222

23-
[Option("Orphans", Required = false, HelpText = "If Model Orphans will be reported!")]
23+
[Option("Orphans", Required = false, HelpText = "If set Model Orphans will be reported!")]
2424
public bool Orphans { get; set; }
2525
}
2626
}

0 commit comments

Comments
 (0)