summaryrefslogtreecommitdiffstats
path: root/lib/App/BorgRestore
diff options
context:
space:
mode:
authorFlorian Pritz <bluewind@xinu.at>2017-09-10 23:47:50 +0200
committerFlorian Pritz <bluewind@xinu.at>2017-09-10 23:47:50 +0200
commite56c3a182202a0e4155cc03765e8b912e50d3001 (patch)
tree3accbb61e69e2225b7737abc73586df15afc3480 /lib/App/BorgRestore
parentcfba77bdcc1520e558891f71b7d4948841783a8c (diff)
downloadApp-BorgRestore-e56c3a182202a0e4155cc03765e8b912e50d3001.tar.gz
App-BorgRestore-e56c3a182202a0e4155cc03765e8b912e50d3001.tar.xz
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 <bluewind@xinu.at>
Diffstat (limited to 'lib/App/BorgRestore')
-rw-r--r--lib/App/BorgRestore/Borg.pm12
-rw-r--r--lib/App/BorgRestore/DB.pm12
-rw-r--r--lib/App/BorgRestore/Helper.pm12
3 files changed, 36 insertions, 0 deletions
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<App::BorgRestore>.
+
+=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<App::BorgRestore>.
+
+=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<App::BorgRestore> namespace.
+
+=cut
+
fun untaint($data, $regex) {
$data =~ m/^($regex)$/ or die "Failed to untaint: $data";
return $1;