From 21681af94d62b41899acc768111b34fe1dd8cdb5 Mon Sep 17 00:00:00 2001
From: Olivier Thauvin <nanardon@mandriva.org>
Date: Fri, 20 Oct 2006 18:55:12 +0000
Subject: - fix doc for some options

---
 lib/MDV/Distribconf/MediaCFG.pm | 53 +++++++++++++++++++++--------------------
 1 file changed, 27 insertions(+), 26 deletions(-)

diff --git a/lib/MDV/Distribconf/MediaCFG.pm b/lib/MDV/Distribconf/MediaCFG.pm
index 249f6e5..91431aa 100644
--- a/lib/MDV/Distribconf/MediaCFG.pm
+++ b/lib/MDV/Distribconf/MediaCFG.pm
@@ -12,7 +12,7 @@ MDV::Distribconf::MediaCFG
 
 =head1 DESCRIPTION
 
-This module provide documenation of know value in media.cfg
+This module provides documenation of known values in F<media.cfg>.
 
 =head1 MEDIACFG VERSION
 
@@ -22,28 +22,28 @@ behavior of this module.
 
 =head2 1
 
-This is the default and the first version of mediacfg format.
+This is the default and the first version of media.cfg format.
 
 =head2 2
 
-Since this version, all media path are relative to the media_info path.
-Before, media was relative to media_info except media with / relative to
-the root of the distrib.
+Since this version, all media paths are relative to the media_info path.
+Previously, media paths were relative to media_info except when beginning with
+F</>, which were relative to the root of the distrib.
 
 =head2 3
 
-This version allow to include in value variable in form of refering to
-other value set in the file:
+This version allows to include in values variables that refer to
+other values defined in the configuration file:
 
 =over 4
 
 =item ${...}
 
-refer to a global value (distribution version, arch...)
+refers to a global value (distribution version, arch...)
 
 =item %{...}
 
-refer to a value proper to the media (name, ...)
+refers to a value specific to the media (name, ...)
 
 =back
 
@@ -93,6 +93,24 @@ The arcitecture of the distribution
 
 =cut
 
+$value->{suppl} = { section => 'media_info' };
+
+=head3 suppl
+
+This tag is used to change installer behavior, when set, user should be allow
+to add media not provided by this distribution.
+
+=cut
+
+$value->{askmedia} = { section => 'media_info' };
+
+=head3 askmedia
+
+This tag is used to change installer behavior, when set, user should be prompt
+before adding each media.
+
+=cut
+
 $value->{branch} = { section => 'media_info' };
 
 =head3 branch
@@ -218,23 +236,6 @@ The size of the media. The value is suffixed by the unit.
 
 =cut
 
-$value->{suppl} = {  };
-
-=head3 suppl
-
-The media is a supplementary media.
-
-=cut
-
-$value->{askmedia} = {  };
-
-=head3 askmedia
-
-Tools should ask to the user if the media should be add or not to
-the configuration
-
-=cut
-
 # valid_param($media, $var, $val)
 #
 # Return a list of errors (if any) about having such value in the config
-- 
cgit v1.2.1