Explorar o código

HADOOP-5468. Add sub-menus to forrest documentation and make some minor edits. (Corinne Chandel via szetszwo)

git-svn-id: https://svn.apache.org/repos/asf/hadoop/core/trunk@756752 13f79535-47bb-0310-9956-ffa450edef68
Tsz-wo Sze %!s(int64=16) %!d(string=hai) anos
pai
achega
36fecddb32

+ 6 - 3
CHANGES.txt

@@ -275,9 +275,6 @@ Trunk (unreleased changes)
     HADOOP-5305. Increase number of files and print debug messages in
     TestCopyFiles.  (szetszwo)
 
-    HADOOP-5320. Add a close() in TestMapReduceLocal.  (Jothi Padmanabhan
-    via szetszwo)
-
     HADOOP-5218.  libhdfs unit test failed because it was unable to 
     start namenode/datanode. Fixed. (dhruba)
 
@@ -661,6 +658,9 @@ Release 0.20.0 - Unreleased
     HADOOP-5275. Add ivy directory and files to built tar.
     (Giridharan Kesavan via nigel)
 
+    HADOOP-5468. Add sub-menus to forrest documentation and make some minor
+    edits.  (Corinne Chandel via szetszwo)
+
   OPTIMIZATIONS
 
     HADOOP-3293. Fixes FileInputFormat to do provide locations for splits
@@ -1071,6 +1071,9 @@ Release 0.20.0 - Unreleased
     HADOOP-5417. Don't ignore InterruptedExceptions that happen when calling 
     into rpc. (omalley)
 
+    HADOOP-5320. Add a close() in TestMapReduceLocal.  (Jothi Padmanabhan
+    via szetszwo)
+
 Release 0.19.2 - Unreleased
 
   BUG FIXES

+ 2 - 2
src/docs/src/documentation/content/xdocs/SLG_user_guide.xml

@@ -18,13 +18,13 @@
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
 	<header>
-		<title> HDFS Utilities: Synthetic Load Generator User Guide </title>
+		<title> HDFS Synthetic Load Generator Guide </title>
 	</header>
 	<body>
 		<section>
 			<title> Description </title>
 			<p>
-        The synthetic load generator is a tool for testing NameNode behavior
+        The synthetic load generator (SLG) is a tool for testing NameNode behavior
         under different client loads. The user can generate different mixes 
         of read, write, and list requests by specifying the probabilities of
         read and write. The user controls the intensity of the load by adjusting

+ 1 - 1
src/docs/src/documentation/content/xdocs/capacity_scheduler.xml

@@ -21,7 +21,7 @@
 <document>
   
   <header>
-    <title>Capacity Scheduler</title>
+    <title>Capacity Scheduler Guide</title>
   </header>
   
   <body>

+ 1 - 1
src/docs/src/documentation/content/xdocs/cluster_setup.xml

@@ -21,7 +21,7 @@
 <document>
   
   <header>
-    <title>Hadoop Cluster Setup</title>
+    <title>Cluster Setup</title>
   </header>
   
   <body>

+ 3 - 3
src/docs/src/documentation/content/xdocs/commands_manual.xml

@@ -19,14 +19,14 @@
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
 	<header>
-		<title>Hadoop Command Guide</title>
+		<title>Commands Guide</title>
 	</header>
 	
 	<body>
 		<section>
 			<title>Overview</title>
 			<p>
-				All the hadoop commands are invoked by the bin/hadoop script. Running hadoop
+				All hadoop commands are invoked by the bin/hadoop script. Running the hadoop
 				script without any arguments prints the description for all commands.
 			</p>
 			<p>
@@ -56,7 +56,7 @@
 			 <section>
 				<title>Generic Options</title>
 				<p>
-				  Following are supported by <a href="commands_manual.html#dfsadmin">dfsadmin</a>, 
+				  The following options are supported by <a href="commands_manual.html#dfsadmin">dfsadmin</a>, 
 				  <a href="commands_manual.html#fs">fs</a>, <a href="commands_manual.html#fsck">fsck</a> and 
 				  <a href="commands_manual.html#job">job</a>. 
 				  Applications should implement 

+ 1 - 1
src/docs/src/documentation/content/xdocs/distcp.xml

@@ -21,7 +21,7 @@
 <document>
 
   <header>
-    <title>Hadoop DistCp Guide</title>
+    <title>DistCp Guide</title>
   </header>
 
   <body>

+ 1 - 1
src/docs/src/documentation/content/xdocs/fair_scheduler.xml

@@ -18,7 +18,7 @@
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
   <header>
-    <title>Fair Scheduler</title>
+    <title>Fair Scheduler Guide</title>
   </header>
   <body>
 

+ 1 - 1
src/docs/src/documentation/content/xdocs/hadoop_archives.xml

@@ -18,7 +18,7 @@
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
         <header>
-        <title>Hadoop Archives</title>
+        <title>Archives Guide</title>
         </header>
         <body>
         <section>

+ 1 - 1
src/docs/src/documentation/content/xdocs/hdfs_permissions_guide.xml

@@ -24,7 +24,7 @@
 
   <header>
     <title>
-      HDFS Administrator Guide: Permissions
+      HDFS Permissions Guide
     </title>
   </header>
 

+ 1 - 1
src/docs/src/documentation/content/xdocs/hdfs_quota_admin_guide.xml

@@ -20,7 +20,7 @@
 
 <document>
 
- <header> <title> HDFS Administrator Guide: Quotas </title> </header>
+ <header> <title> HDFS Quotas Guide</title> </header>
 
  <body>
 

+ 3 - 3
src/docs/src/documentation/content/xdocs/hdfs_shell.xml

@@ -18,15 +18,15 @@
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
 	<header>
-		<title>Hadoop FS Shell Guide</title>
+		<title>HDFS File System Shell Guide</title>
 	</header>
 	<body>
 		<section>
-			<title> FS Shell </title>
+			<title>Overview</title>
 			<p>
       The FileSystem (FS) shell is invoked by 
       <code>bin/hadoop fs &lt;args&gt;</code>.
-      All the FS shell commands take path URIs as arguments. The URI
+      All FS shell commands take path URIs as arguments. The URI
       format is <em>scheme://autority/path</em>. For HDFS the scheme
       is <em>hdfs</em>, and for the local filesystem the scheme
       is <em>file</em>. The scheme and authority are optional. If not

+ 0 - 48
src/docs/src/documentation/content/xdocs/hod.xml

@@ -1,48 +0,0 @@
-<?xml version="1.0"?>
-<!--
-  Licensed to the Apache Software Foundation (ASF) under one or more
-  contributor license agreements.  See the NOTICE file distributed with
-  this work for additional information regarding copyright ownership.
-  The ASF licenses this file to You under the Apache License, Version 2.0
-  (the "License"); you may not use this file except in compliance with
-  the License.  You may obtain a copy of the License at
-
-      http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
--->
-
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
-          "http://forrest.apache.org/dtd/document-v20.dtd">
-
-
-<document>
-
-  <header>
-    <title> 
-      Hadoop On Demand
-    </title>
-  </header>
-
-  <body>
-    <section>
-      <title> Introduction </title>
-      <p>
-Hadoop On Demand (HOD) is a system for provisioning virtual Hadoop clusters over a large physical cluster. It uses the Torque resource manager to do node allocation. On the allocated nodes, it can start Hadoop Map/Reduce and HDFS daemons. It automatically generates the appropriate configuration files (hadoop-site.xml) for the Hadoop daemons and client. HOD also has the capability to distribute Hadoop to the nodes in the virtual cluster that it allocates. In short, HOD makes it easy for administrators and users to quickly setup and use Hadoop. It is also a very useful tool for Hadoop developers and testers who need to share a physical cluster for testing their own Hadoop versions.
-      </p>
-      </section>
-      <section>
-        <title>Documentation</title>
-      <p>Please go through the following to know more about using HOD</p>
-      <ul>
-        <li><a href="hod_admin_guide.html">HOD Admin Guide</a> : This guide provides an overview of the HOD architecture, Torque resource manager, and various support tools and utilities, and shows you how to install, configure, and run HOD.</li>
-        <li><a href="hod_config_guide.html">Hod Configuration Guide</a> : This guide discusses HOD configuration sections and shows you how to work with the most important and commonly used configuration options.</li>
-        <li><a href="hod_user_guide.html">Hod User Guide</a> : This guide shows you how to get started using HOD, reviews various HOD features and command line options, and provides detailed troubleshooting help.</li>
-      </ul>
-    </section>
-  </body>
-</document>

+ 1 - 1
src/docs/src/documentation/content/xdocs/mapred_tutorial.xml

@@ -21,7 +21,7 @@
 <document>
   
   <header>
-    <title>Hadoop Map/Reduce Tutorial</title>
+    <title>Map/Reduce Tutorial</title>
   </header>
   
   <body>

+ 1 - 1
src/docs/src/documentation/content/xdocs/native_libraries.xml

@@ -21,7 +21,7 @@
 <document>
   
   <header>
-    <title>Hadoop Native Libraries</title>
+    <title>Native Libraries Guide</title>
   </header>
   
   <body>

+ 1 - 1
src/docs/src/documentation/content/xdocs/quickstart.xml

@@ -21,7 +21,7 @@
 <document>
   
   <header>
-    <title>Hadoop Quick Start</title>
+    <title>Quick Start</title>
   </header>
   
   <body>

+ 1 - 1
src/docs/src/documentation/content/xdocs/service_level_auth.xml

@@ -21,7 +21,7 @@
 <document>
   
   <header>
-    <title>Hadoop Service Level Authorization</title>
+    <title>Service Level Authorization Guide</title>
   </header>
   
   <body>

+ 44 - 32
src/docs/src/documentation/content/xdocs/site.xml

@@ -31,39 +31,51 @@ See http://forrest.apache.org/docs/linking.html for more info.
 -->
 
 <site label="Hadoop" href="" xmlns="http://apache.org/forrest/linkmap/1.0">
-
-  <docs label="Documentation"> 
-    <overview   label="Overview"           href="index.html" />
-    <quickstart label="Hadoop Quick Start"        href="quickstart.html" />
-    <setup     label="Hadoop Cluster Setup"      href="cluster_setup.html" />
-    <mapred    label="Hadoop Map/Reduce Tutorial" href="mapred_tutorial.html" />
-    <commands  label="Hadoop Command Guide"     href="commands_manual.html" />
-    <fs        label="Hadoop FS Shell Guide"     href="hdfs_shell.html" />
-    <distcp    label="Hadoop DistCp Guide"       href="distcp.html" />
-    <mapred    label="Hadoop Native Libraries" href="native_libraries.html" />
-    <streaming label="Hadoop Streaming"          href="streaming.html" />
-    <archives  label="Hadoop Archives"     href="hadoop_archives.html"/>
-    <hdfs      label="HDFS User Guide"    href="hdfs_user_guide.html" />
-    <hdfs      label="HDFS Architecture"  href="hdfs_design.html" />
-    <hdfs      label="HDFS Admin Guide: Permissions"    href="hdfs_permissions_guide.html" />
-    <hdfs      label="HDFS Admin Guide: Quotas" href="hdfs_quota_admin_guide.html" />
-    <fs        label="HDFS Utilities"  href="SLG_user_guide.html" />
-    <libhdfs   label="HDFS C API"         href="libhdfs.html" />
-    <hod-user-guide label="HOD User Guide" href="hod_user_guide.html"/>
-    <hod-admin-guide label="HOD Admin Guide" href="hod_admin_guide.html"/>
-    <hod-config-guide label="HOD Config Guide" href="hod_config_guide.html"/>
-    <fair_scheduler label="Fair Scheduler" href="fair_scheduler.html"/>
-    <capacity_scheduler label="Capacity Scheduler" href="capacity_scheduler.html"/>
-    <service_level_auth label="Service Level Authorization" href="service_level_auth.html"/>
-    <vaidya    label="Hadoop Vaidya" href="vaidya.html"/>
-    <api       label="API Docs"           href="ext:api/index" />
-    <jdiff     label="API Changes"        href="ext:jdiff/changes" />
-    <wiki      label="Wiki"               href="ext:wiki" />
-    <faq       label="FAQ"                href="ext:faq" />
-    <relnotes  label="Release Notes"      href="ext:relnotes" />
-    <changes   label="Change Log"        href="ext:changes" />
-  </docs>
   
+   <docs label="Getting Started"> 
+		<overview   				label="Overview" 					href="index.html" />
+		<quickstart 				label="Quick Start"        		href="quickstart.html" />
+		<setup     					label="Cluster Setup"      		href="cluster_setup.html" />
+		<mapred    				label="Map/Reduce Tutorial" 	href="mapred_tutorial.html" />
+  </docs>	
+		
+ <docs label="Programming Guides">
+		<commands 				label="Commands"     					href="commands_manual.html" />
+		<distcp    					label="DistCp"       						href="distcp.html" />
+		<native_lib    				label="Native Libraries" 					href="native_libraries.html" />
+		<streaming 				label="Streaming"          				href="streaming.html" />
+		<fair_scheduler 			label="Fair Scheduler" 					href="fair_scheduler.html"/>
+		<cap_scheduler 		label="Capacity Scheduler" 			href="capacity_scheduler.html"/>
+		<SLA					 	label="Service Level Authorization" 	href="service_level_auth.html"/>
+		<vaidya    					label="Vaidya" 								href="vaidya.html"/>
+		<archives  				label="Archives"     						href="hadoop_archives.html"/>
+   </docs>
+   
+   <docs label="HDFS">
+		<hdfs_user      				label="User Guide"    							href="hdfs_user_guide.html" />
+		<hdfs_arch     				label="Architecture"  								href="hdfs_design.html" />	
+		<hdfs_fs       	 				label="File System Shell Guide"     		href="hdfs_shell.html" />
+		<hdfs_perm      				label="Permissions Guide"    					href="hdfs_permissions_guide.html" />
+		<hdfs_quotas     			label="Quotas Guide" 							href="hdfs_quota_admin_guide.html" />
+		<hdfs_SLG        			label="Synthetic Load Generator Guide"  href="SLG_user_guide.html" />
+		<hdfs_libhdfs   				label="C API libhdfs"         						href="libhdfs.html" /> 
+   </docs> 
+   
+   <docs label="HOD">
+		<hod_user 	label="User Guide" 	href="hod_user_guide.html"/>
+		<hod_admin 	label="Admin Guide" 	href="hod_admin_guide.html"/>
+		<hod_config 	label="Config Guide" 	href="hod_config_guide.html"/> 
+   </docs> 
+   
+   <docs label="Miscellaneous"> 
+		<api       	label="API Docs"           href="ext:api/index" />
+		<jdiff     	label="API Changes"      href="ext:jdiff/changes" />
+		<wiki      	label="Wiki"               	href="ext:wiki" />
+		<faq       	label="FAQ"                	href="ext:faq" />
+		<relnotes  label="Release Notes" 	href="ext:relnotes" />
+		<changes	label="Change Log"       href="ext:changes" />
+   </docs> 
+   
   <external-refs>
     <site      href="http://hadoop.apache.org/core/"/>
     <lists     href="http://hadoop.apache.org/core/mailing_lists.html"/>

+ 7 - 7
src/docs/src/documentation/content/xdocs/vaidya.xml

@@ -21,7 +21,7 @@
 <document>
   
   <header>
-    <title>Hadoop Vaidya: A Performance Diagnostic Tool for Map-Reduce Jobs</title>
+    <title>Vaidya Guide</title>
   </header>
   
   <body>
@@ -29,13 +29,13 @@
     <section>
       <title>Purpose</title>
       
-      <p>This document describes various user-facing facets of the Hadoop Vaidya tool. It
-         describes both, how to execute a default set of rules against your Map-Reduce job counters,
-         as well as how to write and execute new rules to detect specific performance problems. 
+      <p>This document describes various user-facing facets of Hadoop Vaidya, a performance diagnostic tool for map/reduce jobs. It
+         describes how to execute a default set of rules against your map/reduce job counters and
+         how to write and execute new rules to detect specific performance problems. 
       </p>
-      <p>At present few sample test rules are provided with the tool with the objective of growing the rules database over the time. 
-         You are welcome to contribute the new rules for everyone's benefit and for that follow the similar
-         <a href="http://wiki.apache.org/hadoop/HowToContribute">procedure</a> 
+      <p>A few sample test rules are provided with the tool with the objective of growing the rules database over the time. 
+         You are welcome to contribute new rules for everyone's benefit; to do so, follow the 
+         <a href="http://wiki.apache.org/hadoop/HowToContribute">How to Contribute</a> procedure
          specified on Apache Hadoop website.
       </p>
     </section>