/usr/bin/dh_installdocs is in debhelper 9.20131227ubuntu1.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 | #!/usr/bin/perl -w
=head1 NAME
dh_installdocs - install documentation into package build directories
=cut
use strict;
use Debian::Debhelper::Dh_Lib;
=head1 SYNOPSIS
B<dh_installdocs> [S<I<debhelper options>>] [B<-A>] [B<-X>I<item>] [S<I<file> ...>]
=head1 DESCRIPTION
B<dh_installdocs> is a debhelper program that is responsible for installing
documentation into F<usr/share/doc/package> in package build directories.
=head1 FILES
=over 4
=item debian/I<package>.docs
List documentation files to be installed into I<package>.
=item F<debian/copyright>
The copyright file is installed into all packages, unless a more
specific copyright file is available.
=item debian/I<package>.copyright
=item debian/I<package>.README.Debian
=item debian/I<package>.TODO
Each of these files is automatically installed if present for a
I<package>.
=item F<debian/README.Debian>
=item F<debian/TODO>
These files are installed into the first binary package listed in
debian/control.
Note that F<README.debian> files are also installed as F<README.Debian>,
and F<TODO> files will be installed as F<TODO.Debian> in non-native packages.
=item debian/I<package>.doc-base
Installed as doc-base control files. Note that the doc-id will be
determined from the B<Document:> entry in the doc-base control file in
question. In the event that multiple doc-base files in a single source
package share the same doc-id, they will be installed to
usr/share/doc-base/package instead of usr/share/doc-base/doc-id.
=item debian/I<package>.doc-base.*
If your package needs to register more than one document, you need
multiple doc-base files, and can name them like this. In the event
that multiple doc-base files of this style in a single source package
share the same doc-id, they will be installed to
usr/share/doc-base/package-* instead of usr/share/doc-base/doc-id.
=back
=head1 OPTIONS
=over 4
=item B<-A>, B<--all>
Install all files specified by command line parameters in ALL packages
acted on.
=item B<-X>I<item>, B<--exclude=>I<item>
Exclude files that contain I<item> anywhere in their filename from
being installed. Note that this includes doc-base files.
=item B<--link-doc=>I<package>
Make the documentation directory of all packages acted on be a symlink to
the documentation directory of I<package>. This has no effect when acting on
I<package> itself, or if the documentation directory to be created already
exists when B<dh_installdocs> is run. To comply with policy, I<package> must
be a binary package that comes from the same source package.
debhelper will try to avoid installing files into linked documentation
directories that would cause conflicts with the linked package. The B<-A>
option will have no effect on packages with linked documentation
directories, and F<copyright>, F<changelog>, F<README.Debian>, and F<TODO> files will
not be installed.
(An older method to accomplish the same thing, which is still supported,
is to make the documentation directory of a package be a dangling symlink,
before calling B<dh_installdocs>.)
=item I<file> ...
Install these files as documentation into the first package acted on. (Or
in all packages if B<-A> is specified).
=back
=head1 EXAMPLES
This is an example of a F<debian/package.docs> file:
README
TODO
debian/notes-for-maintainers.txt
docs/manual.txt
docs/manual.pdf
docs/manual-html/
=head1 NOTES
Note that B<dh_installdocs> will happily copy entire directory hierarchies if
you ask it to (similar to B<cp -a>). If it is asked to install a
directory, it will install the complete contents of the directory.
Note that this command is not idempotent. L<dh_prep(1)> should be called
between invocations of this command. Otherwise, it may cause multiple
instances of the same text to be added to maintainer scripts.
=cut
my %docdir_created;
# Create documentation directories on demand. This allows us to use dangling
# symlinks for linked documentation directories unless additional files need
# to be installed.
sub ensure_docdir {
my $package=shift;
return if $docdir_created{$package};
my $tmp=tmpdir($package);
my $target;
if ($dh{LINK_DOC} && $dh{LINK_DOC} ne $package) {
$target="$tmp/usr/share/doc/$dh{LINK_DOC}";
}
else {
$target="$tmp/usr/share/doc/$package";
}
# If this is a symlink, leave it alone.
if (! -d $target && ! -l $target) {
doit("install","-g",0,"-o",0,"-d",$target);
}
$docdir_created{$package}=1;
}
init(options => {
"link-doc=s" => \$dh{LINK_DOC},
});
foreach my $package (@{$dh{DOPACKAGES}}) {
next if is_udeb($package);
my $tmp=tmpdir($package);
my $file=pkgfile($package,"docs");
my $link_doc=($dh{LINK_DOC} && $dh{LINK_DOC} ne $package);
if ($link_doc) {
# Make sure that the parent directory exists.
if (! -d "$tmp/usr/share/doc" && ! -l "$tmp/usr/share/doc") {
doit("install","-g",0,"-o",0,"-d","$tmp/usr/share/doc");
}
# Create symlink to another documentation directory if
# necessary.
if (! -d "$tmp/usr/share/doc/$package" &&
! -l "$tmp/usr/share/doc/$package") {
doit("ln", "-sf", $dh{LINK_DOC}, "$tmp/usr/share/doc/$package");
# Policy says that if you make your documentation
# directory a symlink, then you have to depend on
# the target.
addsubstvar($package, "misc:Depends", $dh{LINK_DOC});
}
}
else {
ensure_docdir($package);
}
my @docs;
if ($file) {
@docs=filearray($file, ".");
}
if (($package eq $dh{FIRSTPACKAGE} || ($dh{PARAMS_ALL} && ! $link_doc)) && @ARGV) {
push @docs, @ARGV;
}
if (@docs) {
my $exclude = '';
if ($dh{EXCLUDE_FIND}) {
$exclude .= ' -and ! \( '.$dh{EXCLUDE_FIND}.' \)';
}
if (! compat(4)) {
# ignore empty files in subdirs
$exclude .= ' -and ! -empty';
}
foreach my $doc (@docs) {
next if excludefile($doc);
next if -e $doc && ! -s $doc && ! compat(4); # ignore empty files
ensure_docdir($package);
if (-d $doc && length $exclude) {
my $basename = basename($doc);
my $dir = ($basename eq '.') ? $doc : "$doc/..";
my $pwd=`pwd`;
chomp $pwd;
my $docdir = "$pwd/$tmp/usr/share/doc/$package";
complex_doit("cd '$dir' && find '$basename' \\( -type f -or -type l \\)$exclude -print0 | xargs -0 -I {} cp --parents -dp {} $docdir");
}
else {
doit("cp", "-a", $doc, "$tmp/usr/share/doc/$package");
}
}
doit("chown","-R","0:0","$tmp/usr/share/doc");
doit("chmod","-R","go=rX","$tmp/usr/share/doc");
doit("chmod","-R","u+rw","$tmp/usr/share/doc");
}
# .Debian is correct, according to policy, but I'm easy.
my $readme_debian=pkgfile($package,'README.Debian');
if (! $readme_debian) {
$readme_debian=pkgfile($package,'README.debian');
}
if (! $link_doc && $readme_debian && ! excludefile($readme_debian)) {
ensure_docdir($package);
doit("install","-g",0,"-o",0,"-m","644","-p","$readme_debian",
"$tmp/usr/share/doc/$package/README.Debian");
}
my $todo=pkgfile($package,'TODO');
if (! $link_doc && $todo && ! excludefile($todo)) {
ensure_docdir($package);
if (isnative($package)) {
doit("install","-g",0,"-o",0,"-m","644","-p",$todo,
"$tmp/usr/share/doc/$package/TODO");
}
else {
doit("install","-g",0,"-o",0,"-m","644","-p",$todo,
"$tmp/usr/share/doc/$package/TODO.Debian");
}
}
# If the "directory" is a dangling symlink, then don't install
# the copyright file. This is useful for multibinary packages
# that share a doc directory.
if (! $link_doc && (! -l "$tmp/usr/share/doc/$package" || -d "$tmp/usr/share/doc/$package")) {
# Support debian/package.copyright, but if not present, fall
# back on debian/copyright for all packages, not just the
# main binary package.
my $copyright=pkgfile($package,'copyright');
if (! $copyright && -e "debian/copyright") {
$copyright="debian/copyright";
}
if ($copyright && ! excludefile($copyright)) {
ensure_docdir($package);
doit("install","-g",0,"-o",0,"-m","644","-p",$copyright,
"$tmp/usr/share/doc/$package/copyright");
}
}
# Handle doc-base files. There are two filename formats, the usual
# plus an extended format (debian/package.*).
my %doc_ids;
opendir(DEB,"debian/") || error("can't read debian directory: $!");
# If this is the main package, we need to handle unprefixed filenames.
# For all packages, we must support both the usual filename format plus
# that format with a period an something appended.
my $regexp="\Q$package\E\.";
if ($package eq $dh{MAINPACKAGE}) {
$regexp="(|$regexp)";
}
foreach my $fn (grep {/^${regexp}doc-base(\..*)?$/} readdir(DEB)) {
# .EX are example files, generated by eg, dh-make
next if $fn=~/\.EX$/;
next if excludefile($fn);
# Parse the file to get the doc id.
open (IN, "debian/$fn") || die "Cannot read debian/$fn.";
while (<IN>) {
s/\s*$//;
if (/^Document\s*:\s*(.*)/) {
$doc_ids{$fn}=$1;
last;
}
}
if (! exists $doc_ids{$fn}) {
warning("Could not parse $fn for doc-base Document id; skipping");
}
close IN;
}
closedir(DEB);
if (%doc_ids) {
if (! -d "$tmp/usr/share/doc-base/") {
doit("install","-g",0,"-o",0,"-d","$tmp/usr/share/doc-base/");
}
}
# check for duplicate document ids
my %used_doc_ids;
for my $fn (keys %doc_ids) {
$used_doc_ids{$doc_ids{$fn}}++;
}
foreach my $fn (keys %doc_ids) {
# if this document ID is duplicated, we will install
# to usr/share/doc-base/packagename instead of
# usr/share/doc-base/doc_id. To allow for multiple
# conflicting doc-bases in a single package, we will
# install to usr/share/doc-base/packagename-extrabits
# if the doc-base file is
# packagename.doc-base.extrabits
if ($used_doc_ids{$doc_ids{$fn}} > 1) {
my $fn_no_docbase = $fn;
$fn_no_docbase =~ s/\.doc-base(?:\.(.*))?/
if (defined $1 and length $1) {"-$1"} else {''}/xe;
doit("install","-g",0,"-o",0,"-m644","-p","debian/$fn",
"$tmp/usr/share/doc-base/$fn_no_docbase");
}
else {
doit("install","-g",0,"-o",0,"-m644","-p","debian/$fn",
"$tmp/usr/share/doc-base/$doc_ids{$fn}");
}
}
}
=head1 SEE ALSO
L<debhelper(7)>
This program is a part of debhelper.
=head1 AUTHOR
Joey Hess <joeyh@debian.org>
=cut
|