hadoop-common-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tomwh...@apache.org
Subject svn commit: r1195817 - in /hadoop/common/trunk: hadoop-project/src/site/site.xml pom.xml
Date Tue, 01 Nov 2011 04:47:15 GMT
Author: tomwhite
Date: Tue Nov  1 04:47:10 2011
New Revision: 1195817

URL: http://svn.apache.org/viewvc?rev=1195817&view=rev
Log:
HADOOP-7782. Aggregate project javadocs.

Modified:
    hadoop/common/trunk/hadoop-project/src/site/site.xml
    hadoop/common/trunk/pom.xml

Modified: hadoop/common/trunk/hadoop-project/src/site/site.xml
URL: http://svn.apache.org/viewvc/hadoop/common/trunk/hadoop-project/src/site/site.xml?rev=1195817&r1=1195816&r2=1195817&view=diff
==============================================================================
--- hadoop/common/trunk/hadoop-project/src/site/site.xml (original)
+++ hadoop/common/trunk/hadoop-project/src/site/site.xml Tue Nov  1 04:47:10 2011
@@ -68,7 +68,8 @@
       <item name="Capacity Scheduler" href="hadoop-yarn/hadoop-yarn-site/CapacityScheduler.html"/>
     </menu>
     
-    <menu name="Configuration Reference" inherit="top">
+    <menu name="Reference" inherit="top">
+      <item name="API docs" href="api/index.html"/>
       <item name="core-default.xml" href="hadoop-project-dist/hadoop-common/core-default.xml"/>
       <item name="hdfs-default.xml" href="hadoop-project-dist/hadoop-hdfs/hdfs-default.xml"/>
       <item name="mapred-default.xml" href="hadoop-mapreduce-client/hadoop-mapreduce-client-core/mapred-default.xml"/>

Modified: hadoop/common/trunk/pom.xml
URL: http://svn.apache.org/viewvc/hadoop/common/trunk/pom.xml?rev=1195817&r1=1195816&r2=1195817&view=diff
==============================================================================
--- hadoop/common/trunk/pom.xml (original)
+++ hadoop/common/trunk/pom.xml Tue Nov  1 04:47:10 2011
@@ -109,8 +109,7 @@
           <artifactId>maven-site-plugin</artifactId>
           <version>3.0</version>
           <configuration>
-            <!-- Reports are generated at the site level -->
-            <generateReports>false</generateReports>
+            <generateReports>true</generateReports>
           </configuration>
         </plugin>
       </plugins>
@@ -180,6 +179,70 @@
     </plugins>
   </build>
   
+  <reporting>
+    <excludeDefaults>true</excludeDefaults>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.8</version>
+        <reportSets>
+          <reportSet>
+            <id>aggregate</id>
+            <configuration>
+              <maxmemory>1024m</maxmemory>
+              <linksource>true</linksource>
+              <quiet>true</quiet>
+              <verbose>false</verbose>
+              <source>${maven.compile.source}</source>
+              <charset>${maven.compile.encoding}</charset>
+              <reportOutputDirectory>${project.build.directory}/site</reportOutputDirectory>
+              <destDir>hadoop-project/api</destDir>
+              <!-- Non-public APIs -->
+              <excludePackageNames>org.apache.hadoop.authentication*,org.apache.hadoop.hdfs*,org.apache.hadoop.mapreduce.v2.proto,org.apache.hadoop.yarn.proto,org.apache.hadoop.yarn.server*,org.apache.hadoop.yarn.webapp*</excludePackageNames>
+              <groups>
+                <group>
+                  <title>Common</title>
+                  <packages>org.apache.hadoop*</packages>
+                </group>
+                <group>
+                  <title>MapReduce</title>
+                  <packages>org.apache.hadoop.mapred*</packages>
+                </group>
+                <group>
+                  <title>YARN</title>
+                  <packages>org.apache.hadoop.yarn*</packages>
+                </group>
+              </groups>
+              <doclet>org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet</doclet>
+              <docletArtifacts>
+                <docletArtifact>
+                  <groupId>org.apache.hadoop</groupId>
+                  <artifactId>hadoop-annotations</artifactId>
+                  <version>${project.version}</version>
+                </docletArtifact>
+              </docletArtifacts>
+              <useStandardDocletOptions>true</useStandardDocletOptions>
+    
+              <!-- switch on dependency-driven aggregation -->
+              <includeDependencySources>false</includeDependencySources>
+    
+              <dependencySourceIncludes>
+                <!-- include ONLY dependencies I control -->
+                <dependencySourceInclude>org.apache.hadoop:hadoop-annotations</dependencySourceInclude>
+              </dependencySourceIncludes>
+    
+            </configuration>
+            <reports>
+              <report>aggregate</report>
+            </reports>
+          </reportSet>
+        </reportSets>
+      </plugin>
+
+    </plugins>
+  </reporting>
+  
   <profiles>
     <profile>
       <id>src</id>



Mime
View raw message