man/dpkg-buildtree.pod

   1 # dpkg manual page - dpkg-buildtree(1)
   2 #
   3 # Copyright © 2023 Guillem Jover <guillem@debian.org>
   4 #
   5 # This is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17
  18 =encoding utf8
  19
  20 =head1 NAME
  21
  22 dpkg-buildtree - helper for build tree operations during package builds
  23
  24 =head1 SYNOPSIS
  25
  26 B<dpkg-buildtree> [I<option>...] [I<command>]
  27
  28 =head1 DESCRIPTION
  29
  30 B<dpkg-buildtree> is a tool to perform common operations on the build tree
  31 for a source package.
  32
  33 This program was introduced in dpkg 1.22.3.
  34
  35 =head1 COMMANDS
  36
  37 =over
  38
  39 =item B<clean>
  40
  41 Removes all artifacts generated during a build by the various dpkg tools,
  42 and pathnames used or controlled by dpkg tools that are safe to clean.
  43 These files are used to track state between package build runs,
  44 and are in many cases internal implementation details the packager should
  45 not be concerned about,
  46 or are staging directories containing build artifacts.
  47
  48 =item B<--help>
  49
  50 Show the usage message and exit.
  51
  52 =item B<--version>
  53
  54 Show the version and exit.
  55
  56 =back
  57
  58 =head1 FILES
  59
  60 =head2 Cleaned files
  61
  62 =over
  63
  64 =item F<debian/files>
  65
  66 =item F<debian/files.new>
  67
  68 Files generated by L<dpkg-distaddfile(1)>.
  69
  70 =item F<debian/substvars>
  71
  72 =item F<debian/substvars.new>
  73
  74 Files generated by L<dpkg-shlibdeps(1)>.
  75
  76 =item F<debian/tmp>
  77
  78 Staging directory containing the contents to be used when creating a package.
  79 Both L<dpkg-gencontrol(1)> and L<dpkg-gensymbols(1)> generate files within.
  80
  81 =back
  82
  83 =head1 EXAMPLES
  84
  85 =head2 Usage in debian/rules
  86
  87 You can call B<dpkg-buildtree clean> from the F<debian/rules> B<clean> target,
  88 after having performed other necessary cleanups.
  89
  90 For example for an autoconf-like build system:
  91
  92 =over
  93
  94   clean:
  95         [ ! -f Makefile ] || $(MAKE) distclean
  96         dpkg-buildtree clean
  97
  98 =back