mirror of https://github.com/apache/ant-ivy
add detail on graph files
git-svn-id: https://svn.apache.org/repos/asf/incubator/ivy/core/trunk@519050 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Xavier Hanin
parent
eadd7afada
commit
be2a58b8c1
|
|
@ -5,75 +5,75 @@
|
|||
<script type="text/javascript" src="../../xooki/xooki.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<textarea id="xooki-source">
|
||||
Generates reports of dependency resolving. One report per configuration is generated, but all reports generated together are hyperlinked one to each other.
|
||||
|
||||
This task should be used only after a call to resolve, even if the call was not done during the same ant build.
|
||||
In fact, this task uses xml report generated by resolve in cache. So if you call resolve on a module for a given configuration, you can call report safely on this module and this configuration as long as you do not clean your ivy cache.
|
||||
|
||||
If you want to have an idea of what reports look like, check this very simple <a href="../../samples/jayasoft-ivyrep-example-default.html">example</a>.
|
||||
|
||||
The task also generates a graphml file which can be loaded with the free <a href="http://www.yworks.com/en/products_yed_about.htm">yEd</a> graph editor.
|
||||
Then following a few <a href="../../doc/yed.html">simple steps</a> you can obtain a graph like this <a href="../../samples/jayasoft-ivyrep-example-default.jpg">one</a>.
|
||||
|
||||
<div class="since">since 1.4</div> If a custom XSL is specified, it's possible to specify additional parameters to the stylesheet.
|
||||
|
||||
<table class="ant">
|
||||
<thead>
|
||||
<tr><th class="ant-att">Attribute</th><th class="ant-desc">Description</th><th class="ant-req">Required</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>todir</td><td>the directory to which reports should be generated</td>
|
||||
<td>No, defaults to ${ivy.report.todir}, or execution directory if not defined</td></tr>
|
||||
<tr><td>outputpattern</td><td>the generated report names pattern</td>
|
||||
<td>No, defaults to ${ivy.report.output.pattern}, or [organisation]-[module]-[conf].[ext] if not defined</td></tr>
|
||||
<tr><td>xsl</td><td>true to generate a report (by default html report) using xslt, false otherwise <span class="since">since 1.3</span></td>
|
||||
<td>No, defaults to true</td></tr>
|
||||
<tr><td>xml</td><td>true to generate a xml report, false otherwise <span class="since">since 1.3</span></td>
|
||||
<td>No, defaults to false</td></tr>
|
||||
<tr><td>graph</td><td>true to generate graphml files, false otherwise</td>
|
||||
<td>No, defaults to true</td></tr>
|
||||
<tr><td>dot</td><td>true to generate dot files, false otherwise <span class="since">since 1.4</span></td>
|
||||
<td>No, defaults to false</td></tr>
|
||||
<tr><td>conf</td><td>a comma separated list of the configurations for which a report should be generated</td>
|
||||
<td>No. Defaults to the configurations resolved by the last resolve call (during same ant build), or ${ivy.resolved.configurations} if no resolve was called</td></tr>
|
||||
<tr><td>organisation</td><td>the name of the organisation of the module for which report should be generated</td>
|
||||
<td>No, unless no resolve was called during the build. Defaults to last resolved module organisation.</td></tr>
|
||||
<tr><td>module</td><td>the name of the module for which report should be generated</td>
|
||||
<td>No, unless no resolve was called during the build. Defaults to last resolved module.</td></tr>
|
||||
<tr><td>validate</td><td>true to force ivy files validation against ivy.xsd, false to force no validation</td>
|
||||
<td>No. Defaults to default ivy value (as configured in configuration file)</td></tr>
|
||||
<tr><td>xslfile</td><td>indicates which xsl file should be used to generate the report</td>
|
||||
<td>No, defaults to ivy provided xsl which generates html report</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h1>Examples</h1>
|
||||
To generate a HTML and graphml report:
|
||||
<code type="xml">
|
||||
<report conf="compile" />
|
||||
</code>
|
||||
|
||||
<hr/>
|
||||
To generate a HTML report only:
|
||||
<code type="xml">
|
||||
<report conf="compile" graph="false" />
|
||||
</code>
|
||||
|
||||
<hr/>
|
||||
To generate an XML report using a custom stylesheet:
|
||||
<code type="xml">
|
||||
<report conf="compile" xslfile="my-custom-stylesheet.xsl" xslext="xml" />
|
||||
</code>
|
||||
|
||||
To generate an XML report using a custom stylesheet which needs some parameters:
|
||||
<code type="xml">
|
||||
<report conf="compile" xslfile="my-custom-stylesheet.xsl" xslext="xml">
|
||||
<param name="param1" expression="value1" />
|
||||
<param name="param2" expression="value2" />
|
||||
</report>
|
||||
</code>
|
||||
|
||||
<textarea id="xooki-source">
|
||||
Generates reports of dependency resolving. One report per configuration is generated, but all reports generated together are hyperlinked one to each other.
|
||||
|
||||
This task should be used only after a call to resolve, even if the call was not done during the same ant build.
|
||||
In fact, this task uses xml report generated by resolve in cache. So if you call resolve on a module for a given configuration, you can call report safely on this module and this configuration as long as you do not clean your ivy cache.
|
||||
|
||||
If you want to have an idea of what reports look like, check this very simple <a href="../../samples/jayasoft-ivyrep-example-default.html">example</a>.
|
||||
|
||||
The task also generates a graphml file which can be loaded with the free <a href="http://www.yworks.com/en/products_yed_about.htm">yEd</a> graph editor.
|
||||
Then following a few <a href="../../doc/yed.html">simple steps</a> you can obtain a graph like this <a href="../../samples/jayasoft-ivyrep-example-default.jpg">one</a>.
|
||||
|
||||
<div class="since">since 1.4</div> If a custom XSL is specified, it's possible to specify additional parameters to the stylesheet.
|
||||
|
||||
<table class="ant">
|
||||
<thead>
|
||||
<tr><th class="ant-att">Attribute</th><th class="ant-desc">Description</th><th class="ant-req">Required</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>todir</td><td>the directory to which reports should be generated</td>
|
||||
<td>No, defaults to ${ivy.report.todir}, or execution directory if not defined</td></tr>
|
||||
<tr><td>outputpattern</td><td>the generated report names pattern</td>
|
||||
<td>No, defaults to ${ivy.report.output.pattern}, or [organisation]-[module]-[conf].[ext] if not defined</td></tr>
|
||||
<tr><td>xsl</td><td>true to generate a report (by default html report) using xslt, false otherwise <span class="since">since 1.3</span></td>
|
||||
<td>No, defaults to true</td></tr>
|
||||
<tr><td>xml</td><td>true to generate a xml report, false otherwise <span class="since">since 1.3</span></td>
|
||||
<td>No, defaults to false</td></tr>
|
||||
<tr><td>graph</td><td>true to generate graphml files, false otherwise</td>
|
||||
<td>No, defaults to true</td></tr>
|
||||
<tr><td>dot</td><td>true to generate <a href="http://www.graphviz.org/">graphviz dot</a> files, false otherwise <span class="since">since 1.4</span></td>
|
||||
<td>No, defaults to false</td></tr>
|
||||
<tr><td>conf</td><td>a comma separated list of the configurations for which a report should be generated</td>
|
||||
<td>No. Defaults to the configurations resolved by the last resolve call (during same ant build), or ${ivy.resolved.configurations} if no resolve was called</td></tr>
|
||||
<tr><td>organisation</td><td>the name of the organisation of the module for which report should be generated</td>
|
||||
<td>No, unless no resolve was called during the build. Defaults to last resolved module organisation.</td></tr>
|
||||
<tr><td>module</td><td>the name of the module for which report should be generated</td>
|
||||
<td>No, unless no resolve was called during the build. Defaults to last resolved module.</td></tr>
|
||||
<tr><td>validate</td><td>true to force ivy files validation against ivy.xsd, false to force no validation</td>
|
||||
<td>No. Defaults to default ivy value (as configured in configuration file)</td></tr>
|
||||
<tr><td>xslfile</td><td>indicates which xsl file should be used to generate the report</td>
|
||||
<td>No, defaults to ivy provided xsl which generates html report</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h1>Examples</h1>
|
||||
To generate a HTML and graphml report:
|
||||
<code type="xml">
|
||||
<report conf="compile" />
|
||||
</code>
|
||||
|
||||
<hr/>
|
||||
To generate a HTML report only:
|
||||
<code type="xml">
|
||||
<report conf="compile" graph="false" />
|
||||
</code>
|
||||
|
||||
<hr/>
|
||||
To generate an XML report using a custom stylesheet:
|
||||
<code type="xml">
|
||||
<report conf="compile" xslfile="my-custom-stylesheet.xsl" xslext="xml" />
|
||||
</code>
|
||||
|
||||
To generate an XML report using a custom stylesheet which needs some parameters:
|
||||
<code type="xml">
|
||||
<report conf="compile" xslfile="my-custom-stylesheet.xsl" xslext="xml">
|
||||
<param name="param1" expression="value1" />
|
||||
<param name="param2" expression="value2" />
|
||||
</report>
|
||||
</code>
|
||||
|
||||
</textarea>
|
||||
<script type="text/javascript">xooki.postProcess();</script>
|
||||
</body>
|
||||
|
|
|
|||
Loading…
Reference in New Issue