Unverified Commit 0c3b8b7e authored by Itamar Haber's avatar Itamar Haber Committed by GitHub
Browse files

Overhauls command summaries and man pages. (#11942)

This is an attempt to normalize/formalize command summaries.

Main actions performed:

* Starts with the continuation of the phrase "The XXXX command, when called, ..." for user commands.
* Starts with "An internal command...", "A container command...", etc... when applicable.
* Always uses periods.
* Refrains from referring to other commands. If this is needed, backquotes should be used for command names.
* Tries to be very clear about the data type when applicable.
* Tries to mention additional effects, e.g. "The key is created if it doesn't exist" and "The set is deleted if the last member is removed."
* Prefers being terse over verbose.
* Tries to be consistent.
parent cb171786
This source diff could not be displayed because it is too large. You can view the blob instead.
{ {
"CAT": { "CAT": {
"summary": "List the ACL categories or the commands inside a category", "summary": "Lists the ACL categories, or the commands inside a category.",
"complexity": "O(1) since the categories and commands are a fixed set.", "complexity": "O(1) since the categories and commands are a fixed set.",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
...@@ -17,14 +17,14 @@ ...@@ -17,14 +17,14 @@
"anyOf": [ "anyOf": [
{ {
"type": "array", "type": "array",
"description": "In case `categoryname` was not given, a list of existing ACL categories", "description": "In case `category` was not given, a list of existing ACL categories",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
{ {
"type": "array", "type": "array",
"description": "In case `categoryname` was given, list of commands that fall under the provided ACL category", "description": "In case `category` was given, list of commands that fall under the provided ACL category",
"items": { "items": {
"type": "string" "type": "string"
} }
...@@ -33,7 +33,7 @@ ...@@ -33,7 +33,7 @@
}, },
"arguments": [ "arguments": [
{ {
"name": "categoryname", "name": "category",
"type": "string", "type": "string",
"optional": true "optional": true
} }
......
{ {
"DELUSER": { "DELUSER": {
"summary": "Remove the specified ACL users and the associated rules", "summary": "Deletes ACL users, and terminates their connections.",
"complexity": "O(1) amortized time considering the typical user.", "complexity": "O(1) amortized time considering the typical user.",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"DRYRUN": { "DRYRUN": {
"summary": "Returns whether the user can execute the given command without executing the command.", "summary": "Simulates the execution of a command by a user, without executing the command.",
"complexity": "O(1).", "complexity": "O(1).",
"group": "server", "group": "server",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"GENPASS": { "GENPASS": {
"summary": "Generate a pseudorandom secure password to use for ACL users", "summary": "Generates a pseudorandom, secure password that can be used to identify ACL users.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"GETUSER": { "GETUSER": {
"summary": "Get the rules for a specific ACL user", "summary": "Lists the ACL rules of a user.",
"complexity": "O(N). Where N is the number of password, command and pattern rules that the user has.", "complexity": "O(N). Where N is the number of password, command and pattern rules that the user has.",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"HELP": { "HELP": {
"summary": "Show helpful text about the different subcommands", "summary": "Returns helpful text about the different subcommands.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"LIST": { "LIST": {
"summary": "List the current ACL rules in ACL config file format", "summary": "Dumps the effective rules in ACL file format.",
"complexity": "O(N). Where N is the number of configured users.", "complexity": "O(N). Where N is the number of configured users.",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"LOAD": { "LOAD": {
"summary": "Reload the ACLs from the configured ACL file", "summary": "Reloads the rules from the configured ACL file.",
"complexity": "O(N). Where N is the number of configured users.", "complexity": "O(N). Where N is the number of configured users.",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"LOG": { "LOG": {
"summary": "List latest events denied because of ACLs in place", "summary": "Lists recent security events generated due to ACL rules.",
"complexity": "O(N) with N being the number of entries shown.", "complexity": "O(N) with N being the number of entries shown.",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"SAVE": { "SAVE": {
"summary": "Save the current ACL rules in the configured ACL file", "summary": "Saves the effective ACL rules in the configured ACL file.",
"complexity": "O(N). Where N is the number of configured users.", "complexity": "O(N). Where N is the number of configured users.",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"SETUSER": { "SETUSER": {
"summary": "Modify or create the rules for a specific ACL user", "summary": "Creates and modifies an ACL user and its rules.",
"complexity": "O(N). Where N is the number of rules provided.", "complexity": "O(N). Where N is the number of rules provided.",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"USERS": { "USERS": {
"summary": "List the username of all the configured ACL rules", "summary": "Lists all ACL users.",
"complexity": "O(N). Where N is the number of configured users.", "complexity": "O(N). Where N is the number of configured users.",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"WHOAMI": { "WHOAMI": {
"summary": "Return the name of the user associated to the current connection", "summary": "Returns the authenticated username of the current connection.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"ACL": { "ACL": {
"summary": "A container for Access List Control commands ", "summary": "A container for Access List Control commands.",
"complexity": "Depends on subcommand.", "complexity": "Depends on subcommand.",
"group": "server", "group": "server",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"APPEND": { "APPEND": {
"summary": "Append a value to a key", "summary": "Appends a string to the value of a key. Creates the key if it doesn't exist.",
"complexity": "O(1). The amortized time complexity is O(1) assuming the appended value is small and the already present value is of any size, since the dynamic string library used by Redis will double the free space available on every reallocation.", "complexity": "O(1). The amortized time complexity is O(1) assuming the appended value is small and the already present value is of any size, since the dynamic string library used by Redis will double the free space available on every reallocation.",
"group": "string", "group": "string",
"since": "2.0.0", "since": "2.0.0",
......
{ {
"ASKING": { "ASKING": {
"summary": "Sent by cluster clients after an -ASK redirect", "summary": "Signals that a cluster client is following an -ASK redirect.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"AUTH": { "AUTH": {
"summary": "Authenticate to the server", "summary": "Authenticates the connection.",
"complexity": "O(N) where N is the number of passwords defined for the user", "complexity": "O(N) where N is the number of passwords defined for the user",
"group": "connection", "group": "connection",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"BGREWRITEAOF": { "BGREWRITEAOF": {
"summary": "Asynchronously rewrite the append-only file", "summary": "Asynchronously rewrites the append-only file to disk.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"BGSAVE": { "BGSAVE": {
"summary": "Asynchronously save the dataset to disk", "summary": "Asynchronously saves the database(s) to disk.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "1.0.0", "since": "1.0.0",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment