]> err.no Git - dpkg/commitdiff
dpkg-source.1: Rework documentation of -i and -I options
authorFrank Lichtenheld <djpig@debian.org>
Mon, 24 Sep 2007 20:50:53 +0000 (22:50 +0200)
committerFrank Lichtenheld <djpig@debian.org>
Mon, 24 Sep 2007 21:09:21 +0000 (23:09 +0200)
Now gives clearer explanations and better explains the differences between
the two in syntax and semantics.

debian/changelog
man/ChangeLog
man/dpkg-buildpackage.1
man/dpkg-source.1
scripts/dpkg-buildpackage.pl [changed mode: 0755->0644]

index 70d0190ebb395018f60b3fab6d92fdfe444ca6dd..dca92608f2d0eb785ba5e1bcfcc1a5bf048f1be0 100644 (file)
@@ -26,6 +26,8 @@ dpkg (1.14.7) UNRELEASED; urgency=low
   * Allow dpkg-source -I without a pattern which will load a default
     list of pattern similar to -i without regexp. Patch by
     Jari Aalto. Closes: #440972
+  * Rework documentation of dpkg-source's -i and -I options.
+    Closes: #323911, #440956
 
   [ Updated dpkg translations ]
   * Basque (Piarres Beobide). Closes: #440859
index ebc4d9594b629c516d1d1bf7eeb677ae8c4ceabe..4171e9f1d35c58c5ecd44b48ac5eefddb5094218 100644 (file)
@@ -1,3 +1,10 @@
+2007-09-24  Frank Lichtenheld  <djpig@debian.org>
+
+       * dpkg-source.1: Rework documentation of -i
+       and -I options to give clearer explanations and
+       explain the differences between the two in syntax
+       and semantics.
+
 2007-09-24  Jari Aalto  <jari.aalto@cante.net>
 
        * dpkg-source.1: Document new behaviour
index e7a67577a44e5ce4e14c2b708d1bfac145952c06..b33ab12eb3c67a39f4a67053b5fbfc2f163dedf3 100644 (file)
@@ -172,7 +172,7 @@ Do not sign the .changes file.
 Passed unchanged to
 .BR dpkg\-source .
 .TP
-.BI \-I filename
+.BI \-I [\fIpattern\fP]
 Passed unchanged to
 .BR dpkg\-source .
 May be repeated multiple times.
index faaf238fcdd72c20079cde1dcb63a1945af01bcf..c3a9eeb7629e78aa7cc9c137f9de9765f291e8c0 100644 (file)
@@ -1,5 +1,5 @@
 .\" Authors: Ian Jackson
-.TH dpkg\-source 1 "2007-07-18" "Debian Project" "dpkg utilities"
+.TH dpkg\-source 1 "2007-09-24" "Debian Project" "dpkg utilities"
 .SH NAME
 dpkg\-source \- Debian source package (.dsc) manipulation tool
 .
@@ -112,37 +112,48 @@ filtered out of the list of files for the diff. (This list is
 generated by a find command.) \fB\-i\fR by itself enables the option,
 with a default that will filter out control files and directories of the
 most common revision control systems, backup and swap files and Libtool
-build output directories.
+build output directories. There can only be one active regexp, of multiple
+\-i options only the last one will take effect.
+
 
 This is very helpful in cutting out extraneous files that get included
-in the .diff.gz, (eg: "debian/BUGS_TODO/*" or "debian/RCS/*,v"). For
-instance, if you maintain a package that you track via remote CVS,
-where you don't have access permissions for committing the debian
-control files and making tags for \fIcvs\-buildpackage(1)\fR, it is
-necessary to perform an extra checkout/update into a directory you
-keep pristine, to generate the .orig.tar.gz from. That directory will
-have CVS/Entries files in it that will contain timestamps that differ
-from the ones in your working directory, thus causing them to be
-unnecessarily included in every .diff.gz, unless you use the \fB\-i\fR
-switch.
+in the .diff.gz, e.g. if you maintain your source in a revision control
+system and want to use a checkout to build a source package without
+including the additional files and directories that it will usually
+contain (e.g. CVS/, .cvsignore, .svn/). The default regexp is already
+very exhaustive, but if you need to replace it, please note that by
+default it can match any part of a path, so if you want to match the
+begin of a filename or only full filenames, you will need to provide
+the neccessary anchors (e.g. '(^|/)', '($|/)') yourself.
 .TP
-.BI \-I[\fIfile-pattern\fP]
-
-If this option is specified, the pattern will be passed to tar's \-\-exclude
+.BR \-I [\fIfile-pattern\fP]
+If this option is specified, the pattern will be passed to
+.BR tar (1)'s
+\-\-exclude
 option when it is called to generate a .orig.tar.gz or .tar.gz file. For
 example, \-ICVS will make tar skip over CVS directories when generating
 a .tar.gz file. The option may be repeated multiple times to list multiple
 patterns to exclude.
 
-\fB\-I\fR by itself adds default tar(1) \-\-exclude options that will
+\fB\-I\fR by itself adds default \-\-exclude options that will
 filter out control files and directories of the most common revision
 control systems, backup and swap files and Libtool build output
 directories.
 .PP
-All the
-.BI \-s X
-options are mutually exclusive. If you specify more than one only the
-last one will be used.
+.B Note:
+While they have similar purposes, \fB-i\fP and \fB-I\fP have very
+different syntax and semantics. \fB-i\fP can only be specified once and
+takes a perl compatible regular expression which is matched against
+the full relative path of each file. \fB-I\fP can specified
+multiple times and takes a filename pattern with shell wildcards.
+The pattern is applied to the full relative path but also
+to each part of the path individually. The exact semantic of tar's
+\-\-exclude option is somewhat complicated, see
+http://www.gnu.org/software/tar/manual/tar.html#wildcards for a full
+documentation.
+
+The default regexp and patterns for both options can be seen
+in the output of the \fB\-\-help\fP command.
 .TP
 .B Build options (with -b):
 .PP
@@ -233,6 +244,11 @@ Unpacks the original source tree.
 Ensures that the original source is neither copied to the current
 directory nor unpacked. Any original source tree that was in the
 current directory is still removed.
+.PP
+All the
+.BI \-s X
+options are mutually exclusive. If you specify more than one only the
+last one will be used.
 .
 .SH BUGS
 The point at which field overriding occurs compared to certain
old mode 100755 (executable)
new mode 100644 (file)
index 303fdd1..c7cd422
@@ -68,7 +68,7 @@ Options:
   -W             turn certain errors into warnings.       } passed to
   -E             when -W is turned on, -E turns it off.   } dpkg-source
   -i[<regex>]    ignore diffs of files matching regex.    } only passed
-  -I<filename>   filter out files when building tarballs. } to dpkg-source
+  -I[<pattern>]  filter out files when building tarballs. } to dpkg-source
   --admindir=<directory>
                  change the administrative directory.
   -h, --help     show this help message.