caleb-brown/redict
1
0
Fork 0
mirror of https://codeberg.org/redict/redict.git synced 2025-01-21 23:58:51 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update references to redis.io throughout code

Browse Source 
Now that most of the docs have been migrated over, we can update the references
in the codebase to point to redict.io.

Signed-off-by: Drew DeVault <sir@cmpwn.com>
This commit is contained in:
Drew DeVault 2024-04-03 10:26:06 +02:00
parent 8794d03e2b
commit 654fe4ce00
4 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/commands/README.md
View File

@ -8,7 +8,7 @@ The JSON files are used to generate commands.def in Redict, and despite looking
similar to the output of `COMMAND` there are some fields and flags that are
implicitly populated, and that's the reason one shouldn't rely on the raw files.
The structure of each JSON is somewhat documented in https://redis.io/commands/command-docs/ and https://redis.io/commands/command/
The structure of each JSON is somewhat documented in https://redict.io/docs/commands/command-docs and https://redict.io/docs/commands/command
The `reply_schema` section is a standard JSON Schema (see https://json-schema.org/) that describes the reply of each command.
It is designed to someday be used to auto-generate code in client libraries, but is not yet mature and is not exposed externally.

4
src/latency.c
View File

@ -196,7 +196,7 @@ sds createLatencyReport(void) {
if (dictSize(server.latency_events) == 0 &&
server.latency_monitor_threshold == 0)
{
report = sdscat(report,"I'm sorry, Dave, I can't do that. Latency monitoring is disabled in this Redict 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");
report = sdscat(report,"I'm sorry, Dave, I can't do that. Latency monitoring is disabled in this Redict 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://redict.io/docs/usage/optimization/latency-monitor/.\n");
return report;
}
@ -366,7 +366,7 @@ sds createLatencyReport(void) {
}
if (advise_slowlog_inspect) {
report = sdscat(report,"- Check your Slow Log to understand what are the commands you are running which are too slow to execute. Please check https://redis.io/commands/slowlog for more information.\n");
report = sdscat(report,"- Check your Slow Log to understand what are the commands you are running which are too slow to execute. Please check https://redict.io/docs/commands/slowlog for more information.\n");
}
/* Intrinsic latency. */

22
src/module.c
View File

@ -954,7 +954,7 @@ int moduleGetCommandChannelsViaAPI(struct redictCommand *cmd, robj **argv, int a
*
* These functions are used to implement custom Redict commands.
*
* For examples, see https://redis.io/topics/modules-intro.
* For examples, see https://redict.io/docs/modules/.
* -------------------------------------------------------------------------- */
/* Return non-zero if a module command, that was declared with the
@ -1168,7 +1168,7 @@ RedictModuleCommand *moduleCreateCommandProxy(struct RedictModule *module, sds d
* from the same input arguments and key values.
* Starting from Redis 7.0 this flag has been deprecated.
* Declaring a command as "random" can be done using
* command tips, see https://redis.io/topics/command-tips.
* command tips, see https://redict.io/docs/usage/command-tips/.
* * **"allow-stale"**: The command is allowed to run on slaves that don't
* serve stale data. Don't use if you don't know what
* this means.
@ -1202,7 +1202,7 @@ RedictModuleCommand *moduleCreateCommandProxy(struct RedictModule *module, sds d
* the arguments that are channels.
*
* The last three parameters specify which arguments of the new command are
* Redict keys. See https://redis.io/commands/command for more information.
* Redict keys. See https://redict.io/docs/commands/command for more information.
*
* * `firstkey`: One-based index of the first argument that's a key.
* Position 0 is always the command name itself.
@ -1558,7 +1558,7 @@ int RM_SetCommandACLCategories(RedictModuleCommand *command, const char *aclflag
* both strings set to NULL.
*
* - `tips`: A string of space-separated tips regarding this command, meant for
* clients and proxies. See https://redis.io/topics/command-tips.
* clients and proxies. See https://redict.io/docs/usage/command-tips/.
*
* - `arity`: Number of arguments, including the command name itself. A positive
* number specifies an exact number of arguments and a negative number
@ -5379,7 +5379,7 @@ int RM_HashGet(RedictModuleKey *key, int flags, ...) {
/* --------------------------------------------------------------------------
* ## Key API for Stream type
*
* For an introduction to streams, see https://redis.io/topics/streams-intro.
* For an introduction to streams, see https://redict.io/docs/data-types/streams/.
*
* The type RedictModuleStreamID, which is used in stream functions, is a struct
* with two 64-bit fields and is defined as
@ -6252,7 +6252,7 @@ fmterr:
* // Do something with myval.
* }
*
* This API is documented here: https://redis.io/topics/modules-intro
* This API is documented here: https://redict.io/docs/modules/
*/
RedictModuleCallReply *RM_Call(RedictModuleCtx *ctx, const char *cmdname, const char *fmt, ...) {
client *c = NULL;
@ -6761,7 +6761,7 @@ robj *moduleTypeDupOrReply(client *c, robj *fromkey, robj *tokey, int todb, robj
/* Register a new data type exported by the module. The parameters are the
* following. Please for in depth documentation check the modules API
* documentation, especially https://redis.io/topics/modules-native-types.
* documentation, especially https://redict.io/docs/modules/native-types/
*
* * **name**: A 9 characters data type name that MUST be unique in the Redict
* Modules ecosystem. Be creative... and there will be no collisions. Use
@ -7650,7 +7650,7 @@ void RM_LatencyAddSample(const char *event, mstime_t latency) {
* ## Blocking clients from modules
*
* For a guide about blocking commands in modules, see
* https://redis.io/topics/modules-blocking-ops.
* https://redict.io/docs/modules/blocking-ops/
* -------------------------------------------------------------------------- */
/* Returns 1 if the client already in the moduleUnblocked list, 0 otherwise. */
@ -8670,7 +8670,7 @@ void moduleReleaseGIL(void) {
* runs is dangerous and discouraged. In order to react to key space events with
* write actions, please refer to `RM_AddPostNotificationJob`.
*
* See https://redis.io/topics/notifications for more information.
* See https://redict.io/docs/usage/clients/keyspace-notifications/ for more information.
*/
int RM_SubscribeToKeyspaceEvents(RedictModuleCtx *ctx, int types, RedictModuleNotificationFunc callback) {
RedictModuleKeyspaceSubscriber *sub = zmalloc(sizeof(*sub));
@ -9776,7 +9776,7 @@ int moduleGetACLLogEntryReason(RedictModuleACLLogEntryReason reason) {
/* Adds a new entry in the ACL log.
* Returns REDICTMODULE_OK on success and REDICTMODULE_ERR on error.
*
* For more information about ACL log, please refer to https://redis.io/commands/acl-log */
* For more information about ACL log, please refer to https://redict.io/docs/commands/acl-log */
int RM_ACLAddLogEntry(RedictModuleCtx *ctx, RedictModuleUser *user, RedictModuleString *object, RedictModuleACLLogEntryReason reason) {
int acl_reason = moduleGetACLLogEntryReason(reason);
if (!acl_reason) return REDICTMODULE_ERR;
@ -9787,7 +9787,7 @@ int RM_ACLAddLogEntry(RedictModuleCtx *ctx, RedictModuleUser *user, RedictModule
/* Adds a new entry in the ACL log with the `username` RedictModuleString provided.
* Returns REDICTMODULE_OK on success and REDICTMODULE_ERR on error.
*
* For more information about ACL log, please refer to https://redis.io/commands/acl-log */
* For more information about ACL log, please refer to https://redict.io/docs/commands/acl-log */
int RM_ACLAddLogEntryByUserName(RedictModuleCtx *ctx, RedictModuleString *username, RedictModuleString *object, RedictModuleACLLogEntryReason reason) {
int acl_reason = moduleGetACLLogEntryReason(reason);
if (!acl_reason) return REDICTMODULE_ERR;

2
src/notify.c
View File

@ -8,7 +8,7 @@
#include "server.h"
/* This file implements keyspace events notification via Pub/Sub and
* described at https://redis.io/topics/notifications. */
* described at https://redict.io/docs/usage/clients/keyspace-notifications/ */
/* Turn a string representing notification classes into an integer
* representing notification classes flags xored.