diff options
author | Steven Knight <knight@baldmt.com> | 2002-01-29 15:15:05 (GMT) |
---|---|---|
committer | Steven Knight <knight@baldmt.com> | 2002-01-29 15:15:05 (GMT) |
commit | 2479d0f7efbfceb6a43eec7411a35ba13f58fc90 (patch) | |
tree | 183638bcca2f7e5ead9b760ab8900e2d8f23c5c9 /doc | |
parent | 8d639e2c4ee5623f803344a09db1eb074946349a (diff) | |
download | SCons-2479d0f7efbfceb6a43eec7411a35ba13f58fc90.zip SCons-2479d0f7efbfceb6a43eec7411a35ba13f58fc90.tar.gz SCons-2479d0f7efbfceb6a43eec7411a35ba13f58fc90.tar.bz2 |
Update Copyright lines for the new year.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Conscript | 183 | ||||
-rw-r--r-- | doc/SConscript | 2 | ||||
-rw-r--r-- | doc/copyright.sgml | 4 | ||||
-rw-r--r-- | doc/man/scons.1 | 2 |
4 files changed, 128 insertions, 63 deletions
diff --git a/doc/Conscript b/doc/Conscript index a04d280..9eef3e6 100644 --- a/doc/Conscript +++ b/doc/Conscript @@ -3,7 +3,7 @@ # # -# Copyright (c) 2001 Steven Knight +# Copyright (c) 2001, 2002 Steven Knight # # Permission is hereby granted, free of charge, to any person obtaining # a copy of this software and associated documentation files (the @@ -36,6 +36,7 @@ $doc_tar_gz = "#build/dist/scons-doc-${\$env->{VERSION}}.tar.gz"; # We'll only try to build text files (for some documents) # if lynx is available to do the dump. # +$fig2dev = cons::whereis('fig2dev'); $groff = cons::whereis('groff'); $lynx = cons::whereis('lynx'); $man2html = cons::whereis('man2html'); @@ -63,95 +64,159 @@ _EOF_ Ignore("version.sgml"); + # Find internal dependencies in .sgml files: + # + # <!entity bground SYSTEM "bground.sgml"> + # <graphic fileref="file.jpg"> + # <imagedata fileref="file.jpg"> + # + # This only finds one per line, and assumes that anything + # defined as a SYSTEM entity is, in fact, a file included + # somewhere in the document. + sub scansgml { + my $dir = shift; + my @includes = (); + do { + if (/<!entity\s+(?:%\s+)?(?:\S+)\s+SYSTEM\s+"([^"]*)">/i) { + push(@includes, $1); + } elsif (/<(?:graphic|imagedata)\s+fileref="([^"]*)"\s+format="([^"]*)"/) { + ($file, $format) = ($1, $2); + $file = "$file.$format" if ($file !~ /\.$format$/); + if ($dir && ! File::Spec->file_name_is_absolute($file)) { + $file = "build/doc/$dir/$file"; + } + push(@includes, $file); + } elsif (/<(?:graphic|imagedata)\s+fileref="([^"]*)"/) { + $file = $1; + if ($dir && ! File::Spec->file_name_is_absolute($file)) { + $file = "build/doc/$dir/$file"; + } + push(@includes, $file); + } + } while (<scan::quickscan::SCAN>); + @includes; + } + # # Each document will live in its own subdirectory. List them here # as hash keys, with a hash of the info to control its build. # - %doc_dirs = ( + %docs = ( 'design' => { - 'html' => 'book1.html', + 'htmlindex' => 'book1.html', + 'ps' => 1, + 'pdf' => 1, + 'text' => 0, + 'scan' => sub { scansgml("design") }, }, + 'python10' => { + 'htmlindex' => 't1.html', + 'html' => 1, + 'ps' => 1, + 'pdf' => 0, + 'text' => 0, + 'graphics' => [qw( arch builder job-task node scanner sig )], + 'scan' => sub { scansgml("python10") }, + }, 'user' => { - 'html' => 'book1.html', + 'htmlindex' => 'book1.html', + 'html' => 1, + 'ps' => 1, + 'pdf' => 1, + 'text' => 0, + 'scan' => sub { scansgml("user") }, }, ); - # Find internal dependencies in .sgml files: - # - # <!entity bground SYSTEM "bground.sgml"> - # <graphic fileref="file.jpg"> - # - # This only finds one per line, and assumes that anything - # defined as a SYSTEM entity is, in fact, a file included - # somewhere in the document. - sub scansgml { - my @includes = (); - do { - if (/<!entity\s+(?:%\s+)?(?:\S+)\s+SYSTEM\s+"([^"]*)">/i) { - push(@includes, $1); - } elsif (/<graphic[^>]*\sfileref="([^"]*)"/) { - push(@includes, "design/$1"); - } - } while (<scan::quickscan::SCAN>); - @includes; - } - - # - # We have to tell Cons to QuickScan the top-level SGML files which - # get included by the document SGML files in the subdirectories. - # - @included_sgml = qw( - scons.mod - copyright.sgml - ); - - foreach $sgml (@included_sgml) { - $env->QuickScan(\&scansgml, $sgml); - } - - # - # For each document, build the document itself in HTML, Postscript, - # and PDF formats. - # - foreach $doc (keys %doc_dirs) { - my $main = "$doc/main.sgml"; - my $out = "main.out"; + # + # We have to tell Cons to QuickScan the top-level SGML files which + # get included by the document SGML files in the subdirectories. + # + @included_sgml = qw( + scons.mod + copyright.sgml + ); - my $htmldir = "HTML/scons-$doc"; - my $html = "$htmldir/" . $doc_dirs{$doc}->{'html'}; - my $ps = "PS/scons-$doc.ps"; - my $pdf = "PDF/scons-$doc.pdf"; - my $text = "TEXT/scons-$doc.txt"; + foreach $sgml (@included_sgml) { + $env->QuickScan(\&scansgml, $sgml); + } - $env->QuickScan(\&scansgml, $main); + # + # For each document, build the document itself in HTML, Postscript, + # and PDF formats. + # + foreach $doc (keys %docs) { + my $main = "$doc/main.sgml"; + my $out = "main.out"; + + my $htmldir = "HTML/scons-$doc"; + my $htmlindex = "$htmldir/" . $docs{$doc}->{'htmlindex'}; + my $html = "HTML/scons-$doc.html"; + my $ps = "PS/scons-$doc.ps"; + my $pdf = "PDF/scons-$doc.pdf"; + my $text = "TEXT/scons-$doc.txt"; + + if ($docs{$doc}->{'scan'}) { + $env->QuickScan($docs{$doc}->{'scan'}, $main); + } - $env->Command($html, $main, + if ($docs{$doc}->{'html'}) { + $env->Command($htmlindex, $main, qq(rm -f %>:d/*.html jw -b html -o %>:d %< mv -v %>:d/index.html %> || true )); - $env->Command($ps, $main, + $env->Command($html, $main, qq(jw -u -b html %< > %>)); + + push(@tar_deps, $html, $htmlindex); + push(@tar_list, $html, $htmldir); + if ($fig2dev) { + for $g (@{$docs{$doc}->{'graphics'}}) { + $fig = "$doc/$g.fig"; + $jpg = "$htmldir/$g.jpg"; + $env->Command($jpg, $fig, qq($fig2dev -L jpeg -q 100 %< %>)); + $env->Depends($ps, $jpg); + } + } + } + + if ($docs{$doc}->{'ps'}) { + $env->Command($ps, $main, qq(rm -f %>:d/$out jw -b ps -o %>:d %< mv %>:d/main.ps %> rm -f %>:d/$out )); + push(@tar_deps, $ps); + push(@tar_list, $ps); + if ($fig2dev) { + for $g (@{$docs{$doc}->{'graphics'}}) { + $fig = "$doc/$g.fig"; + $eps = "PS/$g.eps"; + $env->Command($eps, $fig, qq($fig2dev -L eps %< %>)); + $env->Depends($ps, $eps); + } + } + } - $env->Command($pdf, $main, + if ($docs{$doc}->{'pdf'}) { + $env->Command($pdf, $main, qq(rm -f %>:d/$out jw -b pdf -o %>:d %< mv %>:d/main.pdf %> rm -f %>:d/$out )); + push(@tar_deps, $pdf); + push(@tar_list, $pdf); + } - if ($doc_dirs{$doc}->{'text'} && $lynx) { - $env->Command($text, $html, qq(lynx -dump %<:a > %>)); - } - - push(@tar_deps, $html, $ps, $pdf); - push(@tar_list, $htmldir, $ps, $pdf); + if ($docs{$doc}->{'text'} && $lynx) { + $env->Command($text, $html, qq(lynx -dump %<:a > %>)); + push(@tar_deps, $text); + push(@tar_list, $text); } + } } # diff --git a/doc/SConscript b/doc/SConscript index aedefd1..cb9df1b 100644 --- a/doc/SConscript +++ b/doc/SConscript @@ -5,7 +5,7 @@ # # -# Copyright (c) 2001 Steven Knight +# Copyright (c) 2001, 2002 Steven Knight # # Permission is hereby granted, free of charge, to any person obtaining # a copy of this software and associated documentation files (the diff --git a/doc/copyright.sgml b/doc/copyright.sgml index 94095ec..a7113ba 100644 --- a/doc/copyright.sgml +++ b/doc/copyright.sgml @@ -1,6 +1,6 @@ <!-- - Copyright (c) 2001 Steven Knight + Copyright (c) 2001, 2002 Steven Knight Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -26,7 +26,7 @@ <blockquote> <para> - Copyright (c) 2001 Steven Knight + Copyright (c) 2001, 2002 Steven Knight Portions of this document, by the same author, were previously published Copyright 2000 by CodeSourcery LLC, under the Software Carpentry diff --git a/doc/man/scons.1 b/doc/man/scons.1 index 69da100..779d199 100644 --- a/doc/man/scons.1 +++ b/doc/man/scons.1 @@ -1,4 +1,4 @@ -.\" Copyright (c) 2001 Steven Knight +.\" Copyright (c) 2001, 2002 Steven Knight .\" .\" Permission is hereby granted, free of charge, to any person obtaining .\" a copy of this software and associated documentation files (the |