-
Notifications
You must be signed in to change notification settings - Fork 33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove version details and history from doc files #22
Closed
Shivshankar-Reddy
wants to merge
6
commits into
valkey-io:main
from
Shivshankar-Reddy:Rename-version
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e99acc2
remove version details and history
Shivshankar-Reddy 4482e48
change remaining verions
Shivshankar-Reddy 4932cfc
remaining versions
Shivshankar-Reddy 33f1be5
correct statement
Shivshankar-Reddy 0092328
updated remaining places
Shivshankar-Reddy 600a346
update download
Shivshankar-Reddy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -87,7 +87,6 @@ Its description follows [below](#redis_object). | |
|
||
### <a name="the-keys-global-variable"></a>The _KEYS_ global variable | ||
|
||
* Since version: 2.6.0 | ||
* Available in scripts: yes | ||
* Available in functions: no | ||
|
||
|
@@ -101,7 +100,6 @@ It is pre-populated with all key name input arguments. | |
|
||
### <a name="the-argv-global-variable"></a>The _ARGV_ global variable | ||
|
||
* Since version: 2.6.0 | ||
* Available in scripts: yes | ||
* Available in functions: no | ||
|
||
|
@@ -110,7 +108,6 @@ It is pre-populated with all regular input arguments. | |
|
||
## <a name="redis_object"></a>_redis_ object | ||
|
||
* Since version: 2.6.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -120,7 +117,6 @@ Following is the API provided by the _redis_ object instance. | |
|
||
### <a name="redis.call"></a> `redis.call(command [,arg...])` | ||
|
||
* Since version: 2.6.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -147,7 +143,6 @@ To handle Redis runtime errors use `redis.pcall()` instead. | |
|
||
### <a name="redis.pcall"></a> `redis.pcall(command [,arg...])` | ||
|
||
* Since version: 2.6.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -178,7 +173,6 @@ redis> EVAL "..." 0 hello world | |
|
||
### <a name="redis.error_reply"></a> `redis.error_reply(x)` | ||
|
||
* Since version: 2.6.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -211,7 +205,6 @@ Scripts are advised to follow this convention, as shown in the example above, bu | |
|
||
### <a name="redis.status_reply"></a> `redis.status_reply(x)` | ||
|
||
* Since version: 2.6.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -241,7 +234,6 @@ Refer to the [Data type conversion](#data-type-conversion) for returning other r | |
|
||
### <a name="redis.sha1hex"></a> `redis.sha1hex(x)` | ||
|
||
* Since version: 2.6.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -256,7 +248,6 @@ redis> EVAL "return redis.sha1hex('')" 0 | |
|
||
### <a name="redis.log"></a> `redis.log(level, message)` | ||
|
||
* Since version: 2.6.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -288,7 +279,6 @@ will produce a line similar to the following in your server's log: | |
|
||
### <a name="redis.setresp"></a> `redis.setresp(x)` | ||
|
||
* Since version: 6.0.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -306,16 +296,12 @@ Please refer to the [Data type conversion](#data-type-conversion) for more infor | |
|
||
### <a name="redis.set_repl"></a> `redis.set_repl(x)` | ||
|
||
* Since version: 3.2.0 | ||
* Available in scripts: yes | ||
* Available in functions: no | ||
|
||
**Note:** | ||
this feature is only available when script effects replication is employed. | ||
Calling it when using verbatim script replication will result in an error. | ||
As of Redis version 2.6.0, scripts were replicated verbatim, meaning that the scripts' source code was sent for execution by replicas and stored in the AOF. | ||
An alternative replication mode added in version 3.2.0 allows replicating only the scripts' effects. | ||
As of Redis version 7.0, script replication is no longer supported, and the only replication mode available is script effects replication. | ||
this feature is only available when script effects replication is employed, | ||
the replication mode available is script effects replication, And no script replication is supported. | ||
|
||
**Warning:** | ||
this is an advanced feature. Misuse can cause damage by violating the contract that binds the Redis master, its replicas, and AOF contents to hold the same logical content. | ||
|
@@ -361,8 +347,6 @@ If you run this script by calling `EVAL "..." 3 A B C 1 2 3`, the result will be | |
|
||
### <a name="redis.replicate_commands"></a> `redis.replicate_commands()` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ideally just delete this, it's no longer supported. |
||
|
||
* Since version: 3.2.0 | ||
* Until version: 7.0.0 | ||
* Available in scripts: yes | ||
* Available in functions: no | ||
|
||
|
@@ -376,23 +360,20 @@ For more information, please refer to [`Replicating commands instead of scripts` | |
|
||
### <a name="redis.breakpoint"></a> `redis.breakpoint()` | ||
|
||
* Since version: 3.2.0 | ||
* Available in scripts: yes | ||
* Available in functions: no | ||
|
||
This function triggers a breakpoint when using the [Redis Lua debugger](/topics/ldb). | ||
|
||
### <a name="redis.debug"></a> `redis.debug(x)` | ||
|
||
* Since version: 3.2.0 | ||
* Available in scripts: yes | ||
* Available in functions: no | ||
|
||
This function prints its argument in the [Redis Lua debugger](/topics/ldb) console. | ||
|
||
### <a name="redis.acl_check_cmd"></a> `redis.acl_check_cmd(command [,arg...])` | ||
|
||
* Since version: 7.0.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -404,7 +385,6 @@ The function will raise an error if the passed command or its arguments are inva | |
|
||
### <a name="redis.register_function"></a> `redis.register_function` | ||
|
||
* Since version: 7.0.0 | ||
* Available in scripts: no | ||
* Available in functions: yes | ||
|
||
|
@@ -504,7 +484,6 @@ Please refer to [Function Flags](/docs/manual/programmability/functions-intro/#f | |
|
||
### <a name="redis.redis_version"></a> `redis.REDIS_VERSION` | ||
|
||
* Since version: 7.0.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -517,7 +496,6 @@ The reply's format is `MM.mm.PP`, where: | |
|
||
### <a name="redis.redis_version_num"></a> `redis.REDIS_VERSION_NUM` | ||
|
||
* Since version: 7.0.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -656,9 +634,8 @@ That means, for example, that returning the RESP3 map type to a RESP2 connection | |
### Using `SELECT` inside scripts | ||
|
||
You can call the `SELECT` command from your Lua scripts, like you can with any normal client connection. | ||
However, one subtle aspect of the behavior changed between Redis versions 2.8.11 and 2.8.12. | ||
Prior to Redis version 2.8.12, the database selected by the Lua script was *set as the current database* for the client connection that had called it. | ||
As of Redis version 2.8.12, the database selected by the Lua script only affects the execution context of the script, and does not modify the database that's selected by the client calling the script. | ||
The database selected by the Lua script was *set as the current database* for the client connection that had called it. | ||
The database selected by the Lua script only affects the execution context of the script, and does not modify the database that's selected by the client calling the script. | ||
This semantic change between patch level releases was required since the old behavior was inherently incompatible with Redis' replication and introduced bugs. | ||
|
||
## Runtime libraries | ||
|
@@ -681,7 +658,6 @@ In addition, the following external libraries are loaded and accessible to scrip | |
|
||
### <a name="os-library"></a> _os_ library | ||
|
||
* Since version: 8.0.0 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Probably keep this one? |
||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -693,7 +669,6 @@ Note that for sandbox security, currently only the following os functions is exp | |
|
||
### <a name="struct-library"></a> _struct_ library | ||
|
||
* Since version: 2.6.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -767,7 +742,6 @@ redis> EVAL "return struct.size('HH')" 0 | |
|
||
### <a name="cjson-library"></a> _cjson_ library | ||
|
||
* Since version: 2.6.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -798,7 +772,6 @@ redis> EVAL "return cjson.decode(ARGV[1])['foo']" 0 '{"foo":"bar"}' | |
|
||
### <a name="cmsgpack-library"></a> _cmsgpack_ library | ||
|
||
* Since version: 2.6.0 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
@@ -831,7 +804,6 @@ redis> EVAL "return cmsgpack.unpack(ARGV[1])" 0 "\x93\xa3foo\xa3bar\xa3baz" | |
|
||
### <a name="bitop-library"></a> _bit_ library | ||
|
||
* Since version: 2.8.18 | ||
* Available in scripts: yes | ||
* Available in functions: yes | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm strongly against this change.
Where is the decision to remove all history? Please show me.
It is a terrible idea for anyone who is upgrading from Redis, which I think will be 99% of our users.
I insist that we keep references to Redis 6.2 and later, i.e. the versions that were still supported when we forked, which is what all users are running before they upgrade to Valkey.
@valkey-io/core-team I would like to know where this idea is coming from. Was it discussed anywhere?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, i think we should keep the history, finding the corresponding supported version is a pain (it deserves to be properly documented at somewhere). I don't remember us discussing this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We didn't discuss this in the core team meeting but there was a discussion on an early re-branding PR (and this predates @enjoy-binbin's time on this project).
#4 (comment)
IIRC, the decision back then is to keep anything beyond 7.2 (the origin of Valkey) and this is why 8.0 was kept.
#4 (comment)
I am not against keeping references to Redis 6.2+ but can you explain how it could help customers who switch over to Valkey?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some users avoid upgrading until it is absolutely necessary. When a version is end of life, users want to switch to the latest version. That means from redis 6.2 to valkey 7.2 or valkey 8.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't see in that PR that there is a decision to keep anything beyond 7.2.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it - I think we should re-instate the history of these versions then. I am all for helping the users.