Skip to content

Conversation

@enjoy-binbin
Copy link
Contributor

If summary or since is empty, we used to return NULL in
COMMAND DOCS. Currently all redis commands will have these
two fields.

But not for module command, summary and since are optional
for RM_SetCommandInfo. With the change in #10043, if a module
command doesn't have the summary or since, redis-cli will
crash (see #10250).

In this commit, COMMAND DOCS avoid adding summary or since
when they are missing.

If summary or since is empty, we used to return NULL in
COMMAND DOCS. Currently all redis commands will have these
two fields.

But not for module command, summary and since are optional
for RM_SetCommandInfo. With the change in redis#10043, if a module
command doesn't have the summary or since, redis-cli will
crash (see redis#10250).

In this commit, COMMAND DOCS avoid adding summary or since
when they are missing.
@enjoy-binbin enjoy-binbin added state:needs-doc-pr requires a PR to redis-doc repository state:to-be-merged The PR should be merged soon, even if not yet ready, this is used so that it won't be forgotten labels Feb 7, 2022
@enjoy-binbin enjoy-binbin requested a review from oranagra February 7, 2022 16:34
@enjoy-binbin
Copy link
Contributor Author

The tests in subcommands and cmdintrospection should cover everything, so I didn't add additional tests
doc-pr is on the way

@oranagra oranagra merged commit 7f4cca1 into redis:unstable Feb 7, 2022
@enjoy-binbin enjoy-binbin deleted the command_docs_summary_since branch February 7, 2022 23:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

state:needs-doc-pr requires a PR to redis-doc repository state:to-be-merged The PR should be merged soon, even if not yet ready, this is used so that it won't be forgotten

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants