blob: 28bc447e114dca00f23c11fd140bbc3b9e7bc335 [file] [log] [blame]
<!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>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
<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> info <b>Parent:</b> <a href="../ivyfile.html">ivy-module</a>
Gives identification and basic information about the module this ivy file describes.
<span class="since">since 1.4</span> This tag supports <a href="../concept.html#extra">extra attributes</a>.
<h1>Attributes</h1>
<table class="ivy-attributes">
<thead>
<tr><th class="ivy-att">Attribute</th><th class="ivy-att-desc">Description</th><th class="ivy-att-req">Required</th></tr>
</thead>
<tbody>
<tr><td>organisation</td><td>the name of the organisation that is the owner of this module.</td>
<td>Yes</td></tr>
<tr><td>module</td><td>the name of the module described by this ivy file.</td>
<td>Yes</td></tr>
<tr><td>branch</td><td>the branch of this module. <span class="since">since 1.4</span></td>
<td>No, defaults to the default branch [[settings/conf setting]], or nothing if no default branch is configured</td></tr>
<tr><td>revision</td><td>the revision of this module.</td>
<td>Yes in repository ivy files, no in ivy files to resolve</td></tr>
<tr><td>status</td><td>the status of this module. See <a href="../reference.html">terminology</a> section for details</td>
<td>No, default to 'integration'</td></tr>
<tr><td>publication</td><td>the date of publication of this module. It should be given in this format: yyyyMMddHHmmss</td>
<td>No, but it's a good practice to set it with delivered ivy files</td></tr>
</tbody>
</table>
<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><a href="../ivyfile/extends.html">extends</a></td><td>identifies a parent Ivy file from which this descriptor inherits content</td>
<td>0..n</td></tr>
<tr><td><a href="../ivyfile/license.html">license</a></td><td>contains information about the licenses of the described module</td>
<td>0..n</td></tr>
<tr><td><a href="../ivyfile/ivyauthor.html">ivyauthor</a></td><td>describes who has contributed to write the ivy file</td>
<td>0..n</td></tr>
<tr><td><a href="../ivyfile/repository.html">repository</a></td><td>describes on which public repositories this module can be found</td>
<td>0..n</td></tr>
<tr><td><a href="../ivyfile/description.html">description</a></td><td>describes how to use the module</td>
<td>0..1</td></tr>
</tbody>
</table>
After the description, you can also place your own tags in your own namespace. This allow to provide some custom information about the module.
</textarea>
<script type="text/javascript">xooki.postProcess();</script>
</body>
</html>