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

Add info to usage of --target #1086

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add info to usage of --target #1086

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
4 changes: 2 additions & 2 deletions docs/docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Generates a temporary `Makefile` according to the MTA descriptor and runs the `m
| ----------- | ------- | ---------- | -----------------------------
| `-p (--platform)` | Optional | The name of the target deployment platform. <br>The supported deployment platforms are: <ul><li>`cf` for SAP Cloud Platform, Cloud Foundry environment <li>`neo` for the SAP Cloud Platform, Neo environment <li>`xsa` for the SAP HANA XS advanced model</ul> If this parameter is not provided, the project is built for the SAP Cloud Platform, Cloud Foundry environment | `mbt build -p=cf`
| `-s (--source)` | Optional | The path to the MTA project; the current path is set as the default. | `mbt build -p=cf -s=C:/TestProject`
| `-t (--target)` | Optional | The folder for the generated `MTAR` file. If this parameter is not provided, the `MTAR` file is saved in the `mta_archives` subfolder of the current folder. If the parameter is provided, the `MTAR` file is saved in the root of the folder provided by the argument. | `mbt build -p=cf -t=C:/TestProject`
| `-t (--target)` | Optional | The folder for the generated `MTAR` file. If this parameter is not provided, the `MTAR` file is saved in the `mta_archives` subfolder of the current folder. If the parameter is provided, the `MTAR` file is saved in the root of the folder provided by the argument. Relative paths are treated relatively to the path provided by the `-s (--source)` argument. | `mbt build -p=cf -t=C:/TestProject`
| `--mtar` | Optional | The file name of the generated archive file. If this parameter is omitted, the file name is created according to the following naming convention: <br><br> `<mta_application_ID>_<mta_application_version>.mtar` <br><br> If the parameter is provided, but does not include an extension, the `.mtar` extension is added. | `mbt build -p=cf --mtar=TestProject.mtar`
| `-e (--extensions)` | Optional | The path or paths to multitarget application extension files (.mtaext). Several extension files separated by commas can be passed with a single flag, or each extension file can be specified with its own flag. |`mbt build -e=test1.mtaext,test2.mtaext`<br>or<br>`mbt build -e=test1.mtaext -e=test2.mtaext`
| `--strict` | Optional | The default value is `true`. If set to `true`, the duplicated fields and fields that are not defined in the `mta.yaml` schema are reported as errors. If set to `false`, they are reported as warnings. | `mbt build -p=cf --strict=true`
Expand Down Expand Up @@ -194,4 +194,4 @@ This command generates SBOMs for project modules and merges the SBOMs into one,
| Flag | Mandatory&nbsp;/<br>Optional | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Examples&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
| ----------- | ------- | ---------- | -----------------------------
| `-s (--source)` | Optional | The path to the MTA project; the current path is set as the default. | `mbt sbom-gen -s C:/TestProject -b sbom-file-gen/test.sbom.xml`
| `-b (--sbom-file-path)` | Optional | The path of the SBOM file. The last part of the path is the file name. <br><ul><li>The sbom-file-path can be null. If the sbom-file-path is null, the default value is <MTA_project_path>/<MTA_project_id>.bom.xml.<li>The sbom-file-path can be relative or abs; If the path is relative, it is the relative path to the project root.<li>The sbom-file-path's last part is the file name.<li>Only the XML file format is currently supported; So, if the file suffix is .xml, or if there's no file suffix, an XML format SBOM will be generated.</ul> | `mbt sbom-gen --sbom-file-path sbom-gen/test.sbom.xml`
| `-b (--sbom-file-path)` | Optional | The path of the SBOM file. The last part of the path is the file name. <br><ul><li>The sbom-file-path can be null. If the sbom-file-path is null, the default value is <MTA_project_path>/<MTA_project_id>.bom.xml.<li>The sbom-file-path can be relative or abs; If the path is relative, it is the relative path to the project root.<li>The sbom-file-path's last part is the file name.<li>Only the XML file format is currently supported; So, if the file suffix is .xml, or if there's no file suffix, an XML format SBOM will be generated.</ul> | `mbt sbom-gen --sbom-file-path sbom-gen/test.sbom.xml`