You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by st...@apache.org on 2016/11/18 21:46:03 UTC
hbase git commit: HBASE-17121 Undo the building of xref as part of
site build; Remove links to xref
Repository: hbase
Updated Branches:
refs/heads/master a8ee83c09 -> be519ca1a
HBASE-17121 Undo the building of xref as part of site build; Remove links to xref
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo
Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/be519ca1
Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/be519ca1
Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/be519ca1
Branch: refs/heads/master
Commit: be519ca1a55827b3c85040cb070e489de5edb11d
Parents: a8ee83c
Author: Michael Stack <st...@apache.org>
Authored: Fri Nov 18 13:17:45 2016 -0800
Committer: Michael Stack <st...@apache.org>
Committed: Fri Nov 18 13:45:57 2016 -0800
----------------------------------------------------------------------
pom.xml | 19 -------------------
.../appendix_contributing_to_documentation.adoc | 2 +-
src/main/asciidoc/_chapters/architecture.adoc | 12 ++++++------
src/main/asciidoc/_chapters/cp.adoc | 5 +----
src/main/site/site.xml | 2 --
5 files changed, 8 insertions(+), 32 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/hbase/blob/be519ca1/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index e8afa11..dfa21a1 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2942,25 +2942,6 @@
</configuration>
</plugin>
- <!-- This seems to be needed by the surefire plugin.
- The Javadoc below provide code as well -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jxr-plugin</artifactId>
- <version>2.3</version>
- <configuration>
- <aggregate>true</aggregate>
- <test-aggregate>true</test-aggregate>
- <linkJavadoc>true</linkJavadoc>
- <javadocDir>${project.reporting.outputDirectory}/devapidocs</javadocDir>
- <testJavadocDir>${project.reporting.outputDirectory}/testdevapidocs</testJavadocDir>
- <destDir>${project.reporting.outputDirectory}/xref</destDir>
- <excludes>
- <exclude>**/generated/*</exclude>
- </excludes>
- </configuration>
- </plugin>
-
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
http://git-wip-us.apache.org/repos/asf/hbase/blob/be519ca1/src/main/asciidoc/_chapters/appendix_contributing_to_documentation.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/_chapters/appendix_contributing_to_documentation.adoc b/src/main/asciidoc/_chapters/appendix_contributing_to_documentation.adoc
index ce6f835..0d68dce 100644
--- a/src/main/asciidoc/_chapters/appendix_contributing_to_documentation.adoc
+++ b/src/main/asciidoc/_chapters/appendix_contributing_to_documentation.adoc
@@ -145,7 +145,7 @@ artifacts using `mvn clean site site:stage`, check out the `asf-site` repository
. Remove previously-generated content using the following command:
+
----
-rm -rf rm -rf *apidocs* *xref* *book* *.html *.pdf* css js
+rm -rf rm -rf *apidocs* *book* *.html *.pdf* css js
----
+
WARNING: Do not remove the `0.94/` directory. To regenerate them, you must check out
http://git-wip-us.apache.org/repos/asf/hbase/blob/be519ca1/src/main/asciidoc/_chapters/architecture.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/_chapters/architecture.adoc b/src/main/asciidoc/_chapters/architecture.adoc
index cfdd638..339566a 100644
--- a/src/main/asciidoc/_chapters/architecture.adoc
+++ b/src/main/asciidoc/_chapters/architecture.adoc
@@ -670,7 +670,7 @@ if creating a table from java, or set `IN_MEMORY => true` when creating or alter
hbase(main):003:0> create 't', {NAME => 'f', IN_MEMORY => 'true'}
----
-For more information, see the link:http://hbase.apache.org/xref/org/apache/hadoop/hbase/io/hfile/LruBlockCache.html[LruBlockCache source]
+For more information, see the LruBlockCache source
[[block.cache.usage]]
==== LruBlockCache Usage
@@ -1551,7 +1551,7 @@ StoreFiles are where your data lives.
The _HFile_ file format is based on the SSTable file described in the link:http://research.google.com/archive/bigtable.html[BigTable [2006]] paper and on Hadoop's link:http://hadoop.apache.org/common/docs/current/api/org/apache/hadoop/io/file/tfile/TFile.html[TFile] (The unit test suite and the compression harness were taken directly from TFile). Schubert Zhang's blog post on link:http://cloudepr.blogspot.com/2009/09/hfile-block-indexed-file-format-to.html[HFile: A Block-Indexed File Format to Store Sorted Key-Value Pairs] makes for a thorough introduction to HBase's HFile.
Matteo Bertozzi has also put up a helpful description, link:http://th30z.blogspot.com/2011/02/hbase-io-hfile.html?spref=tw[HBase I/O: HFile].
-For more information, see the link:http://hbase.apache.org/xref/org/apache/hadoop/hbase/io/hfile/HFile.html[HFile source code].
+For more information, see the HFile source code.
Also see <<hfilev2>> for information about the HFile v2 format that was included in 0.92.
[[hfile_tool]]
@@ -1586,7 +1586,7 @@ The blocksize is configured on a per-ColumnFamily basis.
Compression happens at the block level within StoreFiles.
For more information on compression, see <<compression>>.
-For more information on blocks, see the link:http://hbase.apache.org/xref/org/apache/hadoop/hbase/io/hfile/HFileBlock.html[HFileBlock source code].
+For more information on blocks, see the HFileBlock source code.
[[keyvalue]]
==== KeyValue
@@ -1613,7 +1613,7 @@ The Key is further decomposed as:
KeyValue instances are _not_ split across blocks.
For example, if there is an 8 MB KeyValue, even if the block-size is 64kb this KeyValue will be read in as a coherent block.
-For more information, see the link:http://hbase.apache.org/xref/org/apache/hadoop/hbase/KeyValue.html[KeyValue source code].
+For more information, see the KeyValue source code.
[[keyvalue.example]]
===== Example
@@ -1741,7 +1741,7 @@ With the ExploringCompactionPolicy, major compactions happen much less frequentl
In general, ExploringCompactionPolicy is the right choice for most situations, and thus is the default compaction policy.
You can also use ExploringCompactionPolicy along with <<ops.stripe>>.
-The logic of this policy can be examined in _link:http://hbase.apache.org/xref/org/apache/hadoop/hbase/regionserver/compactions/ExploringCompactionPolicy.html[hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/compactions/ExploringCompactionPolicy.java]_.
+The logic of this policy can be examined in hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/compactions/ExploringCompactionPolicy.java.
The following is a walk-through of the logic of the ExploringCompactionPolicy.
@@ -1957,7 +1957,7 @@ This section has been preserved for historical reasons and refers to the way com
You can still use this behavior if you enable <<compaction.ratiobasedcompactionpolicy.algorithm>>. For information on the way that compactions work in HBase 0.96.x and later, see <<compaction>>.
====
-To understand the core algorithm for StoreFile selection, there is some ASCII-art in the link:http://hbase.apache.org/xref/org/apache/hadoop/hbase/regionserver/Store.html#836[Store source code] that will serve as useful reference.
+To understand the core algorithm for StoreFile selection, there is some ASCII-art in the Store source code that will serve as useful reference.
It has been copied below:
[source]
http://git-wip-us.apache.org/repos/asf/hbase/blob/be519ca1/src/main/asciidoc/_chapters/cp.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/_chapters/cp.adoc b/src/main/asciidoc/_chapters/cp.adoc
index 1817dd3..df4a0e2 100644
--- a/src/main/asciidoc/_chapters/cp.adoc
+++ b/src/main/asciidoc/_chapters/cp.adoc
@@ -475,10 +475,7 @@ In HBase 0.96 and newer, you can instead use the `removeCoprocessor()` method of
[[cp_example]]
== Examples
-HBase ships examples for Observer Coprocessor in
-link:http://hbase.apache.org/xref/org/apache/hadoop/hbase/coprocessor/example/ZooKeeperScanPolicyObserver.html[ZooKeeperScanPolicyObserver]
-and for Endpoint Coprocessor in
-link:http://hbase.apache.org/xref/org/apache/hadoop/hbase/coprocessor/example/RowCountEndpoint.html[RowCountEndpoint]
+HBase ships examples for Observer Coprocessor.
A more detailed example is given below.
http://git-wip-us.apache.org/repos/asf/hbase/blob/be519ca1/src/main/site/site.xml
----------------------------------------------------------------------
diff --git a/src/main/site/site.xml b/src/main/site/site.xml
index f423374..eeaaaab 100644
--- a/src/main/site/site.xml
+++ b/src/main/site/site.xml
@@ -97,8 +97,6 @@
<item name="User API (Test)" href="testapidocs/index.html" target="_blank" />
<item name="Developer API" href="devapidocs/index.html" target="_blank" />
<item name="Developer API (Test)" href="testdevapidocs/index.html" target="_blank" />
- <item name="X-Ref" href="xref/index.html" />
- <item name="X-Ref (Test)" href="xref-test/index.html" />
<item name="\u4e2d\u6587\u53c2\u8003\u6307\u5357(\u5355\u9875)" href="http://abloz.com/hbase/book.html" target="_blank" />
<item name="FAQ" href="book.html#faq" target="_blank" />
<item name="Videos/Presentations" href="book.html#other.info" target="_blank" />