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
{
"LIST": {
"summary": "Get the list of client connections",
"summary": "Lists open connections.",
"complexity": "O(N) where N is the number of client connections",
"group": "connection",
"since": "2.4.0",
......
{
"NO-EVICT": {
"summary": "Set client eviction mode for the current connection",
"summary": "Sets the client eviction mode of the connection.",
"complexity": "O(1)",
"group": "connection",
"since": "7.0.0",
......
{
"NO-TOUCH": {
"summary": "Controls whether commands sent by the client will alter the LRU/LFU of the keys they access.",
"summary": "Controls whether commands sent by the client affect the LRU/LFU of accessed keys.",
"complexity": "O(1)",
"group": "connection",
"since": "7.2.0",
......
{
"PAUSE": {
"summary": "Stop processing commands from clients for some time",
"summary": "Suspends commands processing.",
"complexity": "O(1)",
"group": "connection",
"since": "3.0.0",
......
{
"REPLY": {
"summary": "Instruct the server whether to reply to commands",
"summary": "Instructs the server whether to reply to commands.",
"complexity": "O(1)",
"group": "connection",
"since": "3.2.0",
......
{
"SETINFO": {
"summary": "Set client or connection specific info",
"summary": "Sets information specific to the client or connection.",
"complexity": "O(1)",
"group": "connection",
"since": "7.2.0",
......
{
"SETNAME": {
"summary": "Set the current connection name",
"summary": "Sets the connection name.",
"complexity": "O(1)",
"group": "connection",
"since": "2.6.9",
......
{
"TRACKING": {
"summary": "Enable or disable server assisted client side caching support",
"summary": "Controls server-assisted client-side caching for the connection.",
"complexity": "O(1). Some options may introduce additional complexity.",
"group": "connection",
"since": "6.0.0",
......
{
"TRACKINGINFO": {
"summary": "Return information about server assisted client side caching for the current connection",
"summary": "Returns information about server-assisted client-side caching for the connection.",
"complexity": "O(1)",
"group": "connection",
"since": "6.2.0",
......
{
"UNBLOCK": {
"summary": "Unblock a client blocked in a blocking command from a different connection",
"summary": "Unblocks a client blocked by a blocking command from a different connection.",
"complexity": "O(log N) where N is the number of client connections",
"group": "connection",
"since": "5.0.0",
......
{
"UNPAUSE": {
"summary": "Resume processing of clients that were paused",
"summary": "Resumes processing commands from paused clients.",
"complexity": "O(N) Where N is the number of paused clients",
"group": "connection",
"since": "6.2.0",
......
{
"CLIENT": {
"summary": "A container for client connection commands",
"summary": "A container for client connection commands.",
"complexity": "Depends on subcommand.",
"group": "connection",
"since": "2.4.0",
......
{
"ADDSLOTS": {
"summary": "Assign new hash slots to receiving node",
"summary": "Assigns new hash slots to a node.",
"complexity": "O(N) where N is the total number of hash slot arguments",
"group": "cluster",
"since": "3.0.0",
......
{
"ADDSLOTSRANGE": {
"summary": "Assign new hash slots to receiving node",
"summary": "Assigns new hash slot ranges to a node.",
"complexity": "O(N) where N is the total number of the slots between the start slot and end slot arguments.",
"group": "cluster",
"since": "7.0.0",
......
{
"BUMPEPOCH": {
"summary": "Advance the cluster config epoch",
"summary": "Advances the cluster config epoch.",
"complexity": "O(1)",
"group": "cluster",
"since": "3.0.0",
......
{
"COUNT-FAILURE-REPORTS": {
"summary": "Return the number of failure reports active for a given node",
"summary": "Returns the number of active failure reports active for a node.",
"complexity": "O(N) where N is the number of failure reports",
"group": "cluster",
"since": "3.0.0",
......
{
"COUNTKEYSINSLOT": {
"summary": "Return the number of local keys in the specified hash slot",
"summary": "Returns the number of keys in a hash slot.",
"complexity": "O(1)",
"group": "cluster",
"since": "3.0.0",
......
{
"DELSLOTS": {
"summary": "Set hash slots as unbound in receiving node",
"summary": "Sets hash slots as unbound for a node.",
"complexity": "O(N) where N is the total number of hash slot arguments",
"group": "cluster",
"since": "3.0.0",
......
{
"DELSLOTSRANGE": {
"summary": "Set hash slots as unbound in receiving node",
"summary": "Sets hash slot ranges as unbound for a node.",
"complexity": "O(N) where N is the total number of the slots between the start slot and end slot arguments.",
"group": "cluster",
"since": "7.0.0",
......
{
"FLUSHSLOTS": {
"summary": "Delete a node's own slots information",
"summary": "Deletes all slots information from a node.",
"complexity": "O(1)",
"group": "cluster",
"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