Forráskód Böngészése

man: Place ENVIRONMENT and FILES sections contiguously

Guillem Jover 13 éve
szülő
commit
b07036b2b0
5 módosított fájl, 124 hozzáadás és 122 törlés
  1. 1 0
      debian/changelog
  2. 15 15
      man/dpkg-architecture.1
  3. 46 45
      man/dpkg-buildflags.1
  4. 20 20
      man/dpkg-divert.8
  5. 42 42
      man/dpkg.1

+ 1 - 0
debian/changelog

@@ -14,6 +14,7 @@ dpkg (1.17.0) UNRELEASED; urgency=low
     - Move dangers of installing via dpkg-deb from BUGS to a NOTES section.
     - Move dangers of installing via dpkg-deb from BUGS to a NOTES section.
     - Remove BUGS sections containing obvious or misplaced information.
     - Remove BUGS sections containing obvious or misplaced information.
     - Move BUGS sections before EXAMPLES and SEE ALSO sections.
     - Move BUGS sections before EXAMPLES and SEE ALSO sections.
+    - Place ENVIRONMENT and FILES sections contiguously.
   * Use colon instead of dot for user:group in dpkg debug output.
   * Use colon instead of dot for user:group in dpkg debug output.
   * Remove support for obsolete DM-Upload-Allowed from Dpkg::Vendor::Debian.
   * Remove support for obsolete DM-Upload-Allowed from Dpkg::Vendor::Debian.
   * Fix update-alternatives to use the current alternative link as the first
   * Fix update-alternatives to use the current alternative link as the first

+ 15 - 15
man/dpkg-architecture.1

@@ -157,6 +157,21 @@ The \s-1GNU\s0 system type of the host machine.
 The clarified \s-1GNU\s0 system type of the host machine, used for filesystem
 The clarified \s-1GNU\s0 system type of the host machine, used for filesystem
 paths.
 paths.
 .
 .
+.SH FILES
+All these files have to be present for \fBdpkg\-architecture\fP to
+work. Their location can be overridden at runtime with the environment
+variable \fBDPKG_DATADIR\fP.
+.TP
+.I /usr/share/dpkg/cputable
+Table of known CPU names and mapping to their GNU name.
+.TP
+.I /usr/share/dpkg/ostable
+Table of known operating system names and mapping to their GNU name.
+.TP
+.I /usr/share/dpkg/triplettable
+Mapping between Debian architecture triplets and Debian architecture
+names.
+.
 .SH DEBIAN/RULES
 .SH DEBIAN/RULES
 The environment variables set by \fBdpkg\-architecture\fP are passed to
 The environment variables set by \fBdpkg\-architecture\fP are passed to
 \fIdebian/rules\fP as make variables (see make documentation). However,
 \fIdebian/rules\fP as make variables (see make documentation). However,
@@ -240,21 +255,6 @@ dpkg\-architecture \-ilinux\-any
 .IP
 .IP
 dpkg\-architecture \-ai386 \-ilinux\-any
 dpkg\-architecture \-ai386 \-ilinux\-any
 .
 .
-.SH FILES
-All these files have to be present for \fBdpkg\-architecture\fP to
-work. Their location can be overridden at runtime with the environment
-variable \fBDPKG_DATADIR\fP.
-.TP
-.I /usr/share/dpkg/cputable
-Table of known CPU names and mapping to their GNU name.
-.TP
-.I /usr/share/dpkg/ostable
-Table of known operating system names and mapping to their GNU name.
-.TP
-.I /usr/share/dpkg/triplettable
-Mapping between Debian architecture triplets and Debian architecture
-names.
-.
 .SH SEE ALSO
 .SH SEE ALSO
 .BR dpkg\-buildpackage (1),
 .BR dpkg\-buildpackage (1),
 .BR dpkg\-cross (1).
 .BR dpkg\-cross (1).

+ 46 - 45
man/dpkg-buildflags.1

@@ -162,51 +162,6 @@ and
 .B ,
 .B ,
 have to be stripped from these options). Default value: empty.
 have to be stripped from these options). Default value: empty.
 .
 .
-.SH FILES
-.TP
-.B /etc/dpkg/buildflags.conf
-System wide configuration file.
-.TP
-.BR $XDG_CONFIG_HOME/dpkg/buildflags.conf " or " $HOME/.config/dpkg/buildflags.conf
-User configuration file.
-.SH ENVIRONMENT
-There are 2 sets of environment variables doing the same operations, the
-first one (DEB_\fIflag\fP_\fIop\fP) should never be used within
-\fBdebian/rules\fP. It's meant for any user that wants to rebuild the
-source package with different build flags. The second set
-(DEB_\fIflag\fP_MAINT_\fIop\fP) should only be used in \fBdebian/rules\fP
-by package maintainers to change the resulting build flags.
-.TP
-.BI DEB_ flag _SET
-.TQ
-.BI DEB_ flag _MAINT_SET
-This variable can be used to force the value returned for the given
-\fIflag\fP.
-.TP
-.BI DEB_ flag _STRIP
-.TQ
-.BI DEB_ flag _MAINT_STRIP
-This variable can be used to provide a space separated list of options
-that will be stripped from the set of flags returned for the given
-\fIflag\fP.
-.TP
-.BI DEB_ flag _APPEND
-.TQ
-.BI DEB_ flag _MAINT_APPEND
-This variable can be used to append supplementary options to the value
-returned for the given \fIflag\fP.
-.TP
-.BI DEB_ flag _PREPEND
-.TQ
-.BI DEB_ flag _MAINT_PREPEND
-This variable can be used to prepend supplementary options to the value
-returned for the given \fIflag\fP.
-.TP
-.B DEB_BUILD_MAINT_OPTIONS
-This variable can be used to disable/enable various hardening build
-flags through the \fBhardening\fP option. See the \fBHARDENING\fP section
-for details.
-.
 .SH HARDENING
 .SH HARDENING
 Several compile-time options (detailed below) can be used to help harden
 Several compile-time options (detailed below) can be used to help harden
 a resulting binary against memory corruption attacks, or provide
 a resulting binary against memory corruption attacks, or provide
@@ -307,3 +262,49 @@ architectures (most notably i386) can see performance losses of up to
 15% in very text-segment-heavy application workloads; most workloads
 15% in very text-segment-heavy application workloads; most workloads
 see less than 1%. Architectures with more general registers (e.g. amd64)
 see less than 1%. Architectures with more general registers (e.g. amd64)
 do not see as high a worst-case penalty.
 do not see as high a worst-case penalty.
+.
+.SH ENVIRONMENT
+There are 2 sets of environment variables doing the same operations, the
+first one (DEB_\fIflag\fP_\fIop\fP) should never be used within
+\fBdebian/rules\fP. It's meant for any user that wants to rebuild the
+source package with different build flags. The second set
+(DEB_\fIflag\fP_MAINT_\fIop\fP) should only be used in \fBdebian/rules\fP
+by package maintainers to change the resulting build flags.
+.TP
+.BI DEB_ flag _SET
+.TQ
+.BI DEB_ flag _MAINT_SET
+This variable can be used to force the value returned for the given
+\fIflag\fP.
+.TP
+.BI DEB_ flag _STRIP
+.TQ
+.BI DEB_ flag _MAINT_STRIP
+This variable can be used to provide a space separated list of options
+that will be stripped from the set of flags returned for the given
+\fIflag\fP.
+.TP
+.BI DEB_ flag _APPEND
+.TQ
+.BI DEB_ flag _MAINT_APPEND
+This variable can be used to append supplementary options to the value
+returned for the given \fIflag\fP.
+.TP
+.BI DEB_ flag _PREPEND
+.TQ
+.BI DEB_ flag _MAINT_PREPEND
+This variable can be used to prepend supplementary options to the value
+returned for the given \fIflag\fP.
+.TP
+.B DEB_BUILD_MAINT_OPTIONS
+This variable can be used to disable/enable various hardening build
+flags through the \fBhardening\fP option. See the \fBHARDENING\fP section
+for details.
+.
+.SH FILES
+.TP
+.B /etc/dpkg/buildflags.conf
+System wide configuration file.
+.TP
+.BR $XDG_CONFIG_HOME/dpkg/buildflags.conf " or " $HOME/.config/dpkg/buildflags.conf
+User configuration file.

+ 20 - 20
man/dpkg-divert.8

@@ -95,6 +95,26 @@ Show the usage message and exit.
 .B \-\-version
 .B \-\-version
 Show the version and exit.
 Show the version and exit.
 .
 .
+.SH ENVIRONMENT
+.TP
+.B DPKG_ADMINDIR
+If set and the \fB\-\-admindir\fP option has not been specified, it will
+be used as the dpkg data directory.
+.TP
+.B DPKG_MAINTSCRIPT_PACKAGE
+If set and the \fB\-\-local\fP and \fB\-\-package\fP options have not been
+specified, \fBdpkg\-divert\fP will use it as the package name.
+.
+.SH FILES
+.TP
+.I /var/lib/dpkg/diversions
+File which contains the current list of diversions of the system. It is
+located in the dpkg administration directory, along with other files
+important to dpkg, such as \fIstatus\fP or \fIavailable\fP.
+.br
+Note: \fBdpkg\-divert\fP preserves the old copy of this file, with extension
+\fI\-old\fP, before replacing it with the new one.
+.
 .SH NOTES
 .SH NOTES
 When adding, default is \fB\-\-local\fP and \fB\-\-divert\fP
 When adding, default is \fB\-\-local\fP and \fB\-\-divert\fP
 \fIoriginal\fP\fB.distrib\fP. When removing, \fB\-\-package\fP or
 \fIoriginal\fP\fB.distrib\fP. When removing, \fB\-\-package\fP or
@@ -129,25 +149,5 @@ To remove that diversion:
 .HP
 .HP
 dpkg\-divert \-\-package wibble \-\-rename \-\-remove /usr/bin/example
 dpkg\-divert \-\-package wibble \-\-rename \-\-remove /usr/bin/example
 .
 .
-.SH ENVIRONMENT
-.TP
-.B DPKG_ADMINDIR
-If set and the \fB\-\-admindir\fP option has not been specified, it will
-be used as the dpkg data directory.
-.TP
-.B DPKG_MAINTSCRIPT_PACKAGE
-If set and the \fB\-\-local\fP and \fB\-\-package\fP options have not been
-specified, \fBdpkg\-divert\fP will use it as the package name.
-.
-.SH FILES
-.TP
-.I /var/lib/dpkg/diversions
-File which contains the current list of diversions of the system. It is
-located in the dpkg administration directory, along with other files
-important to dpkg, such as \fIstatus\fP or \fIavailable\fP.
-.br
-Note: \fBdpkg\-divert\fP preserves the old copy of this file, with extension
-\fI\-old\fP, before replacing it with the new one.
-.
 .SH SEE ALSO
 .SH SEE ALSO
 .BR dpkg (1).
 .BR dpkg (1).

+ 42 - 42
man/dpkg.1

@@ -670,48 +670,6 @@ may leave packages in the improper \fBtriggers\-awaited\fP and
 \fB\-\-triggers\fP
 \fB\-\-triggers\fP
 Cancels a previous \fB\-\-no\-triggers\fP.
 Cancels a previous \fB\-\-no\-triggers\fP.
 .
 .
-.SH FILES
-.TP
-.I /etc/dpkg/dpkg.cfg.d/[0-9a-zA-Z_-]*
-Configuration fragment files.
-.TP
-.I /etc/dpkg/dpkg.cfg
-Configuration file with default options.
-.TP
-.I /var/log/dpkg.log
-Default log file (see \fI/etc/dpkg/dpkg.cfg\fP(5) and option
-\fB\-\-log\fP).
-.P
-The other files listed below are in their default directories, see option
-\fB\-\-admindir\fP to see how to change locations of these files.
-.TP
-.I /var/lib/dpkg/available
-List of available packages.
-.TP
-.I /var/lib/dpkg/status
-Statuses of available packages. This file contains information about
-whether a package is marked for removing or not, whether it is
-installed or not, etc. See section \fBINFORMATION ABOUT PACKAGES\fP
-for more info.
-
-The status file is backed up daily in \fI/var/backups\fP. It can be
-useful if it's lost or corrupted due to filesystems troubles.
-.P
-The following files are components of a binary package. See \fBdeb\fP(5)
-for more information about them:
-.TP
-.I control
-.TP
-.I conffiles
-.TP
-.I preinst
-.TP
-.I postinst
-.TP
-.I prerm
-.TP
-.I postrm
-.
 .SH ENVIRONMENT
 .SH ENVIRONMENT
 .TP
 .TP
 .B HOME
 .B HOME
@@ -760,6 +718,48 @@ architecture the package got built for.
 Defined by \fBdpkg\fP on the maintainer script environment to the
 Defined by \fBdpkg\fP on the maintainer script environment to the
 name of the script running (preinst, postinst, prerm, postrm).
 name of the script running (preinst, postinst, prerm, postrm).
 .
 .
+.SH FILES
+.TP
+.I /etc/dpkg/dpkg.cfg.d/[0-9a-zA-Z_-]*
+Configuration fragment files.
+.TP
+.I /etc/dpkg/dpkg.cfg
+Configuration file with default options.
+.TP
+.I /var/log/dpkg.log
+Default log file (see \fI/etc/dpkg/dpkg.cfg\fP(5) and option
+\fB\-\-log\fP).
+.P
+The other files listed below are in their default directories, see option
+\fB\-\-admindir\fP to see how to change locations of these files.
+.TP
+.I /var/lib/dpkg/available
+List of available packages.
+.TP
+.I /var/lib/dpkg/status
+Statuses of available packages. This file contains information about
+whether a package is marked for removing or not, whether it is
+installed or not, etc. See section \fBINFORMATION ABOUT PACKAGES\fP
+for more info.
+
+The status file is backed up daily in \fI/var/backups\fP. It can be
+useful if it's lost or corrupted due to filesystems troubles.
+.P
+The following files are components of a binary package. See \fBdeb\fP(5)
+for more information about them:
+.TP
+.I control
+.TP
+.I conffiles
+.TP
+.I preinst
+.TP
+.I postinst
+.TP
+.I prerm
+.TP
+.I postrm
+.
 .SH BUGS
 .SH BUGS
 \fB\-\-no\-act\fP usually gives less information than might be helpful.
 \fB\-\-no\-act\fP usually gives less information than might be helpful.
 .
 .