<% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>

Devscripts::Uscan::WatchFile

NAME

Devscripts::Uscan::WatchFile - watchfile object for uscan

SYNOPSIS

  use Devscripts::Uscan::Config;
  use Devscripts::Uscan::WatchFile;
  
  my $config = Devscripts::Uscan::Config->new({
    # Uscan config parameters. Example:
    destdir => '..',
  });

  # You can use Devscripts::Uscan::FindFiles to find watchfiles
  
  my $wf = Devscripts::Uscan::WatchFile->new({
      config      => $config,
      package     => $package,
      pkg_dir     => $pkg_dir,
      pkg_version => $version,
      watchfile   => $watchfile,
  });
  return $wf->status if ( $wf->status );
  
  # Do the job
  return $wf->process_lines;

DESCRIPTION

Uscan class to parse watchfiles.

METHODS

new() (Constructor)

Parse watch file and creates Devscripts::Uscan::WatchLine objects for each line.

Required parameters

config: Devscripts::Uscan::Config object
package: Debian package name
pkg_dir: Working directory
pkg_version: Current Debian package version

Main accessors

watchlines: ref to the array that contains watchlines objects
watch_version: format version of the watchfile

process_lines()

Method that launches Devscripts::Uscan::WatchLine::process() on each watchline.

SEE ALSO

uscan, Devscripts::Uscan::WatchLine, Devscripts::Uscan::Config, Devscripts::Uscan::FindFiles

AUTHOR

uscan was originally written by Christoph Lameter <clameter@debian.org> (I believe), modified by Julian Gilbey <jdg@debian.org>. HTTP support was added by Piotr Roszatycki <dexter@debian.org>. uscan was rewritten in Perl by Julian Gilbey. Xavier Guimard <yadd@debian.org> rewrote uscan in object oriented Perl.

COPYRIGHT AND LICENSE

Copyright 2002-2006 by Julian Gilbey <jdg@debian.org>, 2018 by Xavier Guimard <yadd@debian.org>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

<% include ('/elements/footer.html' ) %>