You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2012/04/23 06:29:22 UTC
svn commit: r1329058 - in /lucene/dev/trunk: build.xml lucene/build.xml
lucene/common-build.xml solr/build.xml
Author: rmuir
Date: Mon Apr 23 04:29:21 2012
New Revision: 1329058
URL: http://svn.apache.org/viewvc?rev=1329058&view=rev
Log:
LUCENE-4011: add javadocs-lint tasks for javadocs plus extra checks
Modified:
lucene/dev/trunk/build.xml
lucene/dev/trunk/lucene/build.xml
lucene/dev/trunk/lucene/common-build.xml
lucene/dev/trunk/solr/build.xml
Modified: lucene/dev/trunk/build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/build.xml?rev=1329058&r1=1329057&r2=1329058&view=diff
==============================================================================
--- lucene/dev/trunk/build.xml (original)
+++ lucene/dev/trunk/build.xml Mon Apr 23 04:29:21 2012
@@ -42,6 +42,15 @@
</sequential>
</target>
+ <target name="javadocs-lint">
+ <sequential>
+ <subant target="javadocs-lint" inheritall="false" failonerror="true">
+ <fileset dir="lucene" includes="build.xml" />
+ <fileset dir="solr" includes="build.xml" />
+ </subant>
+ </sequential>
+ </target>
+
<target name="validate" description="Validate dependencies, licenses, etc.">
<sequential><subant target="validate" inheritall="false" failonerror="true">
<fileset dir="lucene" includes="build.xml" />
Modified: lucene/dev/trunk/lucene/build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/build.xml?rev=1329058&r1=1329057&r2=1329058&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/build.xml (original)
+++ lucene/dev/trunk/lucene/build.xml Mon Apr 23 04:29:21 2012
@@ -187,6 +187,12 @@
depends="javadocs,changes-to-html,process-webpages"/>
<target name="javadoc" depends="javadocs"/>
<target name="javadocs" description="Generate javadoc" depends="javadocs-lucene-core, javadocs-modules, javadocs-test-framework"/>
+
+ <!-- we check for broken links across all documentation -->
+ <!-- TODO: also integrate checkJavaDocs.py, which does more checks -->
+ <target name="javadocs-lint" depends="documentation">
+ <check-broken-links dir="build/docs"/>
+ </target>
<target name="process-webpages" depends="resolve-pegdown">
<pathconvert pathsep="|" dirsep="/" property="buildfiles">
Modified: lucene/dev/trunk/lucene/common-build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/common-build.xml?rev=1329058&r1=1329057&r2=1329058&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/common-build.xml (original)
+++ lucene/dev/trunk/lucene/common-build.xml Mon Apr 23 04:29:21 2012
@@ -1559,4 +1559,15 @@ ${tests-output}/junit4-*.suites - pe
</copy>
</sequential>
</macrodef>
+
+ <macrodef name="check-broken-links">
+ <attribute name="dir"/>
+ <sequential>
+ <exec dir="." executable="${python.exe}" failonerror="true">
+ <arg line="${dev-tools.dir}/scripts/checkJavadocLinks.py"/>
+ <arg line="@{dir}"/>
+ </exec>
+ </sequential>
+ </macrodef>
+
</project>
Modified: lucene/dev/trunk/solr/build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/build.xml?rev=1329058&r1=1329057&r2=1329058&view=diff
==============================================================================
--- lucene/dev/trunk/solr/build.xml (original)
+++ lucene/dev/trunk/solr/build.xml Mon Apr 23 04:29:21 2012
@@ -542,6 +542,12 @@
</solr-invoke-javadoc>
</sequential>
</target>
+
+ <!-- TODO: does solr have any other docs we should check? -->
+ <!-- TODO: also integrate checkJavaDocs.py, which does more checks -->
+ <target name="javadocs-lint" depends="javadocs">
+ <!-- TODO: enable <check-broken-links dir="build/docs"/> -->
+ </target>
<target name="generate-maven-artifacts" depends="install-maven-tasks">
<sequential>