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
{ {
"FORGET": { "FORGET": {
"summary": "Remove a node from the nodes table", "summary": "Removes a node from the nodes table.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"GETKEYSINSLOT": { "GETKEYSINSLOT": {
"summary": "Return local key names in the specified hash slot", "summary": "Returns the key names in a hash slot.",
"complexity": "O(N) where N is the number of requested keys", "complexity": "O(N) where N is the number of requested keys",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.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": "cluster", "group": "cluster",
"since": "5.0.0", "since": "5.0.0",
......
{ {
"INFO": { "INFO": {
"summary": "Provides info about Redis Cluster node state", "summary": "Returns information about the state of a node.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"KEYSLOT": { "KEYSLOT": {
"summary": "Returns the hash slot of the specified key", "summary": "Returns the hash slot for a key.",
"complexity": "O(N) where N is the number of bytes in the key", "complexity": "O(N) where N is the number of bytes in the key",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"LINKS": { "LINKS": {
"summary": "Returns a list of all TCP links to and from peer nodes in cluster", "summary": "Returns a list of all TCP links to and from peer nodes.",
"complexity": "O(N) where N is the total number of Cluster nodes", "complexity": "O(N) where N is the total number of Cluster nodes",
"group": "cluster", "group": "cluster",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"MEET": { "MEET": {
"summary": "Force a node cluster to handshake with another node", "summary": "Forces a node to handshake with another node.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"MYID": { "MYID": {
"summary": "Return the node id", "summary": "Returns the ID of a node.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"MYSHARDID": { "MYSHARDID": {
"summary": "Return the node shard id", "summary": "Returns the shard ID of a node.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "cluster", "group": "cluster",
"since": "7.2.0", "since": "7.2.0",
......
{ {
"NODES": { "NODES": {
"summary": "Get Cluster config for the node", "summary": "Returns the cluster configuration for a node.",
"complexity": "O(N) where N is the total number of Cluster nodes", "complexity": "O(N) where N is the total number of Cluster nodes",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"REPLICAS": { "REPLICAS": {
"summary": "List replica nodes of the specified master node", "summary": "Lists the replica nodes of a master node.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "cluster", "group": "cluster",
"since": "5.0.0", "since": "5.0.0",
......
{ {
"REPLICATE": { "REPLICATE": {
"summary": "Reconfigure a node as a replica of the specified master node", "summary": "Configure a node as replica of a master node.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"RESET": { "RESET": {
"summary": "Reset a Redis Cluster node", "summary": "Resets a node.",
"complexity": "O(N) where N is the number of known nodes. The command may execute a FLUSHALL as a side effect.", "complexity": "O(N) where N is the number of known nodes. The command may execute a FLUSHALL as a side effect.",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"SAVECONFIG": { "SAVECONFIG": {
"summary": "Forces the node to save cluster state on disk", "summary": "Forces a node to save the cluster configuration to disk.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"SET-CONFIG-EPOCH": { "SET-CONFIG-EPOCH": {
"summary": "Set the configuration epoch in a new node", "summary": "Sets the configuration epoch for a new node.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"SETSLOT": { "SETSLOT": {
"summary": "Bind a hash slot to a specific node", "summary": "Binds a hash slot to a node.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"SHARDS": { "SHARDS": {
"summary": "Get array of cluster slots to node mappings", "summary": "Returns the mapping of cluster slots to shards.",
"complexity": "O(N) where N is the total number of cluster nodes", "complexity": "O(N) where N is the total number of cluster nodes",
"group": "cluster", "group": "cluster",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"SLAVES": { "SLAVES": {
"summary": "List replica nodes of the specified master node", "summary": "Lists the replica nodes of a master node.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"SLOTS": { "SLOTS": {
"summary": "Get array of Cluster slot to node mappings", "summary": "Returns the mapping of cluster slots to nodes.",
"complexity": "O(N) where N is the total number of Cluster nodes", "complexity": "O(N) where N is the total number of Cluster nodes",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.0.0",
......
{ {
"CLUSTER": { "CLUSTER": {
"summary": "A container for cluster commands", "summary": "A container for Redis Cluster commands.",
"complexity": "Depends on subcommand.", "complexity": "Depends on subcommand.",
"group": "cluster", "group": "cluster",
"since": "3.0.0", "since": "3.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