Differences between revisions 3 and 4
Revision 3 as of 2018-01-31 21:33:16
Size: 4104
Editor: ?gladk
Comment:
Revision 4 as of 2018-02-01 18:43:55
Size: 6038
Editor: ?gladk
Comment:
Deletions are marked like this. Additions are marked like this.
Line 78: Line 78:

=== Examples ===

In this section you will find example debian/control and debian/copyright files that you can use as a template and modify as needed.

==== Example 1.1. Example debian/control for package "foo" ====
{{{
Source: foo
Section: science
Priority: extra
Homepage: http://foo.example.org/
Maintainer: Debian Science Maintainers <debian-science-maintainers@lists.alioth.debian.org>
Uploaders: Your Name <your.name@debian.org>
Vcs-Git: https://anonscm.debian.org/git/debian-science/packages/foo.git
Vcs-Browser: https://anonscm.debian.org/git/debian-science/packages/foo.git
}}}

==== Example 1.2. Example debian/copyright for package "foo" under GPL ====
{{{
This package was downloaded from http://foo.example.org

Files: debian/*
Author: Your Name <your.name@debian.org>
Copyright: Copyright © 2008 Your Name <your.name@debian.org>
License: GPL-3+
 The Debian packaging is licensed under the GPL, version 3 or later,
 see below.

Files: *
Author: John Doe <john.doe@example.org>
Copyright: Copyright © 2007-2008 John Doe <john.doe@example.org>
License: GPL-3+
  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License along
  with the Debian GNU/Linux distribution in /etc/share/common-licenses/GPL.
  If not, see <http://www.gnu.org/licenses/>.

On Debian systems, the complete text of the GNU General Public License
can be found in /usr/share/common-licenses/GPL. }}}

Debian Science Policy migrated to Wiki

About Debian Science

The main goal of the Debian Science project is to provide a system with all the most important free scientific software in each scientific field.

Debian Science will also manage the debian-science's metapackages.

How to Contribute

A list of packages has been created using Debian Pure Blend. This website contains a long list of software packages in Debian and yet to be packaged. You can help by packaging them in coordination with the Debian Science.

In the meantime, you can also help us by updating the debian-science's metapackages.

Becoming a Member

Before becoming a member you need to have on account on Alioth. If you do not have an account already, you can register one.

To request membership, login to salsa.debian.org and join Debian Science Team. Your application will be processed quickly.

Debian Control Files

The following sections describe the changes to the control files stored in the source package's debian/ directory.

debian/changelog

Changes in the Debian version of the package should be briefly explained in the Debian changelog file. The debian/changelog file consists in a series of entries detailing the changes. The format of the entries is described in the Debian Policy.

Not yet uploaded packages should have only a single changelog entry closing the ITP bug. Indeed, when a package is submitted only the latest paragraph is parsed by the Debian bug tracking system. Therefore do not add new changelog entries when updating an unrealeased package, the VCS logs are enough to track the changes.

When a sponsor is uploading a package for you, mark the package target as UNRELEASED. The sponsor will change it as appropriate before uploading the package.

debian/control

Section and Priority Fields

The Section field of the source package should be set to "science", unless a more specific section such as "math" is applicable.

The Priority field should be set to "optional" if this is permitted by the Debian Policy, or set to "optional" otherwise.

Maintainer and Uploaders Fields

The Maintainer field should be "Debian Science Maintainers <debian-science-maintainers@lists.alioth.debian.org>".

You should also add yourself to the Uploaders field. Doing so shows your involvement and interest in the package. Developers listed in Uploaders will take care of maintenance, bug reports and other QA work, helped by the Debian Science team.

Vcs-Git and Vcs-Browser Fields

If you have your package under version control in the Debian Science Repository, you must set the Vcs-Git and Vcs-Browser fields.

The Vcs-Git field should contain the package repository URL, namely "https://salsa.debian.org/science-team/YourPackage.git".

The Vcs-Browser field should point to the web view of your package repository, namely "https://salsa.debian.org/science-team/YourPackage.git".

Homepage Field

If an upstream homepage exists, the Homepage field should be set to the upstream homepage URL.

Config::Model

It is a very good idea to use Config::Model to unify the formatting of debian/control. To do so make sure you have installed

apt-get install cme libconfig-model-dpkg-perl libconfig-model-itself-perl and than you can simply call

cme fix dpkg-control to get a properly formatted, sanity checked debian/control file. Please note that sometimes you need to call this more than once.

debian/copyright

If possible, the machine-readable format should be used.

The license of the packaging work should either match the license of the upstream sources or have a license that is even more free than the upstream license. For example, you should avoid licensing your packaging work under GPL if the upstream license is BSD, even though they are compatible.

debian/watch

If possible, a debian/watch file should be added so upstream releases can be tracked automatically.

Examples

In this section you will find example debian/control and debian/copyright files that you can use as a template and modify as needed.

Example 1.1. Example debian/control for package "foo"

Source: foo
Section: science
Priority: extra
Homepage: http://foo.example.org/
Maintainer: Debian Science Maintainers <debian-science-maintainers@lists.alioth.debian.org>
Uploaders: Your Name <your.name@debian.org>
Vcs-Git: https://anonscm.debian.org/git/debian-science/packages/foo.git
Vcs-Browser: https://anonscm.debian.org/git/debian-science/packages/foo.git

Example 1.2. Example debian/copyright for package "foo" under GPL

This package was downloaded from http://foo.example.org

Files: debian/*
Author: Your Name <your.name@debian.org>
Copyright: Copyright © 2008 Your Name <your.name@debian.org>
License: GPL-3+
 The Debian packaging is licensed under the GPL, version 3 or later,
 see below.

Files: *
Author: John Doe <john.doe@example.org>
Copyright: Copyright © 2007-2008 John Doe <john.doe@example.org>
License: GPL-3+
  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License along
  with the Debian GNU/Linux distribution in /etc/share/common-licenses/GPL.
  If not, see <http://www.gnu.org/licenses/>.

On Debian systems, the complete text of the GNU General Public License
can be found in /usr/share/common-licenses/GPL.