Browse Source

dpkg-maintscript-helper(1): Refactor common parameters into a new section

Guillem Jover 12 years ago
parent
commit
c7f71379d3
1 changed files with 30 additions and 37 deletions
  1. 30 37
      man/dpkg-maintscript-helper.1

+ 30 - 37
man/dpkg-maintscript-helper.1

@@ -42,6 +42,36 @@ program will automatically adapt its behaviour based on the environment
 variable \fBDPKG_MAINTSCRIPT_NAME\fP and on the maintainer scripts arguments
 variable \fBDPKG_MAINTSCRIPT_NAME\fP and on the maintainer scripts arguments
 that you have to forward after a double hyphen.
 that you have to forward after a double hyphen.
 .
 .
+.SH COMMON PARAMETERS
+.TP
+.I prior-version
+Defines the latest version of the package whose upgrade should trigger the
+operation. It is important to calculate \fIprior-version\fP correctly so
+that the operations are correctly performed even if the user rebuilt the
+package with a local version. If \fIprior-version\fP is empty or omitted,
+then the operation is tried on every upgrade (note: it's safer to give
+the version and have the operation tried only once).
+
+For example, for a conffile removed in version \fB2.0\-1\fP of a package,
+\fIprior-version\fP should be set to \fB2.0\-1~\fP. This will cause the
+conffile to be removed even if the user rebuilt the previous version
+\fB1.0\-1\fP as \fB1.0\-1local1\fP.
+
+If the conffile has not been shipped for several versions, and you are
+now modifying the maintainer scripts to clean up the obsolete file,
+\fIprior-version\fP should be based on the version of the package that
+you are now preparing, not the first version of the package that lacked
+the conffile.
+.TP
+.I package
+The package name. When the package is "Multi-Arch: same", this parameter
+must include the architecture qualifier. If empty or omitted, the
+\fBDPKG_MAINTSCRIPT_PACKAGE\fP environment variable (as set by \fBdpkg\fP)
+will be used.
+.TP
+.B \-\-
+All the parameters of the maintainer scripts have to be forwarded to the
+program after \fB\-\-\fP.
 .SH CONFFILE RELATED TASKS
 .SH CONFFILE RELATED TASKS
 .P
 .P
 When upgrading a package, \fBdpkg\fP will not automatically remove a conffile
 When upgrading a package, \fBdpkg\fP will not automatically remove a conffile
@@ -73,29 +103,6 @@ All of this is implemented by putting the following shell snippet in the
 .P
 .P
 \fIconffile\fP is the filename of the conffile to remove.
 \fIconffile\fP is the filename of the conffile to remove.
 .P
 .P
-\fIprior-version\fP defines the latest version of the package whose
-upgrade should trigger the removal. It is important to calculate
-\fIprior-version\fP correctly so that conffiles are correctly removed even
-if the user rebuilt the package with a local version. For example, for a
-conffile removed in version \fB2.0\-1\fP of a package, \fIprior-version\fP
-should be set to \fB2.0\-1~\fP. This will cause the conffile to be removed
-even if the user rebuilt the previous version \fB1.0\-1\fP as
-\fB1.0\-1local1\fP.
-.P
-If the conffile has not been shipped for several versions, and you are now
-modifying the maintainer scripts to clean up the obsolete file,
-\fIprior-version\fP should be based on the version of the package that you are
-now preparing, not the first version of the package that lacked the
-conffile.
-.P
-\fIpackage\fP is the package name. When the package is "Multi-Arch: same",
-this parameter must include the architecture qualifier. If empty or
-omitted, the \fBDPKG_MAINTSCRIPT_PACKAGE\fP environment variable (as set
-by \fBdpkg\fP) will be used.
-.P
-All the parameters of the maintainer scripts have to be forwarded to the
-program after \fB\-\-\fP.
-.P
 Current implementation: in the \fBpreinst\fP, it checks if the conffile
 Current implementation: in the \fBpreinst\fP, it checks if the conffile
 was modified and renames it either to \fIconffile\fP\fB.dpkg\-remove\fP (if not
 was modified and renames it either to \fIconffile\fP\fB.dpkg\-remove\fP (if not
 modified) or to \fIconffile\fP\fB.dpkg\-backup\fP (if modified). In the
 modified) or to \fIconffile\fP\fB.dpkg\-backup\fP (if modified). In the
@@ -123,20 +130,6 @@ scripts:
 \fIold-conffile\fP and \fInew-conffile\fP are the old and new name of the
 \fIold-conffile\fP and \fInew-conffile\fP are the old and new name of the
 conffile to rename.
 conffile to rename.
 .P
 .P
-\fIprior-version\fP defines the latest version of the package whose upgrade
-should trigger the rename of the conffile (see the notes for
-\fBrm_conffile\fR above concerning the correct value). If \fIprior-version\fP
-is empty or omitted, then the operation is tried on every upgrade (note: it's
-safer to give the version and have the operation tried only once).
-.P
-\fIpackage\fP is the package name. When the package is "Multi-Arch: same",
-this parameter must include the architecture qualifier. If empty or
-omitted, the \fBDPKG_MAINTSCRIPT_PACKAGE\fP environment variable (as set
-by \fBdpkg\fP) will be used.
-.P
-All the parameters of the maintainer scripts have to be forwarded to the
-program after \fB\-\-\fP.
-.P
 Current implementation: the \fBpreinst\fP checks if the conffile has been
 Current implementation: the \fBpreinst\fP checks if the conffile has been
 modified, if yes it's left on place otherwise it's renamed to
 modified, if yes it's left on place otherwise it's renamed to
 \fIold-conffile\fP\fB.dpkg\-remove\fP. On configuration, the \fBpostinst\fP
 \fIold-conffile\fP\fB.dpkg\-remove\fP. On configuration, the \fBpostinst\fP