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

FR: jj config help should actually contain or point you to the config documentation #5306

Open
jdmarshall opened this issue Jan 9, 2025 · 1 comment
Labels
polish🪒🐃 Make existing features more convenient and more consistent

Comments

@jdmarshall
Copy link

Is your feature request related to a problem? Please describe.
jj config help makes no mention at all of the docs/config.md file

Describe the solution you'd like
Part of the problem here is that jj config list does not list any default values, and so the config options are largely undiscoverable. The first time someone tries to make a commit they get thrown into pico, and not everybody knows pico.

Part of the point of DVCS tools is I don't need an internet connection while working. That doesn't work if I have to google the contents of files that are already on my machine.

Describe alternatives you've considered
config help should mention more information is in the readme,

and, config list should be able to pull the canonical set of defaults so people know what can be set.

@martinvonz
Copy link
Member

There's jj help -k config, which jj help --help points to. The problem is figuring out that that's where you're supposed to look. PRs to add pointers from e.g. jj help are welcome.

@PhilipMetzger PhilipMetzger added the polish🪒🐃 Make existing features more convenient and more consistent label Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
polish🪒🐃 Make existing features more convenient and more consistent
Projects
None yet
Development

No branches or pull requests

3 participants