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

Generate jx doc.go #21

Open
camh- opened this issue Aug 22, 2020 · 1 comment
Open

Generate jx doc.go #21

camh- opened this issue Aug 22, 2020 · 1 comment

Comments

@camh-
Copy link
Member

camh- commented Aug 22, 2020

cmd/jx/doc.go should be generated from the usage message output by jx --help.

  1. Make jx --help output everything we want in the message
  2. Add a //go:generate to generate doc.go from the usage message.
@camh-
Copy link
Member Author

camh- commented Feb 18, 2021

doc.go has a lot more in it than we would have jx --help output. Perhaps we should have doc_usage.go be the file that contains just the usage docs. It is also questionable whether to use //go:generate when we have a Makefile. The generate command will depend on the binary being built (although perhaps the generate command could be go run ./cmd/jx --help?).

We should add some help/usage text to the message at the very least.

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

No branches or pull requests

1 participant