svn commit: r1792756 - /jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/documentmk.md

[mr...@apache.org]

Author: mreutegg
Date: Wed Apr 26 15:31:44 2017
New Revision: 1792756

URL: http://svn.apache.org/viewvc?rev=1792756&view=rev
Log:
OAK-5898: Revision GC command line tool

Add example usage to documentation

Modified:
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/documentmk.md

Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/documentmk.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/documentmk.md?rev=1792756&r1=1792755&r2=1792756&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/documentmk.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/documentmk.md Wed Apr 26 15:31:44 2017
@@ -671,6 +671,14 @@ parameters or options:
     --timeLimit <Long>     cancel garbage collection after n
                              seconds (default: -1)
 
+A revision garbage collection can be invoked while the system is online and
+running. Using the oak-run runnable jar, a revision GC on a system using the
+MongoDB backend can be initiated with:
+
+    java -jar oak-run-1.8.0.jar revisions mongodb://localhost:27017/oak collect
+    
+This will collect changes identified as garbage, which is older than 24 hours.
+
 [1]: http://docs.mongodb.org/manual/core/read-preference/
 [2]: http://docs.mongodb.org/manual/core/write-concern/
 [3]: http://docs.mongodb.org/manual/reference/connection-string/#read-preference-options