From 758ecd80664339409677c73b5217867f99fd5364 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rolandas=20=C5=A0imkus?= Date: Thu, 2 May 2024 15:53:37 +0300 Subject: [PATCH] Changed links and naming to valkey instead of redis (#389) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This is a minor change where only naming and links now points properly to valkey. Fixes #388 --------- Signed-off-by: Rolandas Šimkus Signed-off-by: simkusr Signed-off-by: simkusr Signed-off-by: Viktor Söderqvist Co-authored-by: simkusr Co-authored-by: Viktor Söderqvist --- 00-RELEASENOTES | 6 +++--- MANIFESTO | 4 ++-- deps/README.md | 24 ++++++++++++------------ deps/linenoise/README.markdown | 2 +- src/commands/README.md | 2 +- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/00-RELEASENOTES b/00-RELEASENOTES index 0a5a8e4dd6..58f7f8dd18 100644 --- a/00-RELEASENOTES +++ b/00-RELEASENOTES @@ -1,5 +1,5 @@ Hello! This file is just a placeholder, since this is the "unstable" branch -of Redis, the place where all the development happens. +of Valkey, the place where all the development happens. There is no release notes for this branch, it gets forked into another branch every time there is a partial feature freeze in order to eventually create @@ -9,8 +9,8 @@ Usually "unstable" is stable enough for you to use it in development environment however you should never use it in production environments. It is possible to download the latest stable release here: - https://download.redis.io/redis-stable.tar.gz + https://valkey.io/download/ -More information is available at https://redis.io +More information is available at https://valkey.io Happy hacking! diff --git a/MANIFESTO b/MANIFESTO index 3727894624..01f2f2f33b 100644 --- a/MANIFESTO +++ b/MANIFESTO @@ -1,5 +1,5 @@ -[Note: this is the Redis manifesto, for general information about - installing and running Redis read the README file instead.] +[Note: This was the manifesto of Redis. It does not represent the ideals of Valkey, but is + kept in remembrance for the ideals that Salvatore had for the project.] Redis Manifesto =============== diff --git a/deps/README.md b/deps/README.md index 8da051baa7..8a04f04b00 100644 --- a/deps/README.md +++ b/deps/README.md @@ -1,9 +1,9 @@ -This directory contains all Redis dependencies, except for the libc that +This directory contains all Valkey dependencies, except for the libc that should be provided by the operating system. * **Jemalloc** is our memory allocator, used as replacement for libc malloc on Linux by default. It has good performances and excellent fragmentation behavior. This component is upgraded from time to time. * **hiredis** is the official C client library for Redis. It is used by redis-cli, redis-benchmark and Redis Sentinel. It is part of the Redis official ecosystem but is developed externally from the Redis repository, so we just upgrade it as needed. -* **linenoise** is a readline replacement. It is developed by the same authors of Redis but is managed as a separated project and updated as needed. +* **linenoise** is a readline replacement. It is developed by the same authors of Valkey but is managed as a separated project and updated as needed. * **lua** is Lua 5.1 with minor changes for security and additional libraries. * **hdr_histogram** Used for per-command latency tracking histograms. @@ -13,10 +13,10 @@ How to upgrade the above dependencies Jemalloc --- -Jemalloc is modified with changes that allow us to implement the Redis -active defragmentation logic. However this feature of Redis is not mandatory -and Redis is able to understand if the Jemalloc version it is compiled -against supports such Redis-specific modifications. So in theory, if you +Jemalloc is modified with changes that allow us to implement the Valkey +active defragmentation logic. However this feature of Valkey is not mandatory +and Valkey is able to understand if the Jemalloc version it is compiled +against supports such Valkey-specific modifications. So in theory, if you are not interested in the active defragmentation, you can replace Jemalloc just following these steps: @@ -28,7 +28,7 @@ just following these steps: Jemalloc configuration script is broken and will not work nested in another git repository. -However note that we change Jemalloc settings via the `configure` script of Jemalloc using the `--with-lg-quantum` option, setting it to the value of 3 instead of 4. This provides us with more size classes that better suit the Redis data structures, in order to gain memory efficiency. +However note that we change Jemalloc settings via the `configure` script of Jemalloc using the `--with-lg-quantum` option, setting it to the value of 3 instead of 4. This provides us with more size classes that better suit the Valkey data structures, in order to gain memory efficiency. If you want to upgrade Jemalloc while also providing support for active defragmentation, in addition to the above steps you need to perform @@ -38,7 +38,7 @@ the following additional steps: to add `#define JEMALLOC_FRAG_HINT`. 6. Implement the function `je_get_defrag_hint()` inside `src/jemalloc.c`. You can see how it is implemented in the current Jemalloc source tree shipped - with Redis, and rewrite it according to the new Jemalloc internals, if they + with Valkey, and rewrite it according to the new Jemalloc internals, if they changed, otherwise you could just copy the old implementation if you are upgrading just to a similar version of Jemalloc. @@ -61,7 +61,7 @@ cd deps/jemalloc Hiredis --- -Hiredis is used by Sentinel, `redis-cli` and `redis-benchmark`. Like Redis, uses the SDS string library, but not necessarily the same version. In order to avoid conflicts, this version has all SDS identifiers prefixed by `hi`. +Hiredis is used by Sentinel, `valkey-cli` and `valkey-benchmark`. Like Valkey, uses the SDS string library, but not necessarily the same version. In order to avoid conflicts, this version has all SDS identifiers prefixed by `hi`. 1. `git subtree pull --prefix deps/hiredis https://github.com/redis/hiredis.git --squash`
This should hopefully merge the local changes into the new version. @@ -71,7 +71,7 @@ Linenoise --- Linenoise is rarely upgraded as needed. The upgrade process is trivial since -Redis uses a non modified version of linenoise, so to upgrade just do the +Valkey uses a non modified version of linenoise, so to upgrade just do the following: 1. Remove the linenoise directory. @@ -81,11 +81,11 @@ Lua --- We use Lua 5.1 and no upgrade is planned currently, since we don't want to break -Lua scripts for new Lua features: in the context of Redis Lua scripts the +Lua scripts for new Lua features: in the context of Valkey Lua scripts the capabilities of 5.1 are usually more than enough, the release is rock solid, and we definitely don't want to break old scripts. -So upgrading of Lua is up to the Redis project maintainers and should be a +So upgrading of Lua is up to the Valkey project maintainers and should be a manual procedure performed by taking a diff between the different versions. Currently we have at least the following differences between official Lua 5.1 diff --git a/deps/linenoise/README.markdown b/deps/linenoise/README.markdown index b3752da162..fdfc5c666c 100644 --- a/deps/linenoise/README.markdown +++ b/deps/linenoise/README.markdown @@ -17,7 +17,7 @@ Line editing with some support for history is a really important feature for com So what usually happens is either: * Large programs with configure scripts disabling line editing if readline is not present in the system, or not supporting it at all since readline is GPL licensed and libedit (the BSD clone) is not as known and available as readline is (Real world example of this problem: Tclsh). - * Smaller programs not using a configure script not supporting line editing at all (A problem we had with Redis-cli for instance). + * Smaller programs not using a configure script not supporting line editing at all (A problem we had with Valkey-cli for instance). The result is a pollution of binaries without line editing support. diff --git a/src/commands/README.md b/src/commands/README.md index 0a4d730f1b..d4c27b2448 100644 --- a/src/commands/README.md +++ b/src/commands/README.md @@ -2,7 +2,7 @@ This directory contains JSON files, one for each command. Each JSON contains all the information about the command itself, but these JSON files are not to be used directly! Any third party who needs access to command information must get it from `COMMAND INFO` and `COMMAND DOCS`. -The output can be extracted in a JSON format by using `redis-cli --json`, in the same manner as in `utils/generate-commands-json.py`. +The output can be extracted in a JSON format by using `valkey-cli --json`, in the same manner as in `utils/generate-commands-json.py`. The JSON files are used to generate commands.def within this repo and JSON files for documentation, and despite looking similar to the output of `COMMAND` there are some fields and flags that are implicitly populated, and that's the