~sethj/ubuntu-packaging-guide/lp1313053

« back to all changes in this revision

Viewing changes to ubuntu-packaging-guide/debian-dir-overview.rst

  • Committer: Daniel Holbach
  • Date: 2014-05-05 09:02:25 UTC
  • mfrom: (525.1.1 ubuntu-packaging-guide)
  • Revision ID: daniel.holbach@canonical.com-20140505090225-gf37euky3p8kdxm9
mergedĀ lp:~mitya57/ubuntu-packaging-guide/anonymous-links

Show diffs side-by-side

added added

removed removed

Lines of Context:
61
61
``2.6-1ubuntu1``. If a package for the application does not exist in Debian, 
62
62
then the Debian revision is ``0`` (e.g. ``2.6-0ubuntu1``).
63
63
 
64
 
For further information, see the `changelog section (Section 4.4) 
65
 
<http://www.debian.org/doc/debian-policy/ch-source.html#s-dpkgchangelog>`_ of 
66
 
the Debian Policy Manual.
 
64
For further information, see the `changelog section (Section 4.4) <policy-changelog_>`_
 
65
of the Debian Policy Manual.
67
66
 
68
67
 
69
68
The control file
114
113
the old value should be saved in the ``XSBC-Original-Maintainer`` field. This 
115
114
can be done automatically with the  ``update-maintainer`` script available in 
116
115
the ``ubuntu-dev-tools`` package. For further information, see the `Debian 
117
 
Maintainer Field spec <https://wiki.ubuntu.com/DebianMaintainerField>`_ on the 
118
 
Ubuntu wiki.
 
116
Maintainer Field spec <MaintField_>`_ on the Ubuntu wiki.
119
117
 
120
118
Each additional paragraph describes a binary package to be built.
121
119
 
122
 
For further information, see the `control file section (Chapter 5) 
123
 
<http://www.debian.org/doc/debian-policy/ch-controlfields.html>`_ of the Debian 
124
 
Policy Manual.
 
120
For further information, see the `control file section (Chapter 5) <policy-control_>`_
 
121
of the Debian Policy Manual.
125
122
 
126
123
 
127
124
The copyright file
128
125
-------------------------------
129
126
 
130
127
This file gives the copyright information for both the upstream source and the 
131
 
packaging. Ubuntu and `Debian Policy (Section 12.5) 
132
 
<http://www.debian.org/doc/debian-policy/ch-docs.html#s-copyrightfile>`_ 
 
128
packaging. Ubuntu and `Debian Policy (Section 12.5) <policy-copyright_>`_ 
133
129
require that each package installs a verbatim copy of its copyright and license 
134
130
information to ``/usr/share/doc/$(package_name)/copyright``.
135
131
 
175
171
  License version 2 can be found in the file
176
172
  `/usr/share/common-licenses/GPL-2'.
177
173
 
178
 
This example follows the `Machine-readable debian/copyright 
179
 
<http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/>`_ format.
 
174
This example follows the `Machine-readable debian/copyright <DEP5_>`_ format.
180
175
You are encouraged to use this format as well.
181
176
 
182
177
 
324
319
     and symlinked hello_2.7.orig.tar.gz to it
325
320
 
326
321
If your tarballs live on Launchpad, the ``debian/watch`` file is a little more
327
 
complicated (see `Question 21146`_ and `Bug 231797`_ for why this is).  In
328
 
that case, use something like::
 
322
complicated (see `Question 21146 <Q21146_>`_ and `Bug 231797 <Bug231797_>`_
 
323
for why this is).  In that case, use something like::
329
324
 
330
325
    version=3
331
326
    https://launchpad.net/flufl.enum/+download http://launchpad.net/flufl.enum/.*/flufl.enum-(.+).tar.gz
364
359
 
365
360
* Not necessary to repack the upstream tarball to strip the debian directory
366
361
 
367
 
* Debian-specific changes are no longer stored in a single .diff.gz but in multiple patches compatible with quilt under ``debian/patches/``
 
362
* Debian-specific changes are no longer stored in a single .diff.gz but in
 
363
  multiple patches compatible with quilt under ``debian/patches/``
368
364
 
369
 
http://wiki.debian.org/Projects/DebSrc3.0 summarizes additional information 
 
365
https://wiki.debian.org/Projects/DebSrc3.0 summarizes additional information 
370
366
concerning the switch to the 3.0 source package formats.
371
367
 
372
368
See ``man dpkg-source`` and the `source/format section (Section 5.21) 
373
 
<http://www.debian.org/doc/manuals/maint-guide/dother.en.html#sourcef>`_  of 
374
 
the Debian New Maintainers' Guide for additional details.
 
369
<policy-format_>`_  of  the Debian New Maintainers' Guide for additional details.
375
370
 
376
371
Additional Resources
377
372
-------------------------------
378
373
 
379
374
In addition to the links to the Debian Policy Manual in each section above, the 
380
375
Debian New Maintainers' Guide has more detailed descriptions of each file. 
381
 
`Chapter 4, "Required files under the debian directory" 
382
 
<http://www.debian.org/doc/maint-guide/dreq.en.html>`_ further discusses the 
383
 
control, changelog, copyright and rules files. `Chapter 5, "Other files under 
384
 
the debian directory" <http://www.debian.org/doc/maint-guide/dother.en.html>`_ 
 
376
`Chapter 4, "Required files under the debian directory" <RequiredFiles_>`_
 
377
further discusses the  control, changelog, copyright and rules files.
 
378
`Chapter 5, "Other files under the debian directory" <OtherFiles_>`_
385
379
discusses additional files that may be used.
386
380
 
387
 
.. _`Question 21146`: https://answers.launchpad.net/launchpad/+question/21146
388
 
.. _`Bug 231797`: https://launchpad.net/bugs/231797
 
381
.. _policy-control: http://www.debian.org/doc/debian-policy/ch-controlfields.html
 
382
.. _policy-changelog: http://www.debian.org/doc/debian-policy/ch-source.html#s-dpkgchangelog
 
383
.. _policy-copyright: http://www.debian.org/doc/debian-policy/ch-docs.html#s-copyrightfile
 
384
.. _policy-format: http://www.debian.org/doc/manuals/maint-guide/dother.en.html#sourcef
 
385
.. _DEP5: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 
386
.. _MaintField: https://wiki.ubuntu.com/DebianMaintainerField
 
387
.. _Q21146: https://answers.launchpad.net/launchpad/+question/21146
 
388
.. _Bug231797: https://launchpad.net/launchpad/+bug/231797
 
389
.. _RequiredFiles: http://www.debian.org/doc/manuals/maint-guide/dreq.en.html
 
390
.. _OtherFiles: http://www.debian.org/doc/manuals/maint-guide/dother.en.html