language-servers/roc
1
0
Fork 0
mirror of https://github.com/roc-lang/roc.git synced 2025-10-02 08:11:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Revise some CLI flag descriptions

Browse source
This commit is contained in:
Richard Feldman 2022-04-20 10:04:37 -04:00
parent 84727b31e5
commit a47b3be9c0
No known key found for this signature in database
GPG key ID: 7E4127D1E4241798
2 changed files with 11 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

19
cli/src/lib.rs
View file

@ -49,10 +49,12 @@ pub const ROC_DIR: &str = "ROC_DIR";
pub const DIRECTORY_OR_FILES: &str = "DIRECTORY_OR_FILES"; pub const DIRECTORY_OR_FILES: &str = "DIRECTORY_OR_FILES";
pub const ARGS_FOR_APP: &str = "ARGS_FOR_APP"; pub const ARGS_FOR_APP: &str = "ARGS_FOR_APP";
const VERSION: &str = include_str!("../../version.txt");
pub fn build_app<'a>() -> App<'a> { pub fn build_app<'a>() -> App<'a> {
let app = App::new("roc") let app = App::new("roc")
.version(concatcp!(include_str!("../../version.txt"), "\n")) .version(concatcp!(VERSION, "\n"))
.about("Runs the given .roc file. Use one of the SUBCOMMANDS below to do something else!") .about("Runs the given .roc file, if there are no compilation errors.\nUse one of the SUBCOMMANDS below to do something else!")
.subcommand(App::new(CMD_BUILD) .subcommand(App::new(CMD_BUILD)
.about("Build a binary from the given .roc file, but don't run it") .about("Build a binary from the given .roc file, but don't run it")
.arg( .arg(
@ -141,7 +143,7 @@ pub fn build_app<'a>() -> App<'a> {
.about("Launch the interactive Read Eval Print Loop (REPL)") .about("Launch the interactive Read Eval Print Loop (REPL)")
) )
.subcommand(App::new(CMD_FORMAT) .subcommand(App::new(CMD_FORMAT)
.about("Format Roc code") .about("Format a .roc file using standard Roc formatting")
.arg( .arg(
Arg::new(DIRECTORY_OR_FILES) Arg::new(DIRECTORY_OR_FILES)
.index(1) .index(1)
@ -155,10 +157,9 @@ pub fn build_app<'a>() -> App<'a> {
) )
) )
.subcommand(App::new(CMD_VERSION) .subcommand(App::new(CMD_VERSION)
.about("Print version information") .about(concatcp!("Print the Roc compiler’s version, which is currently ", VERSION)))
)
.subcommand(App::new(CMD_CHECK) .subcommand(App::new(CMD_CHECK)
.about("When developing, it's recommended to run `check` before `build`. It may provide a useful error message in cases where `build` panics") .about("Check the code for problems, but doesn’t build or run it")
.arg( .arg(
Arg::new(FLAG_TIME) Arg::new(FLAG_TIME)
.long(FLAG_TIME) .long(FLAG_TIME)
@ -193,19 +194,19 @@ pub fn build_app<'a>() -> App<'a> {
.arg( .arg(
Arg::new(FLAG_OPT_SIZE) Arg::new(FLAG_OPT_SIZE)
.long(FLAG_OPT_SIZE) .long(FLAG_OPT_SIZE)
.about("Optimize your compiled Roc program to have a small binary size. (Optimization takes time to complete.)") .about("Optimize the compiled program to have a small binary size. (Optimization takes time to complete.)")
.required(false), .required(false),
) )
.arg( .arg(
Arg::new(FLAG_DEV) Arg::new(FLAG_DEV)
.long(FLAG_DEV) .long(FLAG_DEV)
.about("Make compilation as fast as possible. (Runtime performance may suffer)") .about("Make compilation finish as soon as possible, at the expense of runtime performance.")
.required(false), .required(false),
) )
.arg( .arg(
Arg::new(FLAG_DEBUG) Arg::new(FLAG_DEBUG)
.long(FLAG_DEBUG) .long(FLAG_DEBUG)
.about("Store LLVM debug information in the generated program") .about("Store LLVM debug information in the generated program.")
.requires(ROC_FILE) .requires(ROC_FILE)
.required(false), .required(false),
) )

2
version.txt
View file

@ -1 +1 @@
<to be filled by CI on nightly release> (built from source)