From 04e2b14c395ede7933addb7c4c68e1eca35468c8 Mon Sep 17 00:00:00 2001 From: Martin Whitaker Date: Thu, 4 Jan 2018 12:30:38 +0000 Subject: Improved documentation and error messages. --- lib/MGA/DrakISO/BuildLoop.pm | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'lib/MGA/DrakISO/BuildLoop.pm') 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 -- cgit v1.2.1