Author: gates
Date: Wed Apr 16 10:46:15 2008
New Revision: 648768
URL: http://svn.apache.org/viewvc?rev=648768&view=rev
Log:
PIG-149, PIG-150: Fix doc target so that ant can generate docs.
Added:
incubator/pig/trunk/docs/
incubator/pig/trunk/docs/overview.html
Modified:
incubator/pig/trunk/CHANGES.txt
incubator/pig/trunk/build.xml
Modified: incubator/pig/trunk/CHANGES.txt
URL:
http://svn.apache.org/viewvc/incubator/pig/trunk/CHANGES.txt?rev=648768&r1=648767&r2=648768&view=diff
==============================================================================
--- incubator/pig/trunk/CHANGES.txt (original)
+++ incubator/pig/trunk/CHANGES.txt Wed Apr 16 10:46:15 2008
@@ -231,3 +231,6 @@
PIG-188: Fix mismatches between pig slicer changes and new streaming
feature (acmurthy via gates).
+
+ PIG-149, PIG-150: Fix doc target so that ant can generate docs (xuzh
via
+ gates).
Modified: incubator/pig/trunk/build.xml
URL:
http://svn.apache.org/viewvc/incubator/pig/trunk/build.xml?rev=648768&r1=648767&r2=648768&view=diff
==============================================================================
--- incubator/pig/trunk/build.xml (original)
+++ incubator/pig/trunk/build.xml Wed Apr 16 10:46:15 2008
@@ -16,6 +16,7 @@
<property name="src.dir" value="${basedir}/src/" />
<property name="src.lib.dir" value="${basedir}/lib-src/" />
<property name="src.gen.dir" value="${basedir}/src-gen/" />
+ <property name="src.docs.dir" value="${basedir}/docs/" />
<!-- javacc properties -->
<property name="src.gen.query.parser.dir"
value="${src.gen.dir}/org/apache/pig/impl/logicalLayer/parser" />
@@ -64,6 +65,9 @@
<property name="test.log.dir" value="${basedir}/test/logs"/>
<property name="junit.hadoop.conf" value="${user.home}/pigtest/conf/"/>
<property name="test.output" value="no"/>
+
+ <!-- javadoc properties -->
+ <property name="javadoc.link.java"
value="http://java.sun.com/j2se/1.5.0/docs/api/"; />
<!-- ====================================================== -->
<!-- Stuff needed by all targets -->
@@ -166,14 +170,15 @@
<!-- ================================================================== -->
<!-- Documentation -->
<!-- ================================================================== -->
- <target name="javadoc" depends="init" description="Create documentation">
+ <target name="javadoc" depends="jar" description="Create documentation">
<mkdir dir="${build.javadoc}" />
- <javadoc overview="${src.dir}/overview.html"
packagenames="org.apache.pig.*" destdir="${build.javadoc}" author="true"
version="true" use="true" windowtitle="${Name} ${version} API"
doctitle="${Name} ${version} API" bottom="Copyright &copy; ${year} The
Apache Software Foundation">
+ <javadoc overview="${src.docs.dir}/overview.html"
packagenames="org.apache.pig.*" destdir="${build.javadoc}" author="true"
version="true" use="true" windowtitle="${Name} ${version} API"
doctitle="${Name} ${version} API" bottom="Copyright &copy; ${year} The
Apache Software Foundation">
<packageset dir="${src.dir}" />
<link href="${javadoc.link.java}" />
<classpath>
<path refid="classpath" />
<pathelement path="${java.class.path}" />
+ <pathelement path="${output.jarfile}" />
</classpath>
<group title="pig" packages="org.apache.*" />
</javadoc>
Added: incubator/pig/trunk/docs/overview.html
URL:
http://svn.apache.org/viewvc/incubator/pig/trunk/docs/overview.html?rev=648768&view=auto
==============================================================================
--- incubator/pig/trunk/docs/overview.html (added)
+++ incubator/pig/trunk/docs/overview.html Wed Apr 16 10:46:15 2008
@@ -0,0 +1,13 @@
+<HTML>
+<BODY>
+Provides the classes necessary to create programs in the high-level Pig Latin
+language and the infrastructure for evaluating these programs.
+<p>
+Pig is a platform for analyzing large data sets and consists of 2 layers:
+Pig's infrastructure layer consists of a compiler that produces sequences of
+Map-Reduce programs, for which large-scale parallel implementations already
+exist (e.g., the Hadoop project). Pig's language layer currently consists of
+a textual language called Pig Latin for expressing data analysis programs.
+</BODY>
+</HTML>
+
