From: Bill Allombert <Bill.Allombert@math.u-bordeaux.fr>
Date: Tue, 26 Jan 2010 12:44:11 +0000 (+0100)
Subject: Brace filenames with ~...~
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=52d859b134000966c9372ba8ffa7b43bcfe2db23;p=debian%2Fdebian-policy.git
Brace filenames with ~...~
This avoids /.../ to be intepreted as italic.
---
diff --git a/upgrading-checklist.html b/upgrading-checklist.html
index d20179f..755c3f3 100644
--- a/upgrading-checklist.html
+++ b/upgrading-checklist.html
@@ -7,7 +7,7 @@ lang="en" xml:lang="en">
<title>Policy checklist for upgrading your packages</title>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
<meta name="generator" content="Org-mode"/>
-<meta name="generated" content="2010-01-25 21:41:30 CET"/>
+<meta name="generated" content="2010-01-26 13:43:10 CET"/>
<meta name="author" content="Bill Allombert, Josip Rodin, Julian Gilbey, Russ Allbery, and Manoj Srivastava"/>
<meta name="description" content=""/>
<meta name="keywords" content=""/>
@@ -182,7 +182,7 @@ Permitting files to instead be installed to <code>/lib/triplet</code> and
should instead create them in postinst and remove them in prerm or postrm.
</li>
<li>
-<b>9.1.1</b> : /sys and /selinux directories are explicitly allowed as an
+<b>9.1.1</b> : <code>/sys</code> and <code>/selinux</code> directories are explicitly allowed as an
exception to the FHS.
</li>
@@ -211,7 +211,7 @@ may be used in different versions of the field.
</li>
<li>
<b>5.6.14</b> : The Debian archive software does not support uploading
-to multiple distributions with one \*.changes file.
+to multiple distributions with one <code>*.changes</code> file.
</li>
<li>
<b>5.6.19</b> : The Binary field may span multiple lines.
@@ -225,7 +225,7 @@ or packages using them should be built with RPATH.
<li>
<b>11.8.7</b> : Clarify installation directories for X programs and
remove the requirement to pre-depend on x11-common before installing
-into /usr/include/X11 and /usr/lib/X11.
+into <code>/usr/include/X11</code> and <code>/usr/lib/X11</code>.
</li>
<li>
<b>12.1</b> : Remove the requirement that all characters in a manual
@@ -280,11 +280,11 @@ spelled out.
</li>
<li>
<b>9.1</b>: Legacy XFree86 servers no longer get a special exception from the
-FHS permitting /etc/X11/XF86Config-4.
+FHS permitting <code>/etc/X11/XF86Config-4</code>.
</li>
<li>
<b>9.1.3</b>: Removed obsolete dependency requirements for packages that use
-/var/mail.
+<code>/var/mail</code>.
</li>
<li>
<b>11.8.5</b>: Speedo fonts are now deprecated. The X backend was disabled
@@ -333,12 +333,12 @@ test suite provided by the package should not be run.
<b>5.1</b>: All control files must be encoded in UTF-8.
</li>
<li>
-<b>5.2</b>: debian/control allows comment lines starting with # with no
+<b>5.2</b>: <code>debian/control</code> allows comment lines starting with # with no
preceding whitespace.
</li>
<li>
<b>9.3</b>: Init scripts ending in .sh are not handled specially. They are not
-sourced and are not guaranteed to be run by /bin/sh regardless of
+sourced and are not guaranteed to be run by <code>/bin/sh</code> regardless of
the #! line. This brings Policy in line with the long-standing
behavior of the init system in Debian.
</li>
@@ -347,12 +347,12 @@ behavior of the init system in Debian.
start the daemon again if it's already running.
</li>
<li>
-<b>9.3.2</b>: /var/run and /var/lock may be mounted as temporary filesystems, and
-init scripts must therefore create any necessary subdirectories
+<b>9.3.2</b>: <code>/var/run</code> and <code>/var/lock</code> may be mounted as temporary filesystems,
+and init scripts must therefore create any necessary subdirectories
dynamically.
</li>
<li>
-<b>10.4</b>: /bin/sh scripts may assume that local can take multiple variable
+<b>10.4</b>: <code>/bin/sh</code> scripts may assume that local can take multiple variable
arguments and supports assignment.
</li>
<li>
@@ -403,14 +403,14 @@ used that way.
<li>
<b>4.14</b>: If dpkg-source -x doesn't produce source ready for editing and
building with dpkg-buildpackage, packages should include a
-debian/README.source file explaining how to generate the patched
+<code>debian/README.source</code> file explaining how to generate the patched
source, add a new modification, and remove an existing
modification. This file may also be used to document packaging a
new upstream release and any other complexity of the Debian build
process.
</li>
<li>
-<b>5.6.3</b>: The Uploaders field in debian/control may be wrapped.
+<b>5.6.3</b>: The Uploaders field in <code>debian/control</code> may be wrapped.
</li>
<li>
<b>5.6.12</b>: An empty Debian revision is equivalent to a Debian revision of 0 in
@@ -432,13 +432,13 @@ of -runtime for runtime support programs, since that naming is more
common in Debian.
</li>
<li>
-<b>9.5</b>: Files in /etc/cron.{hourly,daily,weekly,monthly} must be
+<b>9.5</b>: Files in <code>/etc/cron.{hourly,daily,weekly,monthly}</code> must be
configuration files (upgraded from should). Mention the hourly
directory.
</li>
<li>
-<b>11.8.6</b>: Packages providing /etc/X11/Xresources files need not conflict with
-xbase (<< 3.3.2.3a-2), which is long-obsolete.
+<b>11.8.6</b>: Packages providing <code>/etc/X11/Xresources</code> files need not conflict
+with xbase (<< 3.3.2.3a-2), which is long-obsolete.
</li>
<li>
<b>12.1</b>: Manual pages in locale-specific directories should use either the
@@ -451,7 +451,7 @@ UTF-8.
</li>
<li>
<b>12.5</b>: The Apache 2.0 license is now in common-licenses and should be
-referenced rather than quoted in debian/copyright.
+referenced rather than quoted in <code>debian/copyright</code>.
</li>
<li>
<b>12.5</b>: Packages in contrib and non-free should state in the copyright file
@@ -481,7 +481,7 @@ Released Dec 2007.
anything, even the end of a part.
</li>
<li>
-<b>10.4</b>: Scripts may assume that /bin/sh supports local (at a basic level)
+<b>10.4</b>: Scripts may assume that <code>/bin/sh</code> supports local (at a basic level)
and that its test builtin (if any) supports -a and -o binary
logical operators.
</li>
@@ -517,7 +517,7 @@ a gettext-based system such as po-debconf.
</li>
<li>
<b>12.5</b>: GFDL 1.2, GPL 3, and LGPL 3 are now in common-licenses and should
-be referenced rather than quoted in debian/copyright.
+be referenced rather than quoted in <code>debian/copyright</code>.
</li>
</ul>
@@ -582,7 +582,7 @@ of the process.
</li>
<li>
<b>11.8.7</b>: Packages should install any relevant files into the directories
-<i>usr/include/X11/and /usr/lib/X11</i>, but if they do so, they
+<code>/usr/include/X11/</code> and <code>/usr/lib/X11/</code>, but if they do so, they
must pre-depend on x11-common (>= 1:7.0.0)
</li>
@@ -602,17 +602,17 @@ Released Apr 2006.
<ul>
<li>
<b>11.5</b>: Packages shipping web server CGI files are expected to install
-them in <i>usr/lib/cgi-lib</i> directories. This location change
+them in <code>/usr/lib/cgi-lib/</code> directories. This location change
perhaps should be documented in NEWS
</li>
<li>
<b>11.5</b>: Web server packages should include a standard scriptAlias of
-cgi-lib to /usr/lib/cgi-lib.
+cgi-lib to <code>/usr/lib/cgi-lib</code>.
</li>
<li>
<b>9.1.1</b>: The version of FHS mandated by policy has been upped to
2.3. There should be no changes required for most packages,
-though new top level directories /media, /srv, etc may be of
+though new top level directories <code>/media</code>, <code>/srv</code>, etc may be of
interest.
</li>
<li>
@@ -635,9 +635,9 @@ so since it also pays attention to run levels and other local
constraints.
</li>
<li>
-<b>11.8.5.2, 11.8.7, etc</b>: We no longer use /usr/X11R6, since we have
+<b>11.8.5.2, 11.8.7, etc</b>: We no longer use <code>/usr/X11R6</code>, since we have
migrated away to using Xorg paths. This means, for one thing, fonts
-live in <i>usr/share/fonts/X11</i> now, and /usr/X11R6 is gone.
+live in <code>/usr/share/fonts/X11/</code> now, and <code>/usr/X11R6</code> is gone.
</li>
@@ -660,11 +660,11 @@ Recommend. doc-base, and not menu, for registering package documentation.
</li>
<li>
<b>8.1</b>: Run time support programs should live in subdirectories of
-<i>usr/lib</i> or /usr/share, and preferably the shared lib is named
+<code>/usr/lib/</code> or <code>/usr/share</code>, and preferably the shared lib is named
the same as the package name (to avoid name collisions).
</li>
<li>
-<b>11.5</b>: It is recommended that HTTP servers provide an alias /images to
+<b>11.5</b>: It is recommended that HTTP servers provide an alias <code>/images</code> to
allow packages to share image files with the web server
</li>
@@ -868,7 +868,7 @@ special Tasks: field in the control file.
<li>
<b>11.8.4</b>: window managers that support netwm can now add 20 points when
they add themselves as an alternative for
-/usr/bin/x-window-manager
+<code>/usr/bin/x-window-manager</code>
</li>
<li>
<b>10.1</b>: The default compilation options have now changed, one should
@@ -909,15 +909,16 @@ Released Jul 2001.
standard packages
</li>
<li>
-<b>11.5</b>: Programs that access docs need to do so via <i>usr/share/doc, and not via /usr/doc</i> as was the policy previously
+<b>11.5</b>: Programs that access docs need to do so via <code>/usr/share/doc</code>, and
+not via <code>/usr/doc/</code> as was the policy previously
</li>
<li>
-<b>12.3</b>: Putting documentation in /usr/doc versus /usr/share/doc is now
+<b>12.3</b>: Putting documentation in <code>/usr/doc</code> versus <code>/usr/share/doc</code> is now
a ``serious'' policy violation.
</li>
<li>
<b>11.5</b>: For web servers, one should not provide non-local access to the
-/usr/share/doc hierarchy. If one can't provide access controls for
+<code>/usr/share/doc</code> hierarchy. If one can't provide access controls for
the <a href="http://localhost/doc/">http://localhost/doc/</a> directory, then it is preferred that one
ask permission to expose that information during the install.
</li>
@@ -977,7 +978,7 @@ packages
fonts for the X Window System
</li>
<li>
-<b>11.8.6</b>: Packages must not ship <i>usr/X11R6/lib/X11/app-defaults</i>
+<b>11.8.6</b>: Packages must not ship <code>/usr/X11R6/lib/X11/app-defaults/</code>
</li>
<li>
<b>11.8.7</b>: X-related packages should usually use the regular FHS
@@ -1005,9 +1006,9 @@ Released Apr 2001.
</p>
<ul>
<li>
-<b>11.6</b>: The system-wide mail directory is now /var/mail, no longer
-/var/spool/mail. Any packages accessing the mail spool should
-access it via /var/mail and include a suitable Depends field;
+<b>11.6</b>: The system-wide mail directory is now <code>/var/mail</code>, no longer
+<code>/var/spool/mail</code>. Any packages accessing the mail spool should
+access it via <code>/var/mail</code> and include a suitable Depends field;
details in
</li>
<li>
@@ -1037,8 +1038,8 @@ ambiguous. This should not affect any current packages
</li>
<li>
<b>10.7.3</b>: Examples and templates files for use by scripts should now live
-in /usr/share/<package> or /usr/lib/<package>, with
-symbolic links from /usr/share/doc/<package>/examples as
+in <code>/usr/share/<package></code> or <code>/usr/lib/<package></code>, with
+symbolic links from <code>/usr/share/doc/<package>/examples</code> as
needed
</li>
@@ -1058,7 +1059,7 @@ Released Feb 2001.
<ul>
<li>
<b>11.8.6</b>: X app-defaults directory has moved from
-/usr/X11R6/lib/X11/app-defaults to /etc/X11/app-defaults
+<code>/usr/X11R6/lib/X11/app-defaults</code> to <code>/etc/X11/app-defaults</code>
</li>
</ul>
@@ -1114,15 +1115,15 @@ Released Jan 2001.
</p>
<ul>
<li>
-<b>9.3.2</b>: Daemon startup scripts in <i>etc/init.d</i> should not contain
+<b>9.3.2</b>: Daemon startup scripts in <code>/etc/init.d/</code> should not contain
modifiable parameters; these should be moved to a file in
-<i>etc/default</i>
+<code>/etc/default/</code>
</li>
<li>
-<b>12.3</b>: Files in /usr/share/doc must not be referenced by any
+<b>12.3</b>: Files in <code>/usr/share/doc</code> must not be referenced by any
program. If such files are needed, they must be placed in
-<i>usr/share/<package></i>, and symbolic links created as required
-in <i>usr/share/doc/<package></i>
+<code>/usr/share/<package>/</code>, and symbolic links created as required
+in <code>/usr/share/doc/<package>/</code>
</li>
<li>
Much of the packaging manual has now been imported into the
@@ -1189,7 +1190,7 @@ has been codified:
</li>
<li>
<b>11.8.4</b>: X window manager (virtual package x-window-manager, and
-/usr/bin/x-window-manager alternative, with priority
+<code>/usr/bin/x-window-manager</code> alternative, with priority
calculation guidelines)
</li>
<li>
@@ -1247,33 +1248,33 @@ Released Oct 1999.
</p>
<ul>
<li>
-/usr/doc/<package> has to be a symlink pointing to
-/usr/share/doc/<package>, to be maintained by postinst
+<code>/usr/doc/<package></code> has to be a symlink pointing to
+<code>/usr/share/doc/<package></code>, to be maintained by postinst
and prerm scripts. Details are in <b>defunct</b>
</li>
<li>
<b>7.1, 7.6</b>: Introduced source dependencies (Build-Depends, etc.)
</li>
<li>
-<b>9.3.4</b>: /etc/rc.boot has been deprecated in favour of /etc/rcS.d.
+<b>9.3.4</b>: <code>/etc/rc.boot</code> has been deprecated in favour of <code>/etc/rcS.d</code>.
(Packages should not be touching this directory, but should use
update-rc.d instead)
</li>
<li>
<b>9.3.3</b>: update-rc.d is now the <b>only</b> allowable way of accessing the
-/etc/rc?.d/[SK]??* links. Any scripts which manipulate them
+<code>/etc/rc?.d/[SK]??*</code> links. Any scripts which manipulate them
directly must be changed to use update-rc.d instead. (This is
because the file-rc package handles this information in an
incompatible way.)
</li>
<li>
-<b>12.7</b>: Architecture-specific examples go in /usr/lib/<package>/examples
-with symlinks from /usr/share/doc/<package>/examples/* or from
-/usr/share/doc/<package>/examples itself
+<b>12.7</b>: Architecture-specific examples go in <code>/usr/lib/<package>/examples</code>
+with symlinks from <code>/usr/share/doc/<package>/examples/*</code> or from
+<code>/usr/share/doc/<package>/examples</code> itself
</li>
<li>
-<b>9.1.1</b>: Updated FHS to a 2.1 draft; this reverts /var/state to
-/var/lib
+<b>9.1.1</b>: Updated FHS to a 2.1 draft; this reverts <code>/var/state</code> to
+<code>/var/lib</code>
</li>
<li>
<b>9.7; mime-policy</b>: Added MIME sub-policy document
@@ -1341,7 +1342,7 @@ control files, though all four digits are still permitted.
</li>
<li>
<b>12.6</b>: The location of the GPL has changed to
-/usr/share/common-licenses. This may require changing the
+<code>/usr/share/common-licenses</code>. This may require changing the
copyright files to point to the correct location of the GPL and
other major licenses
</li>
@@ -1361,8 +1362,8 @@ System)
that carries the full weight of Debian policy
</li>
<li>
-<b>11.3</b>: Programs which need to modify the files /var/run/utmp,
-/var/log/wtmp and /var/log/lastlog must be installed setgid utmp
+<b>11.3</b>: Programs which need to modify the files <code>/var/run/utmp</code>,
+<code>/var/log/wtmp</code> and <code>/var/log/lastlog</code> must be installed setgid utmp
<p>
@@ -1406,9 +1407,9 @@ gap.
</li>
<li>
Modified the section about changelog files to accommodate
-upstream changelogs which were formatted as HTML/ These
+upstream changelogs which were formatted as HTML. These
upstream changelog files should now be accessible as
-/usr/doc/package/changelog.html.gz
+<code>/usr/doc/package/changelog.html.gz</code>
<ul>
<li>
Symlinks are permissible to link the real, or upstream,
@@ -1422,7 +1423,7 @@ package, though not necessarily the main binary package.
</li>
<li>
Corrected all references to the location of the copyright
-files. The correct location is /usr/doc/package/copyright
+files. The correct location is <code>/usr/doc/package/copyright</code>
</li>
<li>
Ratified the architecture specification strings to cater to the
@@ -1460,7 +1461,7 @@ symbolic links between toplevel directories should be absolute
Updated section 4.9 Games:
<ul>
<li>
-manpages for games should be installed in /usr/man/man6
+manpages for games should be installed in <code>/usr/man/man6</code>
(cf., Policy Weekly Issue#6, topic 3)
</li>
@@ -1497,15 +1498,15 @@ Released Jan 1998
Updated section 3.3.4 Scripts:
<ul>
<li>
-/bin/sh may be any POSIX compatible shell
+<code>/bin/sh</code> may be any POSIX compatible shell
</li>
<li>
-scripts including bashisms have to specify /bin/bash as
+scripts including bashisms have to specify <code>/bin/bash</code> as
interpreter
</li>
<li>
scripts which create files in world-writable directories
-(e.g., in /tmp) should use tempfile or mktemp for creating
+(e.g., in <code>/tmp</code>) should use tempfile or mktemp for creating
the directory
</li>
@@ -1525,16 +1526,16 @@ file extension as the referenced file
Updated section 3.3.6 Device files:
<ul>
<li>
-/dev/tty* serial devices should be used instead of /dev/cu*
+<code>/dev/tty*</code> serial devices should be used instead of <code>/dev/cu*</code>
</li>
</ul>
</li>
<li>
-Updated section 3.4.2 Writing the scripts in /etc/init.d:
+Updated section 3.4.2 Writing the scripts in <code>/etc/init.d</code>:
<ul>
<li>
-all /etc/init.d scripts have to provide the following options:
+all <code>/etc/init.d</code> scripts have to provide the following options:
start, stop, restart, force-reload
</li>
<li>
@@ -1549,7 +1550,7 @@ Updated section 3.5 Cron jobs:
<ul>
<li>
cron jobs that need to be executed more often than daily should
-be installed into /etc/cron.d
+be installed into <code>/etc/cron.d</code>
</li>
</ul>
@@ -1590,7 +1591,7 @@ reasonable default configuration
New section 4.6 News system configuration:
<ul>
<li>
-/etc/news/organization and /etc/news/server should be supported
+<code>/etc/news/organization</code> and <code>/etc/news/server</code> should be supported
by all news servers and clients
</li>
@@ -1614,7 +1615,7 @@ against lesstif and not against a non-free Motif library
Updated section 4.9 Games:
<ul>
<li>
-games for X Windows have to be installed in /usr/games, just as
+games for X Windows have to be installed in <code>/usr/games</code>, just as
non-X games
</li>
@@ -1636,7 +1637,7 @@ Released Sep 1997.
<ul>
<li>
new section `4.2 Daemons' including rules for
-/etc/services, /etc/protocols, /etc/rpc, and /etc/inetd.conf
+<code>/etc/services</code>, <code>/etc/protocols</code>, <code>/etc/rpc</code>, and <code>/etc/inetd.conf</code>
</li>
<li>
@@ -1671,7 +1672,7 @@ i386, alpha, arm, m68k, powerpc, sparc.
</li>
<li>
-detailed rules for /usr/local
+detailed rules for <code>/usr/local</code>
</li>
<li>
@@ -1802,7 +1803,7 @@ Upstream changelog must be installed too
<p class="author"> Author: Bill Allombert, Josip Rodin, Julian Gilbey, Russ Allbery, and Manoj Srivastava
<a href="mailto:srivasta@debian.org"><srivasta@debian.org></a>
</p>
-<p class="date"> Date: 2010-01-25 21:41:30 CET</p>
+<p class="date"> Date: 2010-01-26 13:43:10 CET</p>
<p class="creator">HTML generated by org-mode 6.33f in emacs 23</p>
</div>
</div>
diff --git a/upgrading-checklist.org b/upgrading-checklist.org
index 12cf7d7..884852d 100644
--- a/upgrading-checklist.org
+++ b/upgrading-checklist.org
@@ -69,7 +69,7 @@ Released Jan 2010.
~/usr/lib/triplet~ directories.
+ *10.6* : Explicitly state that packages may not contain named pipes and
should instead create them in postinst and remove them in prerm or postrm.
-+ *9.1.1* : /sys and /selinux directories are explicitly allowed as an
++ *9.1.1* : ~/sys~ and ~/selinux~ directories are explicitly allowed as an
exception to the FHS.
*** 3.8.3.0
@@ -86,7 +86,7 @@ Released Aug 2009.
combination with other architectures. Clarify when /all/ and /any/
may be used in different versions of the field.
+ *5.6.14* : The Debian archive software does not support uploading
- to multiple distributions with one \*.changes file.
+ to multiple distributions with one ~*.changes~ file.
+ *5.6.19* : The Binary field may span multiple lines.
+ *10.2* : Remove the permission for shared library packages to
install libraries in a non-standard location and modify ld.so.conf.
@@ -94,7 +94,7 @@ Released Aug 2009.
or packages using them should be built with RPATH.
+ *11.8.7* : Clarify installation directories for X programs and
remove the requirement to pre-depend on x11-common before installing
- into /usr/include/X11 and /usr/lib/X11.
+ into ~/usr/include/X11~ and ~/usr/lib/X11~.
+ *12.1* : Remove the requirement that all characters in a manual
page be representable in the legacy encoding for that language.
+ *12.1* : Localized man pages should either be kept up-to-date with
@@ -127,9 +127,9 @@ Released Jun 2009.
+ *5.6.1*: The requirements for source package names are now explicitly
spelled out.
+ *9.1*: Legacy XFree86 servers no longer get a special exception from the
- FHS permitting /etc/X11/XF86Config-4.
+ FHS permitting ~/etc/X11/XF86Config-4~.
+ *9.1.3*: Removed obsolete dependency requirements for packages that use
- /var/mail.
+ ~/var/mail~.
+ *11.8.5*: Speedo fonts are now deprecated. The X backend was disabled
starting in lenny.
+ *12.5*: The GNU Free Documentation License version 1.3 is included in
@@ -154,18 +154,18 @@ Released Mar 2009.
+ *4.9.1*: New nocheck option for DEB\_BUILD\_OPTIONS indicating any build-time
test suite provided by the package should not be run.
+ *5.1*: All control files must be encoded in UTF-8.
-+ *5.2*: debian/control allows comment lines starting with # with no
++ *5.2*: ~debian/control~ allows comment lines starting with # with no
preceding whitespace.
+ *9.3*: Init scripts ending in .sh are not handled specially. They are not
- sourced and are not guaranteed to be run by /bin/sh regardless of
+ sourced and are not guaranteed to be run by ~/bin/sh~ regardless of
the #! line. This brings Policy in line with the long-standing
behavior of the init system in Debian.
+ *9.3.2*: The start action of an init script must exit successfully and not
start the daemon again if it's already running.
-+ *9.3.2*: /var/run and /var/lock may be mounted as temporary filesystems, and
- init scripts must therefore create any necessary subdirectories
++ *9.3.2*: ~/var/run~ and ~/var/lock~ may be mounted as temporary filesystems,
+ and init scripts must therefore create any necessary subdirectories
dynamically.
-+ *10.4*: /bin/sh scripts may assume that local can take multiple variable
++ *10.4*: ~/bin/sh~ scripts may assume that local can take multiple variable
arguments and supports assignment.
+ *11.6*: User mailboxes may be mode 600 and owned by the user rather than
mode 660, owned by user, and group mail.
@@ -196,12 +196,12 @@ Released Jun 2008.
used that way.
+ *4.14*: If dpkg-source -x doesn't produce source ready for editing and
building with dpkg-buildpackage, packages should include a
- debian/README.source file explaining how to generate the patched
+ ~debian/README.source~ file explaining how to generate the patched
source, add a new modification, and remove an existing
modification. This file may also be used to document packaging a
new upstream release and any other complexity of the Debian build
process.
-+ *5.6.3*: The Uploaders field in debian/control may be wrapped.
++ *5.6.3*: The Uploaders field in ~debian/control~ may be wrapped.
+ *5.6.12*: An empty Debian revision is equivalent to a Debian revision of 0 in
a version number.
+ *5.6.23*: New Homepage field for upstream web sites.
@@ -213,11 +213,11 @@ Released Jun 2008.
separate package, or into the -dev package. Suggest -tools instead
of -runtime for runtime support programs, since that naming is more
common in Debian.
-+ *9.5*: Files in /etc/cron.{hourly,daily,weekly,monthly} must be
++ *9.5*: Files in ~/etc/cron.{hourly,daily,weekly,monthly}~ must be
configuration files (upgraded from should). Mention the hourly
directory.
-+ *11.8.6*: Packages providing /etc/X11/Xresources files need not conflict with
- xbase (<< 3.3.2.3a-2), which is long-obsolete.
++ *11.8.6*: Packages providing ~/etc/X11/Xresources~ files need not conflict
+ with xbase (<< 3.3.2.3a-2), which is long-obsolete.
+ *12.1*: Manual pages in locale-specific directories should use either the
legacy encoding for that directory or UTF-8. Country names should
not be included in locale-specific manual page directories unless
@@ -226,7 +226,7 @@ Released Jun 2008.
legacy encoding for a locale even if the man page is encoded in
UTF-8.
+ *12.5*: The Apache 2.0 license is now in common-licenses and should be
- referenced rather than quoted in debian/copyright.
+ referenced rather than quoted in ~debian/copyright~.
+ *12.5*: Packages in contrib and non-free should state in the copyright file
that the package is not part of Debian GNU/Linux and briefly
explain why.
@@ -242,7 +242,7 @@ Released Dec 2007.
+ *5.6.12*: Package version numbers may contain tildes, which sort before
anything, even the end of a part.
-+ *10.4*: Scripts may assume that /bin/sh supports local (at a basic level)
++ *10.4*: Scripts may assume that ~/bin/sh~ supports local (at a basic level)
and that its test builtin (if any) supports -a and -o binary
logical operators.
+ *8.5*: The substitution variable ${binary:Version} should be used in place
@@ -264,7 +264,7 @@ Released Dec 2007.
specification must allow for translation of their messages by using
a gettext-based system such as po-debconf.
+ *12.5*: GFDL 1.2, GPL 3, and LGPL 3 are now in common-licenses and should
- be referenced rather than quoted in debian/copyright.
+ be referenced rather than quoted in ~debian/copyright~.
*** 3.7.2.2
:PROPERTIES:
@@ -303,7 +303,7 @@ Released Apr 2006.
consensus, and documenting it in README.Debian constitute most
of the process.
+ *11.8.7*: Packages should install any relevant files into the directories
- /usr/include/X11/and /usr/lib/X11/, but if they do so, they
+ ~/usr/include/X11/~ and ~/usr/lib/X11/~, but if they do so, they
must pre-depend on x11-common (>= 1:7.0.0)
*** 3.7.0.0
@@ -315,13 +315,13 @@ Released Apr 2006.
Released Apr 2006.
+ *11.5*: Packages shipping web server CGI files are expected to install
- them in /usr/lib/cgi-lib/ directories. This location change
+ them in ~/usr/lib/cgi-lib/~ directories. This location change
perhaps should be documented in NEWS
+ *11.5*: Web server packages should include a standard scriptAlias of
- cgi-lib to /usr/lib/cgi-lib.
+ cgi-lib to ~/usr/lib/cgi-lib~.
+ *9.1.1*: The version of FHS mandated by policy has been upped to
2.3. There should be no changes required for most packages,
- though new top level directories /media, /srv, etc may be of
+ though new top level directories ~/media~, ~/srv~, etc may be of
interest.
+ *5.1, 5.6.3*: All fields, apart from the Uploaders field, in the control file
are supposed to be a single logical line, which may be spread
@@ -336,9 +336,9 @@ Released Apr 2006.
+ *9.3.3.2*: packages that invoke initscripts now must use invoke-rc.d to do
so since it also pays attention to run levels and other local
constraints.
-+ *11.8.5.2, 11.8.7, etc*: We no longer use /usr/X11R6, since we have
++ *11.8.5.2, 11.8.7, etc*: We no longer use ~/usr/X11R6~, since we have
migrated away to using Xorg paths. This means, for one thing, fonts
- live in /usr/share/fonts/X11/ now, and /usr/X11R6 is gone.
+ live in ~/usr/share/fonts/X11/~ now, and ~/usr/X11R6~ is gone.
*** 3.6.2.0
@@ -351,9 +351,9 @@ Released 2005
+ Recommend. doc-base, and not menu, for registering package documentation.
+ *8.1*: Run time support programs should live in subdirectories of
- /usr/lib/ or /usr/share, and preferably the shared lib is named
+ ~/usr/lib/~ or ~/usr/share~, and preferably the shared lib is named
the same as the package name (to avoid name collisions).
-+ *11.5*: It is recommended that HTTP servers provide an alias /images to
++ *11.5*: It is recommended that HTTP servers provide an alias ~/images~ to
allow packages to share image files with the web server
*** 3.6.1.0
@@ -434,8 +434,8 @@ Released Mar 2003.
+ *9.3.2*: When asked to restart a service that isn't already running,
the init script should start the service.
+ *12.6*: If the purpose of a package is to provide examples, then the
- example files can be installed into =/usr/share/doc/package= (rather
- than =/usr/share/doc/package/examples=).
+ example files can be installed into ~/usr/share/doc/package~ (rather
+ than ~/usr/share/doc/package/examples~).
*** 3.5.8.0
:PROPERTIES:
@@ -473,7 +473,7 @@ Released Aug 2002.
special Tasks: field in the control file.
+ *11.8.4*: window managers that support netwm can now add 20 points when
they add themselves as an alternative for
- /usr/bin/x-window-manager
+ ~/usr/bin/x-window-manager~
+ *10.1*: The default compilation options have now changed, one should
provide debugging symbols in all cases, and optionally step
back optimization to -O0, depending on the DEB\_BUILD\_OPTIONS
@@ -497,12 +497,12 @@ Released Jul 2001.
+ *2.5*: Emacs and TeX are no longer mandated by policy to be priority
standard packages
-+ *11.5*: Programs that access docs need to do so via /usr/share/doc, and
- not via /usr/doc/ as was the policy previously
-+ *12.3*: Putting documentation in /usr/doc versus /usr/share/doc is now
++ *11.5*: Programs that access docs need to do so via ~/usr/share/doc~, and
+ not via ~/usr/doc/~ as was the policy previously
++ *12.3*: Putting documentation in ~/usr/doc~ versus ~/usr/share/doc~ is now
a ``serious'' policy violation.
+ *11.5*: For web servers, one should not provide non-local access to the
- /usr/share/doc hierarchy. If one can't provide access controls for
+ ~/usr/share/doc~ hierarchy. If one can't provide access controls for
the http://localhost/doc/ directory, then it is preferred that one
ask permission to expose that information during the install.
+ *7*: There are new rules for build-indep/build-arch targets and
@@ -534,7 +534,7 @@ Released May 2001.
* *11.8.3*: Rules for defining x-terminal-emulator improved
* *11.8.5*: X Font policy rewritten: you must read this if you provide
fonts for the X Window System
- * *11.8.6*: Packages must not ship /usr/X11R6/lib/X11/app-defaults/
+ * *11.8.6*: Packages must not ship ~/usr/X11R6/lib/X11/app-defaults/~
* *11.8.7*: X-related packages should usually use the regular FHS
locations; imake-using packages are exempted from this
* *11.8.8*: OpenMotif linked binaries have the same rules as
@@ -548,9 +548,9 @@ Released May 2001.
Released Apr 2001.
-+ *11.6*: The system-wide mail directory is now /var/mail, no longer
- /var/spool/mail. Any packages accessing the mail spool should
- access it via /var/mail and include a suitable Depends field;
++ *11.6*: The system-wide mail directory is now ~/var/mail~, no longer
+ ~/var/spool/mail~. Any packages accessing the mail spool should
+ access it via ~/var/mail~ and include a suitable Depends field;
details in
+ *11.9; perl-policy*: The perl policy is now part of Debian policy
proper. Perl programs and modules should follow the current Perl
@@ -568,8 +568,8 @@ Released Apr 2001.
+ *7.1*: Build-Depends arch syntax has been changed to be less
ambiguous. This should not affect any current packages
+ *10.7.3*: Examples and templates files for use by scripts should now live
- in /usr/share/<package> or /usr/lib/<package>, with
- symbolic links from /usr/share/doc/<package>/examples as
+ in ~/usr/share/<package>~ or ~/usr/lib/<package>~, with
+ symbolic links from ~/usr/share/doc/<package>/examples~ as
needed
*** 3.5.2.0
@@ -581,7 +581,7 @@ Released Apr 2001.
Released Feb 2001.
+ *11.8.6*: X app-defaults directory has moved from
- /usr/X11R6/lib/X11/app-defaults to /etc/X11/app-defaults
+ ~/usr/X11R6/lib/X11/app-defaults~ to ~/etc/X11/app-defaults~
*** 3.5.1.0
:PROPERTIES:
@@ -613,13 +613,13 @@ Released Jan 2001.
Released Jan 2001.
-+ *9.3.2*: Daemon startup scripts in /etc/init.d/ should not contain
++ *9.3.2*: Daemon startup scripts in ~/etc/init.d/~ should not contain
modifiable parameters; these should be moved to a file in
- /etc/default/
-+ *12.3*: Files in /usr/share/doc must not be referenced by any
+ ~/etc/default/~
++ *12.3*: Files in ~/usr/share/doc~ must not be referenced by any
program. If such files are needed, they must be placed in
- /usr/share/<package>/, and symbolic links created as required
- in /usr/share/doc/<package>/
+ ~/usr/share/<package>/~, and symbolic links created as required
+ in ~/usr/share/doc/<package>/~
+ Much of the packaging manual has now been imported into the
policy document
@@ -656,7 +656,7 @@ Released Aug 00.
- *11.8.2*: X server (virtual package xserver)
- *11.8.3*: X terminal emulator (virtual package x-terminal-emulator)
- *11.8.4*: X window manager (virtual package x-window-manager, and
- /usr/bin/x-window-manager alternative, with priority
+ ~/usr/bin/x-window-manager~ alternative, with priority
calculation guidelines)
- *12.8.5*: X fonts (this section has been written from scratch)
- *11.8.6*: X application defaults
@@ -686,23 +686,23 @@ Released Nov 1999.
Released Oct 1999.
-+ /usr/doc/<package> has to be a symlink pointing to
- /usr/share/doc/<package>, to be maintained by postinst
++ ~/usr/doc/<package>~ has to be a symlink pointing to
+ ~/usr/share/doc/<package>~, to be maintained by postinst
and prerm scripts. Details are in *defunct*
+ *7.1, 7.6*: Introduced source dependencies (Build-Depends, etc.)
-+ *9.3.4*: /etc/rc.boot has been deprecated in favour of /etc/rcS.d.
++ *9.3.4*: ~/etc/rc.boot~ has been deprecated in favour of ~/etc/rcS.d~.
(Packages should not be touching this directory, but should use
update-rc.d instead)
+ *9.3.3*: update-rc.d is now the *only* allowable way of accessing the
- /etc/rc?.d/[SK]??* links. Any scripts which manipulate them
+ ~/etc/rc?.d/[SK]??*~ links. Any scripts which manipulate them
directly must be changed to use update-rc.d instead. (This is
because the file-rc package handles this information in an
incompatible way.)
-+ *12.7*: Architecture-specific examples go in /usr/lib/<package>/examples
- with symlinks from /usr/share/doc/<package>/examples/* or from
- /usr/share/doc/<package>/examples itself
-+ *9.1.1*: Updated FHS to a 2.1 draft; this reverts /var/state to
- /var/lib
++ *12.7*: Architecture-specific examples go in ~/usr/lib/<package>/examples~
+ with symlinks from ~/usr/share/doc/<package>/examples/*~ or from
+ ~/usr/share/doc/<package>/examples~ itself
++ *9.1.1*: Updated FHS to a 2.1 draft; this reverts ~/var/state~ to
+ ~/var/lib~
+ *9.7; mime-policy*: Added MIME sub-policy document
+ *12.4*: VISUAL is allowed as a (higher priority) alternative to EDITOR
+ *11.6*: Modified liblockfile description, which affects
@@ -740,7 +740,7 @@ Released Jun 1999.
+ *4.1*: Only 3 digits of the Standards version need be included in
control files, though all four digits are still permitted.
+ *12.6*: The location of the GPL has changed to
- /usr/share/common-licenses. This may require changing the
+ ~/usr/share/common-licenses~. This may require changing the
copyright files to point to the correct location of the GPL and
other major licenses
+ *10.2*: Packages that use libtool to create shared libraries must
@@ -750,8 +750,8 @@ Released Jun 1999.
System)
+ *9.6; menu-policy*: There is now an associated menu policy, in a separate document,
that carries the full weight of Debian policy
-+ *11.3*: Programs which need to modify the files /var/run/utmp,
- /var/log/wtmp and /var/log/lastlog must be installed setgid utmp
++ *11.3*: Programs which need to modify the files ~/var/run/utmp~,
+ ~/var/log/wtmp~ and ~/var/log/lastlog~ must be installed setgid utmp
*Please note that section numbers below this point may not be up to date*
@@ -777,15 +777,15 @@ Policy Manual:
Section 5 after 5.5 were moved down to fill in the number
gap.
+ Modified the section about changelog files to accommodate
- upstream changelogs which were formatted as HTML/ These
+ upstream changelogs which were formatted as HTML. These
upstream changelog files should now be accessible as
- /usr/doc/package/changelog.html.gz
+ ~/usr/doc/package/changelog.html.gz~
+ Symlinks are permissible to link the real, or upstream,
changelog name to the Debian mandated name.
+ Clarified that HTML documentation should be present in some
package, though not necessarily the main binary package.
+ Corrected all references to the location of the copyright
- files. The correct location is /usr/doc/package/copyright
+ files. The correct location is ~/usr/doc/package/copyright~
+ Ratified the architecture specification strings to cater to the
HURD.
@@ -804,7 +804,7 @@ Released Apr 1998.
(cf., Policy Weekly Issue#6, topic 2)
+ Updated section 4.9 Games:
- + manpages for games should be installed in /usr/man/man6
+ + manpages for games should be installed in ~/usr/man/man6~
(cf., Policy Weekly Issue#6, topic 3)
**** Packaging Manual:
@@ -822,11 +822,11 @@ Released Apr 1998.
Released Jan 1998
+ Updated section 3.3.4 Scripts:
- + /bin/sh may be any POSIX compatible shell
- + scripts including bashisms have to specify /bin/bash as
+ + ~/bin/sh~ may be any POSIX compatible shell
+ + scripts including bashisms have to specify ~/bin/bash~ as
interpreter
+ scripts which create files in world-writable directories
- (e.g., in /tmp) should use tempfile or mktemp for creating
+ (e.g., in ~/tmp~) should use tempfile or mktemp for creating
the directory
+ Updated section 3.3.5 Symbolic Links:
@@ -834,17 +834,17 @@ Released Jan 1998
file extension as the referenced file
+ Updated section 3.3.6 Device files:
- + /dev/tty* serial devices should be used instead of /dev/cu*
+ + ~/dev/tty*~ serial devices should be used instead of ~/dev/cu*~
-+ Updated section 3.4.2 Writing the scripts in /etc/init.d:
- + all /etc/init.d scripts have to provide the following options:
++ Updated section 3.4.2 Writing the scripts in ~/etc/init.d~:
+ + all ~/etc/init.d~ scripts have to provide the following options:
start, stop, restart, force-reload
+ the reload option is optional and must never stop and restart
the service
+ Updated section 3.5 Cron jobs:
+ cron jobs that need to be executed more often than daily should
- be installed into /etc/cron.d
+ be installed into ~/etc/cron.d~
+ Updated section 3.7 Menus:
+ removed section about how to register HTML docs to `menu'
@@ -861,7 +861,7 @@ Released Jan 1998
reasonable default configuration
+ New section 4.6 News system configuration:
- + /etc/news/organization and /etc/news/server should be supported
+ + ~/etc/news/organization~ and ~/etc/news/server~ should be supported
by all news servers and clients
+ Updated section 4.7 Programs for the X Window System:
@@ -871,7 +871,7 @@ Released Jan 1998
against lesstif and not against a non-free Motif library
+ Updated section 4.9 Games:
- + games for X Windows have to be installed in /usr/games, just as
+ + games for X Windows have to be installed in ~/usr/games~, just as
non-X games
*** 2.3.0.1, 2.3.0.0
@@ -883,7 +883,7 @@ Released Jan 1998
Released Sep 1997.
+ new section `4.2 Daemons' including rules for
- /etc/services, /etc/protocols, /etc/rpc, and /etc/inetd.conf
+ ~/etc/services~, ~/etc/protocols~, ~/etc/rpc~, and ~/etc/inetd.conf~
+ updated section about `Configuration files':
packages may not touch other packages' configuration files
@@ -904,7 +904,7 @@ Released July 1997.
where <arch> is one of the following:
i386, alpha, arm, m68k, powerpc, sparc.
-+ detailed rules for /usr/local
++ detailed rules for ~/usr/local~
+ user ID's
diff --git a/upgrading-checklist.txt b/upgrading-checklist.txt
index 618c706..6a586fc 100644
--- a/upgrading-checklist.txt
+++ b/upgrading-checklist.txt
@@ -2,7 +2,7 @@
============================================
Author: Bill Allombert, Josip Rodin, Julian Gilbey, Russ Allbery, and Manoj Srivastava <srivasta@debian.org>
-Date: 2010-01-25 21:41:31 CET
+Date: 2010-01-26 13:43:11 CET
About the checklist
@@ -42,7 +42,7 @@ Released Jan 2010.
`/usr/lib/triplet' directories.
+ *10.6* : Explicitly state that packages may not contain named pipes and
should instead create them in postinst and remove them in prerm or postrm.
-+ *9.1.1* : /sys and /selinux directories are explicitly allowed as an
++ *9.1.1* : `/sys' and `/selinux' directories are explicitly allowed as an
exception to the FHS.
3.8.3.0
@@ -56,7 +56,7 @@ Released Aug 2009.
combination with other architectures. Clarify when /all/ and /any/
may be used in different versions of the field.
+ *5.6.14* : The Debian archive software does not support uploading
- to multiple distributions with one \*.changes file.
+ to multiple distributions with one `*.changes' file.
+ *5.6.19* : The Binary field may span multiple lines.
+ *10.2* : Remove the permission for shared library packages to
install libraries in a non-standard location and modify ld.so.conf.
@@ -64,7 +64,7 @@ Released Aug 2009.
or packages using them should be built with RPATH.
+ *11.8.7* : Clarify installation directories for X programs and
remove the requirement to pre-depend on x11-common before installing
- into /usr/include/X11 and /usr/lib/X11.
+ into `/usr/include/X11' and `/usr/lib/X11'.
+ *12.1* : Remove the requirement that all characters in a manual
page be representable in the legacy encoding for that language.
+ *12.1* : Localized man pages should either be kept up-to-date with
@@ -94,9 +94,9 @@ Released Jun 2009.
+ *5.6.1*: The requirements for source package names are now explicitly
spelled out.
+ *9.1*: Legacy XFree86 servers no longer get a special exception from the
- FHS permitting /etc/X11/XF86Config-4.
+ FHS permitting `/etc/X11/XF86Config-4'.
+ *9.1.3*: Removed obsolete dependency requirements for packages that use
- /var/mail.
+ `/var/mail'.
+ *11.8.5*: Speedo fonts are now deprecated. The X backend was disabled
starting in lenny.
+ *12.5*: The GNU Free Documentation License version 1.3 is included in
@@ -118,18 +118,18 @@ Released Mar 2009.
+ *4.9.1*: New nocheck option for DEB\_BUILD\_OPTIONS indicating any build-time
test suite provided by the package should not be run.
+ *5.1*: All control files must be encoded in UTF-8.
-+ *5.2*: debian/control allows comment lines starting with # with no
++ *5.2*: `debian/control' allows comment lines starting with # with no
preceding whitespace.
+ *9.3*: Init scripts ending in .sh are not handled specially. They are not
- sourced and are not guaranteed to be run by /bin/sh regardless of
+ sourced and are not guaranteed to be run by `/bin/sh' regardless of
the #! line. This brings Policy in line with the long-standing
behavior of the init system in Debian.
+ *9.3.2*: The start action of an init script must exit successfully and not
start the daemon again if it's already running.
-+ *9.3.2*: /var/run and /var/lock may be mounted as temporary filesystems, and
- init scripts must therefore create any necessary subdirectories
++ *9.3.2*: `/var/run' and `/var/lock' may be mounted as temporary filesystems,
+ and init scripts must therefore create any necessary subdirectories
dynamically.
-+ *10.4*: /bin/sh scripts may assume that local can take multiple variable
++ *10.4*: `/bin/sh' scripts may assume that local can take multiple variable
arguments and supports assignment.
+ *11.6*: User mailboxes may be mode 600 and owned by the user rather than
mode 660, owned by user, and group mail.
@@ -157,12 +157,12 @@ Released Jun 2008.
used that way.
+ *4.14*: If dpkg-source -x doesn't produce source ready for editing and
building with dpkg-buildpackage, packages should include a
- debian/README.source file explaining how to generate the patched
+ `debian/README.source' file explaining how to generate the patched
source, add a new modification, and remove an existing
modification. This file may also be used to document packaging a
new upstream release and any other complexity of the Debian build
process.
-+ *5.6.3*: The Uploaders field in debian/control may be wrapped.
++ *5.6.3*: The Uploaders field in `debian/control' may be wrapped.
+ *5.6.12*: An empty Debian revision is equivalent to a Debian revision of 0 in
a version number.
+ *5.6.23*: New Homepage field for upstream web sites.
@@ -174,11 +174,11 @@ Released Jun 2008.
separate package, or into the -dev package. Suggest -tools instead
of -runtime for runtime support programs, since that naming is more
common in Debian.
-+ *9.5*: Files in /etc/cron.{hourly,daily,weekly,monthly} must be
++ *9.5*: Files in `/etc/cron.{hourly,daily,weekly,monthly}' must be
configuration files (upgraded from should). Mention the hourly
directory.
-+ *11.8.6*: Packages providing /etc/X11/Xresources files need not conflict with
- xbase (<< 3.3.2.3a-2), which is long-obsolete.
++ *11.8.6*: Packages providing `/etc/X11/Xresources' files need not conflict
+ with xbase (<< 3.3.2.3a-2), which is long-obsolete.
+ *12.1*: Manual pages in locale-specific directories should use either the
legacy encoding for that directory or UTF-8. Country names should
not be included in locale-specific manual page directories unless
@@ -187,7 +187,7 @@ Released Jun 2008.
legacy encoding for a locale even if the man page is encoded in
UTF-8.
+ *12.5*: The Apache 2.0 license is now in common-licenses and should be
- referenced rather than quoted in debian/copyright.
+ referenced rather than quoted in `debian/copyright'.
+ *12.5*: Packages in contrib and non-free should state in the copyright file
that the package is not part of Debian GNU/Linux and briefly
explain why.
@@ -200,7 +200,7 @@ Released Dec 2007.
+ *5.6.12*: Package version numbers may contain tildes, which sort before
anything, even the end of a part.
-+ *10.4*: Scripts may assume that /bin/sh supports local (at a basic level)
++ *10.4*: Scripts may assume that `/bin/sh' supports local (at a basic level)
and that its test builtin (if any) supports -a and -o binary
logical operators.
+ *8.5*: The substitution variable ${binary:Version} should be used in place
@@ -222,7 +222,7 @@ Released Dec 2007.
specification must allow for translation of their messages by using
a gettext-based system such as po-debconf.
+ *12.5*: GFDL 1.2, GPL 3, and LGPL 3 are now in common-licenses and should
- be referenced rather than quoted in debian/copyright.
+ be referenced rather than quoted in `debian/copyright'.
3.7.2.2
--------
@@ -252,7 +252,7 @@ Released Apr 2006.
consensus, and documenting it in README.Debian constitute most
of the process.
+ *11.8.7*: Packages should install any relevant files into the directories
- /usr/include/X11/and /usr/lib/X11/, but if they do so, they
+ `/usr/include/X11/' and `/usr/lib/X11/', but if they do so, they
must pre-depend on x11-common (>= 1:7.0.0)
3.7.0.0
@@ -261,13 +261,13 @@ Released Apr 2006.
Released Apr 2006.
+ *11.5*: Packages shipping web server CGI files are expected to install
- them in /usr/lib/cgi-lib/ directories. This location change
+ them in `/usr/lib/cgi-lib/' directories. This location change
perhaps should be documented in NEWS
+ *11.5*: Web server packages should include a standard scriptAlias of
- cgi-lib to /usr/lib/cgi-lib.
+ cgi-lib to `/usr/lib/cgi-lib'.
+ *9.1.1*: The version of FHS mandated by policy has been upped to
2.3. There should be no changes required for most packages,
- though new top level directories /media, /srv, etc may be of
+ though new top level directories `/media', `/srv', etc may be of
interest.
+ *5.1, 5.6.3*: All fields, apart from the Uploaders field, in the control file
are supposed to be a single logical line, which may be spread
@@ -282,9 +282,9 @@ Released Apr 2006.
+ *9.3.3.2*: packages that invoke initscripts now must use invoke-rc.d to do
so since it also pays attention to run levels and other local
constraints.
-+ *11.8.5.2, 11.8.7, etc*: We no longer use /usr/X11R6, since we have
++ *11.8.5.2, 11.8.7, etc*: We no longer use `/usr/X11R6', since we have
migrated away to using Xorg paths. This means, for one thing, fonts
- live in /usr/share/fonts/X11/ now, and /usr/X11R6 is gone.
+ live in `/usr/share/fonts/X11/' now, and `/usr/X11R6' is gone.
3.6.2.0
@@ -294,9 +294,9 @@ Released 2005
+ Recommend. doc-base, and not menu, for registering package documentation.
+ *8.1*: Run time support programs should live in subdirectories of
- /usr/lib/ or /usr/share, and preferably the shared lib is named
+ `/usr/lib/' or `/usr/share', and preferably the shared lib is named
the same as the package name (to avoid name collisions).
-+ *11.5*: It is recommended that HTTP servers provide an alias /images to
++ *11.5*: It is recommended that HTTP servers provide an alias `/images' to
allow packages to share image files with the web server
3.6.1.0
@@ -398,7 +398,7 @@ Released Aug 2002.
special Tasks: field in the control file.
+ *11.8.4*: window managers that support netwm can now add 20 points when
they add themselves as an alternative for
- /usr/bin/x-window-manager
+ `/usr/bin/x-window-manager'
+ *10.1*: The default compilation options have now changed, one should
provide debugging symbols in all cases, and optionally step
back optimization to -O0, depending on the DEB\_BUILD\_OPTIONS
@@ -419,12 +419,12 @@ Released Jul 2001.
+ *2.5*: Emacs and TeX are no longer mandated by policy to be priority
standard packages
-+ *11.5*: Programs that access docs need to do so via /usr/share/doc, and
- not via /usr/doc/ as was the policy previously
-+ *12.3*: Putting documentation in /usr/doc versus /usr/share/doc is now
++ *11.5*: Programs that access docs need to do so via `/usr/share/doc', and
+ not via `/usr/doc/' as was the policy previously
++ *12.3*: Putting documentation in `/usr/doc' versus `/usr/share/doc' is now
a ``serious'' policy violation.
+ *11.5*: For web servers, one should not provide non-local access to the
- /usr/share/doc hierarchy. If one can't provide access controls for
+ `/usr/share/doc' hierarchy. If one can't provide access controls for
the [http://localhost/doc/] directory, then it is preferred that one
ask permission to expose that information during the install.
+ *7*: There are new rules for build-indep/build-arch targets and
@@ -453,7 +453,7 @@ Released May 2001.
* *11.8.3*: Rules for defining x-terminal-emulator improved
* *11.8.5*: X Font policy rewritten: you must read this if you provide
fonts for the X Window System
- * *11.8.6*: Packages must not ship /usr/X11R6/lib/X11/app-defaults/
+ * *11.8.6*: Packages must not ship `/usr/X11R6/lib/X11/app-defaults/'
* *11.8.7*: X-related packages should usually use the regular FHS
locations; imake-using packages are exempted from this
* *11.8.8*: OpenMotif linked binaries have the same rules as
@@ -464,9 +464,9 @@ Released May 2001.
Released Apr 2001.
-+ *11.6*: The system-wide mail directory is now /var/mail, no longer
- /var/spool/mail. Any packages accessing the mail spool should
- access it via /var/mail and include a suitable Depends field;
++ *11.6*: The system-wide mail directory is now `/var/mail', no longer
+ `/var/spool/mail'. Any packages accessing the mail spool should
+ access it via `/var/mail' and include a suitable Depends field;
details in
+ *11.9; perl-policy*: The perl policy is now part of Debian policy
proper. Perl programs and modules should follow the current Perl
@@ -481,8 +481,8 @@ Released Apr 2001.
+ *7.1*: Build-Depends arch syntax has been changed to be less
ambiguous. This should not affect any current packages
+ *10.7.3*: Examples and templates files for use by scripts should now live
- in /usr/share/<package> or /usr/lib/<package>, with
- symbolic links from /usr/share/doc/<package>/examples as
+ in `/usr/share/<package>' or `/usr/lib/<package>', with
+ symbolic links from `/usr/share/doc/<package>/examples' as
needed
3.5.2.0
@@ -491,7 +491,7 @@ Released Apr 2001.
Released Feb 2001.
+ *11.8.6*: X app-defaults directory has moved from
- /usr/X11R6/lib/X11/app-defaults to /etc/X11/app-defaults
+ `/usr/X11R6/lib/X11/app-defaults' to `/etc/X11/app-defaults'
3.5.1.0
--------
@@ -514,13 +514,13 @@ Released Jan 2001.
Released Jan 2001.
-+ *9.3.2*: Daemon startup scripts in /etc/init.d/ should not contain
++ *9.3.2*: Daemon startup scripts in `/etc/init.d/' should not contain
modifiable parameters; these should be moved to a file in
- /etc/default/
-+ *12.3*: Files in /usr/share/doc must not be referenced by any
+ `/etc/default/'
++ *12.3*: Files in `/usr/share/doc' must not be referenced by any
program. If such files are needed, they must be placed in
- /usr/share/<package>/, and symbolic links created as required
- in /usr/share/doc/<package>/
+ `/usr/share/<package>/', and symbolic links created as required
+ in `/usr/share/doc/<package>/'
+ Much of the packaging manual has now been imported into the
policy document
@@ -551,7 +551,7 @@ Released Aug 00.
- *11.8.2*: X server (virtual package xserver)
- *11.8.3*: X terminal emulator (virtual package x-terminal-emulator)
- *11.8.4*: X window manager (virtual package x-window-manager, and
- /usr/bin/x-window-manager alternative, with priority
+ `/usr/bin/x-window-manager' alternative, with priority
calculation guidelines)
- *12.8.5*: X fonts (this section has been written from scratch)
- *11.8.6*: X application defaults
@@ -575,23 +575,23 @@ Released Nov 1999.
Released Oct 1999.
-+ /usr/doc/<package> has to be a symlink pointing to
- /usr/share/doc/<package>, to be maintained by postinst
++ `/usr/doc/<package>' has to be a symlink pointing to
+ `/usr/share/doc/<package>', to be maintained by postinst
and prerm scripts. Details are in *defunct*
+ *7.1, 7.6*: Introduced source dependencies (Build-Depends, etc.)
-+ *9.3.4*: /etc/rc.boot has been deprecated in favour of /etc/rcS.d.
++ *9.3.4*: `/etc/rc.boot' has been deprecated in favour of `/etc/rcS.d'.
(Packages should not be touching this directory, but should use
update-rc.d instead)
+ *9.3.3*: update-rc.d is now the *only* allowable way of accessing the
- /etc/rc?.d/[SK]??* links. Any scripts which manipulate them
+ `/etc/rc?.d/[SK]??*' links. Any scripts which manipulate them
directly must be changed to use update-rc.d instead. (This is
because the file-rc package handles this information in an
incompatible way.)
-+ *12.7*: Architecture-specific examples go in /usr/lib/<package>/examples
- with symlinks from /usr/share/doc/<package>/examples/* or from
- /usr/share/doc/<package>/examples itself
-+ *9.1.1*: Updated FHS to a 2.1 draft; this reverts /var/state to
- /var/lib
++ *12.7*: Architecture-specific examples go in `/usr/lib/<package>/examples'
+ with symlinks from `/usr/share/doc/<package>/examples/*' or from
+ `/usr/share/doc/<package>/examples' itself
++ *9.1.1*: Updated FHS to a 2.1 draft; this reverts `/var/state' to
+ `/var/lib'
+ *9.7; mime-policy*: Added MIME sub-policy document
+ *12.4*: VISUAL is allowed as a (higher priority) alternative to EDITOR
+ *11.6*: Modified liblockfile description, which affects
@@ -623,7 +623,7 @@ Released Jun 1999.
+ *4.1*: Only 3 digits of the Standards version need be included in
control files, though all four digits are still permitted.
+ *12.6*: The location of the GPL has changed to
- /usr/share/common-licenses. This may require changing the
+ `/usr/share/common-licenses'. This may require changing the
copyright files to point to the correct location of the GPL and
other major licenses
+ *10.2*: Packages that use libtool to create shared libraries must
@@ -633,8 +633,8 @@ Released Jun 1999.
System)
+ *9.6; menu-policy*: There is now an associated menu policy, in a separate document,
that carries the full weight of Debian policy
-+ *11.3*: Programs which need to modify the files /var/run/utmp,
- /var/log/wtmp and /var/log/lastlog must be installed setgid utmp
++ *11.3*: Programs which need to modify the files `/var/run/utmp',
+ `/var/log/wtmp' and `/var/log/lastlog' must be installed setgid utmp
*Please note that section numbers below this point may not be up to date*
@@ -657,15 +657,15 @@ Policy Manual:
Section 5 after 5.5 were moved down to fill in the number
gap.
+ Modified the section about changelog files to accommodate
- upstream changelogs which were formatted as HTML/ These
+ upstream changelogs which were formatted as HTML. These
upstream changelog files should now be accessible as
- /usr/doc/package/changelog.html.gz
+ `/usr/doc/package/changelog.html.gz'
+ Symlinks are permissible to link the real, or upstream,
changelog name to the Debian mandated name.
+ Clarified that HTML documentation should be present in some
package, though not necessarily the main binary package.
+ Corrected all references to the location of the copyright
- files. The correct location is /usr/doc/package/copyright
+ files. The correct location is `/usr/doc/package/copyright'
+ Ratified the architecture specification strings to cater to the
HURD.
@@ -681,7 +681,7 @@ Released Apr 1998.
(cf., Policy Weekly Issue#6, topic 2)
+ Updated section 4.9 Games:
- + manpages for games should be installed in /usr/man/man6
+ + manpages for games should be installed in `/usr/man/man6'
(cf., Policy Weekly Issue#6, topic 3)
* Packaging Manual:
@@ -697,11 +697,11 @@ Released Apr 1998.
Released Jan 1998
+ Updated section 3.3.4 Scripts:
- + /bin/sh may be any POSIX compatible shell
- + scripts including bashisms have to specify /bin/bash as
+ + `/bin/sh' may be any POSIX compatible shell
+ + scripts including bashisms have to specify `/bin/bash' as
interpreter
+ scripts which create files in world-writable directories
- (e.g., in /tmp) should use tempfile or mktemp for creating
+ (e.g., in `/tmp') should use tempfile or mktemp for creating
the directory
+ Updated section 3.3.5 Symbolic Links:
@@ -709,17 +709,17 @@ Released Jan 1998
file extension as the referenced file
+ Updated section 3.3.6 Device files:
- + /dev/tty* serial devices should be used instead of /dev/cu*
+ + `/dev/tty*' serial devices should be used instead of `/dev/cu*'
-+ Updated section 3.4.2 Writing the scripts in /etc/init.d:
- + all /etc/init.d scripts have to provide the following options:
++ Updated section 3.4.2 Writing the scripts in `/etc/init.d':
+ + all `/etc/init.d' scripts have to provide the following options:
start, stop, restart, force-reload
+ the reload option is optional and must never stop and restart
the service
+ Updated section 3.5 Cron jobs:
+ cron jobs that need to be executed more often than daily should
- be installed into /etc/cron.d
+ be installed into `/etc/cron.d'
+ Updated section 3.7 Menus:
+ removed section about how to register HTML docs to `menu'
@@ -736,7 +736,7 @@ Released Jan 1998
reasonable default configuration
+ New section 4.6 News system configuration:
- + /etc/news/organization and /etc/news/server should be supported
+ + `/etc/news/organization' and `/etc/news/server' should be supported
by all news servers and clients
+ Updated section 4.7 Programs for the X Window System:
@@ -746,7 +746,7 @@ Released Jan 1998
against lesstif and not against a non-free Motif library
+ Updated section 4.9 Games:
- + games for X Windows have to be installed in /usr/games, just as
+ + games for X Windows have to be installed in `/usr/games', just as
non-X games
2.3.0.1, 2.3.0.0
@@ -755,7 +755,7 @@ Released Jan 1998
Released Sep 1997.
+ new section `4.2 Daemons' including rules for
- /etc/services, /etc/protocols, /etc/rpc, and /etc/inetd.conf
+ `/etc/services', `/etc/protocols', `/etc/rpc', and `/etc/inetd.conf'
+ updated section about `Configuration files':
packages may not touch other packages' configuration files
@@ -773,7 +773,7 @@ Released July 1997.
where <arch> is one of the following:
i386, alpha, arm, m68k, powerpc, sparc.
-+ detailed rules for /usr/local
++ detailed rules for `/usr/local'
+ user ID's