~ubuntu-branches/ubuntu/vivid/debian-policy/vivid-proposed

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Bazaar Package Importer
  • Author(s): Russ Allbery, Colin Watson, Bill Allombert, Russ Allbery
  • Date: 2010-06-27 21:40:52 UTC
  • mfrom: (4.1.5 sid)
  • Revision ID: james.westby@ubuntu.com-20100627214052-2kfi11r55u6hk2jq
[ Colin Watson ]
* Fix path to changelog.Debian.gz in footnote on documentation symlinks.

[ Bill Allombert ]
* Convert upgrading-checklist to debiandoc-sgml. This generates a better
  looking .txt file.
  Closes: #567845
* Fix typo in package_upstream-version.orig.tar.gz.
  Thanks, Salvatore Bonaccorso. (Closes: #558430)
* Replace 'copyright and distribution license' by 'copyright information
  and distribution license' (three times).
  Proposed by Jonathan Nieder.
  Seconded:  Steve Langasek  <vorlon@debian.org>
  Seconded:  Thijs Kinkhorst <thijs@debian.org>
  Seconded:  Julien Cristau  <jcristau@debian.org>
  Seconded:  Gregor Herrmann <gregoa@debian.org>
  Closes: #566220
* extend UID range of user accounts by removing the 30000-59999 reserved 
  ranges.
  Proposed by Santiago Vila  
  Seconded:  Russ Allbery    <rra@debian.org>
  Seconded:  Luk Claes       <luk@debian.org>
  Seconded:  Raphael Hertzog <hertzog@debian.org>
  Seconded:  Steve Langasek  <vorlon@debian.org>
  Closes: #582495

[ Russ Allbery ]
* Policy: Overhaul Breaks, Conflicts, Provides, and Replaces
  Wording: Russ Allbery <rra@debian.org>
  Seconded: Steve Langasek <vorlon@debian.org>
  Seconded: Raphael Hertzog <hertzog@debian.org>
  Closes: #578854
* Policy: Support for architecture wildcards
  Wording: Manoj Srivastava <srivasta@debian.org>
  Wording: Russ Allbery <rra@debian.org>
  Seconded: Guillem Jover <guillem@debian.org>
  Seconded: Andrew McMillan <andrew@morphoss.com>
  Seconded: Steve Langasek <vorlon@debian.org>
  Closes: #530687
* Policy: Except init.d scripts from the normal set -e requirement
  Wording: Russ Allbery <rra@debian.org>
  Seconded: Raphael Hertzog <hertzog@debian.org>
  Seconded: Guillem Jover <guillem@debian.org>
  Closes: #562506
* Policy: Maintainer scripts might not have a controlling terminal
  Wording: Russ Allbery <rra@debian.org>
  Seconded: Guillem Jover <guillem@debian.org>
  Seconded: Andrew McMillan <andrew@morphoss.com>
  Seconded: Steve Langasek <vorlon@debian.org>
  Closes: #224509
* Policy: Fully specify the date format for changelog entries
  Wording: Charles Plessy <plessy@debian.org>
  Seconded: Russ Allbery <rra@debian.org>
  Seconded: Andrew McMillan <andrew@morphoss.com>
  Seconded: Giacomo A. Catenazzi <cate@debian.org>
  Closes: #569174
* Policy: Deprecate /usr/share/common-licenses/BSD
  Wording: Russ Allbery <rra@debian.org>
  Seconded: Emilio Pozuelo Monfort <pochu@debian.org>
  Seconded: Jakub Wilk <jwilk@debian.org>
  Seconded: gregor herrmann <gregoa@debian.org>
  Closes: #284340
* Policy: Document Checksums-Sha1 and Checksums-Sha256
  Wording: Russ Allbery <rra@stanford.edu>
  Seconded: Julien Cristau <jcristau@debian.org>
  Seconded: Emilio Pozuelo Monfort <pochu@debian.org>
  Closes: #478295
* Policy: Prohibit duplicate field names in a control paragraph
  Wording: Russ Allbery <rra@debian.org>
  Seconded: Charles Plessy <plessy@debian.org>
  Seconded: Steve Langasek <vorlon@debian.org>
  Seconded: Emilio Pozuelo Monfort <pochu@debian.org>
  Closes: #555978
* Policy: Relax requirement that library dev files be in one package
  Wording: Russ Allbery <rra@debian.org>
  Seconded: Julien Cristau <jcristau@debian.org>
  Seconded: Andrew McMillan <andrew@morphoss.com>
  Closes: #347581
* Policy: Tighten requirements for maintainer-like fields
  Wording: Russ Allbery <rra@debian.org>
  Seconded: Emilio Pozuelo Monfort <pochu@debian.org>
  Seconded: Andrew McMillan <andrew@morphoss.com>
  Closes: #575639
* Policy: Update Format control field documentation
  Wording: Russ Allbery <rra@debian.org>
  Wording: Charles Plessy <plessy@debian.org>
  Seconded: Charles Plessy <plessy@debian.org>
  Seconded: Emilio Pozuelo Monfort <pochu27@gmail.com>
  Closes: #547272
* Debconf: Add SETTITLE, like title but uses a template
  Wording: Frans Pop <elendil@planet.nl>
  Seconded: Russ Allbery <rra@debian.org>
  Seconded: Ben Pfaff <blp@cs.stanford.edu>
  Closes: #560411
* Perl Policy: Change perlapi provides to use an ABI version
  Wording: Niko Tyni <ntyni@debian.org>
  Seconded: Russ Allbery <rra@debian.org>
  Seconded: Brendan O'Dea <bod@debian.org>
  Seconded: Damyan Ivanov <dmn@debian.org>
  Closes: #579457
* Perl Policy: Recommend DESTDIR instead of PREFIX with Makefile.PL
  Wording: Niko Tyni <ntyni@debian.org>
  Seconded: Russ Allbery <rra@debian.org>
  Seconded: Raphael Hertzog <hertzog@debian.org>
  Closes: #579461
* Standardize dpkg state wording and bring it in line with dpkg,
  renaming Failed-Config to Half-Configured and use uniform
  capitalization and punctuation.  (Closes: #442134)
* Remove documentation of alternative changelog formats.  This feature
  is not allowed in the Debian archive and will be documented in the
  dpkg-dev documentation instead.  The documentation that was in Policy
  was also somewhat outdated.  (Closes: #555009, see #584141)
* Remove obsolete footnote sentence saying that dpkg-statoverride is a
  new feature and not well-known.  (Closes: #563425)
* Clarify in the Perl Policy that perl-base is essential, not perl, and
  don't imply packages need to depend on perl-base.  (Closes: #576594)
* Document the special debian-installer section in the list of current
  sections and add a link to the list of sections in unstable, which
  contains longer descriptions.  (Closes: #577666)
* Remove the footnote listing every architecture known to dpkg.  This
  list can be trivially produced by dpkg-architecture -L (already
  noted), is very long, and quickly becomes out-of-date.
* Move silly version ordering example to a footnote.  (Closes: #560839)
* Reletter the process steps to not skip State C and use more
  traditional foreground and background colors for Process.html and
  README.html.  (Closes: #584521)
* Fix typo in footnote about help2man.  (Closes: #584796)
* Add an example for Replaces when a package is split.  Thanks, Uwe
  Kleine-König.  (Closes: #572253)
* Explicitly state that packages may remove unmodified, obsolete
  configuration files during  upgrade.  (Closes: #470633)
* Clarify the wording around which build dependencies must be satisfied
  for different debian/rules targets and add a footnote to the
  description of the build-arch and build-indep targets explaining why
  this split does not currently work as desired.  (Closes: #328951)
* Avoid "Debianised" or "Debianized" in favor of just "Debian" or
  "Debian package" as appropriate.  Patch from Ben Finney.
  (Closes: #586163)
* Switch to source format 3.0 (native).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
                            Debian Policy
2
2
                            =============
3
3
 
4
 
Author: Manoj Srivastava And Russ Allbery <srivasta@debian.org>
5
 
Date: 2009-09-15 15:48:35 CDT
 
4
Author: Manoj Srivastava And Russ Allbery
 
5
Date: 2010-06-04 09:42:57 PDT
6
6
 
7
7
 
8
8
Infrastructure 
32
32
against the current Git master branch to the bug report, if you're not
33
33
familiar with Git, the following commands are the basic process:
34
34
 
 
35
 
35
36
  git clone git://git.debian.org/git/dbnpolicy/policy.git
36
37
  git checkout -b <local-branch-name>
37
38
  
44
45
  git checkout master
45
46
  git pull
46
47
  
47
 
  # If there are changes in master that make the branch not apply cleanly:
48
 
   git checkout -b temp master; git merge <local-branch-name>
49
 
  # If error, reset temp, merge master into local; else skip these three lines
50
 
   git reset --hard HEAD;
51
 
   git checkout <local-branch-name>; 
 
48
  git checkout master
 
49
  git merge --no-commit <local-branch-name>
 
50
  git reset --hard HEAD;
 
51
  git checkout <local-branch-name>; 
 
52
  
 
53
  # If there are changes in master that make the branch not apply cleanly, there
 
54
  # should have been en error during the merge step above. If there was an
 
55
  # error, merge the master branch into the local branch, fix the conflicts, and
 
56
  # commit the new version of the local branch.
52
57
   git merge master
53
 
  # get rid of the temp branch:
54
 
   git branch -D temp
 
58
  # Edit files to remove conflict
 
59
   git commit -s 
55
60
  
56
61
  # Checkout the local branch, to create the patch to send to the policy
57
62
  git checkout <local-branch-name>
62
67
                 --to debian-policy@lists.debian.org   \
63
68
                 $dir/
64
69
 
65
 
 
66
70
<local-branch-name> is some convenient name designating your local
67
71
changes. You may want to use some common prefix like local-. You can
68
72
use git format-patch and git send-email if you want, but usually it's
223
227
+ Delete the now-merged branch.
224
228
 
225
229
The Git commands used for this workflow are:
 
230
 
226
231
  git checkout -b bug12345-rra master
227
232
  # edit files
228
233
  # git add files
232
237
  # update your local master branch
233
238
  git checkout master
234
239
  git pull
235
 
  # If there are changes in master that make the branch not apply cleanly:
236
 
  git checkout -b temp master; git merge bug12345-rra
237
 
  # If error;
 
240
  
 
241
  git checkout master
 
242
  git merge --no-commit bug12345-rra
238
243
  git reset --hard HEAD;
239
 
  git checkout bug12345-rra; git branch -D temp
240
 
  git merge master
 
244
  
 
245
  # If there are changes in master that make the branch not apply cleanly, there
 
246
  # should have been en error during the merge step above. If there was an
 
247
  # error, merge the master branch into the local branch, fix the conflicts, and
 
248
  # commit the new version of the local branch.
 
249
   git checkout bug12345-rra
 
250
   git merge master
 
251
  # Edit files to remove conflict
 
252
   git commit -s 
 
253
  
241
254
  git checkout master
242
255
  git merge bug12345-rra
243
256
  # edit debian/changelog and upgrading-checklist.html
247
260
  git branch -d bug12345-rra
248
261
  git push origin :bug12345-rra
249
262
 
250
 
 
251
263
For the debian/changelog entry, use the following format:
 
264
 
252
265
  * <document>: <brief change description>
253
266
    Wording: <author of wording>
254
267
    Seconded: <seconder>
255
268
    Seconded: <seconder>
256
269
    Closes: <bug numbers>
257
270
 
258
 
 
259
271
For example:
 
272
 
260
273
  * Policy: better document version ranking and empty Debian revisions
261
274
    Wording: Russ Allbery <rra@debian.org>
262
275
    Seconded: Raphaël Hertzog <hertzog@debian.org>
264
277
    Seconded: Guillem Jover <guillem@debian.org>
265
278
    Closes: #186700, #458910
266
279
 
267
 
 
268
280
Updating branches 
269
281
==================
270
282
 
272
284
Policy team member, you will generally want to update your working bug
273
285
branches. The equivalent of the following commands should do that:
274
286
 
 
287
 
275
288
  for i in `git show-ref --heads | awk '{print $2}'`; do
276
289
      j=$(basename $i)
277
290
      if [ "$j" != "master" ]; then
280
293
  done
281
294
  git push --all origin
282
295
 
283
 
 
284
296
assuming that you haven't packed the refs in your repository.
285
297
 
286
298
Making a release 
295
307
 
296
308
Then, tag the repository and push the final changes to Alioth:
297
309
 
 
310
 
298
311
  git tag -s v3.8.0.0
299
312
  git push origin
300
313
  git push --tags origin
301
314
 
302
 
 
303
315
replacing the version number with the version of the release, of course.
304
316
 
305
317
Finally, announce the new Policy release on debian-devel-announce,