Differences between revisions 2 and 73 (spanning 71 versions)
Revision 2 as of 2015-04-22 07:14:37
Size: 968
Comment:
Revision 73 as of 2016-04-12 01:55:56
Size: 7316
Editor: SeanWhitton
Comment: dh-make-elpa has reached experimental
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
||<rowstyle="background-color: #EEEEEE;">'''Language'''|| Any || Perl || Ruby ||
||'''Tool (package name)'''|| dh-make || dh-make-perl || gem2deb ||
||'''Upstream repository'''|| N/A || CPAN.org || Rubygems.org ||
||||||||<rowstyle="background-color: #EEEEEE;"> Use cases ||
||||||||<rowstyle="background-color: #EEEEEE;"> Features ||
|| cdbs or dh? ||
|| Fill in debian/copyright ||
|| Fill debian/watch ||
|| Refresh mode (regenerate all files, moving old ones to .bak) ||
|| Handle git repo creation, pristine-tar, etc. ||
|| Generate debian/upstream/metadata (UpstreamMetadata) ||
||<rowstyle="background-color: #EEEEEE;">'''Language'''|| Any || Perl || Ruby || Python || Python || Node.js || Haskell || Go || ELPA (Emacs Lisp) ||
||'''Tool (package name)'''|| [[https://tracker.debian.org/dh-make|dh-make]] || [[https://tracker.debian.org/dh-make-perl|dh-make-perl]] || [[https://tracker.debian.org/gem2deb|gem2deb]] || [[https://tracker.debian.org/python3-stdeb|python3-stdeb]] || [[https://github.com/p1otr/pypi2deb|pypi2deb]] || [[https://tracker.debian.org/npm2deb|npm2deb]] || [[https://tracker.debian.org/cabal-debian|cabal-debian]] || [[https://tracker.debian.org/dh-make-golang|dh-make-golang]] || dh-make-elpa ||
||'''Upstream repository'''|| N/A || [[http://www.cpan.org/|CPAN.org]], [[https://anonscm.debian.org/cgit/pkg-perl/packages/dh-make-perl.git|Alioth]] || [[http://www.rubygems.org/|Rubygems.org]] || [[http://pypi.python.org/|PyPI]] || [[http://pypi.python.org/|PyPI]] || [[https://www.npmjs.com|npm]] || [[http://hackage.haskell.org/|Hackage]] || unknown || [[https://melpa.org/|MELPA]] ||
||||||||||||||||||<rowstyle="background-color: #EEEEEE;"> Features ||||
|| version || 1.20150601 || 0.89-1 || 0.21.1 || 0.8.5-1 || 0.20150816 || 0.2.2-1 || 4.31-1 || 0.0~git20150726.0.fc4210a-1 || 0.1.0 (experimental) ||
|| cdbs or dh? || dh || dh || dh || dh || dh || dh || cdbs || dh || dh ||
|| use DEBEMAIL || yes || yes || yes || yes || yes || yes || yes || yes || yes ||
|| Build-Depends || no || yes || yes || partial || yes || no || yes || yes || partial ||
|| Depends || no || yes || yes || yes || yes || yes || at build time || yes || yes ||
|| Homepage || no || yes || yes || yes || yes || yes || no || yes || yes ||
|| short/long descriptions || no || yes || yes || yes || yes || short only || yes || yes || yes ||
|| DEP8 tests || no || yes (autopkgtest-pkg-perl in pkg-perl mode) || only template || no || no || basic (only require) || no || no || no ||
|| .docs / .examples / etc. || no || docs + examples || docs only || no || docs + examples || docs || no || no || docs only ||
|| debian/copyright || only template || yes || only template || no || yes || yes || yes || yes || yes ||
|| debian/watch || only template || yes|| yes || yes || yes || yes || yes || no || ye s||
|| git repo creation, pristine-tar, etc. || no || yes || no || no || no || no || no || yes || no ||
|| [[UpstreamMetadata|debian/upstream/metadata]] || no || yes || no || no || no || no || no || no || no ||
|| ITP mail template || no || no (use {{{dpt gen-itp}}}) || no || no || yes || yes || no || yes || no ||
== Notes ==
 * There's a [[https://github.com/lnussbaum/autodeb-tests|Git repo]] with some example outputs
 * ''only template'' means that the tool provides a file that is not customized per-package
 * npm2deb only generates the Debian files from metadata, but does not create a proper source package. The upstream source is not downloaded.
 * Several tools use wrap-and-sort to unify structure of debian/ files
=== Build-depends and Depends generation ===
 * dh-make-perl uses local packages and apt-file to identify packages ([[https://bugs.debian.org/783110|broken with 0.84-2 and multiarch]])
 * stdeb also uses apt-file with a fallback on module name conversion ([[https://sources.debian.net/src/stdeb/0.8.2-4/stdeb/util.py/#L265|code]])
 * npm, gem2deb and cabal-Debian only convert upstream package names found in metadata, to Debian package names
 * dh-make-elpa relies on dh-elpa's dependency detection
 * [[https://wiki.debian.org/DEP-11|DEP-11]] could end up being the proper way to generate language-specific dependencies
Line 15: Line 33:
== TO-DO List ==
 * Look at:
  * python-stdeb (Pypi)
  * cabal-debian (haskell)
  * javahelper (Java)
  * npm2deb (Node.js)
  * pkg-php-tools (PHP, PEAR modules)
  * ocaml tool?
 * Investigate meta-helpers
  * debdry
  * https://github.com/FedericoCeratto/debian-package-init
=== Copyright file generation ===
TODO. 'cme update dpkg-copyright' is another approach. See [[https://github.com/dod38fr/config-model/wiki/Updating-debian-copyright-file-with-cme|Updating debian copyright file with cme]]

== Usage ==
 * Download upstream package from repository
  * '''Perl:''' {{{cpan -g Oxford::Calendar}}} (does nothing here ...; here it works :) maybe cpan config needed?)
  * '''Python:''' {{{pypi-download NAME --release VERSION}}}, f.e. {{{pypi-download Mako --release 1.0.1}}}
  * '''npm:''' {{{npm install PKGNAME}}}
  * '''Ruby:''' {{{gem fetch GEMNAME}}}
  * '''Haskell:''' {{{cabal unpack --pristine PKGNAME}}}
  * '''ELPA:''' user is expected to {{{git clone}}} upstream repository
 * Debianize an unpacked upstream source
  * '''Perl:''' {{{dh-make-perl [make] .}}}
  * '''Python:''' {{{python3 setup.py --command-packages=stdeb.command debianize}}}
  * '''Ruby:''' {{{dh-make-ruby}}}
  * '''npm:''' not supported
  * '''Haskell:''' {{{cabal-debian --official}}} (see [[Haskell/CollabMaint/GettingStarted|the step-by-step guide]])
  * '''ELPA:''' {{{dh-make-elpa [make]}}}
 * Debianize (without building source)
  * '''Perl:''' {{{dh-make-perl [make] {SOURCE_DIR | --cpan MODULE|DIST} }}}
  * '''Python:''' not supported
  * '''Ruby:''' {{{gem2deb --only-source-dir GEMNAME|GEMFILE}}}
  * '''npm:''' {{{npm2deb create PKGNAME}}}
  * '''Haskell, ELPA:''' not supported, need unpacked source
 * Debianize and build source package
  * '''Perl:''' {{{dh-make-perl [make] {SOURCE_DIR | --cpan MODULE|DIST} --build-source}}} or {{{cpan2dsc MODULE}}}
  * '''Python:''' {{{py2dsc DISTFILE}}}
  * '''Ruby:''' {{{gem2deb --only-debian-source GEMNAME|GEMFILE}}}
  * '''npm, Haskell, ELPA:''' not supported
 * Debianize and build binary packages
  * '''Perl:''' {{{dh-make-perl [make] {SOURCE_DIR | --cpan MODULE|DIST} --build}}} or {{{cpan2deb MODULE}}}
  * '''Python:''' {{{py2dsc-deb DISTFILE}}}
  * '''Ruby:''' {{{gem2deb GEMNAME|GEMFILE}}}
  * '''npm, Haskell, ELPA:''' not supported
 * Debianize, build, install
  * '''Perl:''' {{{dh-make-perl [make] {SOURCE_DIR | --cpan MODULE|DIST} --install}}}
  * '''Python:''' {{{pypi-install NAME}}}
  * '''Ruby:''' not supported
  * '''npm, Haskell, ELPA:''' not supported
 * Refresh an already created package, moving old files to .bak:
  * '''All:''' {{{cme migrate dpkg}}} or {{{cme fix dpkg}}} See [[https://github.com/dod38fr/config-model/wiki/Managing-Debian-packages-with-cme|Managing Debian package files with cme]]
  * '''Perl:''' {{{dh-make-perl refresh}}}
  * '''Python:''' not supported
  * '''Ruby:''' {{{dh-make-ruby -w}}}
  * '''npm:''' not supported
  * '''Haskell:''' {{{cabal-debian --official --upgrade}}}
  * '''ELPA:''' not yet

== Not (yet) covered tools ==
 * OCaml : oasis2debian and opam2debian

== Other languages without an automated generator ==
 * PHP (PEAR packages) -- see pkg-php-tools for packaging tools (and debpear for a simple generator)
 * Java -- see javahelper/maven-debian-helper for packaging tools. There is also "mh_make"

== See also ==
 * debdry: common frontend for most of the helpers described above [[https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=750576|description]]
 * alien: converts RPM/etc binary packages to deb binary packages
 * checkinstall: run an arbitrary upstream build system and auto-package the output
 * [[Games/GameDataPackager|game-data-packager]]: converts non-free game data files to Debian binary packages

== TODO ==
 * Look at http://tapoueh.org/blog/2015/05/02-ql-to-deb.html
 * The R team seems to have a cran2deb package

This page references tools that aim at providing basic working Debian packages.

Language

Any

Perl

Ruby

Python

Python

Node.js

Haskell

Go

ELPA (Emacs Lisp)

Tool (package name)

dh-make

dh-make-perl

gem2deb

python3-stdeb

pypi2deb

npm2deb

cabal-debian

dh-make-golang

dh-make-elpa

Upstream repository

N/A

CPAN.org, Alioth

Rubygems.org

PyPI

PyPI

npm

Hackage

unknown

MELPA

Features

version

1.20150601

0.89-1

0.21.1

0.8.5-1

0.20150816

0.2.2-1

4.31-1

0.0~git20150726.0.fc4210a-1

0.1.0 (experimental)

cdbs or dh?

dh

dh

dh

dh

dh

dh

cdbs

dh

dh

use DEBEMAIL

yes

yes

yes

yes

yes

yes

yes

yes

yes

Build-Depends

no

yes

yes

partial

yes

no

yes

yes

partial

Depends

no

yes

yes

yes

yes

yes

at build time

yes

yes

Homepage

no

yes

yes

yes

yes

yes

no

yes

yes

short/long descriptions

no

yes

yes

yes

yes

short only

yes

yes

yes

DEP8 tests

no

yes (autopkgtest-pkg-perl in pkg-perl mode)

only template

no

no

basic (only require)

no

no

no

.docs / .examples / etc.

no

docs + examples

docs only

no

docs + examples

docs

no

no

docs only

debian/copyright

only template

yes

only template

no

yes

yes

yes

yes

yes

debian/watch

only template

yes

yes

yes

yes

yes

yes

no

ye s

git repo creation, pristine-tar, etc.

no

yes

no

no

no

no

no

yes

no

debian/upstream/metadata

no

yes

no

no

no

no

no

no

no

ITP mail template

no

no (use dpt gen-itp)

no

no

yes

yes

no

yes

no

Notes

  • There's a Git repo with some example outputs

  • only template means that the tool provides a file that is not customized per-package

  • npm2deb only generates the Debian files from metadata, but does not create a proper source package. The upstream source is not downloaded.
  • Several tools use wrap-and-sort to unify structure of debian/ files

Build-depends and Depends generation

  • dh-make-perl uses local packages and apt-file to identify packages (broken with 0.84-2 and multiarch)

  • stdeb also uses apt-file with a fallback on module name conversion (code)

  • npm, gem2deb and cabal-Debian only convert upstream package names found in metadata, to Debian package names
  • dh-make-elpa relies on dh-elpa's dependency detection
  • DEP-11 could end up being the proper way to generate language-specific dependencies

TODO. 'cme update dpkg-copyright' is another approach. See Updating debian copyright file with cme

Usage

  • Download upstream package from repository
    • Perl: cpan -g Oxford::Calendar (does nothing here ...; here it works :) maybe cpan config needed?)

    • Python: pypi-download NAME --release VERSION, f.e. pypi-download Mako --release 1.0.1

    • npm: npm install PKGNAME

    • Ruby: gem fetch GEMNAME

    • Haskell: cabal unpack --pristine PKGNAME

    • ELPA: user is expected to git clone upstream repository

  • Debianize an unpacked upstream source
    • Perl: dh-make-perl [make] .

    • Python: python3 setup.py --command-packages=stdeb.command debianize

    • Ruby: dh-make-ruby

    • npm: not supported

    • Haskell: cabal-debian --official (see ?the step-by-step guide)

    • ELPA: dh-make-elpa [make]

  • Debianize (without building source)
    • Perl: dh-make-perl [make] {SOURCE_DIR | --cpan MODULE|DIST} 

    • Python: not supported

    • Ruby: gem2deb --only-source-dir GEMNAME|GEMFILE

    • npm: npm2deb create PKGNAME

    • Haskell, ELPA: not supported, need unpacked source

  • Debianize and build source package
    • Perl: dh-make-perl [make] {SOURCE_DIR | --cpan MODULE|DIST} --build-source or cpan2dsc MODULE

    • Python: py2dsc DISTFILE

    • Ruby: gem2deb --only-debian-source GEMNAME|GEMFILE

    • npm, Haskell, ELPA: not supported

  • Debianize and build binary packages
    • Perl: dh-make-perl [make] {SOURCE_DIR | --cpan MODULE|DIST} --build or cpan2deb MODULE

    • Python: py2dsc-deb DISTFILE

    • Ruby: gem2deb GEMNAME|GEMFILE

    • npm, Haskell, ELPA: not supported

  • Debianize, build, install
    • Perl: dh-make-perl [make] {SOURCE_DIR | --cpan MODULE|DIST} --install

    • Python: pypi-install NAME

    • Ruby: not supported

    • npm, Haskell, ELPA: not supported

  • Refresh an already created package, moving old files to .bak:
    • All: cme migrate dpkg or cme fix dpkg See Managing Debian package files with cme

    • Perl: dh-make-perl refresh

    • Python: not supported

    • Ruby: dh-make-ruby -w

    • npm: not supported

    • Haskell: cabal-debian --official --upgrade

    • ELPA: not yet

Not (yet) covered tools

  • OCaml : oasis2debian and opam2debian

Other languages without an automated generator

  • PHP (PEAR packages) -- see pkg-php-tools for packaging tools (and debpear for a simple generator)
  • Java -- see javahelper/maven-debian-helper for packaging tools. There is also "mh_make"

See also

  • debdry: common frontend for most of the helpers described above description

  • alien: converts RPM/etc binary packages to deb binary packages
  • checkinstall: run an arbitrary upstream build system and auto-package the output
  • game-data-packager: converts non-free game data files to Debian binary packages

TODO