Repository navigation
DOC: clarify BITPOS behavior on non-existent vs empty keys - #4282
Merged
dwdougherty merged 1 commit intoOct 16, 2026
Merged
dwdougherty merged 1 commit into
dwdougherty merged 1 commit into
Conversation
dwdougherty
approved these changes
Oct 16, 2026
dwdougherty
left a comment
Collaborator
There was a problem hiding this comment.
Thank you for this contribution, @itsMathew! Much appreciated. Approved.
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
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.
Fixes redis/redis#15987
The BITPOS documentation currently states:
However, BITPOS distinguishes between a missing key and an existing empty string (""):
Non-existent key (o == NULL): Treated as an infinite array of 0 bits.
Existing empty string (""): Contains 0 allocated bytes/bits.
As per discussion in redis/redis#15987 this is the intended behaviour.
This PR updates the final note on the page to accurately describe this difference and prevent confusion.
Note
Low Risk
Documentation-only change to BITPOS; no runtime or API behavior changes.
Overview
Updates the
BITPOScommand docs to fix misleading behavior for missing vs empty keys.The old note said non-existent keys are treated like empty strings. The new text explains that a missing key is modeled as an infinite array of
0bits (BITPOS … 0→0,BITPOS … 1→-1), while an existing key with value""has no bits (BITPOSfor0or1→-1). This matches intended server behavior (redis/redis#15987).Reviewed by Cursor Bugbot for commit 21ee67c. Bugbot is set up for automated code reviews on this repo. Configure here.