.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Required to disable full justification in groff 1.23.0. .if n .ds AD l .\" ======================================================================== .\" .IX Title "File::ShouldUpdate 3pm" .TH File::ShouldUpdate 3pm 2026-03-07 "perl v5.42.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME File::ShouldUpdate \- should files be rebuilt? .SH VERSION .IX Header "VERSION" version 0.2.1 .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& use File::ShouldUpdate qw/ should_update should_update_multi /; \& \& if (should_update("output.html", ":", "in.tt2", "data.sqlite")) \& { \& system("./my\-gen\-html"); \& } \& \& if (should_update_multi(["output.html", "about.html", "contact.html"], ":", ["in.tt2", "data.sqlite"])) \& { \& system("./my\-gen\-html\-multi"); \& } .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This module provides \fBshould_update()\fR and \fBshould_update_multi()\fR which can be used to determine if files should be updated based on the mtime timestamps of their dependencies. They avoid confusing between targets and dependencies by using the syntactic sugar of the familiar makefile rules ( \ ). .SH FUNCTIONS .IX Header "FUNCTIONS" .ie n .SS "my $verdict = should_update($target, "":"", @deps);" .el .SS "my \f(CW$verdict\fP = should_update($target, "":"", \f(CW@deps\fP);" .IX Subsection "my $verdict = should_update($target, "":"", @deps);" Should \f(CW$target\fR be updated if it doesn\*(Aqt exist or older than any of the deps. .ie n .SS "my $verdict = should_update_multi([@targets], "":"", [@deps]);" .el .SS "my \f(CW$verdict\fP = should_update_multi([@targets], "":"", [@deps]);" .IX Subsection "my $verdict = should_update_multi([@targets], "":"", [@deps]);" Should \f(CW@targets\fR be updated if some of them do not exist \fBor\fR any of them are older than any of the deps. .PP Note that you must pass array references. .PP [Added in version 0.2.0.] .SH SUPPORT .IX Header "SUPPORT" .SS Websites .IX Subsection "Websites" The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources. .IP \(bu 4 MetaCPAN .Sp A modern, open\-source CPAN search engine, useful to view POD in HTML format. .Sp .IP \(bu 4 RT: CPAN\*(Aqs Bug Tracker .Sp The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN. .Sp .IP \(bu 4 CPANTS .Sp The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution. .Sp .IP \(bu 4 CPAN Testers .Sp The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions. .Sp .IP \(bu 4 CPAN Testers Matrix .Sp The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms. .Sp .IP \(bu 4 CPAN Testers Dependencies .Sp The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution. .Sp .SS "Bugs / Feature Requests" .IX Subsection "Bugs / Feature Requests" Please report any bugs or feature requests by email to \f(CW\*(C`bug\-file\-shouldupdate at rt.cpan.org\*(C'\fR, or through the web interface at . You will be automatically notified of any progress on the request by the system. .SS "Source Code" .IX Subsection "Source Code" The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :) .PP .PP .Vb 1 \& git clone git://github.com/shlomif/perl\-File\-ShouldUpdate.git .Ve .SH AUTHOR .IX Header "AUTHOR" Shlomi Fish .SH BUGS .IX Header "BUGS" Please report any bugs or feature requests on the bugtracker website .PP When submitting a bug or request, please include a test\-file or a patch to an existing test\-file that illustrates the bug or desired feature. .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2020 by Shlomi Fish. .PP This is free software, licensed under: .PP .Vb 1 \& The MIT (X11) License .Ve