help: keep consistent style of help messages

Use imperative mood everywhere.
End sentences with dots.
Capitalize sentences.
pull/4018/head^2
Alexey 2020-03-14 16:20:44 +03:00 committed by GitHub
parent 8bfa7f0d82
commit 395bb61cf3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 72 additions and 72 deletions

View File

@ -8,54 +8,54 @@ For help regarding building an executable, see `v help build`.
These build flags are enabled on `build` and `run` as long as the backend is set to `c`: These build flags are enabled on `build` and `run` as long as the backend is set to `c`:
-arch <architecture> -arch <architecture>
Changes the architecture that V will tell the C compiler to build. Change the architecture that V will tell the C compiler to build.
List of supported architectures: `x86` and `x64` (default). List of supported architectures: `x86` and `x64` (default).
-cc <compiler>, -compiler <compiler> -cc <compiler>, -compiler <compiler>
Changes the C compiler V invokes to the specified compiler. Change the C compiler V invokes to the specified compiler.
The C compiler is required to support C99. The C compiler is required to support C99.
Officially supported/tested C compilers include: `clang`, `gcc`, `tcc`, `mingw-w64` and `msvc`. Officially supported/tested C compilers include: `clang`, `gcc`, `tcc`, `mingw-w64` and `msvc`.
-cf <flag>, -cflags <flag> -cf <flag>, -cflags <flag>
Passes the provided flag as is to the C compiler. Pass the provided flag as is to the C compiler.
Can be specified multiple times to provide multiple flags. Can be specified multiple times to provide multiple flags.
Use quotes to wrap the flag argument if it contains spaces. Use quotes to wrap the flag argument if it contains spaces.
-cg, -cdebug -cg, -cdebug
Enables debug mode while preserving C line numbers in the compiled executable. Enable debug mode while preserving C line numbers in the compiled executable.
This allows issues regarding C compilation to be located more easily. This allows issues regarding C compilation to be located more easily.
-compress -compress
Strips the compiled executable to compress it. Strip the compiled executable to compress it.
-csource <prettify|keep|drop> -csource <prettify|keep|drop>
Specifies how V deals with the intermediate C source code. Specify how V deals with the intermediate C source code.
* `prettify` - The C source code will be kept. * `prettify` - The C source code will be kept.
`clang-format` is used to prettify the C source code before compiling it. `clang-format` is used to prettify the C source code before compiling it.
* `keep` - The C source code will be kept as generated by V. * `keep` - The C source code will be kept as generated by V.
* `drop` (default) - The C source code will be deleted after compiling the executable. * `drop` (default) - The C source code will be deleted after compiling the executable.
-freestanding -freestanding
Builds the executable without dependency on libc. Build the executable without dependency on libc.
Supported only on `linux` targets currently. Supported only on `linux` targets currently.
-live -live
Builds the executable with live capabilities (`[live]`). Build the executable with live capabilities (`[live]`).
-manual-free -manual-free
Enables manually freeing on all V code. This will cause memory leaks in vlib. Enable manually freeing on all V code. This will cause memory leaks in vlib.
Currently enabled until a stable auto-free system is in place. Currently enabled until a stable auto-free system is in place.
-os <os>, -target-os <os> -os <os>, -target-os <os>
Changes the target OS that V tries to compile for. Change the target OS that V tries to compile for.
By default, the target OS is the host system. By default, the target OS is the host system.
When OS is `cross`, V will attempt to output cross-platform C code. When OS is `cross`, V will attempt to output cross-platform C code.
List of OS supported by V: `linux`, `windows`, `mac`, `freebsd`, `openbsd`, `netbsd`, List of OS supported by V: `linux`, `windows`, `mac`, `freebsd`, `openbsd`, `netbsd`,
`dragonfly`, `solaris`, `android` and `haiku`. `dragonfly`, `solaris`, `android` and `haiku`.
-sanitize -sanitize
Passes flags related to sanitization to the C compiler. Pass flags related to sanitization to the C compiler.
-shared -shared
Tells V to compile a shared object instead of an executable. Tell V to compile a shared object instead of an executable.
The resulting file extension will be `.dll` on Windows and `.so` on Unix systems The resulting file extension will be `.dll` on Windows and `.so` on Unix systems

View File

@ -33,7 +33,7 @@ The build flags are shared by the build and run commands:
current backends when finished current backends when finished
-d <flag>[=<value>], -define <flag>[=<value>] -d <flag>[=<value>], -define <flag>[=<value>]
Defines the provided flag. Define the provided flag.
If value is not provided, it is assumed to be set to `true`. If value is not provided, it is assumed to be set to `true`.
`value` should be `1` or `0` to indicate `true` and `false` respectively otherwise. `value` should be `1` or `0` to indicate `true` and `false` respectively otherwise.
@ -42,21 +42,21 @@ The build flags are shared by the build and run commands:
Currently, the only experiment available is: `prealloc` Currently, the only experiment available is: `prealloc`
-full-rebuild -full-rebuild
Forces a full rebuild of all dependencies. Force a full rebuild of all dependencies.
Enabled by default currently until caching works reliably. Enabled by default currently until caching works reliably.
-g -g
Compiles the executable in debug mode, allowing code to be debugged more easily. Compile the executable in debug mode, allowing code to be debugged more easily.
-o <output>, -output <output> -o <output>, -output <output>
Forces V to output the executable in a specific location. Force V to output the executable in a specific location
(relative to the current working directory if not absolute) (relative to the current working directory if not absolute).
-obf, -obfuscate -obf, -obfuscate
Turns on obfuscation for the code being built. Currently only renames symbols. Turn on obfuscation for the code being built. Currently only renames symbols.
-path -path
Specifies the order of path V looks up in while searching for imported dependencies, Specify the order of path V looks up in while searching for imported dependencies,
separated by pipes (`|`). In addition to absolute paths, you can separated by pipes (`|`). In addition to absolute paths, you can
also use these special strings too: also use these special strings too:
@vmodules - replaced with the location of the global ~/.vmodules/ folder @vmodules - replaced with the location of the global ~/.vmodules/ folder
@ -67,10 +67,10 @@ The build flags are shared by the build and run commands:
By default, -path is just "@vlib|@vmodules" . By default, -path is just "@vlib|@vmodules" .
-prod -prod
Compiles the executable in production mode where most optimizations are enabled. Compile the executable in production mode where most optimizations are enabled.
-prof, -profile -prof, -profile
Compiles the executable with all functions profiled. Compile the executable with all functions profiled.
-stats -stats
Enable more detailed statistics reporting, while compiling test files. Enable more detailed statistics reporting, while compiling test files.
@ -81,7 +81,7 @@ The build flags are shared by the build and run commands:
assertions were made, how many tests passed/failed and so on. assertions were made, how many tests passed/failed and so on.
-translated -translated
Enables features that are discouraged in regular V code but required for translated V code. Enable features that are discouraged in regular V code but required for translated V code.
-v, -vv, -vvv -v, -vv, -vvv
Enable varying verbosity in the V compiler while compiling Enable varying verbosity in the V compiler while compiling

View File

@ -4,28 +4,28 @@ Usage:
v [options] [command] [arguments] v [options] [command] [arguments]
Examples: Examples:
v hello.v compile the file `hello.v` and output it as `hello` or `hello.exe` 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 v run hello.v Same as above but also run the produced executable immediately after compilation.
v -o h.c hello.v translate `hello.v` to `h.c` . Do not compile further. v -o h.c hello.v Translate `hello.v` to `h.c` . Do not compile further.
The commands are: The commands are:
build build V code in the provided path (default) build Build V code in the provided path (default).
create setup the file structure for a V project create Setup the file structure for a V project.
doc generates the documentation for a V module (coming soon in 0.3) doc Generates the documentation for a V module (coming soon in 0.3).
fmt format the V code provided fmt Format the V code provided.
repl run the REPL repl Run the REPL.
run compile and run a V program run Compile and run a V program.
symlink create a symbolic link for V symlink Create a symbolic link for V.
test run all test files in the provided directory test Run all test files in the provided directory.
translate translate C code to V (coming soon in 0.3) translate Translate C code to V (coming soon in 0.3).
up run the V self-updater up Run the V self-updater.
self run the V self-compiler self Run the V self-compiler.
version prints the version text and exits version Print the version text and exits.
install installs a module from VPM install Install a module from VPM.
remove removes a module that was installed from VPM remove Remove a module that was installed from VPM.
search searches for a module from VPM search Search for a module from VPM.
update updates an installed module from VPM update Update an installed module from VPM.
Use "v help <command>" for more information about a command, example: `v help build` Use "v help <command>" for more information about a command, example: `v help build`
Use "v help other" to see less frequently used commands. Use "v help other" to see less frequently used commands.

View File

@ -4,11 +4,11 @@ Usage:
Formats the given V source files, then prints their formatted source to stdout. Formats the given V source files, then prints their formatted source to stdout.
Options: Options:
-c check if file is already formatted. -c Check if file is already formatted.
If it is not, print filepath, and exit with code 2. If it is not, print filepath, and exit with code 2.
-diff display only diffs between the formatted source and the original source. -diff Display only diffs between the formatted source and the original source.
-l list files whose formatting differs from vfmt. -l List files whose formatting differs from vfmt.
-w write result to (source) file(s) instead of to stdout. -w Write result to (source) file(s) instead of to stdout.
-2 Use the new V parser/vfmt. NB: this is EXPERIMENTAL for now. -2 Use the new V parser/vfmt. NB: this is EXPERIMENTAL for now.
The new vfmt is much faster and more forgiving. The new vfmt is much faster and more forgiving.
It also may EAT some of your code for now. It also may EAT some of your code for now.

View File

@ -2,6 +2,6 @@ Usage:
v install module [module] [module] [...] v install module [module] [module] [...]
^^^^^^^^^^^^^ will install the modules you specified ^^^^^^^^^^^^^ will install the modules you specified
Options: Options:
-help - Show usage info -help - Show usage info.
-verbose - Print more details about the performed operation -verbose - Print more details about the performed operation.
-server-url - When doing network operations, use this vpm server. Can be given multiple times. -server-url - When doing network operations, use this vpm server. Can be given multiple times.

View File

@ -1,14 +1,14 @@
These are utility commands that you can also launch through v, These are utility commands that you can also launch through v,
but which are used less frequently by users: but which are used less frequently by users:
bin2v convert a binary file to a v source file, bin2v Convert a binary file to a v source file,
that can be later embedded in a module or program that can be later embedded in a module or program.
build-examples test if all examples can be built build-examples Test if all examples can be built.
build-tools test if all tools can be built build-tools Test if all tools can be built.
build-vbinaries test if V can be built with different configuration build-vbinaries Test if V can be built with different configuration.
test-fmt test if all files in the current directory is formatted properly test-fmt Test if all files in the current directory is formatted properly.
test-compiler test if V is working properly by running all tests, including the compiler ones test-compiler Test if V is working properly by running all tests, including the compiler ones.
NB: this can take a minute or two to run NB: this can take a minute or two to run
setup-freetype setup thirdparty freetype on Windows setup-freetype Setup thirdparty freetype on Windows.

View File

@ -4,6 +4,6 @@ Usage:
b) v remove b) v remove
^^^^^^^^^^^^ will remove ALL installed modules ^^^^^^^^^^^^ will remove ALL installed modules
Options: Options:
-help - Show usage info -help - Show usage info.
-verbose - Print more details about the performed operation -verbose - Print more details about the performed operation.
-server-url - When doing network operations, use this vpm server. Can be given multiple times. -server-url - When doing network operations, use this vpm server. Can be given multiple times.

View File

@ -3,7 +3,7 @@ Usage: v [build flags] run <file.v|directory> [arguments...]
This command is equivalent to running `v build` and running the compiled executable. This command is equivalent to running `v build` and running the compiled executable.
The executable is passed the arguments as provided in [arguments...]. The executable is passed the arguments as provided in [arguments...].
The exit status of Run will be: The exit status of run will be:
* `1` if the compilation failed. * `1` if the compilation failed.
* The exit code of the compiled executable otherwise. * The exit code of the compiled executable otherwise.

View File

@ -3,6 +3,6 @@ Usage:
^^^^^^^^^^^^^^^^^ will search https://vpm.vlang.io/ for matching modules, ^^^^^^^^^^^^^^^^^ will search https://vpm.vlang.io/ for matching modules,
and will show details about them and will show details about them
Options: Options:
-help - Show usage info -help - Show usage info.
-verbose - Print more details about the performed operation -verbose - Print more details about the performed operation.
-server-url - When doing network operations, use this vpm server. Can be given multiple times. -server-url - When doing network operations, use this vpm server. Can be given multiple times.

View File

@ -1,9 +1,9 @@
Usage: Usage:
a) v update module [module] [module] [...] a) v update module [module] [module] [...]
^^^^^^^^^^^^ will update the listed modules to their latest versions ^^^^^^^^^^^^ will update the listed modules to their latest versions.
b) v update b) v update
^^^^^^^^^^^^ will update ALL installed modules to their latest versions ^^^^^^^^^^^^ will update ALL installed modules to their latest versions.
Options: Options:
-help - Show usage info -help - Show usage info.
-verbose - Print more details about the performed operation -verbose - Print more details about the performed operation.
-server-url - When doing network operations, use this vpm server. Can be given multiple times. -server-url - When doing network operations, use this vpm server. Can be given multiple times.