You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by fr...@apache.org on 2016/11/18 11:35:24 UTC
svn commit: r1770365 - in /jackrabbit/site/live/oak/docs:
oak-mongo-js/index.html oak-mongo-js/oak-mongo.js.html
oak-mongo-js/oak.html osgi_config.html
Author: frm
Date: Fri Nov 18 11:35:24 2016
New Revision: 1770365
URL: http://svn.apache.org/viewvc?rev=1770365&view=rev
Log:
OAK-936: Site checkin for project Oak Documentation-1.6-SNAPSHOT
Modified:
jackrabbit/site/live/oak/docs/oak-mongo-js/index.html
jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html
jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html
jackrabbit/site/live/oak/docs/osgi_config.html
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/index.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/index.html?rev=1770365&r1=1770364&r2=1770365&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/index.html (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/index.html Fri Nov 18 11:35:24 2016
@@ -54,7 +54,7 @@
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.3-dev</a> on Thu Nov 17 2016 16:32:58 GMT+0100 (CET)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.3-dev</a> on Fri Nov 18 2016 12:33:06 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html?rev=1770365&r1=1770364&r2=1770365&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html Fri Nov 18 11:35:24 2016
@@ -1065,7 +1065,7 @@ var oak = (function(global){
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.3-dev</a> on Thu Nov 17 2016 16:32:58 GMT+0100 (CET)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.3-dev</a> on Fri Nov 18 2016 12:33:06 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html?rev=1770365&r1=1770364&r2=1770365&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html Fri Nov 18 11:35:24 2016
@@ -3758,7 +3758,7 @@ is inactive.
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.3-dev</a> on Thu Nov 17 2016 16:32:58 GMT+0100 (CET)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.3-dev</a> on Fri Nov 18 2016 12:33:06 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
Modified: jackrabbit/site/live/oak/docs/osgi_config.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/osgi_config.html?rev=1770365&r1=1770364&r2=1770365&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/osgi_config.html (original)
+++ jackrabbit/site/live/oak/docs/osgi_config.html Fri Nov 18 11:35:24 2016
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2016-11-17
+ | Generated by Apache Maven Doxia at 2016-11-18
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20161117" />
+ <meta name="Date-Revision-yyyymmdd" content="20161118" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Repository OSGi Configuration</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -216,7 +216,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2016-11-17</li>
+ <li id="publishDate">Last Published: 2016-11-18</li>
<li class="divider">|</li> <li id="projectVersion">Version: 1.6-SNAPSHOT</li>
@@ -538,7 +538,7 @@
<dl>
<dt>repository.home (string) - tarmk</dt>
-<dd>A path on the file system where repository data will be stored. The Segment Store persists its data in a subdirectory of <tt>repository.home</tt> named <tt>segmentstore</tt>.</dd>
+<dd>A path on the file system where repository data will be stored. The Segment Store persists its data in a subdirectory of <tt>repository.home</tt> named <tt>segmentstore</tt>. The provided path can be relative or absolute. If a relative path is provided, it is handled according to the definition of relative path as specified by <tt>java.io.File</tt>. Placeholders of any kind in the path are not supported.</dd>
<dt>tarmk.mode (string) - 64</dt>
<dd>The architecture model. It can assume only two values, <tt>32</tt> or <tt>64</tt>. If this property is set to <tt>64</tt>, data files used by the Segment Store are memory-mapped. Any other value will instruct the Segment Store not to use memory-mapped files.</dd>
<dt>tarmk.size (int) - 256</dt>
@@ -572,9 +572,9 @@
<dt>standby (boolean) - false</dt>
<dd>Determines if this Node Store is supposed to be used in standby mode.</dd>
<dt>customBlobStore (boolean) - false</dt>
-<dd>Determines if this Node Store is supposed to use a custom Blob Store.</dd>
+<dd>Determines if this Node Store is supposed to use a custom Blob Store. If this property is <tt>true</tt>, a Data Store or a Blob Store needs to be configured for the Segment Store to pick it up (see below). If this property is <tt>false</tt>, binaries will be stored in the Segment Store.</dd>
<dt>repository.backup.dir (string)</dt>
-<dd>The path on the file system where backups of this Node Store should be stored. It defaults to a subdirectory of <tt>repository.home</tt> named <tt>segmentstore-backup</tt>.</dd>
+<dd>The path on the file system where backups of this Node Store should be stored. It defaults to a subdirectory of <tt>repository.home</tt> named <tt>segmentstore-backup</tt>. If a relative path is provided, it is handled according to the definition of relative path as specified by <tt>java.io.File</tt>. Placeholders of any kind in the path are not supported.</dd>
</dl></div>
<div class="section">
<h5>org.apache.jackrabbit.oak.plugins.segment.SegmentNodeStoreService<a name="org.apache.jackrabbit.oak.plugins.segment.SegmentNodeStoreService"></a></h5>
@@ -582,13 +582,11 @@
<dl>
<dt>repository.home (string) - tarmk</dt>
-<dd>Path to repository home under which various repository related data is stored. Segment files would be stored under the <tt>${repository.home}/segmentstore</tt> directory.</dd>
+<dd>A path on the file system where repository data will be stored. The Segment Store persists its data in a subdirectory of <tt>repository.home</tt> named <tt>segmentstore</tt>. The provided path can be relative or absolute. If a relative path is provided, it is handled according to the definition of relative path as specified by <tt>java.io.File</tt>. Placeholders of any kind in the path are not supported.</dd>
<dt>tarmk.mode (string) - 64</dt>
<dd>The architecture model. It can assume only two values, <tt>32</tt> or <tt>64</tt>. If this property is set to <tt>64</tt>, data files used by the Segment Store are memory-mapped. Any other value will instruct the Segment Store not to use memory-mapped files.</dd>
<dt>tarmk.size (int) - 256</dt>
<dd>Maximum file size (in MB).</dd>
-<dt>customBlobStore (boolean) - false</dt>
-<dd>Determines if this Node Store is supposed to use a custom Blob Store.</dd>
<dt>cache (int) - 256</dt>
<dd>Size of the segment cache in MB.</dd>
<dt>compaction.cloneBinaries (boolean) - false</dt>
@@ -616,7 +614,7 @@
<dt>secondary (boolean) - false</dt>
<dd>Determines if this Node Store should be started as a secondary store.</dd>
<dt>customBlobStore (boolean) - false</dt>
-<dd>Determines if this Node Store needs a Blob Store.</dd>
+<dd>Determines if this Node Store is supposed to use a custom Blob Store. If this property is <tt>true</tt>, a Data Store or a Blob Store needs to be configured for the Segment Store to pick it up (see below). If this property is <tt>false</tt>, binaries will be stored in the Segment Store.</dd>
<dt>blobGcMaxAgeInSecs (long) - 86400</dt>
<dd>BLOB Garbage Collector (GC) logic would only consider those BLOBs for GC which are not accessed recently (currentTime - lastModifiedTime > blobGcMaxAgeInSecs). For example, as per default, only those BLOBs which have been created 24 hours in the past would be considered for GC.</dd>
</dl>