info
Tag: info Parent: ivy-module
Gives information about the module this ivy file describe.
since 1.4 This tag supports extra attributes.
Attributes
| Attribute |
Description |
Required |
| organisation |
the name of the organisation that is the owner of this module. |
Yes |
| module |
the name of the module described by this ivy file. |
Yes |
| branch |
the branch of this module. since 1.4 |
No, defaults to the default branch configured, or nothing if no default branch is configured |
| revision |
the revision of this module. |
Yes in repository ivy files, no in ivy files to resolve |
| status |
the status of this module. See terminology section for details |
No, default to 'integration' |
| publication |
the date of publication of this module. It should be given in this format: yyyyMMddHHmmss |
No, but it's a good practice to set it with delivered ivy files |
Child elements
| Element |
Description |
Cardinality |
| license |
contains information about the licenses of the described module |
0..n |
| ivyauthor |
describes who has contributed to write the ivy file |
0..n |
| repository |
describes on which public repositories this module can be found |
0..n |
| description |
describes how to use the module |
0..1 |
license
Tag: license
Parent: info
Gives information about a license of the described module.
Attributes
| Attribute | Description | Required |
|---|
| name | the name of the license. Try to respect spelling when using a classical license. |
Yes |
| url | an url pointing to the license text. |
No, but it's a good practice to indicate it |
ivyauthor
Tag: ivyauthor
Parent: info
Gives information about who has contributed to write this ivy file. It does NOT indicate who
is the author of the module itself.
Attributes
| Attribute | Description | Required |
|---|
| name | the name of the author, as a person or a company. |
Yes |
| url | an url pointing to where the author can bea reached. |
No, but it's a good practice to indicate it |
repository
Tag: repository
Parent: info
Gives information about a public repository where the module can be found. This information
is given as an indication, repositories being able to be down over time.
Attributes
| Attribute | Description | Required |
|---|
| name | the name of the repository. Try to respect spelling for common repositories (ibiblio, ivyrep, ...) |
Yes |
| url | an url pointing to the repository. |
Yes |
| pattern | an ivy pattern to find modules on this repository |
No, but it's recommended to indicate it. |
| ivys | true if ivy file can be found on this repository |
No, defaults to false. |
| artifacts | true if module artifacts can be found on this repository |
No, defaults to false. |
description
Tag: description
Parent: info
Describes the current module. This tag is the only one which can contain free text,
including html. It is used to describe the module itself, usually in a single short phrase
(it is not meant to replace the module description on the corresponding web site), and then
gives all information necessary to use the module, especially information about
public configurations, how and when to use them.
Attributes
| Attribute | Description | Required |
|---|
| homepage | the url of the homepage of the module |
No, but it's recommended to indicate it. |