v help other: describe bug and ast subcommands

pull/10956/head
Delyan Angelov 2021-07-25 10:15:38 +03:00
parent 852ca5f7cf
commit 744a753b47
No known key found for this signature in database
GPG Key ID: 66886C0F12D595ED
1 changed files with 8 additions and 4 deletions

View File

@ -1,6 +1,10 @@
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:
ast Generate a json representation of the AST for a given .v file.
bug Post an issue on the V's issue tracker, including the failing program, and some diagnostic information.
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.
@ -10,20 +14,20 @@ but which are used less frequently by users:
check-md Check that V examples in markdown files are formatted and can compile. check-md Check that V examples in markdown files are formatted and can compile.
setup-freetype Setup thirdparty freetype on Windows.
test-all Run most checks, that the CI does locally. test-all Run most checks, that the CI does locally.
It may take over 2 minutes, and it needs internet connectivity too, It may take over 2 minutes, and it needs internet connectivity too,
because it tries to also verify that `v install` works. because it tries to also verify that `v install` works.
test-fmt Test if all files in the current directory are formatted properly. test-fmt Test if all files in the current directory are formatted properly.
test-self Test if V is working properly by running all tests, including the compiler ones.
NB: this can 1-2 minutes to run.
test-parser Test that the V parser works with the given files, as if test-parser Test that the V parser works with the given files, as if
they were typed by a human programmer, one character at a time. they were typed by a human programmer, one character at a time.
NB: *very slow* for longer files (tens of seconds for 1KB .v file). NB: *very slow* for longer files (tens of seconds for 1KB .v file).
Mainly useful as a parser bug finder for the V Language Server project. Mainly useful as a parser bug finder for the V Language Server project.
setup-freetype Setup thirdparty freetype on Windows. test-self Test if V is working properly by running all tests, including the compiler ones.
NB: this can 1-2 minutes to run.
wipe-cache Remove the V cache folder. Useful for cleaning the cache, and guaranteeing a clean build. wipe-cache Remove the V cache folder. Useful for cleaning the cache, and guaranteeing a clean build.