Update module.c with missing FLAG_REPLICA description - #4279
Conversation
This PR updates module.c with a missing flag added in valkey-io#2868. This allows the generate-module-api-doc.rb script to update front facing documentation for the modules-api-ref.md file in the valkey-doc repo. Signed-off-by: Dragos Andriciuc <andriciucdragos@protonmail.com>
📝 WalkthroughWalkthroughThe inline documentation for ChangesClient info documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
4c3e9f6 to
dce2b24
Compare
There was a problem hiding this comment.
The added line matches the implementation (src/module.c:3891 maps client->flag.replica onto VALKEYMODULE_CLIENTINFO_FLAG_REPLICA, bit 8 in src/valkeymodule.h:711) and keeps the column alignment of the surrounding list, so the doc-generator output will be correct. Two notes on the flag descriptions themselves, including an answer to the FLAG_PRIMARY question from the PR body.
The DCO check is failing on 4c3e9f6 — the commit has no Signed-off-by: trailer. git rebase HEAD~1 --signoff && git push --force-with-lease fixes it.
Co-authored-by: valkey-review-bot[bot] <282604435+valkey-review-bot[bot]@users.noreply.github.com> Signed-off-by: Dragos Andriciuc <andriciucdragos@protonmail.com>
Co-authored-by: valkey-review-bot[bot] <282604435+valkey-review-bot[bot]@users.noreply.github.com> Signed-off-by: Dragos Andriciuc <andriciucdragos@protonmail.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## unstable #4279 +/- ##
============================================
- Coverage 76.88% 76.84% -0.05%
============================================
Files 162 162
Lines 81479 81487 +8
============================================
- Hits 62643 62616 -27
- Misses 18836 18871 +35
🚀 New features to boost your workflow:
|
This PR updates module.c with a missing flag added in #2868. This allows the generate-module-api-doc.rb script to update front facing documentation for the modules-api-ref.md file in the valkey-doc repo.
I also noticed that the FLAG_PRIMARY description reads a bit weirdly: "Client is a fake client used for applying replicated commands from the primary"
Which sounds like it's actually describing a replication-link client maybe? Not literally "this client is the primary."
I could fix this as well if needed since I am writing in this PR anyway the above fix.