Document the ACL DIGEST command - #469
Open
melancholictheory wants to merge 1 commit into
Open
Conversation
ACL DIGEST returns a fingerprint of the ACL rules currently in effect, as a hexadecimal string, so a client can tell which revision of an ACL a server is running without comparing the rules themselves. Adds the command page and the RESP2 and RESP3 reply descriptions. Signed-off-by: melancholictheory <selimvhorst@gmail.com>
zuiderkwast
approved these changes
Aug 20, 2026
zuiderkwast
left a comment
zuiderkwast
left a comment
Contributor
There was a problem hiding this comment.
LGTM, thanks!
Waiting for valkey-io/valkey#4446 to be merged (and for the major decision to be approved) before merging this.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation for
ACL DIGEST, the command added in valkey-io/valkey#4446 and requested in valkey-io/valkey#4355.ACL DIGESTreturns a fingerprint of the ACL rules currently in effect, as a hexadecimal string. A controller that manages users through an ACL file can read it before and after anACL LOADand tell whether the file it wrote is the one now in effect. Comparing the rules instead does not work, because the server reports them in its own normalized form rather than the form they were written in.This adds
commands/acl-digest.mdand the matching entries inresp2_replies.jsonandresp3_replies.json.It should land after or together with the server PR. Until the command JSON exists in valkey, the Makefile leaves the page out of the build, since
commandsis the intersection of the Markdown pages and the JSON files underVALKEY_ROOT/src/commands, so nothing breaks in the meantime.Checks
The example output on the page was taken from a server built from the command branch rather than written by hand.
With
VALKEY_ROOTpointed at that branch,makebuilds_build/man/man3/acl-digest.3valkey.gz. The summary, complexity, ACL categories, since version and reply description all resolve, and the links toACL LISTandACL LOADrender as man page references.utils/check-links.plreports no broken links, and spellchecker-cli is clean against.spellcheckerrc.yml.