summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorFlorian Pritz <bluewind@xinu.at>2017-11-21 17:47:22 +0100
committerFlorian Pritz <bluewind@xinu.at>2017-11-21 17:47:22 +0100
commit8bed4df94caf9bfa51857bb45b32fd287c6680e1 (patch)
treef116a8e6ec31b11a64792a9baa9e8c98d96aa9e3 /lib
parent6b9c0d7719afdf85820e703e58b1358c95b6586e (diff)
downloadApp-BorgRestore-8bed4df94caf9bfa51857bb45b32fd287c6680e1.tar.gz
App-BorgRestore-8bed4df94caf9bfa51857bb45b32fd287c6680e1.tar.xz
settings: Document that config must return true
Signed-off-by: Florian Pritz <bluewind@xinu.at>
Diffstat (limited to 'lib')
-rw-r--r--lib/App/BorgRestore/Settings.pm6
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/App/BorgRestore/Settings.pm b/lib/App/BorgRestore/Settings.pm
index 0e071b7..26a175e 100644
--- a/lib/App/BorgRestore/Settings.pm
+++ b/lib/App/BorgRestore/Settings.pm
@@ -36,6 +36,10 @@ You can set the following options in the config file.
Note that the configuration file is parsed as a perl script. Thus you can also
use any features available in perl itself.
+Also note that it is important that the last statement of the file is positive
+because it is used to check that running the config went well. You can simply
+use "1;" on the last line as shown in the example config.
+
=over
=item C<$borg_repo>
@@ -85,6 +89,8 @@ the disk too much.
);
$sqlite_cache_size = 2097152;
+1; #ensure positive return value
+
=head1 LICENSE
Copyright (C) 2016-2017 Florian Pritz E<lt>bluewind@xinu.atE<gt>