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
{
"FLUSH": {
"summary": "Remove all the scripts from the script cache.",
"summary": "Removes all server-side Lua scripts from the script cache.",
"complexity": "O(N) with N being the number of scripts in cache",
"group": "scripting",
"since": "2.6.0",
......
{
"HELP": {
"summary": "Show helpful text about the different subcommands",
"summary": "Returns helpful text about the different subcommands.",
"complexity": "O(1)",
"group": "scripting",
"since": "5.0.0",
......
{
"KILL": {
"summary": "Kill the script currently in execution.",
"summary": "Terminates a server-side Lua script during execution.",
"complexity": "O(1)",
"group": "scripting",
"since": "2.6.0",
......
{
"LOAD": {
"summary": "Load the specified Lua script into the script cache.",
"summary": "Loads a server-side Lua script to the script cache.",
"complexity": "O(N) with N being the length in bytes of the script body.",
"group": "scripting",
"since": "2.6.0",
......
{
"SCRIPT": {
"summary": "A container for Lua scripts management commands",
"summary": "A container for Lua scripts management commands.",
"complexity": "Depends on subcommand.",
"group": "scripting",
"since": "2.6.0",
......
{
"SDIFF": {
"summary": "Subtract multiple sets",
"summary": "Returns the difference of multiple sets.",
"complexity": "O(N) where N is the total number of elements in all given sets.",
"group": "set",
"since": "1.0.0",
......
{
"SDIFFSTORE": {
"summary": "Subtract multiple sets and store the resulting set in a key",
"summary": "Stores the difference of multiple sets in a key.",
"complexity": "O(N) where N is the total number of elements in all given sets.",
"group": "set",
"since": "1.0.0",
......
{
"SELECT": {
"summary": "Change the selected database for the current connection",
"summary": "Changes the selected database.",
"complexity": "O(1)",
"group": "connection",
"since": "1.0.0",
......
{
"CKQUORUM": {
"summary": "Check for a Sentinel quorum",
"summary": "Checks for a Redis Sentinel quorum.",
"group": "sentinel",
"since": "2.8.4",
"arity": 3,
......
{
"CONFIG": {
"summary": "Configure Sentinel",
"summary": "Configures Redis Sentinel.",
"complexity": "O(1)",
"group": "sentinel",
"since": "6.2.0",
......
{
"DEBUG": {
"summary": "List or update the current configurable parameters",
"summary": "Lists or updates the current configurable parameters of Redis Sentinel.",
"complexity": "O(N) where N is the number of configurable parameters",
"group": "sentinel",
"since": "7.0.0",
......
{
"FAILOVER": {
"summary": "Force a failover",
"summary": "Forces a Redis Sentinel failover.",
"group": "sentinel",
"since": "2.8.4",
"arity": 3,
......
{
"FLUSHCONFIG": {
"summary": "Rewrite configuration file",
"summary": "Rewrites the Redis Sentinel configuration file.",
"complexity": "O(1)",
"group": "sentinel",
"since": "2.8.4",
......
{
"GET-MASTER-ADDR-BY-NAME": {
"summary": "Get port and address of a master",
"summary": "Returns the port and address of a master Redis instance.",
"complexity": "O(1)",
"group": "sentinel",
"since": "2.8.4",
......
{
"HELP": {
"summary": "Show helpful text about the different subcommands",
"summary": "Returns helpful text about the different subcommands.",
"complexity": "O(1)",
"group": "sentinel",
"since": "6.2.0",
......
{
"INFO-CACHE": {
"summary": "Get cached INFO from the instances in the deployment",
"summary": "Returns the cached `INFO` replies from the deployment's instances.",
"complexity": "O(N) where N is the number of instances",
"group": "sentinel",
"since": "3.2.0",
......
{
"IS-MASTER-DOWN-BY-ADDR": {
"summary": "Check if a master is down",
"summary": "Determines whether a master Redis instance is down.",
"complexity": "O(1)",
"group": "sentinel",
"since": "2.8.4",
......
{
"MASTER": {
"summary": "Shows the state of a master",
"summary": "Returns the state of a master Redis instance.",
"complexity": "O(1)",
"group": "sentinel",
"since": "2.8.4",
......
{
"MASTERS": {
"summary": "List the monitored masters",
"summary": "Returns a list of monitored Redis masters.",
"complexity": "O(N) where N is the number of masters",
"group": "sentinel",
"since": "2.8.4",
......
{
"MONITOR": {
"summary": "Start monitoring",
"summary": "Starts monitoring.",
"complexity": "O(1)",
"group": "sentinel",
"since": "2.8.4",
......
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