From 6e1c3ff132ab99602e4e71c1ccaa5795b0d996e7 Mon Sep 17 00:00:00 2001 From: Wen Hui Date: Thu, 9 Jun 2022 03:16:56 -0400 Subject: [PATCH] Update some comments in stream command docs (#10821) some small documentation fixes. --- src/t_stream.c | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/src/t_stream.c b/src/t_stream.c index 4383dcd5a..617976c9c 100644 --- a/src/t_stream.c +++ b/src/t_stream.c @@ -2144,7 +2144,7 @@ void xrevrangeCommand(client *c) { xrangeGenericCommand(c,1); } -/* XLEN */ +/* XLEN key*/ void xlenCommand(client *c) { robj *o; if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL @@ -2156,10 +2156,10 @@ void xlenCommand(client *c) { /* XREAD [BLOCK ] [COUNT ] STREAMS key_1 key_2 ... key_N * ID_1 ID_2 ... ID_N * - * This function also implements the XREAD-GROUP command, which is like XREAD + * This function also implements the XREADGROUP command, which is like XREAD * but accepting the [GROUP group-name consumer-name] additional option. * This is useful because while XREAD is a read command and can be called - * on slaves, XREAD-GROUP is not. */ + * on slaves, XREADGROUP is not. */ #define XREAD_BLOCKED_DEFAULT_COUNT 1000 void xreadCommand(client *c) { long long timeout = -1; /* -1 means, no BLOCK argument given. */ @@ -2566,8 +2566,8 @@ void streamDelConsumer(streamCG *cg, streamConsumer *consumer) { * Consumer groups commands * ----------------------------------------------------------------------- */ -/* XGROUP CREATE [MKSTREAM] [ENTRIESADDED count] - * XGROUP SETID [ENTRIESADDED count] +/* XGROUP CREATE [MKSTREAM] [ENTRIESREAD entries_read] + * XGROUP SETID [ENTRIESREAD entries_read] * XGROUP DESTROY * XGROUP CREATECONSUMER * XGROUP DELCONSUMER */ @@ -2805,7 +2805,6 @@ void xsetidCommand(client *c) { } /* XACK ... - * * Acknowledge a message as processed. In practical terms we just check the * pending entries list (PEL) of the group, and delete the PEL entry both from * the group and the consumer (pending messages are referenced in both places). @@ -3050,7 +3049,7 @@ void xpendingCommand(client *c) { * [IDLE ] [TIME ] [RETRYCOUNT ] * [FORCE] [JUSTID] * - * Gets ownership of one or multiple messages in the Pending Entries List + * Changes ownership of one or multiple messages in the Pending Entries List * of a given stream consumer group. * * If the message ID (among the specified ones) exists, and its idle @@ -3316,7 +3315,7 @@ cleanup: /* XAUTOCLAIM [COUNT ] [JUSTID] * - * Gets ownership of one or multiple messages in the Pending Entries List + * Changes ownership of one or multiple messages in the Pending Entries List * of a given stream consumer group. * * For each PEL entry, if its idle time greater or equal to ,