From e56c3a182202a0e4155cc03765e8b912e50d3001 Mon Sep 17 00:00:00 2001 From: Florian Pritz Date: Sun, 10 Sep 2017 23:47:50 +0200 Subject: Add basic documentation for all packages Module::Build::Tiny installs manpages for all packages and for these 3 the manpages were empty. Signed-off-by: Florian Pritz --- lib/App/BorgRestore/Borg.pm | 12 ++++++++++++ lib/App/BorgRestore/DB.pm | 12 ++++++++++++ lib/App/BorgRestore/Helper.pm | 12 ++++++++++++ 3 files changed, 36 insertions(+) (limited to 'lib') diff --git a/lib/App/BorgRestore/Borg.pm b/lib/App/BorgRestore/Borg.pm index 3766f8f..24d77c8 100644 --- a/lib/App/BorgRestore/Borg.pm +++ b/lib/App/BorgRestore/Borg.pm @@ -9,6 +9,18 @@ use Function::Parameters; use IPC::Run qw(run start new_chunker); use Log::Any qw($log); +=encoding utf-8 + +=head1 NAME + +App::BorgRestore::Borg - Borg abstraction + +=head1 DESCRIPTION + +App::BorgRestore::Borg abstracts borg commands used by L. + +=cut + method new($class: $borg_repo) { my $self = {}; bless $self, $class; diff --git a/lib/App/BorgRestore/DB.pm b/lib/App/BorgRestore/DB.pm index b8eb0be..e918677 100644 --- a/lib/App/BorgRestore/DB.pm +++ b/lib/App/BorgRestore/DB.pm @@ -9,6 +9,18 @@ use DBI; use Function::Parameters; use Log::Any qw($log); +=encoding utf-8 + +=head1 NAME + +App::BorgRestore::DB - Database layer + +=head1 DESCRIPTION + +App::BorgRestore::DB abstracts the database storage used internally by L. + +=cut + method new($class: $db_path, $cache_size) { my $self = {}; bless $self, $class; diff --git a/lib/App/BorgRestore/Helper.pm b/lib/App/BorgRestore/Helper.pm index 91d3e91..a89751a 100644 --- a/lib/App/BorgRestore/Helper.pm +++ b/lib/App/BorgRestore/Helper.pm @@ -6,6 +6,18 @@ use warnings; use Function::Parameters; use POSIX (); +=encoding utf-8 + +=head1 NAME + +App::BorgRestore::Helper - Helper functions + +=head1 DESCRIPTION + +App::BorgRestore::Helper provides some general helper functions used in various packages in the L namespace. + +=cut + fun untaint($data, $regex) { $data =~ m/^($regex)$/ or die "Failed to untaint: $data"; return $1; -- cgit v1.2.3-24-g4f1b