Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixed some docs #58

Merged
merged 1 commit into from
Jul 14, 2022
Merged

Fixed some docs #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions src/Microsoft.Sbom.Api/Config/Args/GenerationArgs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ namespace Microsoft.Sbom.Api.Config.Args
public class GenerationArgs : CommonArgs
{
/// <summary>
/// Gets or sets the root folder of the drop directory for which the manifest file will be generated.
/// Gets or sets the root folder of the drop directory for which the SBOM file will be generated.
/// </summary>
[ArgShortcut("b")]
[ArgRequired(IfNot = "ConfigFilePath")]
[ArgDescription("The root folder of the drop directory for which the manifest file will be generated.")]
[ArgDescription("The root folder of the drop directory for which the SBOM file will be generated.")]
public string BuildDropPath { get; set; }

/// <summary>
Expand All @@ -31,15 +31,17 @@ public class GenerationArgs : CommonArgs
/// by Environment.NewLine. Blank lines are discarded.
/// </summary>
[ArgShortcut("bl")]
[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.")]
[ArgDescription("The file path to a file containing a list of files one file per line for which the SBOM" +
" file will be generated. Only files listed in the file will be inlcuded in the generated SBOM.")]
public string BuildListFile { get; set; }

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

Expand Down