Skip to content
This repository was archived by the owner on Feb 20, 2019. It is now read-only.

Commit 4359c37

Browse files
committed
Merge pull request #706 from owncloud/app-dependencies
document new dependency tags in info.xml
2 parents 70ddb7e + fbfc653 commit 4359c37

File tree

1 file changed

+48
-1
lines changed

1 file changed

+48
-1
lines changed

developer_manual/app/info.rst

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,19 @@ The :file:`appinfo/info.xml` contains metadata about the app:
4343
4444
<default_enable />
4545
<shipped>true</shipped>
46+
47+
<dependencies>
48+
<php min-version="5.4" max-version="5.5"/>
49+
<database>sqlite</database>
50+
<database>mysql</database>
51+
<command os="linux">grep</command>
52+
<command os="windows">notepad.exe</command>
53+
<lib min-version="1.2">xml</lib>
54+
<lib max-version="2.0">intl</lib>
55+
<lib>curl</lib>
56+
<os>Linux</os>
57+
<owncloud min-version="6.0.4" max-version="8"/>
58+
</dependencies>
4659
</info>
4760
4861
id
@@ -96,7 +109,41 @@ link to 'admin' and 'user' documentation
96109

97110
website
98111
-------
99-
link to project webpage
112+
link to project web page
113+
114+
Dependencies
115+
============
116+
All tags within the dependencies tag define a set of requirements which have to be fulfilled in order to operate
117+
properly. As soon as one of these requirements is not met the app cannot be installed.
118+
119+
php
120+
---
121+
Defines the minimum and the maximum version of php which is required to run this app.
122+
123+
database
124+
--------
125+
Each supported database has to be listed in here. Valid values are sqlite, mysql, pgsql, oci and mssql. In the future
126+
it will be possible to specify versions here as well.
127+
In case no database is specified it is assumed that all databases are supported.
128+
129+
command
130+
-------
131+
Defines a command line tool to be available. With the attribute 'os' the required operating system for this tool can be
132+
specified. Valid values for the 'os' attribute are as returned by the php function `php_uname http://php.net/manual/en/function.php-uname.php`_.
133+
134+
lib
135+
---
136+
Defines a required php extension with required minimum and/or maximum version. The names for the libraries have to match the result as returned by the php function `get_loaded_extensions http://php.net/manual/en/function.get-loaded-extensions.php`_.
137+
The explicit version of an extension is read from `phpversion http://php.net/manual/de/function.phpversion.php`_ - with some exception as to be read up in the code base `https://github.com/owncloud/core/blob/master/lib/private/app/platformrepository.php#L45`_
138+
139+
os
140+
--
141+
Defines the required target operating system the app can run on. Valid values are as returned by the php function `php_uname http://php.net/manual/en/function.php-uname.php`_.
142+
143+
owncloud
144+
--------
145+
Defines minimum and maximum versions of the ownCloud core. In case undefined the values will be taken from the tag 'requiremin'.
146+
100147

101148
Deprecated
102149
==========

0 commit comments

Comments
 (0)