Typo. Closes: #653339

[debhelper.git] / dh_compress

diff --git a/dh_compress b/dh_compress
index efeca8ac7ed91d85fabb70b1801c2acf3ac7424e..ff98cb9de6d9c99785b8f41229708f7485fdb259 100755 (executable)
--- a/dh_compress
+++ b/dh_compress
@@ -12,21 +12,21 @@ use Debian::Debhelper::Dh_Lib;
 
 =head1 SYNOPSIS
 
-B<dh_compress> [S<I<debhelper options>>] [B<-X>I<item>] [B<-A>] [S<I<file ...>>]
+B<dh_compress> [S<I<debhelper options>>] [B<-X>I<item>] [B<-A>] [S<I<file> ...>]
 
 =head1 DESCRIPTION
 
-dh_compress is a debhelper program that is responsible for compressing
+B<dh_compress> is a debhelper program that is responsible for compressing
 the files in package build directories, and makes sure that any symlinks
 that pointed to the files before they were compressed are updated to point
 to the new files.
 
-By default, dh_compress compresses files that debian policy mandates should
-be compressed, namely all files in usr/share/info, usr/share/man,
-files in usr/share/doc that are larger than 4k in size,
-(except the copyright file, .html and .css files, image files, and files
+By default, B<dh_compress> compresses files that Debian policy mandates should
+be compressed, namely all files in F<usr/share/info>, F<usr/share/man>,
+files in F<usr/share/doc> that are larger than 4k in size,
+(except the F<copyright> file, F<.html> and other web files, image files, and files
 that appear to be already compressed based on their extensions), and all
-changelog files. Plus PCF fonts underneath usr/share/fonts/X11/
+F<changelog> files. Plus PCF fonts underneath F<usr/share/fonts/X11/>
 
 =head1 FILES
 
@@ -34,11 +34,13 @@ changelog files. Plus PCF fonts underneath usr/share/fonts/X11/
 
 =item debian/I<package>.compress
 
+These files are deprecated.
+
 If this file exists, the default files are not compressed. Instead, the
 file is ran as a shell script, and all filenames that the shell script
 outputs will be compressed. The shell script will be run from inside the
-package build directory. Note though that using -X is a much better idea in
-general; you should only use a debian/package.compress file if you really
+package build directory. Note though that using B<-X> is a much better idea in
+general; you should only use a F<debian/package.compress> file if you really
 need to.
 
 =back
@@ -49,18 +51,17 @@ need to.
 
 =item B<-X>I<item>, B<--exclude=>I<item>
 
-Exclude files that contain "item" anywhere in their filename from being
-compressed. For example, -X.tiff will exclude tiff files from compression.
+Exclude files that contain F<item> anywhere in their filename from being
+compressed. For example, B<-X.tiff> will exclude TIFF files from compression.
 You may use this option multiple times to build up a list of things to
-exclude. You can accomplish the same thing by using a debian/compress file,
-but this is easier.
+exclude.
 
 =item B<-A>, B<--all>
 
 Compress all files specified by command line parameters in ALL packages
 acted on.
 
-=item I<file ...>
+=item I<file> ...
 
 Add these files to the list of files to compress.
 
@@ -91,8 +92,9 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                push @files, @ARGV;
        }
        if ($compress) {
-               # The config file is a sh script that outputs the files to be compressed
+               # The compress file is a sh script that outputs the files to be compressed
                # (typically using find).
+               warning("$compress is deprecated; use -X or avoid calling dh_compress instead");
                push @files, split(/\n/,`sh $olddir/$compress 2>/dev/null`);
        }
        else {
@@ -102,16 +104,21 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                # complete list of such extensions: ".gz", ".z", ".taz", 
                # ".tgz", "-gz", "-z", "_z"
                push @files, split(/\n/,`
-                       find usr/info usr/share/info usr/man usr/share/man usr/X11*/man -type f ! -name "*.gz" 2>/dev/null || true;
-                       find usr/share/doc -type f \\( -size +4k -or -name "changelog*" -or -name "NEWS*" \\) \\
+                       find usr/info usr/share/info usr/man usr/share/man usr/X11*/man -type f ! -iname "*.gz" \\
+                               ! -iname "*.gif" ! -iname "*.png" ! -iname "*.jpg" \\
+                               ! -iname "*.jpeg" \\
+                               2>/dev/null || true;
+                       find usr/share/doc \\
+                               \\( -type d -name _sources -prune -false \\) -o \\
+                               -type f \\( -size +4k -or -name "changelog*" -or -name "NEWS*" \\) \\
                                \\( -name changelog.html -or ! -iname "*.htm*" \\) \\
                                ! -iname "*.gif" ! -iname "*.png" ! -iname "*.jpg" \\
                                ! -iname "*.jpeg" ! -iname "*.gz" ! -iname "*.taz" \\
                                ! -iname "*.tgz" ! -iname "*.z" ! -iname "*.bz2" \\
                                ! -iname "*-gz"  ! -iname "*-z" ! -iname "*_z" \\
                                ! -iname "*.jar" ! -iname "*.zip" ! -iname "*.css" \\
-                               ! -iname "*.svg" ! -iname "*.svgz" \\
-                               ! -name "index.sgml" \\
+                               ! -iname "*.svg" ! -iname "*.svgz" ! -iname "*.js" \\
+                               ! -name "index.sgml" ! -name "objects.inv" \\
                                ! -name "copyright" 2>/dev/null || true;
                        find usr/share/fonts/X11 -type f -name "*.pcf" 2>/dev/null || true;
                `);