Skip to content

v.help: add help for git-fmt-hook tool - #26394

Merged
spytheman merged 1 commit into
vlang:masterfrom
lcheylus:git_fmt_hook-help
Jan 19, 2026
Merged

spytheman merged 1 commit into
vlang:masterfrom
lcheylus:git_fmt_hook-help

Conversation

@lcheylus

@lcheylus lcheylus commented Jan 19, 2026 •

Copy link
Copy Markdown
Contributor
$ ./v help git-fmt-hook
Tool to install/remove pre-commit Git hook

Usage:
  v git-fmt-hook [SUBCMD]

The pre-commit Git hook will check/format V files before commit with 'v fmt' command.

SUBCMD:
  status : get status for Git pre-commit hook .git/hooks/pre-commit
  install: install Git pre-commit hook .git/hooks/pre-commit
  remove : remove Git pre-commit hook

Signed-off-by: Laurent Cheylus <foxy@free.fr>

@spytheman spytheman left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work.
Thanks a lot @lcheylus πŸ™‡πŸ» .

@spytheman
spytheman merged commit 09aa031 into vlang:master Jan 19, 2026
75 checks passed
@lcheylus
lcheylus deleted the git_fmt_hook-help branch January 19, 2026 10:10
@JalonSolov

Copy link
Copy Markdown
Collaborator

Unrelated to this PR, just want to note it when I thought of it...

Where would be a good place to "surface" this higher?

For example, if you just type v help, it tells you a bunch of possibilities for further info:

Use "v help <command>" for more information about a command, example:
`v help build`, `v help build-c`, `v help build-native`

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.

Perhaps mention it in v help other?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants