Skip to content

Commit

Permalink
Squashed 'docs/redis-doc/' changes from 99a0aa524..93a2afb33
Browse files Browse the repository at this point in the history
93a2afb33 Escapes Redis commands
099aae476 Escapes keywords that are also commands
dddae7721 Temp workaround for redis/redis-io#251 (#1646)
2fd52e72b Add ASKING command (#1642)
b9155866a add bitfield_ro command (#1645)
de7eeb2cc Update MONITOR command (#1641)
df6e3889a Update Lua RESP3 reply format (#1619)
be38fe6f1 Add INFO metrics {total,current}_active_defrag_time (#1643)
8ec59f994 Fix grammar in pipelining doc for easier consumption (#1024)
80cd34aff Format Ruby examples (#1136)
12f577959 Add new LMPOP and BLMPOP commands. (#1636)
660170158 Merge pull request #1637 from madolson/numpat-change
d9410a6a1 Update clients.json (#1639)
8dbd962e6 update readme: small typo fix (#1634)
1f5754db4 Escape markdown in my_random_value (#1635)
e94992395 Clarify wording around number of pubsub numpat
845a28d3e Notes on manual failover to a new (just upgraded) replica (#1633)
9a53d7038 Sentinel: rephrase replica-priority paragraph. (#1630)
94a0e4846 Add missing hyperlinks to different sections of the sentinel doc
3554566ce Add SORT_RO documentation (#1621)
46db91367 Update active Java clients (#1623)
dfa8671d3 Sponsor name change (#1624)
b7d1ecfae Avoid confusing use of term "pure function"
87ecbfca7 Add current_cow_peak field in INFO command (#1617)
f9a75a4b0 Add doc for new options of expire commands (#1613)
2d26a5a9c adds new SINTERCARD and ZINTERCARD (#1610)
af282ed4a Fix spelling of acknowledgment (#1618)
1edd7b68a Render lists properly in CLIENT PAUSE doc (#1601)
e3d11f00b Fix inconsistent EVALSHA error output (#1616)
a25c27b0f Add RedisIMS (If-Modified-Since) module (#1599)
228f8c692 Fix typo (#1606)
10a013653 Clarifies that timeout is in seconds. (#1604)
6ca156269 INFO details about fragmentation (#1608)
9877b6740 Fix line feed in acl cats
5b46fada0 add description of the ACL categories (#1609)
a7a331b9d Add 'systemd' to wordlist (#1614)
2320aaeaf Better phrasing and fix typos in streams (#1607)
b00eac4cf Add `process_supervised` description at INFO (#1612)
788189c65 Add info metrics total_eviction_exceeded_time and current_eviction_exceeded_time, redis#9031
5ddb3b26b update stars (#1611)
6a9c6310b RPOPLPUSH minor phrasing updates
bfc5e2cb7 Add unit to TTL summary (be consistent with PTTL) (#1600)
e722a583b Document the INFO field "sentinel_tilt_since_seconds" for Sentinel (#1594)
7282fadc4 GEOSEARCH, GEOSEARCHSTORE more detailed examples (#1597)
5739d443a Change args of BITPOS from [start] [end] to [start [end]]
f0a260346 Merge pull request #1223 from redis/bit-group
9924218f0 Kicked off performance analysis guide - on-CPU profiling and tracing (#1437)
a5ce7cec5 Cluster: reference redis-cli instead of redis-trib + minor fix (#1592)
593ef6677 SCAN: Address documentation typo on parallel iterations (#1595)
632c46aa5 Add client: redis-async (ocaml) #1593
c7143d636 Update the doc about maxmemory on replicas (#1457)
d48c19234 Update time complexity of EXISTS, SPOP (#612)
706170b19 Fix the return of LPOP and RPOP with count + examples (#1591)
7b270c467 Improve wording around expire + transact (#1590)
fe2ff16b9 Cleanup erlang clients that are not maintained
28e7d37d4 Add Bash client https://github.com/SomajitDey/redis-client (#1581)
7f7b61ca9 Add redis-interval-module
8cbe3cfc0 Adding ecredis - Erlang Redis Cluster client (#1586)
157443c74 Add Jedis.jl to clients.json as a new Julia client #1584
5d8afc49f Use 'nil' in LPOS command docs (#1571)
f851b3593 Add note re TTL getting reset by getset
92b7099cf Rephrase description of XX and NX options of ZADD
16d577371 GEOSEARCH command: Changed wording in a few places. (#1568)
d68271df1 Removed wrong space (#1567)
ef1709469 Added SWI-Prolog client (#1407)
618cca8f0 Update SET documentation of the NX and GET flags (#1565)
13a022958 Document optionality of PFADD, EVAL, EVALSHA args
cb3c9b5fb Merge pull request #1572 from sazzad16/patch-3
19db26df5 Merge pull request #1579 from huangzhw/cluster
be82a6f22 Merge pull request #1560 from nmvk/evalro
64d5225df Update PGP key. (#1589)
586b10591 API documentation of EXPIRETIME and PEXPIRETIME commands (#1582)
0146a9e6d slowlog get command supports passing in -1 to get all logs. (#1585)
874d646ee Add missing flag nofailover in "cluster nodes" command output.
9fe1f36dd Add TairHash and TairString modules (#1577)
13bda277d Update client-side-caching.md (#1575)
2865b8e96 ZREMRANGEBYLEX : Replace "return" with "remove" (#1576)
d4b50349f Fix typo (#1574)
23a9ab1b3 MEMORY USAGE command may return 'nil'
af4e30177 add godis client (#1566)
6fca48493 Little tweak on INCR rate limiter 1 (#1516)
29fe06d83 Specifies an error is returned when xadd fails (#1495)
df4eda7ce Add Red to tools.json (#1558)
0e39ef9ec Escapes Redis command names in bitfield's syntax
b2fc5c53c Update bitfield.md (#1553)
3f34db95a SPOP with COUNT returns empty array (not nil) (#1559)
a4fa6557a GEOSEARCHSTORE: Remove WITHCOORD, WITHDIST and WITHHASH (#1561)
eea6e9d1c Apply suggestions from code review
a24651db2 Update to Commands.json
328df19b3 Address PR comments
e42581151 EVAL_RO and EVALSHA_RO documentation
42ccc962f update module api ref again (#1557)
71490b714 Update notifications documentation with module key type event notifications (#1548)
437b16e63 Update module api reference (#1556)
6e749f1fb Updated complexity of BRPOP and BLPOP commands. (#1554)
189ecd19e Fix sentinel failover delay to 2 * failover-timeout (#1555)
3ca7ad000 Add more details about configuration format (#1549)
c79195847 Remove cli tag from XACK (#1552)
ecb0ab336 Update persistence.md (#1550)
29f18a45d update module api doc for 6.2.2 (#1546)
4e2bdf592 Minor spelling / phrasing update. (#1544)
4953e008b Fix LIMIT index error in ZRANGEBYLEX command of indexes.md. (#1542)
48bb84e86 Tiny grammatical change. (#1543)
136bb9ea3 Add documentation for Lua behavior under low memory conditions. (#1533)
5295c398f Fix wrong order of geospatial tuple (#1541)
18e360252 Fix GEOPOS time complexity (#1540)
4514130e0 Update set.md
dbd2b8a0f Stream command cleanups (#1537)
1f28de1ea Update modules.json (#1538)
7f42ec7a6 Adding a link to redicrypt module (#1536)
3493e18c3 Fix RESET command misleading typo and add CLIENT KILL LADDR. (#1535)
ed0b3f694 Added Jedis as an example of client side partitioning (#1534)
400b13f9a Fix incorrect references to SYNC command. (#1531)
18ae06bb2 Adding Redis Interval Sets to the redis.io modules (#1532)
89b88883e Update sponsors.md
8792b6250 Specify STRALGO LCS syntax more accurately. (#1529)
a61380b17 Client and tools cleanups (#1530)
64a0d67c3 Update xpending.md
f1d54a691 module api changes for 6.2.1 (#1526)
7870ef7bb Persistence: Define acronyms RDB and AOF (#1524)
539dd6c06 Fix minor phrasing / grammar issue (#1525)
e0528232f update module api ref (#1523)
8aa3e63c5 grammar changes (#1520)
2cfe75876 update INFO doc for current_fork_perc, current_save_keys_processed, c… (#1518)
08330f388 Fix typo (#1517)
b8434ef82 Add a warning about Sentinel and hostnames. (#1513)
260ee0b73 small typo (#1515)
b702dd26d admin.md: madvise for transparent_hugepage (#841)
eda70b134 Updates tools.json (#1514)
78e0f7ac5 Cleans clients.json (#1512)
4aa0c7c1a Adds aspell dependency to PR action
252a588e4 clients.json: marked node-redis as inactive (#1511)
ac7fcd41e Updates clients.json
ecbe17343 Update clients.json (#1510)
e46f14628 add ltoddy's rust redis client into doc (#1509)
89970b305 Add C# client FreeRedis (#1434)
a2fefb86a Revamps release process description (#1491)
77d54696e improve GETDEL description (#1508)
cac4c937c Update getex.md
3c81ab6ef Update hrandfield.md
99cf22d4c module up update for 6.2 RC3 (#1507)
956e1dd9e Updates for Sentinel in 6.2. (#1506)
f1db48664 Documents the FAILOVER command (#1502)
0923d9e7e Update lazyfree-lazy-user-flush doc (#1493)
47c4105d6 Adds HRANDMEMBER and ZRANDMEMBER, revamps SRANDMEMBER (#1504)
90fccf9f6 Adding redis-py-cluster to the list of clients. (#1505)
3672323bd GETEX, GETDEL and SET PXAT/EXAT Documentation (#1501)
ff1f4bf9a Fix: Removed tonumber from the Lua script (#1496)
0536b897b Apply module command cleanup from redis/8344 (#1499)
3a73cc2d6 Apply module command cleanup from redis/8344 (#1498)
5a336ba5e apply module command cleanup from redis/8344 (#1497)
7b40968c7 apply module command cleanup from redis/8344 (#1497)
bd829f2e8 update module api formatting and missing functions (#1494)
6acf74c4e Update zrangestore.md
7b9874cee Adds complexity to SWAPDB (#1484)
da92d05e9 update module api for 6.2 RC2 (#1492)
926bc64f1 Update set.md (#1490)
01af47f41 GEOSEARCH ANY argument (#1480)
70760fc30 docs for new MINID trim strategy (#1488)
1e8355fe0 Fixed consistency issue with history versions (#1489)
78a3753fd Documention for client pause (#1487)
70c16cffe Updated documentation about BCAST (#1486)
53ead8b58 update INFO doc for current_cow_size field (#1478)
361b855a2 New ZRANGESTORE and ZRANGE new args, deprecate others (#1482)
f256d308b XAUTOCLAIM docs (#1475)
60b5f4bcb new styling guides (#1485)
fd2f0fa52 XREADGROUP example and reply (#1469)
10b306f4c Update clients.json (#1477)
63966e54f hedis now supports cluster (#1483)
31c5e3e6c Rename Presto SQL to Trino (#1476)
40933ff8f Adds CH/NX/XX options to GEOADD (#1474)
090a5fe57 Added documentation regarding error statistics (redis/redis#8217) (#1472)
d1a28e7b2 add command deprecatoin note for GEORADIUS (#1481)
a55223bc7 Documents noargs HELLO variant (#1471)
9f43155fe add reauthenticate and deauthenticate to workdlist
54a440872 Update reset.md
a8278c441 Update reset.md
d60438a09 Documents CLIENT TRACKINGINFO (#1459)
2042e052c Adds count to L/RPOP (#1464)
33bc5ddcf Abide current HELLO subcommand (#1381)
bc5c60596 Documents '--cluster-yes' and a couple of env vars (#1435)
0629c3a5c Clarify the usage of maxlen with a value of 0 (#1436)
616eab455 change port 7002 after redirection (#1468)
7dc7474bb Revert "Use a static example for client info"
056315147 Use a static example for client info
43f18c80b update module docs for 6.2 RC1 (#1466)
0ee00bbc9 Add GEOSEARCH/GEOSEARCHSTORE (#1465)
ed8571b22 Documented redis#8132: Redis main thread cpu time, and scrape system time (#1455)
248dce42a Add description for total_forks in INFO STATS (#1461)
f3caf86cf Copy edit intro (#1463)
dbd555ab4 fix twitter account to g_korland (#1460)
c92e61613 Documents XPENDING's exclusive ranges (#1453)
b6251621d Add Pottery Redlock implementation (#1458)
7ec457eca Typo fix (#1456)
05247b6d0 Adds CLIENT INFO and CLIENT LIST ID (#1451)
940ce878d Clients: Add forks of C and Erlang clients and mark old as inactive (#1452)
a65ca12ac Adds exclusive ranges to XRANGE/XREVRANGE (#1444)
0521a4dbf Documents ACL Pub/Sub (#1448)
871c84235 Adds names to blocks (#1449)
899df8d8a Adds nested arguments (#1443)
4772fa991 Add asynchronous Redlock PHP implementation (#1445)
9220d0235 Jedis is moved under Redis (#1447)
e18dcb675 Fix XPENDING IDLE (#1446)
e382212fa Add handy-redis to list of clients (#1416)
07a0cee32 Adds the COPY command (#1439)
7d664e59d Docs for XPENDING IDLE (#1442)
ca01ef14d Add documentation for the new zdiff/zdiffstore commands (#1428)
76e46bff4 Stream intro doc cleanups (#1433)
7b6de45a4 add missing user information in client list (#1441)
edbe192ba update client list command for including bcast and redir information (#1440)
751fe6501 Adds empty authors to Presto
895548224 Add Presto Redis connector (#1430)
c62a515eb Adds NewLife.Redis C# client (#1431)
4787687dc Typo fix: entires -> entries (#1432)
e3daa2f95 Updates INFO fields about diskless loading progress and maxclients (#1427)
08904d273 Adds the RESET command (#1426)
1b594c6cf Adds clarifications about Pub/Sub replies in a Redis Cluster (#1425)
7a03ea3ed Update latency-reset.md
8a0d21a22 Update cluster-flushslots.md
a0a330b73 Updated CLIENT LIST and KILL doc to include laddr (#1424)
8d4bf9bc4 Update module api before releasing 6.0.9 (#1423)
8bb78b4c2 Some cleanups to streams doc (#1422)
c387a8f0c Updates to Sentinel doc (#1417)
e0fb54518 Renames bit group to bitmap to conform to internals
207e09f20 Moves some commands to a new 'bit' category

git-subtree-dir: docs/redis-doc
git-subtree-split: 93a2afb336b3456699d755a7c3d7b2ab27298a9a
  • Loading branch information
mmkal committed Sep 17, 2021
1 parent 0c6c01a commit ef78f6e
Show file tree
Hide file tree
Showing 134 changed files with 6,873 additions and 1,979 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ jobs:
check:
runs-on: ubuntu-latest
steps:
- name: Install aspell
run: sudo apt-get install aspell
- uses: ruby/setup-ruby@v1
with:
ruby-version: 2.6
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,10 @@ Returns all keys matching the given pattern.

Please use the following formatting rules:

* Wrap lines to 80 characters.
* No need for manual lines wrapping at any specific length, doing so usually
means that adding a word creates a cascade effect and changes other lines.
* Please avoid writing lines that are too long, this makes the diff harder to
review when only one word is changed.
* Start every sentence on a new line.

Luckily, this repository comes with an automated Markdown formatter.
Expand All @@ -82,11 +85,12 @@ The formatter has the following dependencies:
* Redcarpet
* Nokogiri
* The `par` tool
* batch

Installation of the Ruby gems:

```
gem install redcarpet nokogiri
gem install redcarpet nokogiri batch
```

Installation of par (OSX):
Expand Down
Loading

0 comments on commit ef78f6e

Please sign in to comment.