summaryrefslogtreecommitdiffstats
path: root/lib/MGA/DrakISO/BuildLoop.pm
diff options
context:
space:
mode:
authorMartin Whitaker <mageia@martin-whitaker.me.uk>2018-01-04 12:30:38 +0000
committerMartin Whitaker <mageia@martin-whitaker.me.uk>2018-01-04 12:31:48 +0000
commit04e2b14c395ede7933addb7c4c68e1eca35468c8 (patch)
treeaf1ab2715e11d3003e59bfec0e0da440899b42fc /lib/MGA/DrakISO/BuildLoop.pm
parent0a90f0baf2b522b2c74278e0e7dcd3e3ff97bca5 (diff)
downloaddrakiso-04e2b14c395ede7933addb7c4c68e1eca35468c8.tar
drakiso-04e2b14c395ede7933addb7c4c68e1eca35468c8.tar.gz
drakiso-04e2b14c395ede7933addb7c4c68e1eca35468c8.tar.bz2
drakiso-04e2b14c395ede7933addb7c4c68e1eca35468c8.tar.xz
drakiso-04e2b14c395ede7933addb7c4c68e1eca35468c8.zip
Improved documentation and error messages.
Diffstat (limited to 'lib/MGA/DrakISO/BuildLoop.pm')
-rw-r--r--lib/MGA/DrakISO/BuildLoop.pm8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/MGA/DrakISO/BuildLoop.pm b/lib/MGA/DrakISO/BuildLoop.pm
index 8cdd6e5..3722644 100644
--- a/lib/MGA/DrakISO/BuildLoop.pm
+++ b/lib/MGA/DrakISO/BuildLoop.pm
@@ -17,6 +17,11 @@
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA.
+# SYNOPSIS
+# --------
+# This package provides a function to build the compressed images that will
+# be mounted as loopback filesystems when booting a Live system.
+
package MGA::DrakISO::BuildLoop;
use strict;
@@ -34,6 +39,9 @@ use Exporter;
our @ISA = qw(Exporter);
our @EXPORT = qw(build_live_loopback_files list_loopback_modules);
+# This is the top-level function called to build the loopback images. The Live
+# root filesystem must have been prepared before calling this function.
+#
sub build_live_loopback_files {
my ($build) = @_;
# make sure no external filesystems are mounted before creating the loopback