Guillem Jover [Thu, 14 Feb 2013 18:09:11 +0000 (19:09 +0100)]
Switch appendix section for dpkg-buildpackage into a stub
The section only documents things already present in the man page,
and in cases the documentation is outdated. Just turn it into a stub
pointing to the man page, to avoid renumbering issues.
Charles Plessy [Thu, 1 Mar 2012 13:58:41 +0000 (22:58 +0900)]
Rely on triggers instead of calling update-mime
Closes: 661816
This patch also:
- Removes mention of the MIME policy. This is a leftover from its removal.
- Documents /usr/lib/mime/packages/, and recommends to use binary package
names as a file names.
- Cosmetically changes the emphasis on a "should not".
Move alternative init systems to avoid renumbering
While keeping all the init-related material together would be nice,
it causes section renumbering, which causes other problems. Move it
to the bottom of that chapter. We'll fix this when we rewrite all of
Policy and reorder everything.
Steve Langasek [Mon, 10 Jan 2011 01:58:58 +0000 (19:58 -0600)]
Document generic and upstart-specific init-system requirements
Add a new section on alternative init systems that outlines the
compatibility requirements for both init replacements and packages shipping
upstart jobs. Closes: #591791
Jonathan Nieder [Sun, 12 Aug 2012 23:30:54 +0000 (16:30 -0700)]
symbols/shlibs policy: cosmetic fixes
Use "zlib1g (>= 1:1.2.3.3.dfsg-2~)" in the sample shlibs dependency
field to emphasize the backport-friendly convention described in the
sharedlibs-updates section.
Also correct two small typos --- one sentence is uncapitalized and
another missing a noun --- and rephrase a sentence that describes when
to bump the dependency-version to make it easier to read.
Jonathan Nieder [Sun, 12 Aug 2012 20:43:50 +0000 (13:43 -0700)]
Clarifications to symbols and shlibs policy
subject/verb agreement: s/provide/provides/
Packages with libraries or binaries linking to a shared library must
use symbols or shlibs files to compute their dependencies. Packages
that dlopen() a shared library should do so as well, but since that
is not typical practice and the tools to do that don't exist, it is
not made a policy "must" yet.
The minimal version for a symbol can be bumped after the version of
the package in which the symbol was introduced.
Add a footnote explaining why shlibs files cannot be used for
libraries with unusual sonames.
The shlibs file for a library udeb goes in the corresponding deb.
The library deb corresponding to a udeb is supposed to provide a
shlibs file, rather than consuming (using) one.
Add "for example" when talking about dpkg-shlibdeps -T. This is
just an illustration and not meant to be normative.
If a library is used both directly and indirectly, the direct
dependency still needs to be declared.
Backward-compatibility is defined in terms of what reasonable
programs and libraries need.
In the normal case, symbols files go in dpkg's admindir as package
control files.
wording fix: "dependency on" avoids some of the ambiguity in
"dependency of".
Russ Allbery [Sun, 12 Aug 2012 20:14:55 +0000 (13:14 -0700)]
Make build-arch and build-indep required targets
Implement the Debian Technical Committee decision in #629385.
Remove the normative documentation of what to do when the targets
aren't provided. Remove the informative footnote saying that
the build daemons don't support this.
Charles Plessy [Sat, 7 Jan 2012 06:00:30 +0000 (15:00 +0900)]
Document VCS fields
Uses Developers's Reference §6.2.5 for inspiration.
Closes: #654958
[jrnieder@gmail.com:
- declared repositories should be publicly accessible
- Vcs-Browser should point to a webapp
- Vcs-<system> should use the version control system's conventional syntax
- if multiple branches are used for packaging (e.g., "stable",
"testing", "sid"), any one of them will do
- for Vcs-Git, "-b <branch>" can be omitted when the intended branch is the
default branch
- list some Vcs-<foo> fields by name in the lists in §5.2 and §5.4
- declared repositories track development of the Debian source
package, not just the upstream code
- Vcs-Browser can be a web interface using any protocol (e.g., HTTPS
is fine)
- picking a good branch is optional
Thanks to Russ Allbery for several improvements to the text.]
Russ Allbery [Sat, 17 Mar 2012 18:04:14 +0000 (11:04 -0700)]
Further symbols wording fixes from Charles Plessy
Retain the dpkg-shlibdeps section in the appendix as a stub pointing
to the main page so that we don't renumber subsequent sections. Add
more explanation for why dependencies change for each build of a
binary package. Combine the dpkg-shlibdeps instructions somewhat and
mention that debian/substvars is only a default.
Russ Allbery [Sat, 17 Mar 2012 17:41:41 +0000 (10:41 -0700)]
Substantial revision to the new symbols draft
Pull out lots of information that's shared between symbols and shlibs
into new sections directly under shared library dependencies. Make
both symbols and shlibs subsections of that section. Flesh out the
documentation of how to choose between symbols and shlibs and what the
differences in the systems are.
Document that C++ libraries may be better off with shlibs and don't
deprecate shlibs quite as much.
Move the information on how to determine the shared library soversion
to the runtime shared library section where it's now primarily used,
and reference it in the shlibs section.
Russ Allbery [Sat, 3 Mar 2012 03:21:09 +0000 (19:21 -0800)]
Convert debian/copyright to copyright-format 1.0
* Convert debian/copyright to copyright-format 1.0, and in the process
add the license information for the documents other than Policy itself
and the FHS. Note the implication of the GPL source code requirement
for distributing generated versions of the Policy documents.
Russ Allbery [Sat, 3 Mar 2012 02:41:34 +0000 (18:41 -0800)]
Add Policy version to DocBook subdocuments, fix whitespace
* Embed the Debian Policy version and build date in the debconf
specification and the copyright-format document. We'll make
non-normative changes without updating other version numbers, and it's
good to know which version one is looking at.
* Fix some whitespace issues in the debconf specification articleinfo.
Russ Allbery [Mon, 27 Feb 2012 05:02:00 +0000 (21:02 -0800)]
Update dpkg-buildpackage documentation to mention fakeroot
* Update the dpkg-buildpackage -r documentation in the appendix to
reflect the current behavior of using fakeroot. Wording from Sam
Morris. (Closes: #658009)
Russ Allbery [Mon, 27 Feb 2012 04:34:04 +0000 (20:34 -0800)]
Clarify dependency relationships between build, build-{arch,indep}
* Clarify that only one of build-arch or build-indep may be provided
(currently, at least) and that build should depend on whichever exist
or perform the equivalent actions. Thanks to Jonathan Nieder for some
of the wording. (Closes: #601839)
Russ Allbery [Mon, 27 Feb 2012 03:47:49 +0000 (19:47 -0800)]
Suggest checkbashisms or posh rather than dash to check scripts
* Suggest checkbashisms from devscripts or the posh shell for checking
whether /bin/sh scripts are Policy-compliant rather than recommending
dash. Thanks, Raphael Geissert. (Closes: #490604)
Russ Allbery [Mon, 27 Feb 2012 03:25:36 +0000 (19:25 -0800)]
Additional wording clarifications to copyright-format 1.0
* Additional wording improvements to copyright-format 1.0 for clarity.
Also mention that the Files pattern syntax is the same as fnmatch(3)
and GNU find -path without [] patterns. Thanks, Jonathan Nieder and
Ben Finney.
Russ Allbery [Mon, 27 Feb 2012 00:53:23 +0000 (16:53 -0800)]
Install copyright-format source without a version
* Ship the copyright-format source as copyright-format.xml.tar.gz
without a version, since it will include all of the versions, not just
the current version.
Russ Allbery [Mon, 27 Feb 2012 00:29:38 +0000 (16:29 -0800)]
Install HTML upgrading-checklist in policy.html directory
* Install the HTML version of upgrading-checklist in the policy.html
directory as upgrading-checklist.html so that it can be deployed on
www.debian.org in a way that will allow links to Policy sections to
work easily. Thanks, Charles Plessy. (Closes: #639663)
For right now, this is done with a bit of a hack to copy the file into
the appropriate directory and to turn the one-page HTML version of it
into a symlink inside the constructed package.
The clean solution will be to make the upgrading checklist an appendix
of Policy, which may be done as part of a DocBook conversion.
Russ Allbery [Sun, 26 Feb 2012 23:50:59 +0000 (15:50 -0800)]
General cleanup of debian/rules
* Strip down and reformat debian/rules to remove unused variables,
references to old files no longer included, use a more standard
layout and standardize variable names, and add comments for better
maintainability.
Russ Allbery [Tue, 21 Feb 2012 20:36:00 +0000 (12:36 -0800)]
General editing pass for the copyright format specification
Add a pointer to DEP-5 in the synopsis and change the verb tense
to present from imperative. Rephrase the introduction to talk about
this document as a specification rather than a proposal.
Explicitly mention Files: * as the way to write a single files
paragraph that covers the entire package.
Mention after one of the examples that the two paragraphs for files
with the same license but different copyright holders could be combined
at the discretion of the document author.
Give the complete correct Format field for the current version of the
document in the description of that field.
Add more explanation for how Disclaimer is used.
Say explicitly that more general files paragraphs should be given
first, followed by more specific overrides.
Update the license list to note that "Universal" is removed from the
version of CC0 when forming the short name, to list the new versions
of the GFDL, and to be more explicit about when to use GFDL-NIV.
Rewording and rephrasing in various places to hopefully make the
text flow better, read more smoothly, and be more idiomatic.
Add multiple additional in-line examples, particularly around the
Files patterns and the formation of license short names.
Charles Plessy [Tue, 21 Feb 2012 18:19:05 +0000 (10:19 -0800)]
DEP-5 updates from further debian-project discussion
Clarify that this document does not supersede or modify the
requirements in Policy and that use of the specification is
optional. Note that a single Files paragraph can apply to the
whole package (rather than using the "all files" wording) and
that only the license and copyright information required by
the Debian archive has to be listed.
Clarify the wording of stand-alone license paragraphs to be
clear that they can be used with exceptions.
Some wording improvements, including making the attributes
listed after the fields lowercase. Fix a few links and the
official keyword of the BSD-3-clause license in some examples.
Russ Allbery [Tue, 21 Feb 2012 18:01:04 +0000 (10:01 -0800)]
Update copyright-format to match the current DEP-5 website text
This addresses multiple issues, clarifications, and reformatting
done as part of the DEP process after the initial import of the
document into the Debian Policy repository.
projects / debian / debian-policy.git / log