File: README.source

package info (click to toggle)
roundcube-plugins-extra 0.7-20120110
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 2,372 kB
  • sloc: php: 10,427; xml: 574; sh: 75; makefile: 53; awk: 51
file content (67 lines) | stat: -rw-r--r-- 2,372 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
README.source for the roundcube-plugins-extra package
=====================================================

roundcube-plugins-extra is a collection of plugins for the Roundcube webmail
that are not maintained by Roundcube upstreams. This package aggregates
plugins from different sources, using the "multiple upstream tarballs" feature
introduced in Debian package source format 3.0.

For more informations about "multiple upstream tarball", please look up the
relevant F.A.Q entry:

  http://wiki.debian.org/Projects/DebSrc3.0#How_to_use_multiple_upstream_tarball_in_3.0_.28quilt.29_format.3F

Version number
--------------

The upstream package version number should be the some as the upstream version
number of the roundcube package.

The Debian revision is made with the date of the package upload.

Example:

                 package upload date
                      vvvvvvvv
                0.5.1-20110529
                ^^^^^
       roundcube version number

How to add a new plugin
-----------------------

1. Add a new 'Plugin' paragraph in `debian/plugins`.
2. Call `debian/rules get-orig-tarballs` to download the new tarball.
3. Call `debian/rules extract-tarballs` to unpack the plugin at the
   right place.
4. Look at its files and document their license in `debian/copyright`.
5. Mention the plugin in the extended description of the package
   in `debian/control`.

`debian/plugins`
----------------

The `debian/plugins` describe the plugins shipped in `roundcube-plugins-extra`
in a machine-readable format.

It mimics the RFC822-like format of many Debian files.

Each plugin is described in a 'Plugin' paragraph with the following fields:

 * 'Plugin' contains the short name of the plugin,
 * 'Source' is the URL with the plugin tarball,
 * 'Version' contains the plugin version.
 * 'Exclude-patterns' (optional) contains a list (one on each line) of patterns
   that `tar` will exclude when uncompressing the tarball.
 * 'Repack' (optional) if set to 'yes' the upstream tarball will be
   uncompressed (excluding files matching the previous patterns) and
   recompressed.

An example:

    Plugin: sieverules
    Source: http://www.tehinterweb.co.uk/roundcube/plugins/sieverules.tar.gz
    Version: 1.11

The plugin version MUST be incremented every time there is an upstream update,
otherwise there will be an issue on the next package upload.