settings

Tag: settings

Configures some important ivy info: default cache, default resolver, ...

Default cache is used whenever a cache is not provided. It usually points to a directory in your filesystem. This should not point to a directory used as a repository!
Since 2.0 Once the settings are loaded, the value of the defaultCache (either configured or the default value) is stored in an Ivy variable: ivy.cache.dir.

Default resolver is used whenever nothing else is configured in the modules section of the configuration file. It should give the name of a dependency resolver defined in the resolvers section of the configuration file.

Default latest strategy and conflict manager can also be configured here.

validate indicates if ivy files should generally be validate against xsd or not. This setting is only a default value, and can be overriden :
1) in ant tasks
2) in resolvers
So if there is a setting in the resolver, it always win against all other settings.

checkUpToDate indicates to ivy if it must check date of artifacts before retrieving them (i.e. copying them from
cache to another place in your filesystem). Usually it is a good thing to check date to avoid unnecessary copy, even if it's most of the time a local copy.

cacheIvyPattern and cacheArtifactPattern are used to configure the way ivy stores ivy files and artifacts in the cache. Usually you do not have to change this, unless you want to use the cache directly from another tool, which is not recommended.

Attributes

Attribute	Description	Required
defaultCache	a path to a directory to use as default cache	No, defaults to .ivy2/cache in user home
defaultResolver	the name of the default resolver to use	No, but all modules should be configured in the modules section if not provided
defaultLatestStrategy	the name of the default latest strategy to use	No, defaults to latest-revision
defaultConflictManager	the name of the default conflict manager to use	No, defaults to latest-revision
defaultBranch	the default branch to use for all modules, except if they have a module specific branch setting. since 1.4	No, defaults to no default branch
circularDependencyStrategy	the name of the circular dependency strategy to use since 1.4	No, defaults to warn
validate	Indicates if ivy files should be validated against ivy.xsd or not.	No, defaults to true
checkUpToDate	Indicates if date should be checked before retrieving artifacts from cache	No, defaults to true
cacheIvyPattern	a pattern to indicate where ivy files should be put in cache	No, defaults to [organisation]/[module]/ivy-[revision].xml
cacheArtifactPattern	a pattern to indicate where artifact files should be put in cache	No, defaults to [organisation]/[module]/[type]s/[artifact]-[revision].[ext]
useRemoteConfig	true to configure ivyrep and ibiblio resolver from a remote configuration file (updated with changes in those repository structure if any) (since 1.2)	No, defaults to false