Debian package source: what changed

Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		Once a [[Debian upstream]] is ready, it is possible to make a source package from it. This is the role of the maintainer.
2	2
3	3		### Requesting help
4	4
5	5		You can request that someone would make the source package with an RFP bug: <https://wiki.debian.org/RFP>
6	6
7	7		It will be useful to the maintainer to know about the dependencies necessary to compile a Lazarus project:
8	8
9	9		- `fpc, lcl, lazarus` for all projects
10	10		- `libqt5pas-dev` if the project uses Qt5
11	11
12	12		Though in practice, it is likely that you will have to make the package source yourself. Debian provides a number of tools to build and test a source package, as well as documentation on the process (see Further reading below).
13	13
14	14		### debian directory
15	15
16	16		If you will do the role of the maintainer, or if you would like to check required dependencies, you will need to add the `debian` folder (in lowercase). Here is the minimal structure:
17	17
18	18		`debian`\
19	19		` ├─ changelog # changes with previous version`\
20	20		` ├─ control # description of Debian packages`\
21	21		` ├─ copyright # copyright information of the source code`\
22	22		` ├─ rules # build script`\
23	23		` ├─ watch # file to check for latest version`\
24	24		` ├─ source`\
25	25		` │ └─ format # format of this package source`\
26	26		` └─ upstream`\
27	27		` └─ metadata # upstream repository information`
28	28
29	29		#### changelog
30	30
31	31		The first changelog of your program should be something like (spaces are important):
32	32
33	33		`myproject (1.0-1) unstable; urgency=medium`\
34		-	\
	34	+
35	35		` * Initial release. (Closes: #ITP_NUMBER)`\
36		-	\
	36	+
37	37		` -- Firstname Lastname <email@server.com> Sun, 1 Nov 2020 15:01:00 +0100`
38	38
39	39		Of course you need to specify myproject, ITP_NUMBER, Firstname, Lastname, email and date. The version of the upstream program here is supposed to be 1.0 but it can be otherwise. The "-1" specifies the version of the package source as there a may be newer version of the package source but based on the same upstream version, in order to fix bugs for example.
40	40
41	41		You may not have an ITP number yet, as it is a number you will get when you make the request for your package to be added to Debian. If you would like to be the maintainer, here is an example of e-mail to send. In this case the ITP number is 972503: <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=972503>
42	42
43	43		#### control
44	44
45	45		This file gives all the information on the Debian packages, what is needed to build it, etc. This format is a bit different from the one found inside the [[Debian package structure\|.deb files]].
46	46
47	47		`Source: myproject`\
48	48		`Section: graphics`\
49	49		`Priority: optional`\
50	50		`Maintainer: Firstname Lastname <email@server.com>`\
51	51		`Build-Depends: fpc, lcl, lazarus, libqt5pas-dev, debhelper-compat (= 13)`\
52	52		`Rules-Requires-Root: no`\
53	53		`Standards-Version: 4.5.0`\
54	54		`Homepage: `[`https://mywebsite/myproject`](https://mywebsite/myproject)\
55	55		`Vcs-Git: `[`https://github.com/myorg/myproject.git`](https://github.com/myorg/myproject.git)\
56	56		`Vcs-Browser: `[`https://github.com/myorg/myproject`](https://github.com/myorg/myproject)\
57		-	\
	57	+
58	58		`Package: myproject`\
59	59		`Architecture: any`\
60	60		`Depends: ${misc:Depends}, ${shlibs:Depends}`\
61	61		`Conflicts: myoldproject`\
62	62		`Description: Short description`\
63	63		` More details, blablabla`
64	64
65	65		Here we suppose it is a graphics application using qt5 and with its repository on GitHub. If the project does not use qt5, you can remove the build-dependency `libqt5pas-dev`.
66	66
67	67		Note that the empty line is important. It introduces one package and there can be multiple packages in one package source, for example one for each widgetset and one common package.
68	68
69	69		#### copyright
70	70
71	71		Basically a copyright file contains a reference to all copyrights in the source code, as well as a global copyright for the package and for the debian folder. If you include custom packages in your upstream (that are statically linked), you need to specify the copyright for them as well. The first part of the file looks like this:
72	72
73	73		`Format: `[`https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/`](https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/)\
74	74		`Upstream-Name: mypackage`\
75	75		`Upstream-Contact: Firstname Lastname <email@server.com>`\
76	76		`Source: `[`https://github.com/myorg/myproject`](https://github.com/myorg/myproject)\
77		-	\
	77	+
78	78		`Files: *`\
79	79		`Copyright: 2011-2020 Firstname Lastname <email@server.com>`\
80	80		`License: GPL-3+`\
81		-	\
	81	+
82	82		`Files: debian/*`\
83	83		`Copyright: 2011-2020 Maintainer <email@server.com>`\
84	84		`License: GPL-3+`\
85		-	\
	85	+
86	86		`Files: custompackage1/*`\
87	87		`Copyright: 2012 Author <mail@server.com>`\
88	88		`License: LGPL-2+`
89	89
90	90		Then the file contains an empty line and the description of the licenses. Those descriptions are also separated by empty lines.
91	91
92	92		Make sure you look for all mention of copyright in the source code (using grep or search in files). Even if the code is opensource, it is better to provide the full name of the person that created the files in the first place and the year. This can be needed for legal purposes as writing the copyright statement in a digital file counts as declaring the copyright. It is valid up to 70 years after the death of the copyright owner. This is based on the American legislation though other legislations may apply as well. For example, in French legislation, there is no need to declare a copyright, just being identified as the author is sufficient.
93	93
94	94		File format documentation: <https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/>
95	95
96	96		Complete list of licenses: <https://spdx.org/licenses/> and <https://spdx.org/licenses/exceptions-index.html>
97	97
98	98		##### LGPL-2
99	99
100	100		This is the license for libraries that can be used with commercial projects. With Lazarus, you need to add the linking exception, but it is not part of the SPDX list, so I would add it in the license description (second paragraph).
101	101
102	102		`License: LGPL-2`\
103	103		` This program is free software; you can redistribute it and/or modify`\
104	104		` it under the terms of the GNU Lesser General Public License as published`\
105	105		` by the Free Software Foundation; version 2, with the following modification:`\
106	106		` .`\
107	107		` As a special exception, the copyright holders of this library give you`\
108	108		` permission to link this library with independent modules to produce an`\
109	109		` executable, regardless of the license terms of these independent modules,`\
110	110		` and to copy and distribute the resulting executable under terms of your choice,`\
111	111		` provided that you also meet, for each linked independent module, the terms`\
112	112		` and conditions of the license of that module. An independent module is a`\
113	113		` module which is not derived from or based on this library. If you modify this`\
114	114		` library, you may extend this exception to your version of the library, but`\
115	115		` you are not obligated to do so. If you do not wish to do so, delete this`\
116	116		` exception statement from your version.`\
117	117		` .`\
118	118		` This program is distributed in the hope that it will be useful,`\
119	119		` but WITHOUT ANY WARRANTY; without even the implied warranty of`\
120	120		` MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`\
121	121		` GNU Lesser General Public License for more details.`\
122	122		` .`\
123	123		` You should have received a copy of the GNU Lesser General Public License`\
124	124		` along with this program; if not, write to the Free Software Foundation,`\
125	125		` Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.`\
126	126		` .`\
127	127		` On Debian systems, the full text of the GNU Lesser General Public`\
128	128		` License version 2 can be found in the file`\
129	129		` '/usr/share/common-licenses/LGPL-2'.`
130	130
131	131		##### LGPL-2+
132	132
133	133		Same as above, but not limited to version 2.
134	134
135	135		`License: LGPL-2+`\
136	136		` This program is free software; you can redistribute it and/or modify`\
137	137		` it under the terms of the GNU Lesser General Public License as published`\
138	138		` by the Free Software Foundation; either version 2 of the License, or`\
139	139		` (at your option) any later version, with the following modification:`\
140	140		` .`\
141	141		` As a special exception, the copyright holders of this library give you`\
142	142		` permission to link this library with independent modules to produce an`\
143	143		` executable, regardless of the license terms of these independent modules,`\
144	144		` and to copy and distribute the resulting executable under terms of your choice,`\
145	145		` provided that you also meet, for each linked independent module, the terms`\
146	146		` and conditions of the license of that module. An independent module is a`\
147	147		` module which is not derived from or based on this library. If you modify this`\
148	148		` library, you may extend this exception to your version of the library, but`\
149	149		` you are not obligated to do so. If you do not wish to do so, delete this`\
150	150		` exception statement from your version.`\
151	151		` .`\
152	152		` This program is distributed in the hope that it will be useful,`\
153	153		` but WITHOUT ANY WARRANTY; without even the implied warranty of`\
154	154		` MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`\
155	155		` GNU Lesser General Public License for more details.`\
156	156		` .`\
157	157		` You should have received a copy of the GNU Lesser General Public License`\
158	158		` along with this program; if not, write to the Free Software Foundation,`\
159	159		` Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.`\
160	160		` .`\
161	161		` On Debian systems, the full text of the GNU Lesser General Public`\
162	162		` License version 2 can be found in the file`\
163	163		` '/usr/share/common-licenses/LGPL-2'.`
164	164
165	165		##### LGPL-3-linking-exception
166	166
167	167		The version 3 has a specific name when there is the linking exception.
168	168
169	169		`License: LGPL-3-linking-exception`\
170	170		` This program is free software; you can redistribute it and/or modify`\
171	171		` it under the terms of the GNU Lesser General Public License as published`\
172	172		` by the Free Software Foundation; version 3, with the following modification:`\
173	173		` .`\
174	174		` As a special exception, the copyright holders of this library give you`\
175	175		` permission to link this library with independent modules to produce an`\
176	176		` executable, regardless of the license terms of these independent modules,`\
177	177		` and to copy and distribute the resulting executable under terms of your choice,`\
178	178		` provided that you also meet, for each linked independent module, the terms`\
179	179		` and conditions of the license of that module. An independent module is a`\
180	180		` module which is not derived from or based on this library. If you modify this`\
181	181		` library, you may extend this exception to your version of the library, but`\
182	182		` you are not obligated to do so. If you do not wish to do so, delete this`\
183	183		` exception statement from your version.`\
184	184		` .`\
185	185		` This program is distributed in the hope that it will be useful,`\
186	186		` but WITHOUT ANY WARRANTY; without even the implied warranty of`\
187	187		` MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`\
188	188		` GNU Lesser General Public License for more details.`\
189	189		` .`\
190	190		` You should have received a copy of the GNU Lesser General Public License`\
191	191		` along with this program; if not, write to the Free Software Foundation,`\
192	192		` Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.`\
193	193		` .`\
194	194		` On Debian systems, the full text of the GNU Lesser General Public`\
195	195		` License version 3 can be found in the file`\
196	196		` '/usr/share/common-licenses/LGPL-3'.`
197	197
198	198		##### GPL-3+
199	199
200	200		This is the recommended license when possible.
201	201
202	202		`License: GPL-3+`\
203	203		` This program is free software; you can redistribute it and/or modify`\
204	204		` it under the terms of the GNU General Public License as published by`\
205	205		` the Free Software Foundation; either version 3 of the License, or`\
206	206		` (at your option) any later version. `\
207	207		` .`\
208	208		` This program is distributed in the hope that it will be useful,`\
209	209		` but WITHOUT ANY WARRANTY; without even the implied warranty of`\
210	210		` MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`\
211	211		` GNU General Public License for more details.`\
212	212		` .`\
213	213		` You should have received a copy of the GNU General Public License along`\
214	214		` with this program; if not, write to the Free Software Foundation, Inc.,`\
215	215		` 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.`\
216	216		` .`\
217	217		` On Debian systems, the full text of the GNU General Public`\
218	218		` License version 3 can be found in the file`\
219	219		` '/usr/share/common-licenses/GPL-3'.`
220	220
221	221		#### rules
222	222
223	223		The `rules` file contains build instructions. If you are building a simple package, it will be the following:
224	224
225	225		`#!/usr/bin/make -f`\
226		-	\
	226	+
227	227		`# see FEATURE AREAS in dpkg-buildflags(1)`\
228	228		`export DEB_BUILD_MAINT_OPTIONS = hardening=+all`\
229		-	\
	229	+
230	230		`%:`\
231	231		` dh $@ --no-parallel`
232	232
233	233		The `--no-parallel` flag is needed to avoid potential problems with parallel builds.
234	234
235	235		#### watch
236	236
237	237		The `watch` file explains how to check for latest version. For example, on GitHub, that would be:
238	238
239	239		`version=4`\
240	240		`opts=filenamemangle=s/.+\/v?(\d\S+)\.tar\.gz/myproject-$1\.tar\.gz/ \`\
241	241		` `[`https://github.com/myorg/myproject/tags`](https://github.com/myorg/myproject/tags)` .*/v?(\d\S+)\.tar\.gz`
242	242
243	243		The version 4 is the for the file format, not your program. You need to change the myorg and myproject to your actual project.
244	244
245	245		See documentation: <https://wiki.debian.org/debian/watch>
246	246
247	247		#### source/format
248	248
249	249		At the moment of this writing, it is:
250	250
251	251		`3.0 (quilt)`
252	252
253	253		#### upstream/metadata
254	254
255	255		For a project on GitHub, that would be:
256	256
257	257		`Bug-Database: `[`https://github.com/myorg/myproject/issues`](https://github.com/myorg/myproject/issues)\
258	258		`Bug-Submit: `[`https://github.com/myorg/myproject/issues/new`](https://github.com/myorg/myproject/issues/new)\
259	259		`Repository: `[`https://github.com/myorg/myproject.git`](https://github.com/myorg/myproject.git)\
260	260		`Repository-Browse: `[`https://github.com/myorg/myproject`](https://github.com/myorg/myproject)
261	261
262	262		You may need to change those path according to the tools you are using.
263	263
264	264		### Further reading
265	265
266	266		- <https://wiki.debian.org/BuildingTutorial>
267	267		- <https://www.debian.org/doc/manuals/maint-guide/first.en.html>
268	268		- <https://lintian.debian.org/tags.html> and <https://lintian.debian.org/sources/fpc>
269	269
270	270		---
271	271		From the Free Pascal wiki, page "Debian package source", as it stood on 2022-01-22 after a change by Kai Burghardt, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).

Back to history