Skip to content

Commit 691b4ab

Browse files
authored
Fixed generation parameter docs (microsoft#58)
1 parent 16bb543 commit 691b4ab

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/Microsoft.Sbom.Api/Config/Args/GenerationArgs.cs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ namespace Microsoft.Sbom.Api.Config.Args
1111
public class GenerationArgs : CommonArgs
1212
{
1313
/// <summary>
14-
/// Gets or sets the root folder of the drop directory for which the manifest file will be generated.
14+
/// Gets or sets the root folder of the drop directory for which the SBOM file will be generated.
1515
/// </summary>
1616
[ArgShortcut("b")]
1717
[ArgRequired(IfNot = "ConfigFilePath")]
18-
[ArgDescription("The root folder of the drop directory for which the manifest file will be generated.")]
18+
[ArgDescription("The root folder of the drop directory for which the SBOM file will be generated.")]
1919
public string BuildDropPath { get; set; }
2020

2121
/// <summary>
@@ -31,15 +31,17 @@ public class GenerationArgs : CommonArgs
3131
/// by Environment.NewLine. Blank lines are discarded.
3232
/// </summary>
3333
[ArgShortcut("bl")]
34-
[ArgDescription("The file path to a file containing a list of files one file per line for which the manifest file will be generated. Only files listed in the file will be inlcuded in the generated manifest.")]
34+
[ArgDescription("The file path to a file containing a list of files one file per line for which the SBOM" +
35+
" file will be generated. Only files listed in the file will be inlcuded in the generated SBOM.")]
3536
public string BuildListFile { get; set; }
3637

3738
/// <summary>
3839
/// Gets or sets the root folder where the generated manifest files as well as other files will be placed.
3940
/// By default we will generate this folder in the same level as the build drop with the name '_manifest'.
4041
/// </summary>
4142
[ArgShortcut("m")]
42-
[ArgDescription("The path of the directory where the generated manifest files will be placed." +
43+
[ArgDescription("The path of the directory where the generated SBOM files will be placed." +
44+
" A folder named '_manifest' will be created at this location, where all generated SBOMs will be placed." +
4345
" If this parameter is not specified, the files will be placed in {BuildDropPath}/_manifest directory.")]
4446
public string ManifestDirPath { get; set; }
4547

0 commit comments

Comments
 (0)