Browse Source

doc, man: Remove Debian specific policy references

Debian, although a primary one, is just one of the many "downstreams",
and dpkg should document everything it implements, so adding references
to the Debian policy makes it more confusing for people that use dpkg
in non-Debian systems.
Guillem Jover 9 years ago
parent
commit
a52e0f2202

+ 1 - 0
debian/changelog

@@ -7,6 +7,7 @@ dpkg (1.18.5) UNRELEASED; urgency=medium
     - Document missing Install-Size, Built-For-Profiles and Build-Profiles
       fields in man pages.
     - Add new dsc(5), deb-changelog(5) and deb-changes(5) man pages.
+    - Remove Debian specific policy references.
 
  -- Guillem Jover <guillem@debian.org>  Fri, 25 Dec 2015 14:20:16 +0100
 

+ 3 - 3
doc/triggers.txt

@@ -247,7 +247,7 @@ packages' names change.
 Explicit trigger names form part of the interface between packages.
 Therefore in case of wider use of any trigger the name and purpose
 should be discussed in the usual way and documented in the appropriate
-packaging guidelines (eg, in policy).
+packaging guidelines (eg, in the distribution policy).
 
 
 File triggers
@@ -261,8 +261,8 @@ dpkg during package unpack or removal.  The pathname must be absolute.
 
 File triggers should not generally be used without mutual consent.
 The use of a file trigger, and the name of the trigger used, should be
-stated in policy, so that a package which creates a relevant file in a
-maintainer script can activate the trigger explicitly.
+stated in the distribution policy, so that a package which creates a
+relevant file in a maintainer script can activate the trigger explicitly.
 
 File triggers must definitely not be used as an escalation tool in
 disagreements between different packages as to the desired contents of

+ 3 - 5
man/deb-control.5

@@ -80,14 +80,12 @@ Sets the importance of this package in relation to the system as a whole.
 Common priorities are \fBrequired\fP, \fBstandard\fP, \fBoptional\fP,
 \fBextra\fP, etc.
 .LP
-In Debian, the
+The
 .B Section
 and
 .B Priority
-fields have a defined set of accepted values based on the Policy Manual.
-A list of these values can be obtained from the latest version of the
-.B debian\-policy
-package.
+fields usually have a defined set of accepted values based on the specific
+distribution policy.
 .
 .TP
 .BR Installed\-Size: " size"

+ 2 - 3
man/deb-override.5

@@ -48,7 +48,7 @@ not found in the tree of binary packages are ignored.
 and
 .I section
 correspond to the respective control fields available in the .deb. The
-allowed values are listed in the Debian policy.
+allowed values are specific to each distribution archive.
 .PP
 .IR maintainerinfo ,
 if present, can be either the name of a maintainer for an unconditional
@@ -68,5 +68,4 @@ directory on any Debian mirror.
 .nh
 .BR dpkg\-scanpackages (1),
 .BR dpkg\-scansources (1),
-.BR apt\-ftparchive (1),
-.BR /usr/share/doc/debian\-policy/policy.html/index.html .
+.BR apt\-ftparchive (1).

+ 1 - 2
man/deb-shlibs.5

@@ -41,7 +41,6 @@ but the \fIdependencies\fP field extends to the end of the line.  The
 .PP
 The \fIdependencies\fP field has the same syntax as the \fBDepends\fP
 field in a binary control file, see \fBdeb\-control\fP(5).
-See also the Debian Policy Manual for further details.
 .
 .SH EXAMPLES
 .PP
@@ -61,7 +60,7 @@ symbols to the library: in the above example, new symbols were added to
 version 1.2 of
 .IR libcrunch .
 This is not the only reason the dependencies might need to be
-tightened; again, see the Debian Policy Manual for details.
+tightened.
 .
 .SH SEE ALSO
 .BR deb\-control (5),

+ 6 - 12
man/deb-src-control.5

@@ -67,10 +67,8 @@ separated by a comma.
 
 .TP
 .BI Standards\-Version: " version-string"
-This documents the most recent version of the standards (which consists of the
-Debian Policy Manual and referenced texts from the
-.B debian\-policy
-package) this package complies to.
+This documents the most recent version of the distribution policy standards
+this package complies with.
 
 .TP
 .BI Homepage: " url"
@@ -127,14 +125,12 @@ Sets the importance of this package in relation to the system as a whole.
 Common priorities are \fBrequired\fP, \fBstandard\fP, \fBoptional\fP,
 \fBextra\fP, etc.
 
-In Debian, the
+The
 .B Section
 and
 .B Priority
-fields have a defined set of accepted values based on the Policy Manual.
-A list of these values can be obtained from the latest version of the
-.B debian\-policy
-package.
+fields usually have a defined set of accepted values based on the specific
+distribution policy.
 
 .TP
 .BI Build\-Depends: " package-list"
@@ -348,9 +344,7 @@ package.
 These fields declare relationships between packages. They are discussed in
 the
 .BR deb\-control (5)
-manpage and in the
-.B debian\-policy
-package.
+manpage.
 
 .SH USER-DEFINED FIELDS
 It is allowed to add additional user-defined fields to the control file. The

+ 3 - 2
man/dpkg-buildpackage.1

@@ -123,8 +123,9 @@ This is the same as the default case when no build option is specified.
 Calls \fBdebian/rules\fP \fItarget\fP after having setup the build
 environment and stops the package build process here (since dpkg 1.15.0).
 If \fB\-\-as\-root\fP is also given, then the command is executed
-as root (see \fB\-r\fP). Note that official targets that are required to
-be run as root by the Debian policy do not need this option.
+as root (see \fB\-r\fP). Note that known targets that are required to
+be run as root do not need this option (i.e. the \fBclean\fP, \fBbinary\fP,
+\fBbinary\-arch\fP and \fBbinary\-indep\fP targets).
 .TP
 .B \-\-as\-root
 Only meaningful together with \fB\-\-target\fP (since dpkg 1.15.0).

+ 2 - 4
man/dselect.1

@@ -239,10 +239,8 @@ at easing package management and administration, it is only instrumental
 in doing so and can not be assumed to be a sufficient substitute for
 administrator skill and understanding. The user is required to
 be familiar with the concepts underlying the Debian packaging system.
-In case of doubt, consult the \fBdpkg\fP(1) manpage and the Debian
-Policy manual, contained in the
-.B debian\-policy
-package.
+In case of doubt, consult the \fBdpkg\fP(1) manpage and the distribution
+policy.
 .sp
 Unless \fBdselect\fP is run in expert
 or immediate mode, a help screen is first displayed when choosing this

+ 2 - 6
scripts/Dpkg/Changelog/Debian.pm

@@ -24,9 +24,8 @@ Dpkg::Changelog::Debian - parse Debian changelogs
 
 =head1 DESCRIPTION
 
-Dpkg::Changelog::Debian parses Debian changelogs as described in the Debian
-policy (version 3.6.2.1 at the time of this writing). See section
-L<"SEE ALSO"> for locations where to find this definition.
+Dpkg::Changelog::Debian parses Debian changelogs as described in
+deb-changelog(5).
 
 The parser tries to ignore most cruft like # or /* */ style comments,
 CVS comments, vim variables, emacs local variables and stuff from
@@ -250,9 +249,6 @@ __END__
 
 Dpkg::Changelog
 
-Description of the Debian changelog format in the Debian policy:
-L<https://www.debian.org/doc/debian-policy/ch-source.html#s-dpkgchangelog>.
-
 =head1 CHANGES
 
 =head2 Version 1.00 (dpkg 1.15.6)