Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v help message formatting #23363

Merged
merged 2 commits into from
Jan 4, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions vlib/v/help/build/build.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ to be a .v source file or folder containing .v source files.
Everything after that, is assumed to be flags, that V will ignore itself,
but will pass to the executable after it is compiled.

This enables you to do for example: `v -cc gcc -g myfile.v run -param1 abcde`
This enables you to do for example: `v -cc gcc -g run myfile.v -param1 abcde`
... which means for V: "compile using gcc, produce debugging information,
then run `./myfile -param1 abcde` and exit with its exit code".

Expand Down Expand Up @@ -59,7 +59,7 @@ NB: the build flags are shared with the run command too:
value assigned to `<flag>`.
If no flag identifier (or value) is assigned, `$d()` will return the passed `<default value>`.

-g
-g, -debug
Compile the executable in debug mode, allowing code to be debugged more easily.

-o <output>, -output <output>
Expand Down
32 changes: 18 additions & 14 deletions vlib/v/help/default.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,21 @@ Examples:
`hello` or `hello.exe`.
v run hello.v Same as above but also run the produced
executable immediately after compilation.
v -g run hello.v Same as above, but make debugging easier
(in case your program crashes).
v crun hello.v Same as above, but do not recompile, if the
executable already exists, and is newer than the
v -g run hello.v Same as above but makes debugging easier
(Useful in case your program crashes).
(see `v help build` and `v help build-c`
for more information)
v crun hello.v Same as above but do not recompile if the
executable already exists and is newer than the
sources.
v -o h.c hello.v Translate `hello.v` to `h.c`. Do not compile
v -o h.c hello.v Translate `hello.v` to `h.c` only. Do not compile
further.
v -o - hello.v Translate `hello.v` and output the C source code
to stdout. Do not compile further.
v watch hello.v Re-does the same compilation, when a source code
change is detected.
The program is only compiled, not run.
v watch run hello.v Re-runs the same `hello.v` file, when a source
v -o - hello.v Translate `hello.v` and outputs the C source
code to stdout. Does not compile further.
v watch hello.v Re-do the same compilation when a source code
change is detected. The compiled result does not
get executed, only compiled.
v watch run hello.v Re-run the same `hello.v` file when a source
code change is detected.

V supports the following commands:
Expand All @@ -44,11 +46,13 @@ V supports the following commands:
fmt Format the V code provided.
vet Report suspicious code constructs.
doc Generate the documentation for a V module.
example: `v doc strings`
vlib-docs Generate and open the documentation of all the
vlib modules.
repl Run the REPL.
repl Run the REPL (Read-eval-print loop).
watch Re-compile/re-run a source file, each time it is
changed.
example: `v watch run hello.v`
where Find and print the location of current project
declarations.

Expand Down Expand Up @@ -76,5 +80,5 @@ Use "v help other" to see less frequently used commands.
Use "v help topics" to see a list of all known help topics.

Note: Help is required to write more help topics.
Only build, new, init, doc, fmt, vet, run, test, watch, search, install, remove,
update, bin2v, check-md are properly documented currently.
Only build, new, init, doc, fmt, vet, run, test, watch, search, install,
remove, update, bin2v, check-md are properly documented currently.
Loading