From 2c87a9c7ccb992da9b742646e2f07a4ccdca1563 Mon Sep 17 00:00:00 2001 From: Anastasia Alexadrova Date: Wed, 16 Oct 2024 14:37:01 +0300 Subject: [PATCH] Updated the disclaimer about the usage of the word slave --- commands/cluster-nodes.md | 2 +- commands/cluster-slaves.md | 2 +- commands/contributing.md | 2 ++ commands/info.md | 2 +- commands/memory-stats.md | 2 +- commands/role.md | 2 +- commands/slaveof.md | 2 +- 7 files changed, 8 insertions(+), 6 deletions(-) create mode 100644 commands/contributing.md diff --git a/commands/cluster-nodes.md b/commands/cluster-nodes.md index 475b67aa..24ae1cba 100644 --- a/commands/cluster-nodes.md +++ b/commands/cluster-nodes.md @@ -105,4 +105,4 @@ Note that: 1. Migration and importing slots are only added to the node flagged as `myself`. This information is local to a node, for its own slots. 2. Importing and migrating slots are provided as **additional info**. If the node has a given hash slot assigned, it will be also a plain number in the list of hash slots, so clients that don't have a clue about hash slots migrations can just skip this special fields. -**A note about the word slave used in this man page and command name**: If not for Redis OSS compatibility, the Valkey project does not use the word slave. Unfortunately in this command the word slave is part of the protocol, so we'll be able to remove such occurrences only when this API will be naturally deprecated. +> NOTE: If not for backward compatibility, the Valkey project no longer uses the words "master" and "slave". Unfortunately in the given commands these words are part of the protocol, so we’ll be able to remove such occurrences only when this API will be naturally deprecated. diff --git a/commands/cluster-slaves.md b/commands/cluster-slaves.md index 67831dd4..5944f7ba 100644 --- a/commands/cluster-slaves.md +++ b/commands/cluster-slaves.md @@ -1,4 +1,4 @@ -**A note about the word slave used in this man page and command name**: If not for Redis OSS compatibility, the Valkey project does not use the word slave. Please use the new command `CLUSTER REPLICAS`. The command `CLUSTER SLAVES` will continue to work for backward compatibility. +**A note about the word slave used in this man page and command name**: the Valkey project no longer uses the words "master" and "slave". Please use the new command `CLUSTER REPLICAS`. The command `CLUSTER SLAVES` will continue to work for backward compatibility. The command provides a list of replica nodes replicating from the specified primary node. The list is provided in the same format used by `CLUSTER NODES` (please refer to its documentation for the specification of the format). diff --git a/commands/contributing.md b/commands/contributing.md new file mode 100644 index 00000000..aa7770b8 --- /dev/null +++ b/commands/contributing.md @@ -0,0 +1,2 @@ +# Contributing guide + diff --git a/commands/info.md b/commands/info.md index 8f234de8..00e6a92f 100644 --- a/commands/info.md +++ b/commands/info.md @@ -687,6 +687,6 @@ It won't be included when `INFO` or `INFO ALL` are called, and it is returned on [hcgcpgp]: http://code.google.com/p/google-perftools/ -**A note about the word slave used in this man page**: If not for backward compatibility, the Valkey project no longer uses the word slave. Unfortunately in this command the word slave is part of the protocol, so we'll be able to remove such occurrences only when this API will be naturally deprecated. +**A note about the word slave used in this man page**: If not for backward compatibility, the Valkey project no longer uses the words "master" and "slave". Unfortunately in the given commands these words are part of the protocol, so we’ll be able to remove such occurrences only when this API will be naturally deprecated. **Modules generated sections**: Starting with Valkey 6, modules can inject their info into the `INFO` command, these are excluded by default even when the `all` argument is provided (it will include a list of loaded modules but not their generated info fields). To get these you must use either the `modules` argument or `everything`., diff --git a/commands/memory-stats.md b/commands/memory-stats.md index 72cf27e7..4c51a325 100644 --- a/commands/memory-stats.md +++ b/commands/memory-stats.md @@ -54,4 +54,4 @@ values. The following metrics are reported: * `fragmentation`: See `INFO`'s `mem_fragmentation_ratio` * `fragmentation.bytes`: See `INFO`'s `mem_fragmentation_bytes` -**A note about the word slave used in this man page**: If not for Redis OSS compatibility, the Valkey project does not use the word slave. Unfortunately in this command the word slave is part of the protocol, so we'll be able to remove such occurrences only when this API will be naturally deprecated. +**A note about the word slave used in this man page**: If not for backward compatibility, the Valkey project no longer uses the words "master" and "slave". Unfortunately in the given commands these words are part of the protocol, so we’ll be able to remove such occurrences only when this API will be naturally deprecated. diff --git a/commands/role.md b/commands/role.md index 8e16ba62..17295963 100644 --- a/commands/role.md +++ b/commands/role.md @@ -78,4 +78,4 @@ The sentinel output is composed of the following parts: 3) (empty array) ``` -**A note about the word slave used in this man page**: If not for Redis OSS compatibility, the Valkey project does not use the word slave. Unfortunately in this command the word slave is part of the protocol, so we'll be able to remove such occurrences only when this API will be naturally deprecated. +**A note about the word slave used in this man page**: If not for backward compatibility, the Valkey project no longer uses the words "master" and "slave". Unfortunately in the given commands these words are part of the protocol, so we’ll be able to remove such occurrences only when this API will be naturally deprecated. \ No newline at end of file diff --git a/commands/slaveof.md b/commands/slaveof.md index 6455c214..e672ea51 100644 --- a/commands/slaveof.md +++ b/commands/slaveof.md @@ -1,4 +1,4 @@ -**A note about the word slave used in this man page and command name**: If not for Redis OSS compatibility, the Valkey project does not use the word slave. Please use the new command `REPLICAOF`. The command `SLAVEOF` will continue to work for backward compatibility. +**A note about the word slave used in this man page and command name**: If not for backward compatibility, the Valkey project no longer uses the words "master" and "slave". Please use the new command `REPLICAOF`. The command `SLAVEOF` will continue to work for backward compatibility. The `SLAVEOF` command can change the replication settings of a replica on the fly. If a Valkey server is already acting as replica, the command `SLAVEOF` NO ONE will