summaryrefslogtreecommitdiffstats
path: root/lib/MDV
diff options
context:
space:
mode:
authorOlivier Thauvin <nanardon@mandriva.org>2007-03-22 12:33:24 +0000
committerOlivier Thauvin <nanardon@mandriva.org>2007-03-22 12:33:24 +0000
commit0dcaef65a3809b25a0d40f9e8c1a4143767818da (patch)
treea6d13985c0a51f70706c1834902714ab4005d29f /lib/MDV
parent3ec62b9b9f2af34402e33add8975071d9e828664 (diff)
downloadperl-MDV-Distribconf-0dcaef65a3809b25a0d40f9e8c1a4143767818da.tar
perl-MDV-Distribconf-0dcaef65a3809b25a0d40f9e8c1a4143767818da.tar.gz
perl-MDV-Distribconf-0dcaef65a3809b25a0d40f9e8c1a4143767818da.tar.bz2
perl-MDV-Distribconf-0dcaef65a3809b25a0d40f9e8c1a4143767818da.tar.xz
perl-MDV-Distribconf-0dcaef65a3809b25a0d40f9e8c1a4143767818da.zip
- update doc
Diffstat (limited to 'lib/MDV')
-rw-r--r--lib/MDV/Distribconf.pm55
-rw-r--r--lib/MDV/Distribconf/MediaCFG.pm13
2 files changed, 14 insertions, 54 deletions
diff --git a/lib/MDV/Distribconf.pm b/lib/MDV/Distribconf.pm
index 560ae19..ddcb908 100644
--- a/lib/MDV/Distribconf.pm
+++ b/lib/MDV/Distribconf.pm
@@ -51,49 +51,6 @@ Some values have specific signification:
=over 4
-=item media specific values:
-
-=over 4
-
-=item B<hdlist>
-
-The path or basename of the hdlist. By default, this is
-C<hdlist_mediapath.cz>, with slashes and spaces being replaced by '_'.
-
-=item B<synthesis>
-
-The path or basename of the synthesis. By default, this is the hdlist
-name prefixed by C<synthesis>.
-
-=item B<pubkey>
-
-The path or basename of the gpg public key file. By default, this is
-the media name prefixed by C<pubkey_>.
-
-=item B<name>
-
-A human-readable name for the media. By default this is the media path
-(that is, the section name), where slashes have been replaced by
-underscores.
-
-=back
-
-=item global specific values:
-
-=over 4
-
-=item B<version>
-
-OS version.
-
-=item B<branch>
-
-OS branch (cooker, etc.)
-
-=item B<arch>
-
-Media target architecture.
-
=item B<root>
The root path of the distribution tree. This value is not set in
@@ -114,12 +71,10 @@ version.
=back
-=back
-
-For the paths of the hdlist and synthesis files, if only a basename is
-provided, the path is assumed to be relative to the mediadir or infodir.
-(hdlist and synthesis are created in both directories.) If it's a complete
-path, it's assumed to be relative to the 'root'. For example,
+Up to version 2 of media.cfg, for the paths of the hdlist and synthesis files,
+if only a basename is provided, the path is assumed to be relative to the
+mediadir or infodir. (hdlist and synthesis are created in both directories.)
+If it's a complete path, it's assumed to be relative to the 'root'. For example,
hdlist.cz -> <root>/<infodir>/hdlist.cz
./hdlist.cz -> <root>/./hdlist.cz
@@ -150,6 +105,8 @@ Here's a complete example of a F<media.cfg> file:
name=Contrib Sources
noauto=1
+See L<MDV::Distribconf::MediaCFG> for specific value set in media.cfg.
+
=head1 METHODS
=cut
diff --git a/lib/MDV/Distribconf/MediaCFG.pm b/lib/MDV/Distribconf/MediaCFG.pm
index 91431aa..90a320d 100644
--- a/lib/MDV/Distribconf/MediaCFG.pm
+++ b/lib/MDV/Distribconf/MediaCFG.pm
@@ -155,17 +155,20 @@ foreach (qw(hdlist name synthesis pubkey)) {
The name of the media. If unset, the section is the name.
-=head3 hdlist
+=head3 B<hdlist>
-The hdlist file holding rpm infos for the media
+The basename of the hdlist. By default, this is
+C<hdlist_mediapath.cz>, with slashes and spaces being replaced by '_'.
-=head3 synthesis
+=head3 B<synthesis>
-The synthesis file holding rpm infos for the media
+The basename of the synthesis. By default, this is the hdlist
+name prefixed by C<synthesis>.
=head3 pubkey
-The file holding public gpg key used to sign rpms in this media.
+The basename of the gpg public key file. By default, this is
+the media name prefixed by C<pubkey_>.
=cut