PODify the installer

1 files changed, 58 insertions, 0 deletions

diff --git a/perl-install/install/any.pm b/perl-install/install/any.pm
index fecd03c1b..1176c8e0a 100644
--- a/perl-install/install/any.pm
+++ b/perl-install/install/any.pm
@@ -208,6 +208,12 @@ sub prep_net_suppl_media {
     sleep(3);
 }
 
+=item ask_suppl_media_url($o, $method, $o_url)
+
+Ask which actual server or mirror to use
+
+=cut
+
 sub ask_suppl_media_url {
     my ($o, $method, $o_url) = @_;
 
@@ -707,6 +713,14 @@ sub set_rpmsrate_category_flags {
 }
 
 
+
+=item rpmsrate_always_flags($o)
+
+Set flags for selecting packages in rpmsrate according to available hardware.
+Eg selecting software to burn CD/DVDs if a CD/DVD writer is installed
+
+=cut
+
 sub rpmsrate_always_flags {
     my ($o) = @_;
 
@@ -752,6 +766,13 @@ sub rpmsrate_always_flags {
     $rpmsrate_flags_chosen;
 }
 
+
+=item default_bootloader()
+
+Return the default bootloader to use according to the platform (UEFI, bios, ...)
+
+=cut
+
 sub default_bootloader() {
     require bootloader;
     my (undef, $p) = bootloader::get_grub2_pkg();
@@ -848,6 +869,14 @@ Do you really want to remove these packages?
     }
 }
 
+
+=item addToBeDone($f, $step)
+
+The I<$f> function will be executed if $step has already been completed.
+Else it is stored to be run later when $step is completed.
+
+=cut
+
 sub addToBeDone(&$) {
     my ($f, $step) = @_;
 
@@ -900,6 +929,13 @@ sub log_system_info {
 #-###############################################################################
 sub auto_inst_file() { "$::prefix/root/drakx/auto_inst.cfg.pl" }
 
+=item report_bug()
+
+Write the Drakx report in order to review eg a failed installation.
+See any::report_bug()
+
+=cut
+
 sub report_bug() {
     any::report_bug('auto_inst' => g_auto_install('', 1));
 }
@@ -1028,6 +1064,22 @@ sub selected_leaves_pl {
       $str;
 }
 
+=item loadO($O, $f)
+
+Retrieve the auto installation configuration
+
+=over 4
+
+=item * Retrieveing auto_inst.cfg.pl file, either on a local disk or by downloading it
+
+=item * Adusting $o for the parameters loaded from auto_inst.cfg.pl
+
+=item * Handling any old format parameter
+
+=back
+
+=cut
+
 sub loadO {
     my ($O, $f) = @_; $f ||= auto_inst_file();
     if ($f =~ /^(floppy|patch)$/) {
@@ -1082,6 +1134,12 @@ sub loadO_ {
     $o;
 }
 
+=item sub handle_old_auto_install_format($o)
+
+Convert the auto install parameter for any API change.
+
+=cut
+
 sub handle_old_auto_install_format {
     my ($o) = @_;