summaryrefslogtreecommitdiffstats
path: root/lib/MGA/DrakISO/BuildRoot.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/MGA/DrakISO/BuildRoot.pm')
-rw-r--r--lib/MGA/DrakISO/BuildRoot.pm14
1 files changed, 14 insertions, 0 deletions
diff --git a/lib/MGA/DrakISO/BuildRoot.pm b/lib/MGA/DrakISO/BuildRoot.pm
index 77181e6..8710043 100644
--- a/lib/MGA/DrakISO/BuildRoot.pm
+++ b/lib/MGA/DrakISO/BuildRoot.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 functions to create and customise the root filesystem
+# for a Live system.
+
package MGA::DrakISO::BuildRoot;
use strict;
@@ -32,6 +37,10 @@ use Exporter;
our @ISA = qw(Exporter);
our @EXPORT = qw(install_live_system customise_live_system);
+# This is the top-level function called to create the basic root filesystem. It
+# uses stage2 of the Mageia installer to do the actual work. It is independent
+# of any other preparatory step.
+#
sub install_live_system {
my ($build) = @_;
@@ -64,6 +73,11 @@ sub install_live_system {
) or die "unable to install system chroot\n";
}
+# This is the top-level function called to customise the root filesystem. It
+# allows a standard Mageia installation to be fine-tuned for use as a Live
+# system. The basic root filesystem must have been prepared before calling
+# this function.
+#
sub customise_live_system {
my ($build) = @_;