Skip to content

Commit

Permalink
Updated the disclaimer about the usage of the word slave
Browse files Browse the repository at this point in the history
  • Loading branch information
nastena1606 committed Oct 16, 2024
1 parent 77de0ff commit 2c87a9c
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion commands/cluster-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 well be able to remove such occurrences only when this API will be naturally deprecated.
2 changes: 1 addition & 1 deletion commands/cluster-slaves.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
2 changes: 2 additions & 0 deletions commands/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Contributing guide

2 changes: 1 addition & 1 deletion commands/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 well 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`.,
2 changes: 1 addition & 1 deletion commands/memory-stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 well be able to remove such occurrences only when this API will be naturally deprecated.
2 changes: 1 addition & 1 deletion commands/role.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 well be able to remove such occurrences only when this API will be naturally deprecated.
2 changes: 1 addition & 1 deletion commands/slaveof.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 2c87a9c

Please sign in to comment.