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

Document DEBUG subcommands #191

Open
stockholmux opened this issue Nov 22, 2024 · 3 comments
Open

Document DEBUG subcommands #191

stockholmux opened this issue Nov 22, 2024 · 3 comments

Comments

@stockholmux
Copy link
Member

The docs have a container for the DEBUG command but the subcommands remain undocumented.

There are very useful subcommands here, many of which have been around for a decade without proper documentation. It's obvious that these commands are potentially highly dangerous and blocked by default, but documenting them for normal users has real utility.

As an example, DEBUG POPULATE is super useful to a lot of folks testing out an Valkey, I don't think it's reasonable to keep this information from users.

@madolson
Copy link
Member

madolson commented Nov 23, 2024

We didn't document them in Redis since that implies we won't break them in the future without deprecating them. We don't want anyone to take a dependency. We just need to make that behavior clear. I think we should also only selectively document them.

@stockholmux
Copy link
Member Author

I think that's fine @madolson .

I'd welcome any feedback about the safe to document ones.

Alternately, would it make sense to mark the unsafe ones as 'experimental' ?

@stockholmux
Copy link
Member Author

I think this can accomplish by using the output of DEBUG HELP and dumping it to the /commands/debug.md.

Maybe something that does some simple parsing and removing the subcommands that falls outside of "selectively document" criteria.

It would probably also be useful to coverenable-debug-command from conf since that's a gate for DEBUG

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

2 participants