From 277c55fe5b17b319232a4dc8f061daa2f7ed5e28 Mon Sep 17 00:00:00 2001
From: lutherwenxu <lutherchanpublic+git@gmail.com>
Date: Sun, 16 Feb 2020 19:50:25 +0800
Subject: [PATCH] cmd/v: rewrite default help message

---
 cmd/v/{help.v => internal/help/doc_help.v} | 46 ++++++++++++++++++----
 cmd/v/v.v                                  |  5 ++-
 2 files changed, 41 insertions(+), 10 deletions(-)
 rename cmd/v/{help.v => internal/help/doc_help.v} (72%)

diff --git a/cmd/v/help.v b/cmd/v/internal/help/doc_help.v
similarity index 72%
rename from cmd/v/help.v
rename to cmd/v/internal/help/doc_help.v
index ed7607616e..274acffc13 100644
--- a/cmd/v/help.v
+++ b/cmd/v/internal/help/doc_help.v
@@ -1,14 +1,44 @@
-module main
+module help
 
-const (
-	help_text = 'Usage: v [options/commands] [file.v | directory]
+pub const (
+	help_text = 'V is a tool for managing V source code.
 
-   To run V in REPL mode, run V without any arguments.
-   To compile a directory/file, pass it as the only argument.
+Usage:
+   v [options] [command] [arguments]
 
-   To run a directory/file, use `v run [file.v | directory]`. V will compile and run it for you.
-   
-   This help message is only intended to be a quick start guide. For a comprehensive help message, use `v help --verbose`.'
+Examples:
+   v hello.v         compile the file `hello.v` and output it as `hello` or `hello.exe`
+   v run hello.v     same as above but also run the produced executable immediately after compilation
+
+The commands are:
+   build             build V code in the provided path (default)
+   create            setup the file structure for a V project
+   doc               generates the documentation for a V module (coming soon in 0.3)
+   fmt               format the V code provided
+   repl              run the REPL
+   run               compile and run a V program
+   symlink           create a symbolic link for V
+   translate         translate C code to V (coming soon in 0.3)
+   up                run the V self-updater
+   version           prints the version text and exits
+
+   install           installs a module from VPM
+   remove            removes a module that was installed from VPM
+   search            searches for a module from VPM
+   update            updates an installed module from VPM
+
+   bin2v             embed a binary file as a constant and output it in a V file
+   build-examples    test if all examples can be built
+   build-tools       test if all tools can be built
+   build-vbinaries   test if V can be built with different configuration
+   test              run all test files in the provided directory
+   test-fmt          test if all files in the current directory is formatted properly
+   test-compiler     run the V self-test suite to make sure V is working properly
+
+For a comprehensive list of options, please refer to `v help --verbose`.'
+//Use "v help <command>" for more information about a command.'
+//TODO When docs have been written for all the subcommands, delete the verbose help text and
+//     tell the user to use "v help <command>" instead.
 	verbose_help_text = 'Usage: v [options/commands] [file.v | directory]
 
    When V is run without any arguments, it is run in REPL mode.
diff --git a/cmd/v/v.v b/cmd/v/v.v
index a3d5caa606..4ea4788f41 100644
--- a/cmd/v/v.v
+++ b/cmd/v/v.v
@@ -5,6 +5,7 @@ module main
 
 import (
 	compiler
+	internal.help
 	os
 )
 
@@ -30,10 +31,10 @@ fn main() {
 	}
 	if '-h' in option || '--help' in option || command == 'help' {
 		if is_verbose {
-			println(verbose_help_text)
+			println(help.verbose_help_text)
 		}
 		else {
-			println(help_text)
+			println(help.help_text)
 		}
 		return
 	}