From 0040b1f460c9224c43e2510de3ff9b65939e2477 Mon Sep 17 00:00:00 2001 From: Tom Jack Date: Thu, 21 Nov 2019 11:44:27 -0600 Subject: [PATCH] Mention subcommand --help only once --- src/bin/cli.ml | 11 ++++++---- src/bin/expect_tests/help_tests.ml | 35 +++++++++++++----------------- 2 files changed, 22 insertions(+), 24 deletions(-) diff --git a/src/bin/cli.ml b/src/bin/cli.ml index bd3da2499..88ffa5307 100644 --- a/src/bin/cli.ml +++ b/src/bin/cli.ml @@ -3,7 +3,10 @@ open Trace open Cli_helpers let main = - (Term.(ret (const (`Help (`Auto, None)))) , Term.info "ligo") + let man = + [ `S "MORE HELP"; + `P "Use `$(mname) $(i,COMMAND) --help' for help on a single command." ] in + (Term.(ret (const (`Help (`Auto, None)))), Term.info "ligo" ~man) let source_file n = let open Arg in @@ -94,7 +97,7 @@ let compile_file = let term = Term.(const f $ source_file 0 $ entry_point 1 $ syntax $ display_format $ michelson_code_format) in let cmdname = "compile-contract" in - let doc = "Subcommand: compile a contract. See `ligo " ^ cmdname ^ " --help' for a list of options specific to this subcommand." in + let doc = "Subcommand: compile a contract." in (term , Term.info ~doc cmdname) let compile_parameter = @@ -108,7 +111,7 @@ let compile_parameter = let term = Term.(const f $ source_file 0 $ entry_point 1 $ expression "PARAMETER" 2 $ syntax $ display_format $ michelson_code_format) in let cmdname = "compile-parameter" in - let doc = "Subcommand: compile parameters to a michelson expression. The resulting michelson expression can be passed as an argument in a transaction which calls a contract. See `ligo " ^ cmdname ^ " --help' for a list of options specific to this subcommand." in + let doc = "Subcommand: compile parameters to a michelson expression. The resulting michelson expression can be passed as an argument in a transaction which calls a contract." in (term , Term.info ~doc cmdname) let compile_storage = @@ -122,7 +125,7 @@ let compile_storage = let term = Term.(const f $ source_file 0 $ entry_point 1 $ expression "STORAGE" 2 $ syntax $ display_format $ michelson_code_format) in let cmdname = "compile-storage" in - let doc = "Subcommand: compile an initial storage in ligo syntax to a michelson expression. The resulting michelson expression can be passed as an argument in a transaction which originates a contract. See `ligo " ^ cmdname ^ " --help' for a list of options specific to this subcommand." in + let doc = "Subcommand: compile an initial storage in ligo syntax to a michelson expression. The resulting michelson expression can be passed as an argument in a transaction which originates a contract." in (term , Term.info ~doc cmdname) let dry_run = diff --git a/src/bin/expect_tests/help_tests.ml b/src/bin/expect_tests/help_tests.ml index 35a4c1ec9..4aecf0190 100644 --- a/src/bin/expect_tests/help_tests.ml +++ b/src/bin/expect_tests/help_tests.ml @@ -10,10 +10,12 @@ let%expect_test _ = SYNOPSIS ligo COMMAND ... + MORE HELP + Use `ligo COMMAND --help' for help on a single command. + COMMANDS compile-contract - Subcommand: compile a contract. See `ligo compile-contract --help' - for a list of options specific to this subcommand. + Subcommand: compile a contract. compile-expression Subcommand: compile to a michelson value. @@ -21,15 +23,13 @@ let%expect_test _ = compile-parameter Subcommand: compile parameters to a michelson expression. The resulting michelson expression can be passed as an argument in a - transaction which calls a contract. See `ligo compile-parameter - --help' for a list of options specific to this subcommand. + transaction which calls a contract. compile-storage Subcommand: compile an initial storage in ligo syntax to a michelson expression. The resulting michelson expression can be passed as an argument in a transaction which originates a - contract. See `ligo compile-storage --help' for a list of options - specific to this subcommand. + contract. dry-run Subcommand: run a smart-contract with the given storage and input. @@ -54,10 +54,12 @@ let%expect_test _ = SYNOPSIS ligo COMMAND ... + MORE HELP + Use `ligo COMMAND --help' for help on a single command. + COMMANDS compile-contract - Subcommand: compile a contract. See `ligo compile-contract --help' - for a list of options specific to this subcommand. + Subcommand: compile a contract. compile-expression Subcommand: compile to a michelson value. @@ -65,15 +67,13 @@ let%expect_test _ = compile-parameter Subcommand: compile parameters to a michelson expression. The resulting michelson expression can be passed as an argument in a - transaction which calls a contract. See `ligo compile-parameter - --help' for a list of options specific to this subcommand. + transaction which calls a contract. compile-storage Subcommand: compile an initial storage in ligo syntax to a michelson expression. The resulting michelson expression can be passed as an argument in a transaction which originates a - contract. See `ligo compile-storage --help' for a list of options - specific to this subcommand. + contract. dry-run Subcommand: run a smart-contract with the given storage and input. @@ -93,9 +93,7 @@ let%expect_test _ = run_ligo_good [ "compile-contract" ; "--help" ] ; [%expect {| NAME - ligo-compile-contract - Subcommand: compile a contract. See `ligo - compile-contract --help' for a list of options specific to this - subcommand. + ligo-compile-contract - Subcommand: compile a contract. SYNOPSIS ligo compile-contract [OPTION]... SOURCE_FILE ENTRY_POINT @@ -137,9 +135,7 @@ let%expect_test _ = NAME ligo-compile-parameter - Subcommand: compile parameters to a michelson expression. The resulting michelson expression can be passed as an - argument in a transaction which calls a contract. See `ligo - compile-parameter --help' for a list of options specific to this - subcommand. + argument in a transaction which calls a contract. SYNOPSIS ligo compile-parameter [OPTION]... SOURCE_FILE ENTRY_POINT @@ -186,8 +182,7 @@ let%expect_test _ = ligo-compile-storage - Subcommand: compile an initial storage in ligo syntax to a michelson expression. The resulting michelson expression can be passed as an argument in a transaction which originates a - contract. See `ligo compile-storage --help' for a list of options - specific to this subcommand. + contract. SYNOPSIS ligo compile-storage [OPTION]... SOURCE_FILE ENTRY_POINT