README.org

   1 -*- mode: org; fill-column: 78 -*-
   2 #+STARTUP: showall
   3 #+STARTUP: lognotedone lognotestate
   4 #+OPTIONS: H:4 toc:2
   5 #+TITLE:  Debian Policy
   6 #+AUTHOR: Manoj Srivastava And Russ Allbery
   7 #+EMAIL: srivasta@debian.org
   8 #+OPTIONS:   H:3 num:nil toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:nil skip:t d:nil tags:not-in-toc
   9 #+LINK_HOME: http://wiki.debian.org/Teams/Policy
  10 #+LINK_UP: http://www.debian.org/
  11
  12 \usepackage{landscape}
  13
  14 \setlength{\oddsidemargin}{0in}         % default=0in
  15 \setlength{\textwidth}{9in}             % default=9in
  16
  17 \setlength{\columnsep}{0.5in}           % default=10pt
  18 \setlength{\columnseprule}{1pt}         % default=0pt (no line)
  19
  20 \setlength{\textheight}{5.85in}         % default=5.15in
  21 \setlength{\topmargin}{-0.15in}         % default=0.20in
  22 \setlength{\headsep}{0.25in}            % default=0.35in
  23
  24 \setlength{\parskip}{1.2ex}
  25 \setlength{\parindent}{0mm}
  26 \pagestyle{empty}
  27
  28 \setlength{\headheight}{0pt}
  29 \setlength{\headsep}{0pt}
  30 \setlength{\footskip}{5pt}
  31 \setlength{\textheight}{9.0in}
  32 \setlength{\textwidth}{6.5in}
  33
  34
  35 * Infrastructure
  36
  37 + Website:: http://www.debian.org/doc/devel-manuals#policy
  38 + Mailing list:: debian-policy@lists.debian.org lists
  39 + Source Code::
  40   * git clone git://git.debian.org/git/dbnpolicy/policy.git
  41   * Browser: http://git.debian.org/?p=dbnpolicy/policy.git
  42 + Unix group:: dbnpolicy
  43 + Alioth Project:: http://alioth.debian.org/projects/dbnpolicy (exists
  44   to manage the repository but not otherwise used)
  45
  46 ** Interacting with the team
  47
  48 + Email contact:: mailto:debian-policy@lists.debian.org
  49 + Request tracker:: http://bugs.debian.org/src:debian-policy
  50
  51 Debian Policy uses a formal procedure and a set of user tags to manage
  52 the lifecycle of change proposals. For definitions of those tags and
  53 proposal states and information about what the next step is for each
  54 phase, see [[./Process.org][Policy changes process]].
  55
  56 Once the wording for a change has been finalized, please send a patch
  57 against the current Git master branch to the bug report, if you're not
  58 familiar with Git, the following commands are the basic process:
  59
  60 #+BEGIN_SRC Sh
  61 git clone git://git.debian.org/git/dbnpolicy/policy.git
  62 git checkout -b <local-branch-name>
  63
  64 # edit files, but don't make changes to upgrading-checklist or debian/changelog
  65 git add <files>
  66 git commit
  67 # repeat as necessary
  68
  69 # update your branch against the current master
  70 git checkout master
  71 git pull
  72
  73 git checkout master
  74 git merge --no-commit <local-branch-name>
  75 git reset --hard HEAD;
  76 git checkout <local-branch-name>;
  77
  78 # If there are changes in master that make the branch not apply cleanly, there
  79 # should have been en error during the merge step above. If there was an
  80 # error, merge the master branch into the local branch, fix the conflicts, and
  81 # commit the new version of the local branch.
  82  : git merge master
  83 # Edit files to remove conflict
  84  : git commit -s
  85
  86 # Checkout the local branch, to create the patch to send to the policy
  87 git checkout <local-branch-name>
  88 dir=$(mktemp -d)
  89 git format-patch -o $dir -s master
  90 # check out the patches created in $dir
  91 git send-email --from "you <your@email>"             \
  92                --to debian-policy@lists.debian.org   \
  93                $dir/
  94 #+END_SRC
  95
  96 <local-branch-name> is some convenient name designating your local
  97 changes. You may want to use some common prefix like local-. You can
  98 use git format-patch and git send-email if you want, but usually it's
  99 overkill.
 100
 101 * Usual Roles
 102
 103 The Debian Policy team are official project delegates (see the DPL
 104 delegation). All of the Policy team members do basically the same
 105 work: shepherd proposals, propose wording, and merge changes when
 106 consensus has been reached. The current delegates are:
 107
 108 + Russ Allbery
 109 + Bill Allombert
 110 + Andrew McMillan
 111 + Manoj Srivastava
 112 + Colin Watson (cjwatson)
 113
 114 The special tasks of Policy delegates are:
 115
 116 + Commit access to the Git repository and uploads of the debian-policy
 117   package itself, which makes them responsible for debian-policy as a
 118   package in Debian and for making final decisions about when a new
 119   version is released and what bits go into it.
 120 + Rejecting proposals. Anyone can argue against a proposal, but only
 121   Policy delegates can formally reject it.
 122 + Counting seconds and weighing objections to proposals to determine
 123   whether the proposal has sufficient support to be included.
 124
 125 Everything else can be done by anyone, or any DD (depending on the
 126 outcome of the discussion about seconding). We explicitly want any
 127 Debian DD to review and second or object to proposals. The more
 128 participation, the better. Many other people are active on the Policy
 129 mailing list without being project delegates.
 130
 131 * Task description
 132
 133 The Debian Policy team is responsible for maintaining and coordinating
 134 updates to the technical Policy manuals for the project. The primary
 135 output of the team is the Debian Policy Manual and the assorted
 136 subpolicies, released as the debian-policy Debian package and also
 137 published at [[http://www.debian.org/doc/]].
 138
 139 In addition to the main technical manual, the team currently also maintains:
 140
 141 + [[http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/][Machine-readable debian/copyright format]]
 142 + [[http://www.debian.org/doc/packaging-manuals/menu-policy/][Debian Menu sub-policy]]
 143 + [[http://www.debian.org/doc/packaging-manuals/perl-policy/][Debian Perl Policy]]
 144 + [[http://www.debian.org/doc/packaging-manuals/mime-policy/][Debian MIME support sub-policy]]
 145 + [[http://www.debian.org/doc/packaging-manuals/debconf_specification.html][Debconf Specification]]
 146 + [[http://www.debian.org/doc/packaging-manuals/virtual-package-names-list.txt][Authoritative list of virtual package names ]]
 147
 148 These documents are maintained using the [[./Process.org][Policy changes process]], and
 149 the current state of all change proposals is tracked using the
 150 [[http://bugs.debian.org/src:debian-policy][debian-policy BTS]].
 151
 152 * Get involved
 153
 154 The best way to help is to review the [[http://bugs.debian.org/src:debian-policy][current open bugs]], pick a bug
 155 that no one is currently shepherding (ask on
 156 [[mailto:debian-policy@lists.debian.org][debian-policy@lists.debian.org]] if you're not sure if a particular bug
 157 is being shepherded), and help it through the change process. This
 158 will involve guiding the discussion, seeking additional input
 159 (particularly from experts in the area being discussed), possibly
 160 raising the issue on other mailing lists, proposing or getting other
 161 people to propose specific wording changes, and writing diffs against
 162 the current Policy document. All of the steps of [[./Process.org][Policy changes process]]
 163 can be done by people other than Policy team members except
 164 the final acceptance steps and almost every change can be worked on
 165 independently, so there's a lot of opportunity for people to help.
 166
 167 There are also some other, larger projects:
 168
 169 + Policy is currently maintained in DebianDoc-SGML, which is no longer
 170   very actively maintained and isn't a widely used or understood
 171   format. The most logical replacement would be DocBook. However,
 172   DocBook is a huge language with many tags and options, making it
 173   rather overwhelming. We badly need someone with DocBook experience
 174   to write a style guide specifying exactly which tags should be used
 175   and what they should be used for so that we can limit ourselves to
 176   an easy-to-understand and documented subset of the language.
 177 + Policy contains several appendices which are really documentation of
 178   how parts of the dpkg system works rather than technical
 179   Policy. Those appendices should be removed from the Policy document
 180   and maintained elsewhere, probably as part of dpkg, and any Policy
 181   statements in them moved into the main document. This project will
 182   require reviewing the current contents of the appendices and feeding
 183   the useful bits that aren't currently documented back to the dpkg
 184   team as documentation patches.
 185 + Policy has grown organically over the years and suffers from
 186   organizational issues because of it. It also doesn't make use of the
 187   abilities that a current XML language might give us, such as being
 188   able to extract useful portions of the document (all *must*
 189   directives, for example). There has been quite a bit of discussion
 190   of a new format that would allow for this, probably as part of
 191   switching to DocBook, but as yet such a reorganization and reworking
 192   has not been started.
 193
 194 If you want to work on any of these projects, please mail
 195 [[mailto:debian-policy@lists.debian.org][debian-policy@lists.debian.org ]] for more information. We'll be happy to
 196 help you get started.
 197
 198 ** Maintenance procedures
 199
 200 ** Repository layout
 201
 202 The Git repository used for Debian Policy has the following branches:
 203
 204 +  master:: the current accepted changes that will be in the next release
 205 +  bug<number>-<user>:: changes addressing bug <number>, shepherded by <user>
 206 +  rra:: old history of Russ's arch repository, now frozen
 207 +  srivasta:: old history of Manoj's arch repository
 208
 209 ** Managing a bug
 210
 211 The process used by Policy team members to manage a bug, once there is
 212 proposed wording, is:
 213
 214 + Create a bug<number>-<user> branch for the bug, where <number> is
 215   the bug number in the BTS and <user> is a designator of the Policy
 216   team member who is shepherding the bug.
 217 + Commit wording changes in that branch until consensus is
 218   achieved. Do not modify debian/changelog or upgrading-checklist.html
 219   during this phase. Use the BTS to track who proposed the wording and
 220   who seconded it.
 221 + git pull master to make sure you have the latest version.
 222 + Once the change has been approved by enough people, git merge the
 223   branch into master immediately after making the final commit adding
 224   the changelog entry to minimize conflicts.
 225 + add the debian/changelog and upgrading-checklist.html changes, and
 226   commit to master.
 227 + Push master out so other people may merge in their own bug branches
 228   without conflicts.
 229 + Tag the bug as pending and remove other process tags.
 230 + Delete the now-merged branch.
 231
 232 The Git commands used for this workflow are:
 233 #+BEGIN_SRC Sh
 234 git checkout -b bug12345-rra master
 235 # edit files
 236 # git add files
 237 git commit
 238 git push origin bug12345-rra
 239 # iterate until good
 240 # update your local master branch
 241 git checkout master
 242 git pull
 243
 244 git checkout master
 245 git merge --no-commit bug12345-rra
 246 git reset --hard HEAD;
 247
 248 # If there are changes in master that make the branch not apply cleanly, there
 249 # should have been en error during the merge step above. If there was an
 250 # error, merge the master branch into the local branch, fix the conflicts, and
 251 # commit the new version of the local branch.
 252  : git checkout bug12345-rra
 253  : git merge master
 254 # Edit files to remove conflict
 255  : git commit -s
 256
 257 git checkout master
 258 git merge bug12345-rra
 259 # edit debian/changelog and upgrading-checklist.html
 260 git add debian/changelog upgrading-checklist.html
 261 git commit
 262 git push origin master
 263 git branch -d bug12345-rra
 264 git push origin :bug12345-rra
 265 #+END_SRC
 266
 267 For the debian/changelog entry, use the following format:
 268 #+BEGIN_EXAMPLE
 269   * <document>: <brief change description>
 270     Wording: <author of wording>
 271     Seconded: <seconder>
 272     Seconded: <seconder>
 273     Closes: <bug numbers>
 274 #+END_EXAMPLE
 275
 276 For example:
 277 #+BEGIN_EXAMPLE
 278   * Policy: better document version ranking and empty Debian revisions
 279     Wording: Russ Allbery <rra@debian.org>
 280     Seconded: Raphaël Hertzog <hertzog@debian.org>
 281     Seconded: Manoj Srivastava <srivasta@debian.org>
 282     Seconded: Guillem Jover <guillem@debian.org>
 283     Closes: #186700, #458910
 284 #+END_EXAMPLE
 285
 286 ** Updating branches
 287
 288 After commits to master have been pushed, either by you or by another
 289 Policy team member, you will generally want to update your working bug
 290 branches. The equivalent of the following commands should do that:
 291
 292 #+BEGIN_SRC Sh
 293 for i in `git show-ref --heads | awk '{print $2}'`; do
 294     j=$(basename $i)
 295     if [ "$j" != "master" ]; then
 296         git checkout $j && git merge master
 297     fi
 298 done
 299 git push --all origin
 300 #+END_SRC
 301
 302 assuming that you haven't packed the refs in your repository.
 303
 304 ** Making a release
 305
 306 For a final Policy release, change UNRELEASED to unstable in
 307 debian/changelog and update the timestamp to match the final release
 308 time (dch -r may be helpful for this), update the release date in
 309 upgrading-checklist.html, update Standards-Version in debian/control,
 310 and commit that change. Then do the final release build and make sure
 311 that it builds and installs.
 312
 313 Then, tag the repository and push the final changes to Alioth:
 314
 315 #+BEGIN_SRC Sh
 316 git tag -s v3.8.0.0
 317 git push origin
 318 git push --tags origin
 319 #+END_SRC
 320
 321 replacing the version number with the version of the release, of course.
 322
 323 Finally, announce the new Policy release on debian-devel-announce,
 324 including in the announcement the upgrading-checklist section for the
 325 new release.
 326
 327 ** Setting release goals
 328
 329 Policy has a large bug backlog, and each bug against Policy tends to
 330 take considerable time and discussion to resolve. I've found it
 331 useful, when trying to find a place to start, to pick a manageable set
 332 of bugs and set as a target resolving them completely before the next
 333 Policy release. Resolving a bug means one of the following:
 334
 335 + Proposing new language to address the bug that's seconded and approved by
 336   the readers of the Policy list following the [[./Progress.org][Policy changes process]] (or
 337   that's accepted by one of the Policy delegates if the change isn't
 338   normative; i.e., doesn't change the technical meaning of the document).
 339 + Determining that the bug is not relevant to Policy and closing it.
 340 + Determining that either there is no consensus that the bug indicates
 341   a problem, that the solutions that we can currently come up with are
 342   good solutions, or that Debian is ready for the change. These bugs
 343   are tagged wontfix and then closed after a while. A lot of Policy
 344   bugs fall into this category; just because it would be useful to
 345   have a policy in some area doesn't mean that we're ready to make
 346   one, and keeping the bugs open against Policy makes it difficult to
 347   tell what requires work. If the problem is worth writing a policy
 348   for, it will come up again later when hopefully the project
 349   consensus is more mature.
 350
 351 Anyone can pick bugs and work resolve them. The final determination to
 352 accept a wording change or reject a bug will be made by a Policy
 353 delegate, but if a patch is already written and seconded, or if a
 354 summary of why a bug is not ready to be acted on is already written,
 355 the work is much easier for the Policy delegate.
 356
 357 One of the best ways to help out is to pick one or two bugs (checking
 358 on the Policy list first), say that you'll make resolving them a goal
 359 for the next release, and guide the discussion until the bugs can
 360 reach one of the resolution states above.