| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| <html> |
| <head> |
| <script type="text/javascript">var xookiConfig = {level: 1};</script> |
| <script type="text/javascript" src="../xooki/xooki.js"></script> |
| </head> |
| <body> |
| <textarea id="xooki-source"> |
| <b>Tag:</b> outputters |
| |
| <span class="tagdoc" id="ivysettings.outputters">Defines a list of report outputters usable in ivy. </span> |
| |
| A report outputter is used at the end of the resolve process to generate a report of how the resolve has been performed. |
| |
| Two report outputters are registered by default: |
| <ul> |
| <li>a log report outputter ([[gitfile:src/java/org/apache/ivy/plugins/report/LogReportOutputter.java LogReportOutputter]])</li>which produces the output on the console at the end of the resolve, which looks like this: |
| <code> |
| --------------------------------------------------------------------- |
| | | modules || artifacts | |
| | conf | number| search|dwnlded|evicted|| number|dwnlded| |
| --------------------------------------------------------------------- |
| | default | 1 | 1 | 0 | 0 || 1 | 1 | |
| --------------------------------------------------------------------- |
| </code> |
| <li>an xml report outputter ([[gitfile:src/java/org/apache/ivy/plugins/report/XmlReportOutputter.java XmlReportOutputter]])</li>which produces an xml report in the cache, which is mandatory for correct Ivy behaviour, since it's that report which is used when you do a post resolve step in a separate build from the resolve itself. It's also this xml report which is processed to generate all the different reports available in the [[ant:report]] task. |
| </ul> |
| |
| The child tag used for the parser must be equal to a name of a report outputter type (added with the typedef tag). |
| |
| To see how to define your own report outputter see <a href="../extend.html">Extending Ivy documentation</a> |
| |
| <h1>Child elements</h1> |
| <table class="ivy-children"> |
| <thead> |
| <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr> |
| </thead> |
| <tbody> |
| <tr><td>any report outputter</td><td>adds a report outputter to the list of available ones</td> |
| <td>0..n</td></tr> |
| </tbody> |
| </table> |
| |
| </textarea> |
| <script type="text/javascript">xooki.postProcess();</script> |
| </body> |
| </html> |