OAK-2698 : Deprecate oak-mk-api (adjust documentation)

git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/oak/trunk@1670084 13f79535-47bb-0310-9956-ffa450edef68
mrozati · Mar 30, 2015 · a9db51d · a9db51d
1 parent 487033c
commit a9db51d
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -50,8 +50,8 @@ The build consists of the following main components:
   - oak-parent        - parent POM
   - oak-doc           - Oak documentation
   - oak-commons       - shared utility code
-  - oak-mk-api        - MicroKernel API
-  - oak-mk            - default MicroKernel implementation
+  - oak-mk-api        - MicroKernel API (_deprecated_)
+  - oak-mk            - MicroKernel implementation
   - [oak-core][1]     - Oak repository API and implementation
   - oak-jcr           - JCR binding for the Oak repository
   - oak-sling         - integration with Apache Sling

diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/commit/ConflictHook.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/commit/ConflictHook.java
@@ -31,7 +31,7 @@
  * {@link org.apache.jackrabbit.oak.spi.commit.ConflictHandler}
  * for resolving the conflicts.
  *
- * @see org.apache.jackrabbit.mk.api.MicroKernel#rebase(String, String)
+ * @see org.apache.jackrabbit.oak.spi.state.NodeStore#rebase(org.apache.jackrabbit.oak.spi.state.NodeBuilder)
  */
 public class ConflictHook implements CommitHook {
     private final ConflictHandler conflictHandler;

diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/AbstractRebaseDiff.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/AbstractRebaseDiff.java
@@ -26,7 +26,7 @@
 /**
  * {@code AbstractRebaseDiff} serves as base for rebase implementations.
  * It implements a {@link NodeStateDiff}, which performs the conflict
- * handling as defined in {@link org.apache.jackrabbit.mk.api.MicroKernel#rebase(String, String)}
+ * handling as defined in {@link org.apache.jackrabbit.oak.spi.state.NodeStore#rebase(NodeBuilder)}
  * on the Oak SPI state level.
  * <p>
  * Intended use of this class is to re-base a branched version of the node state

diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/ConflictAnnotatingRebaseDiff.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/ConflictAnnotatingRebaseDiff.java
@@ -16,7 +16,6 @@
  */
 package org.apache.jackrabbit.oak.spi.state;
 
-import org.apache.jackrabbit.mk.api.MicroKernel;
 import org.apache.jackrabbit.oak.api.PropertyState;
 
 import static org.apache.jackrabbit.oak.spi.state.ConflictType.DELETE_CHANGED_PROPERTY;
@@ -31,7 +30,7 @@
 
 /**
  * This implementation of {@code AbstractRebaseDiff} implements a {@link NodeStateDiff},
- * which performs the conflict handling as defined in {@link MicroKernel#rebase(String, String)}
+ * which performs the conflict handling as defined in {@link NodeStore#rebase(NodeBuilder)}
  * on the Oak SPI state level by annotating conflicting items with conflict
  * markers.
  */

diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/ConflictType.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/ConflictType.java
@@ -22,7 +22,7 @@
 /**
  * Enum to define various types of conflicts.
  *
- * @see org.apache.jackrabbit.mk.api.MicroKernel#rebase(String, String)
+ * @see org.apache.jackrabbit.oak.spi.state.NodeStore#rebase(NodeBuilder)
  */
 public enum ConflictType {
 

diff --git a/oak-doc/src/site/markdown/dev_getting_started.md b/oak-doc/src/site/markdown/dev_getting_started.md
@@ -62,8 +62,8 @@ The build consists of the following main components:
   - oak-parent        - parent POM
   - oak-doc           - Oak documentation
   - oak-commons       - shared utility code
-  - oak-mk-api        - MicroKernel API
-  - oak-mk            - default MicroKernel implementation
+  - oak-mk-api        - MicroKernel API (_deprecated_)
+  - oak-mk            - MicroKernel implementation
   - [oak-core][1]     - Oak repository API and implementation
   - oak-jcr           - JCR binding for the Oak repository
   - oak-sling         - integration with Apache Sling