Debian Bug report logs - #262533
php4-pear: Packaging convention for PEAR modules

Toggle useless messages

Message #5 received at submit@bugs.debian.org (full text, mbox, reply):

From: Jeroen van Wolffelaar <jeroen@wolffelaar.nl>

To: Debian Bug Tracking System <submit@bugs.debian.org>

Subject: php4-pear: Packaging convention for PEAR modules

Date: Sat, 31 Jul 2004 17:36:34 +0200

Package: php4-pear
Version: 4:4.3.4-4
Severity: wishlist

It'd be useful to have a packaging policy/convention for PEAR modules.
The only pear module currently in the archive is php4-pear-log, but it
still uses /usr/share/pear, so isn't really a good prototype. This
policy could best be added (at least) to /usr/share/doc/php4-pear, which
is at least the place where I looked first for such a document, probably
add also a reference to there from php4-dev just in case.

Here a draft of this document. I think this is useful, because several
packages fail one or more points (php4-pear-log fails install location
and naming convention, php-date and php-file fail to acknowledge the
authors in their copyright files, the available changelog isn't always
put in the package, and the documentation isn't extracted and made
available via /usr/share/doc/package)

1) Package name

Module Mail_Mime will be packaged as php-mail-mime

2) Packaging

- Download from pear.php.net
- Write a watch file while you're at it. Example:

version=2
http://pear.php.net/package/<package>/download /get/<package>-([\d.]+)\.tgz

- Repack the original tarball to move the top-level package.xml file
one level up
- Lookup copyright in the package.xml, and write a debian/copyright with
  it, add the authors to the copyright file too, don't forget to name
  the website http://pear.php.net/package/<package>
- Convert the package.xml to an upstream changelog (get the <changelog>
  .. </changelog> part, sed away all tags, re-whitespace, and be done
  with it)
- Install the correct files in /usr/share/php/<Package> (with _ replaced by /)
- Add to /usr/share/doc/<packagename> a README where you refer to the
  website for documentation, bugs (optional, one could use Debian's BTS
  too), etc
- Documentation on the website is generated by phpDocumenter from the
  source package, you should run it, and put the documentation in
  /usr/share/doc/.../html). If it's much, you might split the
  documentation out of it, but that'd usually not be necessary.

3) Beyond packaging

Respond to bugs, use rss2email to subscribe to the RSS feed for that
package to know about new releases.

--Jeroen

-- System Information:
Debian Release: testing/unstable
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: i386 (i686)
Kernel: Linux 2.6.3
Locale: LANG=nl_NL.UTF-8@euro, LC_CTYPE=nl_NL.UTF-8@euro

Versions of packages php4-pear depends on:
ii  php4-cgi                      4:4.3.4-4  A server-side, HTML-embedded scrip

-- no debconf information

-- 
Jeroen van Wolffelaar
jeroen@wolffelaar.nl
http://jeroen.A-Eskwadraat.nl

Message #10 received at 262533@bugs.debian.org (full text, mbox, reply):

From: Charles Fry <debian@frogcircus.org>

To: Debian Bug Tracking System <262533@bugs.debian.org>

Subject: php4-pear: current pear module packaging best practices

Date: Sat, 01 Oct 2005 00:36:10 -0400

Package: php4-pear
Version: 4:4.4.0-2
Followup-For: Bug #262533

For the record, a more thorough document was put together by Pierre
Habouzit at:

   http://www.madism.org/debian.pear.php

There was a long discussion about this on the debian-webapps mailing
list, that included a long list of specific changes that should be made
to that document:

   http://lists.debian.org/debian-webapps/2005/07/msg00011.html

The team working on a Debain Webapps Policy was going to work on
integrating these changes into Pierre's document:

   http://cvs.alioth.debian.org/cgi-bin/cvsweb.cgi/webapps-common/doc/Webapps-Pear-Policy-Manual-DRAFT.html?cvsroot=webapps-common

In the meantime, Uwe Steinmann created dh-make-php, and we went to great
effort to ensure that it was consistent with the agreed upon policy for
packaging PEAR modules (even though noone had succesfully wrotten that
policy down). As a result, the current dh-make-php (which contains
dh-make-pear) is the current embodiment of this policy.

Finally, I am working on a cdbs pear.mk file based off of Uwe's
dh-make-pear debian/rules.

So, I guess if nothing else, that gives you at least one easy way to
close this bug: by mentioning dh-make-pear somewhere. :-)

Charles

-- System Information:
Debian Release: testing/unstable
  APT prefers testing
  APT policy: (900, 'testing'), (800, 'stable'), (70, 'unstable')
Architecture: i386 (i686)
Shell:  /bin/sh linked to /bin/bash
Kernel: Linux 2.6.8-2-386
Locale: LANG=en_US, LC_CTYPE=en_US (charmap=ISO-8859-1)

Versions of packages php4-pear depends on:
ii  php-db                        1.7.6-2    PHP PEAR Database Abstraction Laye
ii  php-http                      1.3.6-2    PHP PEAR module for HTTP related s
ii  php-mail                      1.1.6-2    PHP PEAR module for sending email
ii  php-net-smtp                  1.2.6-2    PHP PEAR module implementing SMTP 
ii  php-net-socket                1.0.6-2    PHP PEAR Network Socket Interface 
ii  php-pear                      5.0.5-1    PEAR - PHP Extension and Applicati
ii  php-xml-parser                1.2.6-2    PHP PEAR module for parsing XML
ii  php4-common                   4:4.4.0-2  Common files for packages built fr

php4-pear recommends no packages.

-- no debconf information

Message #17 received at 262533-done@bugs.debian.org (full text, mbox, reply):

From: Mathieu Parent <math.parent@gmail.com>

To: 262533-done@bugs.debian.org

Subject: Closing

Date: Sat, 7 Nov 2015 14:29:43 +0100

Hello,

The current convention of PEAR packaging is using pkg-php-tools and
documented at: http://pkg-php.alioth.debian.org/

dh-make-php is on the way out (tracked by #801269)

Regards
-- 
Mathieu

Send a report that this bug log contains spam.