Skip to content

Document database-level ACL rules in valkey.conf and acl.c#3808

Merged
enjoy-binbin merged 3 commits into
valkey-io:unstablefrom
enjoy-binbin:doc
May 23, 2026
Merged

Document database-level ACL rules in valkey.conf and acl.c#3808
enjoy-binbin merged 3 commits into
valkey-io:unstablefrom
enjoy-binbin:doc

Conversation

@enjoy-binbin

Copy link
Copy Markdown
Member

The db=, alldbs and resetdbs rules introduced in #2309 were
missing from the ACL self-documenting block in valkey.conf.
Also update the reset description to include alldbs and
sanitize-payload, and add ERANGE to the documented errno values.

The db=, alldbs and resetdbs rules introduced in valkey-io#2309 were
missing from the ACL self-documenting block in valkey.conf.
Also update the `reset` description to include alldbs and
sanitize-payload, and add ERANGE to the documented errno values.

Signed-off-by: Binbin <binloveplay1314@qq.com>
@coderabbitai

coderabbitai Bot commented May 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a115bdd3-4885-4b3a-aa9a-56bdd47491c8

📥 Commits

Reviewing files that changed from the base of the PR and between 4fc01aa and 70b74ae.

📒 Files selected for processing (1)
  • src/acl.c
✅ Files skipped from review due to trivial changes (1)
  • src/acl.c

📝 Walkthrough

Walkthrough

This PR updates ACL documentation across src/acl.c and valkey.conf to clarify database-ID scoping (db=<dbid>, multi-ID, alldbs, resetdbs), expand the reset directive to list database allowance resets and sanitize-payload, and add an ERANGE note for out-of-range db= IDs.

Changes

ACL Documentation Updates

Layer / File(s) Summary
ACL reset directive and database permissions documentation
src/acl.c, valkey.conf
The reset directive documentation is extended to enumerate database-ID allowance resets (alldbs ..., resetdbs) and sanitize-payload. valkey.conf documents db=<dbid> scoping and multi-ID syntax. src/acl.c adds an ERANGE error-case note for out-of-range db= IDs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding documentation for database-level ACL rules to valkey.conf and acl.c, which is the primary focus of the changeset.
Description check ✅ Passed The description clearly relates to the changeset, explaining the missing documentation for db=, alldbs, and resetdbs rules, updates to the reset directive, and addition of ERANGE error documentation.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov

codecov Bot commented May 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.94%. Comparing base (8d3e6c3) to head (70b74ae).

Additional details and impacted files
@@             Coverage Diff              @@
##           unstable    #3808      +/-   ##
============================================
+ Coverage     76.72%   76.94%   +0.21%     
============================================
  Files           162      162              
  Lines         80710    80710              
============================================
+ Hits          61927    62104     +177     
+ Misses        18783    18606     -177     
Files with missing lines Coverage Δ
src/acl.c 92.53% <ø> (ø)

... and 20 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dvkashapov dvkashapov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you! One minor suggestion on wording, took it from our docs.

Comment thread valkey.conf Outdated
enjoy-binbin and others added 2 commits May 22, 2026 18:42
Co-authored-by: Daniil Kashapov <daniil.kashapov.ykt@gmail.com>
Signed-off-by: Binbin <binloveplay1314@qq.com>
Signed-off-by: Binbin <binloveplay1314@qq.com>
@enjoy-binbin enjoy-binbin requested a review from zuiderkwast May 22, 2026 10:45

@zuiderkwast zuiderkwast left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks,

just notice, santitize-payload will be removed in #3721. We need to keep track and remember to update accordingly when rebasing/merging them.

@enjoy-binbin enjoy-binbin merged commit c59b247 into valkey-io:unstable May 23, 2026
63 checks passed
@enjoy-binbin enjoy-binbin deleted the doc branch May 23, 2026 02:33
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

Successfully merging this pull request may close these issues.

3 participants