search

valkey-io / valkey-doc

Content for website and man pages
Other
23 stars 36 forks source link

Document `DEBUG` subcommands #191

Open stockholmux opened 22 hours ago

stockholmux commented 22 hours ago

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 commented 13 hours ago

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.