Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MPXDOC-141: Perform JSL transforms on xdocs *only* when they have changed. New property 'maven.xdoc.skip.uptodate'.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@291077 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
ltheussl 2005-09-23 05:42:42 +00:00
parent 33ca3709f1
commit c467e038c7
4 changed files with 47 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
xdoc/plugin.jelly
View File

@ -440,7 +440,21 @@
<!-- generate output file name --> <!-- generate output file name -->
<util:replace var="outFileForward" oldChar="\" newChar="/" value="${file.toString()}"/> <util:replace var="outFileForward" oldChar="\" newChar="/" value="${file.toString()}"/>
<j:set var="outFile" value="${mapper.mapFileName(outFileForward).0}"/> <j:set var="outFile" value="${mapper.mapFileName(outFileForward).0}"/>
<j:set var="varname" value="up${file.toString()}"/>
<uptodate
property="${varname}"
srcfile="${file.toString()}"
targetfile="${outFile.toString()}" />
<j:set var="speedup" value="${maven.xdoc.skip.uptodate}"/>
<j:choose>
<j:when test="${context.getVariable(varname) and speedup.equals('true')}">
<!-- <echo>${outFile} is up to date.</echo> -->
</j:when>
<j:otherwise>
<echo>Generating ${outFile} from ${file}</echo> <echo>Generating ${outFile} from ${file}</echo>
<!-- work out relative path --> <!-- work out relative path -->
<util:replace var="docsForward" oldChar="\" newChar="/" value="${srcdir}"/> <util:replace var="docsForward" oldChar="\" newChar="/" value="${srcdir}"/>
@ -479,6 +493,10 @@
prettyPrint="no"> prettyPrint="no">
<j:include uri="${stylesheet.toString()}"/> <j:include uri="${stylesheet.toString()}"/>
</j:file> </j:file>
</j:otherwise>
</j:choose>
</j:forEach> </j:forEach>
</util:available> </util:available>

2
xdoc/plugin.properties
View File

@ -84,6 +84,8 @@ maven.xdoc.copy.excludes.classic=external-classic.png,help_logo.gif,icon_arrowfo
# Note that navigation.xml and ${maven.xdoc.xml.copy} are included implicitly # Note that navigation.xml and ${maven.xdoc.xml.copy} are included implicitly
maven.xdoc.validate.exclude=changes.xml maven.xdoc.validate.exclude=changes.xml
maven.xdoc.skip.uptodate=false
# #
# I18N Preferences # I18N Preferences
# #

1
xdoc/xdocs/changes.xml
View File

@ -27,6 +27,7 @@
</properties> </properties>
<body> <body>
<release version="1.10" date="in SVN"> <release version="1.10" date="in SVN">
<action dev="ltheussl" type="add" issue="MPXDOC-141" due-to="M. Sean Gilligan">Perform JSL transforms on xdocs <strong>only</strong> when they have changed.</action>
<action dev="ltheussl" type="add" issue="MPXDOC-169">Add xdoc tag library documentation to the plugin site.</action> <action dev="ltheussl" type="add" issue="MPXDOC-169">Add xdoc tag library documentation to the plugin site.</action>
<action dev="ltheussl" type="fix" issue="MPXDOC-87">Fix <code>xdoc:validate</code>.</action> <action dev="ltheussl" type="fix" issue="MPXDOC-87">Fix <code>xdoc:validate</code>.</action>
<action dev="ltheussl" type="fix" issue="MPXDOC-106" due-to="Jerome Lacoste">One cannot call xdoc:copy-user-resources directly.</action> <action dev="ltheussl" type="fix" issue="MPXDOC-106" due-to="Jerome Lacoste">One cannot call xdoc:copy-user-resources directly.</action>

25
xdoc/xdocs/properties.xml
View File

@ -61,6 +61,15 @@
<code>${maven.build.dir}/generated-xdocs</code>. <code>${maven.build.dir}/generated-xdocs</code>.
</td> </td>
</tr> </tr>
</table>
</section>
<section name="Performance Properties">
<table>
<tr>
<th>Property name</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr> <tr>
<td>maven.xdoc.xml.copy</td> <td>maven.xdoc.xml.copy</td>
<td>Yes</td> <td>Yes</td>
@ -102,6 +111,22 @@
<code>changes.xml</code>. <code>changes.xml</code>.
</td> </td>
</tr> </tr>
<tr>
<td>maven.xdoc.skip.uptodate</td>
<td>Yes</td>
<td>
If set to <code>true</code>, Maven compares the timestamps
of corresponding source- and generated files and only
performs a transformation if they are different.
This leads to a speedup of the site generation by eliminating
tranforms of unchanged documents. <strong>Note</strong>:
this only applies to user-supplied source documents, if you
change settings in <code>project.xml</code>, <code>navigation.xml</code>
or any other properties- or configuration file, you should
generate the site from scratch to make sure all cross-links
are correct. Defaults to <code>false</code>.
</td>
</tr>
</table> </table>
</section> </section>
<section name="Localization Properties"> <section name="Localization Properties">