diff options
Diffstat (limited to 'doc/user/precious.sgml')
-rw-r--r-- | doc/user/precious.sgml | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/user/precious.sgml b/doc/user/precious.sgml new file mode 100644 index 0000000..9cd2a43 --- /dev/null +++ b/doc/user/precious.sgml @@ -0,0 +1,69 @@ +<!-- + + Copyright (c) 2001, 2002, 2003 Steven Knight + + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be included + in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY + KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE + WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +--> + +<!-- + +=head2 The C<Precious> method + +The C<Precious> method asks cons not to delete the specified file or +list of files before building them again. It is invoked as: + + Precious <files>; + +This is especially useful for allowing incremental updates to libraries +or debug information files which are updated rather than rebuilt anew each +time. Cons will still delete the files when the C<-r> flag is specified. + +=head2 The C<AfterBuild> method + +The C<AfterBuild> method evaluates the specified perl string after +building the given file or files (or finding that they are up to date). +The eval will happen once per specified file. C<AfterBuild> is called +as follows: + + AfterBuild $env 'foo.o', qq(print "foo.o is up to date!\n"); + +The perl string is evaluated in the C<script> package, and has access +to all variables and subroutines defined in the F<Conscript> file in +which the C<AfterBuild> method is called. + +--> + + <para> + + X + + </para> + + <section> + <title>The &Precious; Method</title> + + <para> + + X + + </para> + + </section> |