Author: stack
Date: Fri Aug 8 22:19:16 2014
New Revision: 1616896
URL: http://svn.apache.org/r1616896
Log:
Update site
Added:
hbase/hbase.apache.org/trunk/apidocs/org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html
hbase/hbase.apache.org/trunk/apidocs/org/apache/hadoop/hbase/io/util/class-use/HeapMemorySizeUtil.html
hbase/hbase.apache.org/trunk/appendix_contributing_to_documentation.html
hbase/hbase.apache.org/trunk/book/apas05.html
hbase/hbase.apache.org/trunk/book/apas06.html
hbase/hbase.apache.org/trunk/book/apas07.html
hbase/hbase.apache.org/trunk/book/apas08.html
hbase/hbase.apache.org/trunk/book/apas09.html
hbase/hbase.apache.org/trunk/book/apcs03.html
hbase/hbase.apache.org/trunk/book/apcs04.html
hbase/hbase.apache.org/trunk/book/apds02.html
hbase/hbase.apache.org/trunk/book/ape.html
hbase/hbase.apache.org/trunk/book/apfs02.html
hbase/hbase.apache.org/trunk/book/apfs03.html
hbase/hbase.apache.org/trunk/book/apks02.html
hbase/hbase.apache.org/trunk/book/apks03.html
hbase/hbase.apache.org/trunk/book/apks04.html
hbase/hbase.apache.org/trunk/book/appendix_contributing_to_documentation.html
hbase/hbase.apache.org/trunk/book/ch01s14.html
hbase/hbase.apache.org/trunk/book/ch01s18.html
hbase/hbase.apache.org/trunk/book/ch15s14.html
hbase/hbase.apache.org/trunk/book/ch15s18.html
hbase/hbase.apache.org/trunk/book/ld-d2012e1089.html
hbase/hbase.apache.org/trunk/book/ld-d4029e17132.html
hbase/hbase.apache.org/trunk/book/ld-d4029e21286.html
hbase/hbase.apache.org/trunk/book/ld-d4029e21296.html
hbase/hbase.apache.org/trunk/book/ld-d4029e21311.html
hbase/hbase.apache.org/trunk/book/repos.html
hbase/hbase.apache.org/trunk/devapidocs/org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html
hbase/hbase.apache.org/trunk/devapidocs/org/apache/hadoop/hbase/io/util/class-use/HeapMemorySizeUtil.html
hbase/hbase.apache.org/trunk/ld-d2012e1089.html
hbase/hbase.apache.org/trunk/ld-d4029e17132.html
hbase/hbase.apache.org/trunk/ld-d4029e21286.html
hbase/hbase.apache.org/trunk/ld-d4029e21296.html
hbase/hbase.apache.org/trunk/ld-d4029e21311.html
hbase/hbase.apache.org/trunk/xref-test/org/apache/hadoop/hbase/io/hfile/bucket/TestBucketWriterThread.html
hbase/hbase.apache.org/trunk/xref-test/org/apache/hadoop/hbase/regionserver/wal/TestHLogReaderOnSecureHLog.html
hbase/hbase.apache.org/trunk/xref-test/org/apache/hadoop/hbase/security/visibility/TestVisibilityWithCheckAuths.html
hbase/hbase.apache.org/trunk/xref-test/org/apache/hadoop/hbase/security/visibility/VisibilityTestUtil.html
hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html
Added:
hbase/hbase.apache.org/trunk/apidocs/org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html
URL:
http://svn.apache.org/viewvc/hbase/hbase.apache.org/trunk/apidocs/org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html?rev=1616896&view=auto
==============================================================================
---
hbase/hbase.apache.org/trunk/apidocs/org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html
(added)
+++
hbase/hbase.apache.org/trunk/apidocs/org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html
Fri Aug 8 22:19:16 2014
@@ -0,0 +1,426 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_51) on Fri Aug 08 14:18:03 PDT 2014
-->
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>HeapMemorySizeUtil (HBase 2.0.0-SNAPSHOT API)</title>
+<meta name="date" content="2014-08-08">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css"
title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="HeapMemorySizeUtil (HBase 2.0.0-SNAPSHOT API)";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a
name="navbar_top_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/HeapMemorySizeUtil.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a
href="../../../../../../org/apache/hadoop/hbase/io/util/Dictionary.html"
title="interface in org.apache.hadoop.hbase.io.util"><span class="strong">Prev
Class</span></a></li>
+<li><a
href="../../../../../../org/apache/hadoop/hbase/io/util/LRUDictionary.html"
title="class in org.apache.hadoop.hbase.io.util"><span class="strong">Next
Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a
href="../../../../../../index.html?org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html"
target="_top">Frames</a></li>
+<li><a href="HeapMemorySizeUtil.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field_summary">Field</a> | </li>
+<li><a href="#constructor_summary">Constr</a> | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field_detail">Field</a> | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.hadoop.hbase.io.util</div>
+<h2 title="Class HeapMemorySizeUtil" class="title">Class
HeapMemorySizeUtil</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">java.lang.Object</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@InterfaceAudience.Private
+public class <span class="strong">HeapMemorySizeUtil</span>
+extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a></pre>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static float</code></td>
+<td class="colLast"><code><strong><a
href="../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html#DEFAULT_MEMSTORE_SIZE">DEFAULT_MEMSTORE_SIZE</a></strong></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static float</code></td>
+<td class="colLast"><code><strong><a
href="../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html#DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT">DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT</a></strong></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><strong><a
href="../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html#MEMSTORE_SIZE_KEY">MEMSTORE_SIZE_KEY</a></strong></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><strong><a
href="../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html#MEMSTORE_SIZE_LOWER_LIMIT_KEY">MEMSTORE_SIZE_LOWER_LIMIT_KEY</a></strong></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><strong><a
href="../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html#MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY">MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY</a></strong></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><strong><a
href="../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html#MEMSTORE_SIZE_OLD_KEY">MEMSTORE_SIZE_OLD_KEY</a></strong></code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a
href="../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html#HeapMemorySizeUtil()">HeapMemorySizeUtil</a></strong>()</code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><strong><a
href="../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html#checkForClusterFreeMemoryLimit(org.apache.hadoop.conf.Configuration)">checkForClusterFreeMemoryLimit</a></strong>(org.apache.hadoop.conf.Configuration conf)</code>
+<div class="block">Checks whether we have enough heap memory left out after
portion for Memstore and Block cache.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static float</code></td>
+<td class="colLast"><code><strong><a
href="../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html#getBlockCacheHeapPercent(org.apache.hadoop.conf.Configuration)">getBlockCacheHeapPercent</a></strong>(org.apache.hadoop.conf.Configuration conf)</code>
+<div class="block">Retrieve configured size for on heap block cache as
percentage of total heap.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static float</code></td>
+<td class="colLast"><code><strong><a
href="../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html#getGlobalMemStoreLowerMark(org.apache.hadoop.conf.Configuration,
float)">getGlobalMemStoreLowerMark</a></strong>(org.apache.hadoop.conf.Configuration c,
+ float globalMemStorePercent)</code>
+<div class="block">Retrieve configured size for global memstore lower water
mark as percentage of total heap.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static float</code></td>
+<td class="colLast"><code><strong><a
href="../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html#getGlobalMemStorePercent(org.apache.hadoop.conf.Configuration,
boolean)">getGlobalMemStorePercent</a></strong>(org.apache.hadoop.conf.Configuration c,
+ boolean logInvalid)</code>
+<div class="block">Retrieve global memstore configured size as percentage of
total heap.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a></h3>
+<code><a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()"
title="class or interface in java.lang">clone</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)"
title="class or interface in java.lang">equals</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()"
title="class or interface in java.lang">finalize</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()"
title="class or interface in java.lang">getClass</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()"
title="class or interface in java.lang">hashCode</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()"
title="class or interface in java.lang">notify</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang
/Object.html?is-external=true#notifyAll()" title="class or interface in
java.lang">notifyAll</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()"
title="class or interface in java.lang">toString</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()"
title="class or interface in java.lang">wait</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)"
title="class or interface in java.lang">wait</a>, <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,
int)" title="class or interface in java.lang">wait</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="MEMSTORE_SIZE_KEY">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>MEMSTORE_SIZE_KEY</h4>
+<pre>public static final <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> MEMSTORE_SIZE_KEY</pre>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil.MEMSTORE_SIZE_KEY">Constant
Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="MEMSTORE_SIZE_OLD_KEY">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>MEMSTORE_SIZE_OLD_KEY</h4>
+<pre>public static final <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> MEMSTORE_SIZE_OLD_KEY</pre>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil.MEMSTORE_SIZE_OLD_KEY">Constant
Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="MEMSTORE_SIZE_LOWER_LIMIT_KEY">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>MEMSTORE_SIZE_LOWER_LIMIT_KEY</h4>
+<pre>public static final <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>
MEMSTORE_SIZE_LOWER_LIMIT_KEY</pre>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil.MEMSTORE_SIZE_LOWER_LIMIT_KEY">Constant
Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY</h4>
+<pre>public static final <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>
MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY</pre>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil.MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY">Constant
Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="DEFAULT_MEMSTORE_SIZE">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>DEFAULT_MEMSTORE_SIZE</h4>
+<pre>public static final float DEFAULT_MEMSTORE_SIZE</pre>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil.DEFAULT_MEMSTORE_SIZE">Constant
Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT</h4>
+<pre>public static final float DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT</pre>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil.DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT">Constant
Field Values</a></dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="HeapMemorySizeUtil()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>HeapMemorySizeUtil</h4>
+<pre>public HeapMemorySizeUtil()</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="checkForClusterFreeMemoryLimit(org.apache.hadoop.conf.Configuration)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>checkForClusterFreeMemoryLimit</h4>
+<pre>public
static void checkForClusterFreeMemoryLimit(org.apache.hadoop.conf.Configuration conf)</pre>
+<div class="block">Checks whether we have enough heap memory left out after
portion for Memstore and Block cache.
+ We need atleast 20% of heap left out for other RS functions.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> -
</dd></dl>
+</li>
+</ul>
+<a name="getGlobalMemStorePercent(org.apache.hadoop.conf.Configuration,
boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getGlobalMemStorePercent</h4>
+<pre>public
static float getGlobalMemStorePercent(org.apache.hadoop.conf.Configuration c,
+ boolean logInvalid)</pre>
+<div class="block">Retrieve global memstore configured size as percentage of
total heap.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> -
</dd><dd><code>logInvalid</code> - </dd></dl>
+</li>
+</ul>
+<a name="getGlobalMemStoreLowerMark(org.apache.hadoop.conf.Configuration,
float)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getGlobalMemStoreLowerMark</h4>
+<pre>public
static float getGlobalMemStoreLowerMark(org.apache.hadoop.conf.Configuration c,
+ float globalMemStorePercent)</pre>
+<div class="block">Retrieve configured size for global memstore lower water
mark as percentage of total heap.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> -
</dd><dd><code>globalMemStorePercent</code> - </dd></dl>
+</li>
+</ul>
+<a name="getBlockCacheHeapPercent(org.apache.hadoop.conf.Configuration)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getBlockCacheHeapPercent</h4>
+<pre>public
static float getBlockCacheHeapPercent(org.apache.hadoop.conf.Configuration conf)</pre>
+<div class="block">Retrieve configured size for on heap block cache as
percentage of total heap.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> -
</dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!-- -->
+</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a
name="navbar_bottom_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/HeapMemorySizeUtil.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a
href="../../../../../../org/apache/hadoop/hbase/io/util/Dictionary.html"
title="interface in org.apache.hadoop.hbase.io.util"><span class="strong">Prev
Class</span></a></li>
+<li><a
href="../../../../../../org/apache/hadoop/hbase/io/util/LRUDictionary.html"
title="class in org.apache.hadoop.hbase.io.util"><span class="strong">Next
Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a
href="../../../../../../index.html?org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html"
target="_top">Frames</a></li>
+<li><a href="HeapMemorySizeUtil.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field_summary">Field</a> | </li>
+<li><a href="#constructor_summary">Constr</a> | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field_detail">Field</a> | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright © 2014 <a
href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights
Reserved.</small></p>
+</body>
+</html>
Added:
hbase/hbase.apache.org/trunk/apidocs/org/apache/hadoop/hbase/io/util/class-use/HeapMemorySizeUtil.html
URL:
http://svn.apache.org/viewvc/hbase/hbase.apache.org/trunk/apidocs/org/apache/hadoop/hbase/io/util/class-use/HeapMemorySizeUtil.html?rev=1616896&view=auto
==============================================================================
---
hbase/hbase.apache.org/trunk/apidocs/org/apache/hadoop/hbase/io/util/class-use/HeapMemorySizeUtil.html
(added)
+++
hbase/hbase.apache.org/trunk/apidocs/org/apache/hadoop/hbase/io/util/class-use/HeapMemorySizeUtil.html
Fri Aug 8 22:19:16 2014
@@ -0,0 +1,117 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_51) on Fri Aug 08 14:22:35 PDT 2014
-->
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>Uses of Class org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil (HBase
2.0.0-SNAPSHOT API)</title>
+<meta name="date" content="2014-08-08">
+<link rel="stylesheet" type="text/css"
href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Uses of Class
org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil (HBase 2.0.0-SNAPSHOT API)";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a
name="navbar_top_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="../package-summary.html">Package</a></li>
+<li><a
href="../../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html"
title="class in org.apache.hadoop.hbase.io.util">Class</a></li>
+<li class="navBarCell1Rev">Use</li>
+<li><a href="../package-tree.html">Tree</a></li>
+<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a
href="../../../../../../../index.html?org/apache/hadoop/hbase/io/util/class-use/HeapMemorySizeUtil.html"
target="_top">Frames</a></li>
+<li><a href="HeapMemorySizeUtil.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h2 title="Uses of Class org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil"
class="title">Uses of
Class<br>org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil</h2>
+</div>
+<div class="classUseContainer">No usage of
org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil</div>
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!-- -->
+</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a
name="navbar_bottom_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="../package-summary.html">Package</a></li>
+<li><a
href="../../../../../../../org/apache/hadoop/hbase/io/util/HeapMemorySizeUtil.html"
title="class in org.apache.hadoop.hbase.io.util">Class</a></li>
+<li class="navBarCell1Rev">Use</li>
+<li><a href="../package-tree.html">Tree</a></li>
+<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a
href="../../../../../../../index.html?org/apache/hadoop/hbase/io/util/class-use/HeapMemorySizeUtil.html"
target="_top">Frames</a></li>
+<li><a href="HeapMemorySizeUtil.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright © 2014 <a
href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights
Reserved.</small></p>
+</body>
+</html>
Added: hbase/hbase.apache.org/trunk/appendix_contributing_to_documentation.html
URL:
http://svn.apache.org/viewvc/hbase/hbase.apache.org/trunk/appendix_contributing_to_documentation.html?rev=1616896&view=auto
==============================================================================
--- hbase/hbase.apache.org/trunk/appendix_contributing_to_documentation.html
(added)
+++ hbase/hbase.apache.org/trunk/appendix_contributing_to_documentation.html
Fri Aug 8 22:19:16 2014
@@ -0,0 +1,199 @@
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>Appendix A. Contributing to Documentation</title><link
rel="stylesheet" type="text/css"
href="${baserdir}/src/main/site/resources/css/freebsd_docbook.css"><meta
name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body
bgcolor="white" text="black" link="#0000FF" vlink="#840084"
alink="#0000FF"><script type="text/javascript">
+ var disqus_shortname = 'hbase'; // required: replace example with your
forum shortname
+ var disqus_url =
'http://hbase.apache.org/book/appendix_contributing_to_documentation.html';
+ </script><div class="appendix"><div class="titlepage"><div><div><h2
class="title"><a
name="appendix_contributing_to_documentation"></a>Appendix A. Contributing
to Documentation</h2></div></div></div><div class="toc"><p><b>Table of
Contents</b></p><dl class="toc"><dt><span class="section"><a
href="#d9580e47">A.1. Getting Access to the Wiki</a></span></dt><dt><span
class="section"><a href="#d9580e55">A.2. Contributing to Documentation or Other
Strings</a></span></dt><dt><span class="section"><a href="#d9580e126">A.3.
Editing the HBase Website</a></span></dt><dt><span class="section"><a
href="#d9580e155">A.4. Editing the HBase Reference
Guide</a></span></dt><dt><span class="section"><a href="#d9580e174">A.5.
Auto-Generated Content</a></span></dt><dt><span class="section"><a
href="#d9580e189">A.6. Multi-Page and Single-Page
Output</a></span></dt><dt><span class="section"><a href="#d9580e212">A.7.
Images in the HBase Reference Guide</a></span></dt><dt><span class="section">
<a href="#d9580e228">A.8. Adding a New Chapter to the HBase Reference
Guide</a></span></dt><dt><span class="section"><a href="#d9580e239">A.9.
Docbook Common Issues</a></span></dt></dl></div><p>The Apache HBase project
welcomes contributions to all aspects of the project, including
+ the documentation. In HBase, documentation includes the following
areas, and probably some
+ others:</p><div class="itemizedlist"><ul class="itemizedlist"
style="list-style-type: disc; "><li class="listitem"><p>The <a class="link"
href="http://hbase.apache.org/book.html"; target="_top">HBase Reference
+ Guide</a> (this book)</p></li><li class="listitem"><p>The
<a class="link" href="http://hbase.apache.org/"; target="_top">HBase
website</a>e</p></li><li class="listitem"><p>The <a class="link"
href="http://wiki.apache.org/hadoop/Hbase"; target="_top">HBase
+ Wiki</a></p></li><li class="listitem"><p>API
documentation</p></li><li class="listitem"><p>Command-line utility output and
help text</p></li><li class="listitem"><p>Web UI strings, explicit help text,
context-sensitive strings, and others</p></li><li class="listitem"><p>Log
messages</p></li><li class="listitem"><p>Comments in source files,
configuration files, and others</p></li><li class="listitem"><p>Localization of
any of the above into target languages other than
English</p></li></ul></div><p>No matter which area you want to help out with,
the first step is almost always to
+ download (typically by cloning the Git repository) and familiarize
yourself with the HBase
+ source code. The only exception in the list above is the HBase Wiki,
which is edited online.
+ For information on downloading and building the source, see <a
class="xref" href="#">???</a>.</p><div class="section"><div
class="titlepage"><div><div><h2 class="title" style="clear: both"><a
name="d9580e47"></a>A.1. Getting Access to the
Wiki</h2></div></div></div><p>The HBase Wiki is not well-maintained and much of
its content has been moved into the
+ HBase Reference Guide (this guide). However, some pages on the
Wiki are well maintained,
+ and it would be great to have some volunteers willing to help out
with the Wiki. To
+ request access to the Wiki, register a new account at <a
class="link" href="https://wiki.apache.org/hadoop/Hbase?action=newaccount";
target="_top">https://wiki.apache.org/hadoop/Hbase?action=newaccount</a>.
Contact one of the
+ HBase committers, who can either give you access or refer you to
someone who can.</p></div><div class="section"><div
class="titlepage"><div><div><h2 class="title" style="clear: both"><a
name="d9580e55"></a>A.2. Contributing to Documentation or Other
Strings</h2></div></div></div><p> If you spot an error in a string in a UI,
utility, script, log message, or elsewhere,
+ or you think something could be made more clear, or you think text
needs to be added
+ where it doesn't currently exist, the first step is to file a
JIRA. Be sure to set the
+ component to <code class="literal">Documentation</code> in
addition any other involved components.
+ Most components have one or more default owners, who monitor new
issues which come into
+ those queues. Regardless of whether you feel able to fix the bug,
you should still file
+ bugs where you see them.</p><p>If you want to try your hand at
fixing your newly-filed bug, assign it to yourself.
+ You will need to clone the HBase Git repository to your local
system and work on the
+ issue there. When you have developed a potential fix, submit it
for review. If it
+ addresses the issue and is seen as an improvement, one of the
HBase committers will
+ commit it to one or more branches, as appropriate.</p><div
class="procedure"><a name="submit_doc_patch_procedure"></a><p
class="title"><b>Procedure A.1. Suggested Work flow for Submitting
Patches</b></p><p>This procedure goes into more detail than Git pros will need,
but is included in
+ this appendix so that people unfamiliar with Git can feel
confident contributing to
+ HBase while they learn.</p><ol class="procedure" type="1"><li
class="step"><p>If you have not already done so, clone the Git repository
locally. You only
+ need to do this once.</p></li><li class="step"><p>Fairly
often, pull remote changes into your local repository by using the
+ <code class="code">git pull</code> command, while your
master branch is checked
+ out.</p></li><li class="step"><p>For each issue you work
on, create a new branch. One convention that works
+ well for naming the branches is to name a given branch the
same as the JIRA it
+ relates to:</p><pre class="screen">$ git checkout -b
HBASE-<span class="hl-number">123456</span></pre></li><li class="step"><p>Make
your suggested changes on your branch, committing your changes to your
+ local repository often. If you need to switch to working
on a different issue,
+ remember to check out the appropriate branch.</p></li><li
class="step"><p>When you are ready to submit your patch, first be sure that
HBase builds
+ cleanly and behaves as expected in your modified branch.
If you have made
+ documentation changes, be sure the documentation and
website builds.</p><div class="note" style="margin-left: 0.5in; margin-right:
0.5in;"><h3 class="title">Note</h3><p>Before you use the <code
class="literal">site</code> target the very first time, be
+ sure you have built HBase at least once, in order to
fetch all the Maven
+ dependencies you need.</p></div><pre class="screen">$
mvn clean install -DskipTests <em class="hl-comment"
style="color: silver"># Builds HBase</em></pre><pre class="screen">$ mvn clean
site -DskipTests <em class="hl-comment" style="color:
silver"># Builds the website and documentation</em></pre><p>If any errors
occur, address them.</p></li><li class="step"><p>If it takes you several days
or weeks to implement your fix, or you know that
+ the area of the code you are working in has had a lot of
changes lately, make
+ sure you rebase your branch against the remote master and
take care of any
+ conflicts before submitting your patch.</p><pre
class="screen">
+$ git checkout HBASE-<span class="hl-number">123456</span>
+$ git rebase origin/master
+ </pre></li><li class="step"><p>Generate your patch against the
remote master. Run the following command from
+ the top level of your git repository (usually called
+ <code class="literal">hbase</code>):</p><pre
class="screen">$ git diff --no-prefix origin/master > HBASE-<span
class="hl-number">123456.</span>patch</pre><p>The name of the patch should
contain the JIRA ID. Look over the patch file to
+ be sure that you did not change any additional files by
accident and that there
+ are no other surprises. When you are satisfied, attach the
patch to the JIRA and
+ click the <span class="guibutton">Patch Available</span>
button. A reviewer
+ will review your patch. If you need to submit a new
version of the patch, leave
+ the old one on the JIRA and add a version number to the
name of the new
+ patch.</p></li><li class="step"><p>After a change has been
committed, there is no need to keep your local branch
+ around. Instead you should run <span
class="command"><strong>git pull</strong></span> to get the new change
+ into your master branch.</p></li></ol></div></div><div
class="section"><div class="titlepage"><div><div><h2 class="title"
style="clear: both"><a name="d9580e126"></a>A.3. Editing the HBase
Website</h2></div></div></div><p>The source for the HBase website is in the
HBase source, in the
+ <code class="filename">src/main/site/</code> directory. Within
this directory, source for the
+ individual pages is in the <code class="filename">xdocs/</code>
directory, and images referenced
+ in those pages are in the <code class="filename">images/</code>
directory. This directory also
+ stores images used in the HBase Reference Guide.</p><p>The
website's pages are written in an HTML-like XML dialect called xdoc, which has a
+ reference guide at <a class="link"
href="http://maven.apache.org/archives/maven-1.x/plugins/xdoc/reference/xdocs.html";
target="_top">http://maven.apache.org/archives/maven-1.x/plugins/xdoc/reference/xdocs.html</a>.
+ You can edit these files in a plain-text editor, an IDE, or an XML
editor such as
+ XML Mind XML Editor (XXE) or Oxygen XML Author. </p><p>To preview
your changes, build the website using the <span class="command"><strong>mvn
clean site
+ -DskipTests</strong></span> command. The HTML output resides
in the
+ <code class="filename">target/site/</code> directory. When you
are satisfied with your
+ changes, follow the procedure in <a class="xref"
href="#submit_doc_patch_procedure" title="Procedure A.1. Suggested
Work flow for Submitting Patches">Procedure A.1, “Suggested Work
flow for Submitting Patches”</a> to submit
+ your patch.</p></div><div class="section"><div
class="titlepage"><div><div><h2 class="title" style="clear: both"><a
name="d9580e155"></a>A.4. Editing the HBase Reference
Guide</h2></div></div></div><p>The source for the HBase Reference Guide is in
the HBase source, in the
+ <code class="filename">src/main/docbkx/</code> directory. It
is written in <a class="link" href="http://www.docbook.org/";
target="_top">Docbook</a> XML. Docbook can be
+ intimidating, but you can typically follow the formatting of the
surrounding file to get
+ an idea of the mark-up. You can edit Docbook XML files using a
plain-text editor, an
+ XML-aware IDE, or a specialized XML editor.</p><p>Docbook's syntax
can be picky. Before submitting a patch, be sure to build the output
+ locally using the <span class="command"><strong>mvn
site</strong></span> command. If you do not get any build
+ errors, that means that the XML is well-formed, which means that
each opening tag is
+ balanced by a closing tag. Well-formedness is not exactly the same
as validity. Check
+ the output in <code class="filename">target/docbkx/</code> for any
surprises before submitting a
+ patch.</p></div><div class="section"><div
class="titlepage"><div><div><h2 class="title" style="clear: both"><a
name="d9580e174"></a>A.5. Auto-Generated
Content</h2></div></div></div><p>Some parts of the HBase Reference Guide, most
notably <a class="xref" href="#">???</a>,
+ are generated automatically, so that this area of the
documentation stays in sync with
+ the code. This is done by means of an XSLT transform, which you
can examine in the
+ source at <code
class="filename">src/main/xslt/configuration_to_docbook_section.xsl</code>. This
+ transforms the <code
class="filename">hbase-common/src/main/resources/hbase-default.xml</code>
+ file into a Docbook output which can be included in the Reference
Guide. Sometimes, it
+ is necessary to add configuration parameters or modify their
descriptions. Make the
+ modifications to the source file, and they will be included in the
Reference Guide when
+ it is rebuilt.</p><p>It is possible that other types of content
can and will be automatically generated
+ from HBase source files in the future.</p></div><div
class="section"><div class="titlepage"><div><div><h2 class="title"
style="clear: both"><a name="d9580e189"></a>A.6. Multi-Page and
Single-Page Output</h2></div></div></div><p>You can examine the <code
class="literal">site</code> target in the Maven
+ <code class="filename">pom.xml</code> file included at the top
level of the HBase source for
+ details on the process of building the website and documentation.
The Reference Guide is
+ built twice, once as a single-page output and once with one HTML
file per chapter. The
+ single-page output is located in <code
class="filename">target/docbkx/book.html</code>, while the
+ multi-page output's index page is at <code
class="filename">target/docbkx/book/book.html</code>.
+ Each of these outputs has its own <code
class="filename">images/</code> and
+ <code class="filename">css/</code> directories, which are
created at build time.</p></div><div class="section"><div
class="titlepage"><div><div><h2 class="title" style="clear: both"><a
name="d9580e212"></a>A.7. Images in the HBase Reference
Guide</h2></div></div></div><p>You can include images in the HBase Reference
Guide. For accessibility reasons, it is
+ recommended that you use a <figure> Docbook element for an
image. This allows
+ screen readers to navigate to the image and also provides
alternative text for the
+ image. The following is an example of a <figure>
element.</p><pre class="programlisting"><strong class="hl-tag" style="color:
#000096"><figure></strong>
+ <strong class="hl-tag" style="color: #000096"><title></strong>HFile
Version 1<strong class="hl-tag" style="color: #000096"></title></strong>
+ <strong class="hl-tag" style="color: #000096"><mediaobject></strong>
+ <strong class="hl-tag" style="color: #000096"><imageobject></strong>
+ <strong class="hl-tag" style="color: #000096"><imagedata</strong>
<span class="hl-attribute" style="color: #F5844C">fileref</span>=<span
class="hl-value" style="color:
#993300">"timeline_consistency.png"</span><strong class="hl-tag" style="color:
#000096"> /></strong>
+ <strong class="hl-tag" style="color: #000096"></imageobject></strong>
+ <strong class="hl-tag" style="color: #000096"><textobject></strong>
+ <strong class="hl-tag" style="color:
#000096"><phrase></strong>HFile Version 1<strong class="hl-tag"
style="color: #000096"></phrase></strong>
+ <strong class="hl-tag" style="color: #000096"></textobject></strong>
+ <strong class="hl-tag" style="color: #000096"></mediaobject></strong>
+<strong class="hl-tag" style="color: #000096"></figure></strong>
+ </pre><p>The <textobject> can contain a few sentences describing
the image, rather than
+ simply reiterating the title. You can optionally specify alignment
and size options in
+ the <imagedata> element.</p><p>When doing a local build,
save the image to the
+ <code class="filename">src/main/site/resources/images/</code>
directory. In the
+ <imagedata> element, refer to the image as above, with no
directory component. The
+ image will be copied to the appropriate target location during the
build of the
+ output.</p><p>When you submit a patch which includes adding an
image to the HBase Reference Guide,
+ attach the image to the JIRA. If the committer asks where the
image should be committed,
+ it should go into the above directory.</p></div><div
class="section"><div class="titlepage"><div><div><h2 class="title"
style="clear: both"><a name="d9580e228"></a>A.8. Adding a New Chapter to
the HBase Reference Guide</h2></div></div></div><p>If you want to add a new
chapter to the HBase Reference Guide, the easiest way is to
+ copy an existing chapter file, rename it, and change the ID and
title elements near the
+ top of the file. Delete the existing content and create the new
content. Then open the
+ <code class="filename">book.xml</code> file, which is the main
file for the HBase Reference
+ Guide, and use an <xi:include> element to include your new
chapter in the
+ appropriate location. Be sure to add your new file to your Git
repository before
+ creating your patch. Note that the <code
class="filename">book.xml</code> file currently contains
+ many chapters. You can only include a chapter at the same nesting
levels as the other
+ chapters in the file. When in doubt, check to see how other files
have been
+ included.</p></div><div class="section"><div
class="titlepage"><div><div><h2 class="title" style="clear: both"><a
name="d9580e239"></a>A.9. Docbook Common
Issues</h2></div></div></div><p>The following Docbook issues come up often.
Some of these are preferences, but others
+ can create mysterious build errors or other problems.</p><div
class="qandaset"><a name="d9580e244"></a><dl><dt>A.9.1. <a
href="#d9580e245">What can go where?</a></dt><dt>A.9.2. <a
href="#d9580e255">Paragraphs and Admonitions</a></dt><dt>A.9.3. <a
href="#d9580e264">Wrap textual <listitem> and <entry> contents in
<para>
+ elements.</a></dt><dt>A.9.4. <a href="#d9580e273">When
to use <command>, <code>, <programlisting>,
+ <screen></a></dt><dt>A.9.5. <a
href="#d9580e290">How to escape XML elements so that they show up as
XML</a></dt><dt>A.9.6. <a href="#d9580e297">Tips and tricks for making screen
output look good</a></dt><dt>A.9.7. <a href="#d9580e316">Isolate Changes for
Easy Diff Review.</a></dt><dt>A.9.8. <a href="#d9580e323">Syntax
Highlighting</a></dt></dl><table border="0" style="width: 100%;"><colgroup><col
align="left" width="1%"><col></colgroup><tbody><tr class="question"><td
align="left" valign="top"><a name="d9580e245"></a><a
name="d9580e246"></a><p><b>A.9.1.</b></p></td><td align="left"
valign="top"><p>What can go where?</p></td></tr><tr class="answer"><td
align="left" valign="top"></td><td align="left" valign="top"><p>There is often
confusion about which child elements are valid in a given
+ context. When in doubt, <a class="link"
href="http://docbook.org/tdg/en/html/docbook.html"; target="_top">Docbook: The
+ Definitive Guide</a> is the best resource. It has
an appendix which
+ is indexed by element and contains all valid child and
parent elements of
+ any given element. If you edit Docbook often, a
schema-aware XML editor
+ makes things easier.</p></td></tr><tr
class="question"><td align="left" valign="top"><a name="d9580e255"></a><a
name="d9580e256"></a><p><b>A.9.2.</b></p></td><td align="left"
valign="top"><p>Paragraphs and Admonitions</p></td></tr><tr class="answer"><td
align="left" valign="top"></td><td align="left" valign="top"><p>It is a common
pattern, and it is technically valid, to put an admonition
+ such as a <note> inside a <para> element.
Because admonitions
+ render as block-level elements (they take the whole
width of the page), it
+ is better to mark them up as siblings to the
paragraphs around them, like
+ this:</p><pre class="programlisting"><strong
class="hl-tag" style="color: #000096"><para></strong>This is the
paragraph.<strong class="hl-tag" style="color: #000096"></para></strong>
+<strong class="hl-tag" style="color: #000096"><note></strong>
+ <strong class="hl-tag" style="color: #000096"><para></strong>This is
an admonition which occurs after the paragraph.<strong class="hl-tag"
style="color: #000096"></para></strong>
+<strong class="hl-tag" style="color:
#000096"></note></strong></pre></td></tr><tr class="question"><td
align="left" valign="top"><a name="d9580e264"></a><a
name="d9580e265"></a><p><b>A.9.3.</b></p></td><td align="left"
valign="top"><p>Wrap textual <listitem> and <entry> contents in
<para>
+ elements.</p></td></tr><tr class="answer"><td
align="left" valign="top"></td><td align="left" valign="top"><p>Because the
contents of a <listitem> (an element in an itemized,
+ ordered, or variable list) or an <entry> (a cell
in a table) can
+ consist of things other than plain text, they need to
be wrapped in some
+ element. If they are plain text, they need to be
inclosed in <para>
+ tags. This is tedious but necessary for
validity.</p><pre class="programlisting"><strong class="hl-tag" style="color:
#000096"><itemizedlist></strong>
+ <strong class="hl-tag" style="color: #000096"><listitem></strong>
+ <strong class="hl-tag" style="color:
#000096"><para></strong>This is a paragraph.<strong class="hl-tag"
style="color: #000096"></para></strong>
+ <strong class="hl-tag" style="color: #000096"></listitem></strong>
+ <strong class="hl-tag" style="color: #000096"><listitem></strong>
+ <strong class="hl-tag" style="color:
#000096"><screen></strong>This is screen output.<strong class="hl-tag"
style="color: #000096"></screen></strong>
+ <strong class="hl-tag" style="color: #000096"></listitem></strong>
+<strong class="hl-tag" style="color:
#000096"></itemizedlist></strong></pre></td></tr><tr class="question"><td
align="left" valign="top"><a name="d9580e273"></a><a
name="d9580e274"></a><p><b>A.9.4.</b></p></td><td align="left"
valign="top"><p>When to use <command>, <code>,
<programlisting>,
+ <screen></p></td></tr><tr class="answer"><td
align="left" valign="top"></td><td align="left" valign="top"><p>The first two
are in-line tags, which can occur within the flow of
+ paragraphs or titles. The second two are block
elements.</p><p>Use <command> to mention a command such as <span
class="command"><strong>hbase
+ shell</strong></span> in the flow of a sentence.
Use <code> for other
+ inline text referring to code. Incidentally, use
<literal> to specify
+ literal strings that should be typed or entered
exactly as shown. Within a
+ <screen> listing, it can be helpful to use the
<userinput> and
+ <computeroutput> elements to mark up the text
further.</p><p>Use <screen> to display input and output as the user would
+ <span class="emphasis"><em>see</em></span> it on
the screen, in a log file, etc. Use
+ <programlisting> only for blocks of code that
occur within a file,
+ such as Java or XML code, or a Bash shell
script.</p></td></tr><tr class="question"><td align="left" valign="top"><a
name="d9580e290"></a><a name="d9580e291"></a><p><b>A.9.5.</b></p></td><td
align="left" valign="top"><p>How to escape XML elements so that they show up as
XML</p></td></tr><tr class="answer"><td align="left" valign="top"></td><td
align="left" valign="top"><p>For one-off instances or short in-line mentions,
use the &lt; and
+ &gt; encoded characters. For longer mentions, or
blocks of code, enclose
+ it with &lt;![CDATA[]]&gt;, which is much
easier to maintain and
+ parse in the source files..</p></td></tr><tr
class="question"><td align="left" valign="top"><a name="d9580e297"></a><a
name="d9580e298"></a><p><b>A.9.6.</b></p></td><td align="left"
valign="top"><p>Tips and tricks for making screen output look
good</p></td></tr><tr class="answer"><td align="left" valign="top"></td><td
align="left" valign="top"><p>Text within <screen> and
<programlisting> elements is shown
+ exactly as it appears in the source, including
indentation, tabs, and line
+ wrap.</p><div class="itemizedlist"><ul
class="itemizedlist" style="list-style-type: disc; "><li
class="listitem"><p>Indent the starting and closing XML elements, but do not
indent
+ the content. Also, to avoid having an extra
blank line at the
+ beginning of the programlisting output, do not
put the CDATA
+ element on its own line. For example:</p><pre
class="programlisting"> <programlisting>
+<strong class="hl-keyword">case</strong> $<span class="hl-number">1</span> in
+ --cleanZk|--cleanHdfs|--cleanAll)
+ matches=<strong class="hl-string"><em
style="color:red">"yes"</em></strong> ;;
+ *) ;;
+<strong class="hl-keyword">esac</strong>
+ </programlisting></pre></li><li class="listitem"><p>After
pasting code into a programlisting, fix the indentation
+ manually, using two <span
class="emphasis"><em>spaces</em></span> per desired
+ indentation. For screen output, be sure to
include line breaks so
+ that the text is no longer than 100
characters.</p></li></ul></div></td></tr><tr class="question"><td align="left"
valign="top"><a name="d9580e316"></a><a
name="d9580e317"></a><p><b>A.9.7.</b></p></td><td align="left"
valign="top"><p>Isolate Changes for Easy Diff Review.</p></td></tr><tr
class="answer"><td align="left" valign="top"></td><td align="left"
valign="top"><p>Be careful with pretty-printing or re-formatting an entire XML
file, even
+ if the formatting has degraded over time. If you need
to reformat a file, do
+ that in a separate JIRA where you do not change any
content. Be careful
+ because some XML editors do a bulk-reformat when you
open a new file,
+ especially if you use GUI mode in the
editor.</p></td></tr><tr class="question"><td align="left" valign="top"><a
name="d9580e323"></a><a name="d9580e324"></a><p><b>A.9.8.</b></p></td><td
align="left" valign="top"><p>Syntax Highlighting</p></td></tr><tr
class="answer"><td align="left" valign="top"></td><td align="left"
valign="top"><p>The HBase Reference Guide uses the <a class="link"
href="http://sourceforge.net/projects/xslthl/files/xslthl/2.1.0/";
target="_top">XSLT Syntax Highlighting</a> Maven module for syntax highlighting.
+ To enable syntax highlighting for a given
<programlisting> or
+ <screen> (or possibly other elements), add the
attribute
+ <code class="literal">language=<em
class="replaceable"><code>LANGUAGE_OF_CHOICE</code></em></code>
+ to the element, as in the following example:</p><pre
class="programlisting">
+<strong class="hl-tag" style="color: #000096"><programlisting</strong>
<span class="hl-attribute" style="color: #F5844C">language</span>=<span
class="hl-value" style="color: #993300">"xml"</span><strong class="hl-tag"
style="color: #000096">></strong>
+ <strong class="hl-tag" style="color:
#000096"><foo></strong>bar<strong class="hl-tag" style="color:
#000096"></foo></strong>
+ <strong class="hl-tag" style="color:
#000096"><bar></strong>foo<strong class="hl-tag" style="color:
#000096"></bar></strong>
+<strong class="hl-tag" style="color:
#000096"></programlisting></strong></pre><p>Several syntax types are
supported. The most interesting ones for the
+ HBase Reference Guide are <code
class="literal">java</code>, <code class="literal">xml</code>,
+ <code class="literal">sql</code>, and <code
class="literal">bourne</code> (for BASH shell
+ output or Linux command-line
examples).</p></td></tr></tbody></table></div></div></div><div
id="disqus_thread"></div><script type="text/javascript">
+ /* * * DON'T EDIT BELOW THIS LINE * * */
+ (function() {
+ var dsq = document.createElement('script'); dsq.type =
'text/javascript'; dsq.async = true;
+ dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
+ (document.getElementsByTagName('head')[0] ||
document.getElementsByTagName('body')[0]).appendChild(dsq);
+ })();
+</script><noscript>Please enable JavaScript to view the <a
href="http://disqus.com/?ref_noscript";>comments powered by
Disqus.</a></noscript><a href="http://disqus.com"; class="dsq-brlink">comments
powered by <span class="logo-disqus">Disqus</span></a></body></html>
\ No newline at end of file
Added: hbase/hbase.apache.org/trunk/book/apas05.html
URL:
http://svn.apache.org/viewvc/hbase/hbase.apache.org/trunk/book/apas05.html?rev=1616896&view=auto
==============================================================================
--- hbase/hbase.apache.org/trunk/book/apas05.html (added)
+++ hbase/hbase.apache.org/trunk/book/apas05.html Fri Aug 8 22:19:16 2014
@@ -0,0 +1,22 @@
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>A.5. Auto-Generated Content</title><link rel="stylesheet"
type="text/css"
href="${baserdir}/src/main/site/resources/css/freebsd_docbook.css"><meta
name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home"
href="appendix_contributing_to_documentation.html"
title="Appendix A. Contributing to Documentation"><link rel="up"
href="appendix_contributing_to_documentation.html"
title="Appendix A. Contributing to Documentation"><link rel="prev"
href="apas04.html" title="A.4. Editing the HBase Reference Guide"><link
rel="next" href="apas06.html" title="A.6. Multi-Page and Single-Page
Output"></head><body bgcolor="white" text="black" link="#0000FF"
vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">A.5. Auto-Generated Content</th></tr><tr><td width="20%"
align="left"><a accesskey="p" href="apas04.html">Prev</a> </td><th
width="60%" align
="center"> </th><td width="20%" align="right"> <a accesskey="n"
href="apas06.html">Next</a></td></tr></table><hr></div><script
type="text/javascript">
+ var disqus_shortname = 'hbase'; // required: replace example with your
forum shortname
+ var disqus_url = 'http://hbase.apache.org/book/.html';
+ </script><div class="section"><div class="titlepage"><div><div><h2
class="title" style="clear: both"><a
name="d9580e174"></a>A.5. Auto-Generated
Content</h2></div></div></div><p>Some parts of the HBase Reference Guide, most
notably <a class="xref" href="">???</a>,
+ are generated automatically, so that this area of the
documentation stays in sync with
+ the code. This is done by means of an XSLT transform, which you
can examine in the
+ source at <code
class="filename">src/main/xslt/configuration_to_docbook_section.xsl</code>. This
+ transforms the <code
class="filename">hbase-common/src/main/resources/hbase-default.xml</code>
+ file into a Docbook output which can be included in the Reference
Guide. Sometimes, it
+ is necessary to add configuration parameters or modify their
descriptions. Make the
+ modifications to the source file, and they will be included in the
Reference Guide when
+ it is rebuilt.</p><p>It is possible that other types of content
can and will be automatically generated
+ from HBase source files in the future.</p></div><div
id="disqus_thread"></div><script type="text/javascript">
+ /* * * DON'T EDIT BELOW THIS LINE * * */
+ (function() {
+ var dsq = document.createElement('script'); dsq.type =
'text/javascript'; dsq.async = true;
+ dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
+ (document.getElementsByTagName('head')[0] ||
document.getElementsByTagName('body')[0]).appendChild(dsq);
+ })();
+</script><noscript>Please enable JavaScript to view the <a
href="http://disqus.com/?ref_noscript";>comments powered by
Disqus.</a></noscript><a href="http://disqus.com"; class="dsq-brlink">comments
powered by <span class="logo-disqus">Disqus</span></a><div
class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td
width="40%" align="left"><a accesskey="p"
href="apas04.html">Prev</a> </td><td width="20%"
align="center"> </td><td width="40%" align="right"> <a accesskey="n"
href="apas06.html">Next</a></td></tr><tr><td width="40%" align="left"
valign="top">A.4. Editing the HBase Reference Guide </td><td
width="20%" align="center"><a accesskey="h"
href="appendix_contributing_to_documentation.html">Home</a></td><td width="40%"
align="right" valign="top"> A.6. Multi-Page and Single-Page
Output</td></tr></table></div></body></html>
\ No newline at end of file
Added: hbase/hbase.apache.org/trunk/book/apas06.html
URL:
http://svn.apache.org/viewvc/hbase/hbase.apache.org/trunk/book/apas06.html?rev=1616896&view=auto
==============================================================================
--- hbase/hbase.apache.org/trunk/book/apas06.html (added)
+++ hbase/hbase.apache.org/trunk/book/apas06.html Fri Aug 8 22:19:16 2014
@@ -0,0 +1,20 @@
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>A.6. Multi-Page and Single-Page Output</title><link
rel="stylesheet" type="text/css"
href="${baserdir}/src/main/site/resources/css/freebsd_docbook.css"><meta
name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home"
href="appendix_contributing_to_documentation.html"
title="Appendix A. Contributing to Documentation"><link rel="up"
href="appendix_contributing_to_documentation.html"
title="Appendix A. Contributing to Documentation"><link rel="prev"
href="apas05.html" title="A.5. Auto-Generated Content"><link rel="next"
href="apas07.html" title="A.7. Images in the HBase Reference
Guide"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084"
alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation
header"><tr><th colspan="3" align="center">A.6. Multi-Page and Single-Page
Output</th></tr><tr><td width="20%" align="left"><a accesskey="p"
href="apas05.html">Prev</a> </td><th widt
h="60%" align="center"> </th><td width="20%" align="right"> <a
accesskey="n" href="apas07.html">Next</a></td></tr></table><hr></div><script
type="text/javascript">
+ var disqus_shortname = 'hbase'; // required: replace example with your
forum shortname
+ var disqus_url = 'http://hbase.apache.org/book/.html';
+ </script><div class="section"><div class="titlepage"><div><div><h2
class="title" style="clear: both"><a name="d9580e189"></a>A.6. Multi-Page
and Single-Page Output</h2></div></div></div><p>You can examine the <code
class="literal">site</code> target in the Maven
+ <code class="filename">pom.xml</code> file included at the top
level of the HBase source for
+ details on the process of building the website and documentation.
The Reference Guide is
+ built twice, once as a single-page output and once with one HTML
file per chapter. The
+ single-page output is located in <code
class="filename">target/docbkx/book.html</code>, while the
+ multi-page output's index page is at <code
class="filename">target/docbkx/book/book.html</code>.
+ Each of these outputs has its own <code
class="filename">images/</code> and
+ <code class="filename">css/</code> directories, which are
created at build time.</p></div><div id="disqus_thread"></div><script
type="text/javascript">
+ /* * * DON'T EDIT BELOW THIS LINE * * */
+ (function() {
+ var dsq = document.createElement('script'); dsq.type =
'text/javascript'; dsq.async = true;
+ dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
+ (document.getElementsByTagName('head')[0] ||
document.getElementsByTagName('body')[0]).appendChild(dsq);
+ })();
+</script><noscript>Please enable JavaScript to view the <a
href="http://disqus.com/?ref_noscript";>comments powered by
Disqus.</a></noscript><a href="http://disqus.com"; class="dsq-brlink">comments
powered by <span class="logo-disqus">Disqus</span></a><div
class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td
width="40%" align="left"><a accesskey="p"
href="apas05.html">Prev</a> </td><td width="20%"
align="center"> </td><td width="40%" align="right"> <a accesskey="n"
href="apas07.html">Next</a></td></tr><tr><td width="40%" align="left"
valign="top">A.5. Auto-Generated Content </td><td width="20%"
align="center"><a accesskey="h"
href="appendix_contributing_to_documentation.html">Home</a></td><td width="40%"
align="right" valign="top"> A.7. Images in the HBase Reference
Guide</td></tr></table></div></body></html>
\ No newline at end of file
Added: hbase/hbase.apache.org/trunk/book/apas07.html
URL:
http://svn.apache.org/viewvc/hbase/hbase.apache.org/trunk/book/apas07.html?rev=1616896&view=auto
==============================================================================
--- hbase/hbase.apache.org/trunk/book/apas07.html (added)
+++ hbase/hbase.apache.org/trunk/book/apas07.html Fri Aug 8 22:19:16 2014
@@ -0,0 +1,35 @@
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>A.7. Images in the HBase Reference Guide</title><link
rel="stylesheet" type="text/css"
href="${baserdir}/src/main/site/resources/css/freebsd_docbook.css"><meta
name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home"
href="appendix_contributing_to_documentation.html"
title="Appendix A. Contributing to Documentation"><link rel="up"
href="appendix_contributing_to_documentation.html"
title="Appendix A. Contributing to Documentation"><link rel="prev"
href="apas06.html" title="A.6. Multi-Page and Single-Page Output"><link
rel="next" href="apas08.html" title="A.8. Adding a New Chapter to the
HBase Reference Guide"></head><body bgcolor="white" text="black" link="#0000FF"
vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3" align="center">A.7. Images
in the HBase Reference Guide</th></tr><tr><td width="20%" align="left"><a
accesskey="p" href="apas06.html
">Prev</a> </td><th width="60%" align="center"> </th><td width="20%"
align="right"> <a accesskey="n"
href="apas08.html">Next</a></td></tr></table><hr></div><script
type="text/javascript">
+ var disqus_shortname = 'hbase'; // required: replace example with your
forum shortname
+ var disqus_url = 'http://hbase.apache.org/book/.html';
+ </script><div class="section"><div class="titlepage"><div><div><h2
class="title" style="clear: both"><a name="d9580e212"></a>A.7. Images in
the HBase Reference Guide</h2></div></div></div><p>You can include images in
the HBase Reference Guide. For accessibility reasons, it is
+ recommended that you use a <figure> Docbook element for an
image. This allows
+ screen readers to navigate to the image and also provides
alternative text for the
+ image. The following is an example of a <figure>
element.</p><pre class="programlisting"><strong class="hl-tag" style="color:
#000096"><figure></strong>
+ <strong class="hl-tag" style="color: #000096"><title></strong>HFile
Version 1<strong class="hl-tag" style="color: #000096"></title></strong>
+ <strong class="hl-tag" style="color: #000096"><mediaobject></strong>
+ <strong class="hl-tag" style="color: #000096"><imageobject></strong>
+ <strong class="hl-tag" style="color: #000096"><imagedata</strong>
<span class="hl-attribute" style="color: #F5844C">fileref</span>=<span
class="hl-value" style="color:
#993300">"timeline_consistency.png"</span><strong class="hl-tag" style="color:
#000096"> /></strong>
+ <strong class="hl-tag" style="color: #000096"></imageobject></strong>
+ <strong class="hl-tag" style="color: #000096"><textobject></strong>
+ <strong class="hl-tag" style="color:
#000096"><phrase></strong>HFile Version 1<strong class="hl-tag"
style="color: #000096"></phrase></strong>
+ <strong class="hl-tag" style="color: #000096"></textobject></strong>
+ <strong class="hl-tag" style="color: #000096"></mediaobject></strong>
+<strong class="hl-tag" style="color: #000096"></figure></strong>
+ </pre><p>The <textobject> can contain a few sentences describing
the image, rather than
+ simply reiterating the title. You can optionally specify alignment
and size options in
+ the <imagedata> element.</p><p>When doing a local build,
save the image to the
+ <code class="filename">src/main/site/resources/images/</code>
directory. In the
+ <imagedata> element, refer to the image as above, with no
directory component. The
+ image will be copied to the appropriate target location during the
build of the
+ output.</p><p>When you submit a patch which includes adding an
image to the HBase Reference Guide,
+ attach the image to the JIRA. If the committer asks where the
image should be committed,
+ it should go into the above directory.</p></div><div
id="disqus_thread"></div><script type="text/javascript">
+ /* * * DON'T EDIT BELOW THIS LINE * * */
+ (function() {
+ var dsq = document.createElement('script'); dsq.type =
'text/javascript'; dsq.async = true;
+ dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
+ (document.getElementsByTagName('head')[0] ||
document.getElementsByTagName('body')[0]).appendChild(dsq);
+ })();
+</script><noscript>Please enable JavaScript to view the <a
href="http://disqus.com/?ref_noscript";>comments powered by
Disqus.</a></noscript><a href="http://disqus.com"; class="dsq-brlink">comments
powered by <span class="logo-disqus">Disqus</span></a><div
class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td
width="40%" align="left"><a accesskey="p"
href="apas06.html">Prev</a> </td><td width="20%"
align="center"> </td><td width="40%" align="right"> <a accesskey="n"
href="apas08.html">Next</a></td></tr><tr><td width="40%" align="left"
valign="top">A.6. Multi-Page and Single-Page Output </td><td
width="20%" align="center"><a accesskey="h"
href="appendix_contributing_to_documentation.html">Home</a></td><td width="40%"
align="right" valign="top"> A.8. Adding a New Chapter to the HBase
Reference Guide</td></tr></table></div></body></html>
\ No newline at end of file
Added: hbase/hbase.apache.org/trunk/book/apas08.html
URL:
http://svn.apache.org/viewvc/hbase/hbase.apache.org/trunk/book/apas08.html?rev=1616896&view=auto
==============================================================================
--- hbase/hbase.apache.org/trunk/book/apas08.html (added)
+++ hbase/hbase.apache.org/trunk/book/apas08.html Fri Aug 8 22:19:16 2014
@@ -0,0 +1,22 @@
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>A.8. Adding a New Chapter to the HBase Reference
Guide</title><link rel="stylesheet" type="text/css"
href="${baserdir}/src/main/site/resources/css/freebsd_docbook.css"><meta
name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home"
href="appendix_contributing_to_documentation.html"
title="Appendix A. Contributing to Documentation"><link rel="up"
href="appendix_contributing_to_documentation.html"
title="Appendix A. Contributing to Documentation"><link rel="prev"
href="apas07.html" title="A.7. Images in the HBase Reference Guide"><link
rel="next" href="apas09.html" title="A.9. Docbook Common
Issues"></head><body bgcolor="white" text="black" link="#0000FF"
vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3" align="center">A.8. Adding
a New Chapter to the HBase Reference Guide</th></tr><tr><td width="20%"
align="left"><a accesskey="p" href="apas07.ht
ml">Prev</a> </td><th width="60%" align="center"> </th><td
width="20%" align="right"> <a accesskey="n"
href="apas09.html">Next</a></td></tr></table><hr></div><script
type="text/javascript">
+ var disqus_shortname = 'hbase'; // required: replace example with your
forum shortname
+ var disqus_url = 'http://hbase.apache.org/book/.html';
+ </script><div class="section"><div class="titlepage"><div><div><h2
class="title" style="clear: both"><a name="d9580e228"></a>A.8. Adding a
New Chapter to the HBase Reference Guide</h2></div></div></div><p>If you want
to add a new chapter to the HBase Reference Guide, the easiest way is to
+ copy an existing chapter file, rename it, and change the ID and
title elements near the
+ top of the file. Delete the existing content and create the new
content. Then open the
+ <code class="filename">book.xml</code> file, which is the main
file for the HBase Reference
+ Guide, and use an <xi:include> element to include your new
chapter in the
+ appropriate location. Be sure to add your new file to your Git
repository before
+ creating your patch. Note that the <code
class="filename">book.xml</code> file currently contains
+ many chapters. You can only include a chapter at the same nesting
levels as the other
+ chapters in the file. When in doubt, check to see how other files
have been
+ included.</p></div><div id="disqus_thread"></div><script
type="text/javascript">
+ /* * * DON'T EDIT BELOW THIS LINE * * */
+ (function() {
+ var dsq = document.createElement('script'); dsq.type =
'text/javascript'; dsq.async = true;
+ dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
+ (document.getElementsByTagName('head')[0] ||
document.getElementsByTagName('body')[0]).appendChild(dsq);
+ })();
+</script><noscript>Please enable JavaScript to view the <a
href="http://disqus.com/?ref_noscript";>comments powered by
Disqus.</a></noscript><a href="http://disqus.com"; class="dsq-brlink">comments
powered by <span class="logo-disqus">Disqus</span></a><div
class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td
width="40%" align="left"><a accesskey="p"
href="apas07.html">Prev</a> </td><td width="20%"
align="center"> </td><td width="40%" align="right"> <a accesskey="n"
href="apas09.html">Next</a></td></tr><tr><td width="40%" align="left"
valign="top">A.7. Images in the HBase Reference Guide </td><td
width="20%" align="center"><a accesskey="h"
href="appendix_contributing_to_documentation.html">Home</a></td><td width="40%"
align="right" valign="top"> A.9. Docbook Common
Issues</td></tr></table></div></body></html>
\ No newline at end of file
