You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by sz...@apache.org on 2009/03/20 21:57:33 UTC
svn commit: r756757 - in /hadoop/core/branches/branch-0.20: ./
src/docs/src/documentation/content/xdocs/
Author: szetszwo
Date: Fri Mar 20 20:57:32 2009
New Revision: 756757
URL: http://svn.apache.org/viewvc?rev=756757&view=rev
Log:
HADOOP-5468. Add sub-menus to forrest documentation and make some minor edits. (Corinne Chandel via szetszwo)
Removed:
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hod.xml
Modified:
hadoop/core/branches/branch-0.20/CHANGES.txt
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/SLG_user_guide.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/capacity_scheduler.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/cluster_setup.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/commands_manual.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/distcp.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/fair_scheduler.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hadoop_archives.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_permissions_guide.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_quota_admin_guide.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_shell.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/mapred_tutorial.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/native_libraries.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/quickstart.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/service_level_auth.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/site.xml
hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/vaidya.xml
Modified: hadoop/core/branches/branch-0.20/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/CHANGES.txt?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/CHANGES.txt (original)
+++ hadoop/core/branches/branch-0.20/CHANGES.txt Fri Mar 20 20:57:32 2009
@@ -351,6 +351,9 @@
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
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/SLG_user_guide.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/SLG_user_guide.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/SLG_user_guide.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/SLG_user_guide.xml Fri Mar 20 20:57:32 2009
@@ -17,13 +17,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
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/capacity_scheduler.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/capacity_scheduler.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/capacity_scheduler.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/capacity_scheduler.xml Fri Mar 20 20:57:32 2009
@@ -20,7 +20,7 @@
<document>
<header>
- <title>Capacity Scheduler</title>
+ <title>Capacity Scheduler Guide</title>
</header>
<body>
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/cluster_setup.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/cluster_setup.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/cluster_setup.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/cluster_setup.xml Fri Mar 20 20:57:32 2009
@@ -20,7 +20,7 @@
<document>
<header>
- <title>Hadoop Cluster Setup</title>
+ <title>Cluster Setup</title>
</header>
<body>
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/commands_manual.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/commands_manual.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/commands_manual.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/commands_manual.xml Fri Mar 20 20:57:32 2009
@@ -18,14 +18,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>
@@ -55,7 +55,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
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/distcp.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/distcp.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/distcp.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/distcp.xml Fri Mar 20 20:57:32 2009
@@ -20,7 +20,7 @@
<document>
<header>
- <title>Hadoop DistCp Guide</title>
+ <title>DistCp Guide</title>
</header>
<body>
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/fair_scheduler.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/fair_scheduler.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/fair_scheduler.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/fair_scheduler.xml Fri Mar 20 20:57:32 2009
@@ -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>
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hadoop_archives.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hadoop_archives.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hadoop_archives.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hadoop_archives.xml Fri Mar 20 20:57:32 2009
@@ -17,7 +17,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>
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_permissions_guide.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_permissions_guide.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_permissions_guide.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_permissions_guide.xml Fri Mar 20 20:57:32 2009
@@ -23,7 +23,7 @@
<header>
<title>
- HDFS Administrator Guide: Permissions
+ HDFS Permissions Guide
</title>
</header>
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_quota_admin_guide.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_quota_admin_guide.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_quota_admin_guide.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_quota_admin_guide.xml Fri Mar 20 20:57:32 2009
@@ -15,7 +15,7 @@
<document>
- <header> <title> HDFS Administrator Guide: Quotas </title> </header>
+ <header> <title> HDFS Quotas Guide</title> </header>
<body>
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_shell.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_shell.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_shell.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/hdfs_shell.xml Fri Mar 20 20:57:32 2009
@@ -17,15 +17,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 <args></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
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/mapred_tutorial.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/mapred_tutorial.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/mapred_tutorial.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/mapred_tutorial.xml Fri Mar 20 20:57:32 2009
@@ -20,7 +20,7 @@
<document>
<header>
- <title>Hadoop Map/Reduce Tutorial</title>
+ <title>Map/Reduce Tutorial</title>
</header>
<body>
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/native_libraries.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/native_libraries.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/native_libraries.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/native_libraries.xml Fri Mar 20 20:57:32 2009
@@ -20,7 +20,7 @@
<document>
<header>
- <title>Hadoop Native Libraries</title>
+ <title>Native Libraries Guide</title>
</header>
<body>
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/quickstart.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/quickstart.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/quickstart.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/quickstart.xml Fri Mar 20 20:57:32 2009
@@ -20,7 +20,7 @@
<document>
<header>
- <title>Hadoop Quick Start</title>
+ <title>Quick Start</title>
</header>
<body>
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/service_level_auth.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/service_level_auth.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/service_level_auth.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/service_level_auth.xml Fri Mar 20 20:57:32 2009
@@ -20,7 +20,7 @@
<document>
<header>
- <title>Hadoop Service Level Authorization</title>
+ <title>Service Level Authorization Guide</title>
</header>
<body>
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/site.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/site.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/site.xml Fri Mar 20 20:57:32 2009
@@ -30,39 +30,51 @@
-->
<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"/>
Modified: hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/vaidya.xml
URL: http://svn.apache.org/viewvc/hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/vaidya.xml?rev=756757&r1=756756&r2=756757&view=diff
==============================================================================
--- hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/vaidya.xml (original)
+++ hadoop/core/branches/branch-0.20/src/docs/src/documentation/content/xdocs/vaidya.xml Fri Mar 20 20:57:32 2009
@@ -20,7 +20,7 @@
<document>
<header>
- <title>Hadoop Vaidya: A Performance Diagnostic Tool for Map-Reduce Jobs</title>
+ <title>Vaidya Guide</title>
</header>
<body>
@@ -28,13 +28,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>