~ubuntu-branches/ubuntu/quantal/python-peak.rules/quantal

« back to all changes in this revision

Viewing changes to debian/README.source

  • Committer: Package Import Robot
  • Author(s): Barry Warsaw
  • Date: 2011-10-21 18:51:25 UTC
  • mfrom: (0.8.1) (0.7.1) (1.4.1) (4.1.2 precise)
  • Revision ID: package-import@ubuntu.com-20111021185125-tasydfgcvgc6ynyh
Tags: 0.5a1+r2707-1fakesync1
Fake sync due to mismatching orig tarball.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
 
2
1
Upgrade to a new upstream
3
2
=========================
4
3
 
5
 
This package is a multi-upstream source package, i.e., its
6
 
.orig.tar.gz is composed by several upstream tarballs, possibly
7
 
released by independent authors.
8
 
 
9
 
To obtain a new orig tarball you can invoke the get-orig-source target
10
 
of debian/rules as follows:
11
 
 
12
 
   $ debian/rules get-orig-source
13
 
 
14
 
If all goes well, that should leave around a .orig.tar.gz
15
 
 
16
 
Note that the target does not check whether creating a new upstream
17
 
version is needed: invoke it only if you know that some of the
18
 
upstream parts of this package need updates. Otherwise, use "apt-get
19
 
source PACKAGE" to work on the latest uploaded upstream release.
 
4
This package use multiple upstream tarballs support provided by source package
 
5
format "3.0 (quilt)".
 
6
 
 
7
To obtain new orig tarballs you have to specify package version inside
 
8
debian/changelog, update module version in the $(PRIORITIZED_METHODS) Makefile
 
9
variable inside debian/rules and then invoke the get-orig-source target of
 
10
debian/rules as follows:
 
11
 
 
12
    $ debian/rules get-orig-source
 
13
 
 
14
If all goes well, that should leave, inside the the current directory a tarball
 
15
called
 
16
 
 
17
    PACKAGE_VERSION.orig.tar.gz
 
18
 
 
19
    where PACKAGE is the source package name and VERSION is the version
 
20
    specified in debian/changelog;
 
21
 
 
22
and a two tarballs called
 
23
 
 
24
    PACKAGE_VERSION.orig-rules.tar.gz
 
25
 
 
26
    PACKAGE_VERSION.orig-EXTENSIONNAME-EXTENSIONVERSION.tar.gz
 
27
 
 
28
    where EXTENSIONNAME and EXTENSIONVERSION are specified in the
 
29
    $(PRIORITIZED_METHODS) Makefile variable inside debian/rules:
 
30
    the only known extension, at the time of this packaging work, is
 
31
    prioritized_methods so we can directly pertain to it.
 
32
 
 
33
When using svn-buildpackage because --svn-download-orig argument
 
34
doesn't work as expected (see #577140) *.orig tarballs must manually moved
 
35
inside origDir.
20
36
 
21
37
 
22
38
Package version
30
46
Adding a new contrib
31
47
====================
32
48
 
33
 
As this package ships contribs for PEAK.rules, it is natural to expect
34
 
that in the future new contribs will be added. To add one to the
35
 
package follow a few simple rules:
 
49
At the time of this packaging work only one contrib exists, but it is natural
 
50
to expect that in the future new contribs will be added. To add one to the
 
51
package a bit of refactoring is needed:
36
52
 
37
 
1) add the module name (usually the egg name) to the $(UPSTREAMS)
38
 
   Makefile variable in debian/rules
 
53
1) $(PRIORITIZED_METHODS) must be renamed to something like $(CONTRIBS) to take
 
54
   note of each contrib name and version
39
55
 
40
56
2) add the per-contrib watch file as debian/NAME.watch, where NAME is
41
 
   the module name
 
57
   the contrib name
42
58
 
43
59
3) add license and copyright information about the new module to
44
60
   debian/copyright
45
61
 
46
 
4) run "debian/rules get-orig-source" to recreate the new tarball
47
 
 
48
 
 
49
 
 -- Stefano Zacchiroli <zack@debian.org>, Thu, 25 Jun 2009 15:30:02 +0200
50
 
 
 
62
4) refactor get-orig-source to handle multiple contrib
 
63
 
 
64
For a complete example you can look at python-peak.util's debian/rules.