Skip to content

Commit 7f38c7b

Browse files
authored
Update old links for modules-api-ref.md (redis#13479)
This PR replaces old .../topics/... links with current links, specifically for the modules-api-ref.md file and the new automation that Paolo Lazzari is working on. A few of the topics links have redirects, but some don't. Best to use updated links.
1 parent 050a8ce commit 7f38c7b

8 files changed

Lines changed: 22 additions & 21 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Another good example is to think of Redis as a more complex version of memcached
1515

1616
If you want to know more, this is a list of selected starting points:
1717

18-
* Introduction to Redis data types. https://redis.io/topics/data-types-intro
18+
* Introduction to Redis data types. https://redis.io/docs/latest/develop/data-types/
19+
1920
* The full list of Redis commands. https://redis.io/commands
2021
* There is much more inside the official Redis documentation. https://redis.io/documentation
2122

@@ -493,7 +494,7 @@ Other C files
493494
* `dict.c` is an implementation of a non-blocking hash table which rehashes incrementally.
494495
* `cluster.c` implements the Redis Cluster. Probably a good read only after being very familiar with the rest of the Redis code base. If you want to read `cluster.c` make sure to read the [Redis Cluster specification][4].
495496

496-
[4]: https://redis.io/topics/cluster-spec
497+
[4]: https://redis.io/docs/latest/operate/oss_and_stack/reference/cluster-spec/
497498

498499
Anatomy of a Redis command
499500
---

deps/hiredis/async.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -478,7 +478,7 @@ static int __redisGetSubscribeCallback(redisAsyncContext *ac, redisReply *reply,
478478

479479
/* Match reply with the expected format of a pushed message.
480480
* The type and number of elements (3 to 4) are specified at:
481-
* https://redis.io/topics/pubsub#format-of-pushed-messages */
481+
* https://redis.io/docs/latest/develop/interact/pubsub/#format-of-pushed-messages */
482482
if ((reply->type == REDIS_REPLY_ARRAY && !(c->flags & REDIS_SUPPORTS_PUSH) && reply->elements >= 3) ||
483483
reply->type == REDIS_REPLY_PUSH) {
484484
assert(reply->element[0]->type == REDIS_REPLY_STRING);

redis.conf

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -838,7 +838,7 @@ replica-priority 100
838838
# this is used in order to send invalidation messages to clients. Please
839839
# check this page to understand more about the feature:
840840
#
841-
# https://redis.io/topics/client-side-caching
841+
# https://redis.io/docs/latest/develop/use/client-side-caching/
842842
#
843843
# When tracking is enabled for a client, all the read only queries are assumed
844844
# to be cached: this will force Redis to store information in the invalidation
@@ -1016,7 +1016,7 @@ replica-priority 100
10161016
# * stream - Data type: streams related.
10171017
#
10181018
# For more information about ACL configuration please refer to
1019-
# the Redis web site at https://redis.io/topics/acl
1019+
# the Redis web site at https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
10201020

10211021
# ACL LOG
10221022
#
@@ -1393,7 +1393,7 @@ disable-thp yes
13931393
# restarting the server can lead to data loss. A conversion needs to be done
13941394
# by setting it via CONFIG command on a live server first.
13951395
#
1396-
# Please check https://redis.io/topics/persistence for more information.
1396+
# Please check https://redis.io/docs/latest/operate/oss_and_stack/management/persistence/ for more information.
13971397

13981398
appendonly no
13991399

@@ -1880,7 +1880,7 @@ latency-monitor-threshold 0
18801880
############################# EVENT NOTIFICATION ##############################
18811881

18821882
# Redis can notify Pub/Sub clients about events happening in the key space.
1883-
# This feature is documented at https://redis.io/topics/notifications
1883+
# This feature is documented at https://redis.io/docs/latest/develop/use/keyspace-notifications/
18841884
#
18851885
# For instance if keyspace events notification is enabled, and a client
18861886
# performs a DEL operation on key "foo" stored in the Database 0, two

sentinel.conf

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ sentinel monitor mymaster 127.0.0.1 6379 2
133133
sentinel down-after-milliseconds mymaster 30000
134134

135135
# IMPORTANT NOTE: starting with Redis 6.2 ACL capability is supported for
136-
# Sentinel mode, please refer to the Redis website https://redis.io/topics/acl
136+
# Sentinel mode, please refer to the Redis website https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
137137
# for more details.
138138

139139
# Sentinel's ACL users are defined in the following format:
@@ -145,7 +145,7 @@ sentinel down-after-milliseconds mymaster 30000
145145
# user worker +@admin +@connection ~* on >ffa9203c493aa99
146146
#
147147
# For more information about ACL configuration please refer to the Redis
148-
# website at https://redis.io/topics/acl and redis server configuration
148+
# website at https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/ and redis server configuration
149149
# template redis.conf.
150150

151151
# ACL LOG
@@ -174,7 +174,7 @@ acllog-max-len 128
174174
# so Sentinel will try to authenticate with the same password to all the
175175
# other Sentinels. So you need to configure all your Sentinels in a given
176176
# group with the same "requirepass" password. Check the following documentation
177-
# for more info: https://redis.io/topics/sentinel
177+
# for more info: https://redis.io/docs/latest/operate/oss_and_stack/management/sentinel/
178178
#
179179
# IMPORTANT NOTE: starting with Redis 6.2 "requirepass" is a compatibility
180180
# layer on top of the ACL system. The option effect will be just setting

src/latency.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ sds createLatencyReport(void) {
203203
if (dictSize(server.latency_events) == 0 &&
204204
server.latency_monitor_threshold == 0)
205205
{
206-
report = sdscat(report,"I'm sorry, Dave, I can't do that. Latency monitoring is disabled in this Redis instance. You may use \"CONFIG SET latency-monitor-threshold <milliseconds>.\" in order to enable it. If we weren't in a deep space mission I'd suggest to take a look at https://redis.io/topics/latency-monitor.\n");
206+
report = sdscat(report,"I'm sorry, Dave, I can't do that. Latency monitoring is disabled in this Redis instance. You may use \"CONFIG SET latency-monitor-threshold <milliseconds>.\" in order to enable it. If we weren't in a deep space mission I'd suggest to take a look at https://redis.io/docs/latest/operate/oss_and_stack/management/optimization/latency-monitor.\n");
207207
return report;
208208
}
209209

src/module.c

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -983,7 +983,7 @@ int moduleGetCommandChannelsViaAPI(struct redisCommand *cmd, robj **argv, int ar
983983
*
984984
* These functions are used to implement custom Redis commands.
985985
*
986-
* For examples, see https://redis.io/topics/modules-intro.
986+
* For examples, see https://redis.io/docs/latest/develop/reference/modules/.
987987
* -------------------------------------------------------------------------- */
988988

989989
/* Return non-zero if a module command, that was declared with the
@@ -1197,7 +1197,7 @@ RedisModuleCommand *moduleCreateCommandProxy(struct RedisModule *module, sds dec
11971197
* from the same input arguments and key values.
11981198
* Starting from Redis 7.0 this flag has been deprecated.
11991199
* Declaring a command as "random" can be done using
1200-
* command tips, see https://redis.io/topics/command-tips.
1200+
* command tips, see https://redis.io/docs/latest/develop/reference/command-tips/.
12011201
* * **"allow-stale"**: The command is allowed to run on slaves that don't
12021202
* serve stale data. Don't use if you don't know what
12031203
* this means.
@@ -1587,7 +1587,7 @@ int RM_SetCommandACLCategories(RedisModuleCommand *command, const char *aclflags
15871587
* both strings set to NULL.
15881588
*
15891589
* - `tips`: A string of space-separated tips regarding this command, meant for
1590-
* clients and proxies. See https://redis.io/topics/command-tips.
1590+
* clients and proxies. See https://redis.io/docs/latest/develop/reference/command-tips/.
15911591
*
15921592
* - `arity`: Number of arguments, including the command name itself. A positive
15931593
* number specifies an exact number of arguments and a negative number
@@ -5425,7 +5425,7 @@ int RM_HashGet(RedisModuleKey *key, int flags, ...) {
54255425
/* --------------------------------------------------------------------------
54265426
* ## Key API for Stream type
54275427
*
5428-
* For an introduction to streams, see https://redis.io/topics/streams-intro.
5428+
* For an introduction to streams, see https://redis.io/docs/latest/develop/data-types/streams/.
54295429
*
54305430
* The type RedisModuleStreamID, which is used in stream functions, is a struct
54315431
* with two 64-bit fields and is defined as
@@ -6298,7 +6298,7 @@ robj **moduleCreateArgvFromUserFormat(const char *cmdname, const char *fmt, int
62986298
* // Do something with myval.
62996299
* }
63006300
*
6301-
* This API is documented here: https://redis.io/topics/modules-intro
6301+
* This API is documented here: https://redis.io/docs/latest/develop/reference/modules/
63026302
*/
63036303
RedisModuleCallReply *RM_Call(RedisModuleCtx *ctx, const char *cmdname, const char *fmt, ...) {
63046304
client *c = NULL;
@@ -6808,7 +6808,7 @@ robj *moduleTypeDupOrReply(client *c, robj *fromkey, robj *tokey, int todb, robj
68086808

68096809
/* Register a new data type exported by the module. The parameters are the
68106810
* following. Please for in depth documentation check the modules API
6811-
* documentation, especially https://redis.io/topics/modules-native-types.
6811+
* documentation, especially https://redis.io/docs/latest/develop/reference/modules/modules-native-types/.
68126812
*
68136813
* * **name**: A 9 characters data type name that MUST be unique in the Redis
68146814
* Modules ecosystem. Be creative... and there will be no collisions. Use
@@ -7697,7 +7697,7 @@ void RM_LatencyAddSample(const char *event, mstime_t latency) {
76977697
* ## Blocking clients from modules
76987698
*
76997699
* For a guide about blocking commands in modules, see
7700-
* https://redis.io/topics/modules-blocking-ops.
7700+
* https://redis.io/docs/latest/develop/reference/modules/modules-blocking-ops/.
77017701
* -------------------------------------------------------------------------- */
77027702

77037703
/* Returns 1 if the client already in the moduleUnblocked list, 0 otherwise. */
@@ -8709,7 +8709,7 @@ void moduleReleaseGIL(void) {
87098709
* runs is dangerous and discouraged. In order to react to key space events with
87108710
* write actions, please refer to `RM_AddPostNotificationJob`.
87118711
*
8712-
* See https://redis.io/topics/notifications for more information.
8712+
* See https://redis.io/docs/latest/develop/use/keyspace-notifications/ for more information.
87138713
*/
87148714
int RM_SubscribeToKeyspaceEvents(RedisModuleCtx *ctx, int types, RedisModuleNotificationFunc callback) {
87158715
RedisModuleKeyspaceSubscriber *sub = zmalloc(sizeof(*sub));

src/notify.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
#include "server.h"
1010

1111
/* This file implements keyspace events notification via Pub/Sub and
12-
* described at https://redis.io/topics/notifications. */
12+
* described at https://redis.io/docs/latest/develop/use/keyspace-notifications/. */
1313

1414
/* Turn a string representing notification classes into an integer
1515
* representing notification classes flags xored.

utils/whatisdoing.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# Software Watchdog, which provides a similar functionality but in
55
# a more reliable / easy to use way.
66
#
7-
# Check https://redis.io/topics/latency for more information.
7+
# Check https://redis.io/docs/latest/operate/oss_and_stack/management/optimization/latency/ for more information.
88

99
#!/bin/bash
1010
nsamples=1

0 commit comments

Comments
 (0)