Update README.md

Open-CMSIS-Pack · Jun 20, 2023 · c62086a · c62086a
1 parent 731d019
commit c62086a
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -17,37 +17,35 @@ By default, `cbuild` expects a fully configured solution (*.csolution.yml) or co
 ## Usage
 
 ```bash
-cbuild: Build Invocation 1.3.0 (C) 2023 Arm Ltd. and Contributors
+cbuild: Build Invocation 2.0.0-dev2 (C) 2023 Arm Ltd. and Contributors
 
 Usage:
-  cbuild [command] <project.cprj|csolution.yml> [flags]
+  cbuild [command] <csolution.yml> [flags]
 
 Available Commands:
+  buildcprj   Generate output
   help        Help about any command
   list        List information
 
 Flags:
-  -c, --clean                  Remove intermediate and output directories
-      --configuration string   Input configuration name e.g. [.buildType][+targetType]
-      --context string         Input context name e.g. project.buildType+targetType
-  -d, --debug                  Enable debug messages
-  -g, --generator string       Select build system generator (default "Ninja")
-  -h, --help                   Print usage
-  -i, --intdir string          Set directory for intermediate files
-  -j, --jobs int               Number of job slots for parallel execution
-      --load string            Set policy for packs loading [latest|all|required]
-  -l, --log string             Save output messages in a log file
-  -o, --outdir string          Set directory for output binary files
-  -O, --output string          Set directory for all output files
-  -p, --packs                  Download missing software packs with cpackget
-  -q, --quiet                  Suppress output messages except build invocations
-  -r, --rebuild                Remove intermediate and output directories and rebuild
-  -s, --schema                 Validate project input file(s) against schema
-  -t, --target string          Optional CMake target name
-  -u, --update string          Generate *.cprj file for reproducing current build
-      --update-rte             Update the RTE directory and files
-  -v, --verbose                Enable verbose messages from toolchain builds
-  -V, --version                Print version
+  -C, --clean              Remove intermediate and output directories
+  -c, --context strings    Input context name e.g. [<cproject>][.<build-type>][+<target-type>]
+  -d, --debug              Enable debug messages
+  -g, --generator string   Select build system generator (default "Ninja")
+  -h, --help               Print usage
+  -j, --jobs int           Number of job slots for parallel execution
+  -l, --load string        Set policy for packs loading [latest|all|required]
+      --log string         Save output messages in a log file
+  -O, --output string      Set directory for all output files
+  -p, --packs              Download missing software packs with cpackget
+  -q, --quiet              Suppress output messages except build invocations
+  -r, --rebuild            Remove intermediate and output directories and rebuild
+  -s, --schema             Validate project input file(s) against schema
+  -t, --target string      Optional CMake target name
+      --toolchain string   Input toolchain to be used
+      --update-rte         Update the RTE directory and files
+  -v, --verbose            Enable verbose messages from toolchain builds
+  -V, --version            Print version
 
 Use "cbuild [command] --help" for more information about a command.
 ```
diff --git a/cmd/cbuild/commands/root.go b/cmd/cbuild/commands/root.go
@@ -185,7 +185,7 @@ func NewRootCmd() *cobra.Command {
 	rootCmd.Flags().BoolP("rebuild", "r", false, "Remove intermediate and output directories and rebuild")
 	rootCmd.Flags().BoolP("update-rte", "", false, "Update the RTE directory and files")
 	rootCmd.Flags().StringP("generator", "g", "Ninja", "Select build system generator")
-	rootCmd.Flags().StringSliceP("context", "c", []string{}, "Input context name e.g. project.buildType+targetType")
+	rootCmd.Flags().StringSliceP("context", "c", []string{}, "Input context name e.g. [<cproject>][.<build-type>][+<target-type>]")
 	rootCmd.Flags().StringP("load", "l", "", "Set policy for packs loading [latest|all|required]")
 	rootCmd.Flags().IntP("jobs", "j", 0, "Number of job slots for parallel execution")
 	rootCmd.Flags().StringP("target", "t", "", "Optional CMake target name")