Updated French man page translation. Closes: #685560

[debhelper.git] / dh_strip

diff --git a/dh_strip b/dh_strip
index a7052871e8ed230dad4129b1f28012a077f5d0d5..ea5315a3b12999cd1b63d956f62ffa1b9ca6a9ca 100755 (executable)
--- a/dh_strip
+++ b/dh_strip
@@ -12,16 +12,25 @@ use Debian::Debhelper::Dh_Lib;
 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 

-  dh_strip [debhelper options] [-Xitem]
+B<dh_strip> [S<I<debhelper options>>] [B<-X>I<item>] [B<--dbg-package=>I<package>] [B<--keep-debug>]

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 

-dh_strip is a debhelper program that is responsible for stripping
+B<dh_strip> is a debhelper program that is responsible for stripping

 executables, shared libraries, and static libraries that are not used for
 debugging.
 
 executables, shared libraries, and static libraries that are not used for
 debugging.
 

-It assumes that files that have names like lib*_g.a are static libraries
-used in debugging, and will not strip them.
+This program examines your package build directories and works out what
+to strip on its own. It uses L<file(1)> and file permissions and filenames
+to figure out what files are shared libraries (F<*.so>), executable binaries,
+and static (F<lib*.a>) and debugging libraries (F<lib*_g.a>, F<debug/*.so>), and
+strips each as much as is possible. (Which is not at all for debugging
+libraries.) In general it seems to make very good guesses, and will do the
+right thing in almost all cases.
+
+Since it is very hard to automatically guess if a file is a
+module, and hard to determine how to strip a module, B<dh_strip> does not
+currently deal with stripping binary modules such as F<.o> files.

 
 =head1 OPTIONS
 
 
 =head1 OPTIONS
 


@@ -29,16 +38,38 @@ used in debugging, and will not strip them.
 
 =item B<-X>I<item>, B<--exclude=>I<item>
 
 
 =item B<-X>I<item>, B<--exclude=>I<item>
 

-Exclude files that contain "item" anywhere in their filename from being
+Exclude files that contain I<item> anywhere in their filename from being

 stripped. You may use this option multiple times to build up a list of
 things to exclude.
 
 stripped. You may use this option multiple times to build up a list of
 things to exclude.
 

+=item B<--dbg-package=>I<package>
+
+Causes B<dh_strip> to save debug symbols stripped from the packages it acts on
+as independent files in the package build directory of the specified debugging
+package.
+
+For example, if your packages are libfoo and foo and you want to include a
+I<foo-dbg> package with debugging symbols, use B<dh_strip --dbg-package=>I<foo-dbg>.
+
+Note that this option behaves significantly different in debhelper
+compatibility levels 4 and below. Instead of specifying the name of a debug
+package to put symbols in, it specifies a package (or packages) which
+should have separated debug symbols, and the separated symbols are placed
+in packages with B<-dbg> added to their name.
+
+=item B<-k>, B<--keep-debug>
+
+Debug symbols will be retained, but split into an independent
+file in F<usr/lib/debug/> in the package build directory. B<--dbg-package>
+is easier to use than this option, but this option is more flexible.
+

 =back
 
 =head1 NOTES
 
 =back
 
 =head1 NOTES
 

-If the DEB_BUILD_OPTIONS environment variable contains "nostrip", nothing
-will be stripped, in accordance with Debian policy.
+If the B<DEB_BUILD_OPTIONS> environment variable contains B<nostrip>, nothing
+will be stripped, in accordance with Debian policy (section 10.1
+"Binaries").

 
 =head1 CONFORMS TO
 
 
 =head1 CONFORMS TO
 


@@ -46,20 +77,36 @@ Debian policy, version 3.0.1
 
 =cut
 
 
 =cut
 

-init();
+init(options => {
+       "keep-debug" => \$dh{K_FLAG},
+});

 
 # This variable can be used to turn off stripping (see Policy).
 
 # This variable can be used to turn off stripping (see Policy).

-if (defined $ENV{DEB_BUILD_OPTIONS} && $ENV{DEB_BUILD_OPTIONS} =~ /nostrip/) {
+if (get_buildoption('nostrip')) {

        exit;
 }
 
        exit;
 }
 

+my $objcopy = cross_command("objcopy");
+my $strip = cross_command("strip");
+
+# I could just use `file $_[0]`, but this is safer
+sub get_file_type {
+       my $file=shift;
+       open (FILE, '-|') # handle all filenames safely
+               || exec('file', $file)
+               || die "can't exec file: $!";
+       my $type=<FILE>;
+       close FILE;
+       return $type;
+}
+

 # Check if a file is an elf binary, shared library, or static library,
 # for use by File::Find. It'll fill the following 3 arrays with anything
 # it finds:
 my (@shared_libs, @executables, @static_libs);
 sub testfile {
        return if -l $_ or -d $_; # Skip directories and symlinks always.
 # Check if a file is an elf binary, shared library, or static library,
 # for use by File::Find. It'll fill the following 3 arrays with anything
 # it finds:
 my (@shared_libs, @executables, @static_libs);
 sub testfile {
        return if -l $_ or -d $_; # Skip directories and symlinks always.

-
+       

        # See if we were asked to exclude this file.
        # Note that we have to test on the full filename, including directory.
        my $fn="$File::Find::dir/$_";
        # See if we were asked to exclude this file.
        # Note that we have to test on the full filename, including directory.
        my $fn="$File::Find::dir/$_";


@@ -67,10 +114,14 @@ sub testfile {
                return if ($fn=~m/\Q$f\E/);
        }
 
                return if ($fn=~m/\Q$f\E/);
        }
 

+       # Is it a debug library in a debug subdir?
+       return if $fn=~m/debug\/.*\.so/;
+

        # Does its filename look like a shared library?
        # Does its filename look like a shared library?

-       if (m/.*\.so.*?/) {
+       # (*.cmxs are OCaml native code shared libraries)
+       if (m/.*\.(so.*?|cmxs$)/) {

                # Ok, do the expensive test.
                # Ok, do the expensive test.

-               my $type=`file $_`;
+               my $type=get_file_type($_);

                if ($type=~m/.*ELF.*shared.*/) {
                        push @shared_libs, $fn;
                        return;
                if ($type=~m/.*ELF.*shared.*/) {
                        push @shared_libs, $fn;
                        return;


@@ -81,8 +132,8 @@ sub testfile {
        my (undef,undef,$mode,undef)=stat(_);
        if ($mode & 0111) {
                # Ok, expensive test.
        my (undef,undef,$mode,undef)=stat(_);
        if ($mode & 0111) {
                # Ok, expensive test.

-               my $type=`file $_`;
-               if ($type=~m/.*ELF.*executable.*/) {
+               my $type=get_file_type($_);
+               if ($type=~m/.*ELF.*(executable|shared).*/) {

                        push @executables, $fn;
                        return;
                }
                        push @executables, $fn;
                        return;
                }


@@ -90,36 +141,107 @@ sub testfile {
        
        # Is it a static library, and not a debug library?
        if (m/lib.*\.a$/ && ! m/.*_g\.a$/) {
        
        # Is it a static library, and not a debug library?
        if (m/lib.*\.a$/ && ! m/.*_g\.a$/) {

-               push @static_libs, $fn;
-               return;
+               # Is it a binary file, or something else (maybe a liner
+               # script on Hurd, for example? I don't use file, because
+               # file returns a variety of things on static libraries.
+               if (-B $_) {
+                       push @static_libs, $fn;
+                       return;
+               }

        }
 }
 
        }
 }
 

+sub make_debug {
+       my $file=shift;
+       my $tmp=shift;
+       my $desttmp=shift;
+       
+       # Don't try to copy debug symbols out if the file is already
+       # stripped.
+       return unless get_file_type($file) =~ /not stripped/;
+
+       my ($base_file)=$file=~/^\Q$tmp\E(.*)/;
+       my $debug_path;
+       if (! compat(8) && 
+           `readelf -n $file`=~ /^\s+Build ID: ([0-9a-f]{2})([0-9a-f]+)$/m) {
+               $debug_path=$desttmp."/usr/lib/debug/.build-id/$1/$2.debug"
+       }
+       else {
+               $debug_path=$desttmp."/usr/lib/debug/".$base_file;
+       }
+       my $debug_dir=dirname($debug_path);
+       if (! -d $debug_dir) {
+               doit("install", "-d", $debug_dir);
+       }
+       if (compat(8)) {
+               doit($objcopy, "--only-keep-debug", $file, $debug_path);
+       }
+       else {
+               doit($objcopy, "--only-keep-debug", "--compress-debug-sections", $file, $debug_path);
+       }
+       # No reason for this to be executable.
+       doit("chmod", 644, $debug_path);
+       return $debug_path;
+}
+
+sub attach_debug {
+       my $file=shift;
+       my $debug_path=shift;
+       doit($objcopy, "--add-gnu-debuglink", $debug_path, $file);
+}
+

 foreach my $package (@{$dh{DOPACKAGES}}) {
        my $tmp=tmpdir($package);
 
 foreach my $package (@{$dh{DOPACKAGES}}) {
        my $tmp=tmpdir($package);
 

+       # Support for keeping the debugging symbols in a detached file.
+       my $keep_debug=$dh{K_FLAG};
+       my $debugtmp=$tmp;
+       if (! compat(4)) {
+               if (ref $dh{DEBUGPACKAGES}) {
+                       $keep_debug=1;
+                       # Note that it's only an array for the v4 stuff;
+                       # for v5 only one value is used.
+                       my $debugpackage=@{$dh{DEBUGPACKAGES}}[0];
+                       if (! grep { $_ eq $debugpackage } getpackages()) {
+                               error("debug package $debugpackage is not listed in the control file");
+                       }
+                       $debugtmp=tmpdir($debugpackage);
+               }
+       }
+       else {
+               if (ref $dh{DEBUGPACKAGES} && grep { $_ eq $package } @{$dh{DEBUGPACKAGES}}) {
+                       $keep_debug=1;
+                       $debugtmp=tmpdir($package."-dbg");
+               }
+       }
+       
+       @shared_libs=@executables=@static_libs=();

        find(\&testfile,$tmp);
 
        foreach (@shared_libs) {
        find(\&testfile,$tmp);
 
        foreach (@shared_libs) {

+               my $debug_path = make_debug($_, $tmp, $debugtmp) if $keep_debug;

                # Note that all calls to strip on shared libs
                # Note that all calls to strip on shared libs

-               # *must* inclde the --strip-unneeded.
-               doit("strip","--remove-section=.comment",
+               # *must* include the --strip-unneeded.
+               doit($strip,"--remove-section=.comment",

                        "--remove-section=.note","--strip-unneeded",$_);
                        "--remove-section=.note","--strip-unneeded",$_);

+               attach_debug($_, $debug_path) if defined $debug_path;

        }
        
        foreach (@executables) {
        }
        
        foreach (@executables) {

-               doit("strip","--remove-section=.comment",
+               my $debug_path = make_debug($_, $tmp, $debugtmp) if $keep_debug;
+               doit($strip,"--remove-section=.comment",

                        "--remove-section=.note",$_);
                        "--remove-section=.note",$_);

+               attach_debug($_, $debug_path) if defined $debug_path;

        }
 
        foreach (@static_libs) {
        }
 
        foreach (@static_libs) {

-               doit("strip","--strip-debug",$_);
+               doit($strip,"--strip-debug",$_);

        }
 }
 
 =head1 SEE ALSO
 
        }
 }
 
 =head1 SEE ALSO
 

-L<debhelper(1)>
+L<debhelper(7)>

 
 This program is a part of debhelper.
 
 
 This program is a part of debhelper.