improve comments of texlive eclasses so that they're ready to get a man page, thanks to mren <bugs@rennings.net>, bug #210049

1 files changed, 20 insertions, 4 deletions

diff --git a/eclass/texlive-common.eclass b/eclass/texlive-common.eclass
index a4c24e8d4a0a..8893a4f70ed1 100644
--- a/eclass/texlive-common.eclass
+++ b/eclass/texlive-common.eclass
@@ -1,19 +1,26 @@
-# Copyright 1999-2007 Gentoo Foundation
+# Copyright 1999-2008 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
-# $Header: /var/cvsroot/gentoo-x86/eclass/texlive-common.eclass,v 1.3 2007/11/06 23:34:43 aballier Exp $
+# $Header: /var/cvsroot/gentoo-x86/eclass/texlive-common.eclass,v 1.4 2008/02/14 09:02:11 aballier Exp $
 
+# @ECLASS: texlive-common.eclass
+# @MAINTAINER:
+# tex@gentoo.org
 #
 # Original Author: Alexis Ballier <aballier@gentoo.org>
+# @BLURB: Provide various functions used by both texlive-core and texlive modules
+# @DESCRIPTION:
 # Purpose: Provide various functions used by both texlive-core and texlive
 # modules.
-# Note that this eclass *must* not assume the presence of any standard tex tool
 #
+# Note that this eclass *must* not assume the presence of any standard tex tool
 
 
 TEXMF_PATH=/usr/share/texmf
 TEXMF_DIST_PATH=/usr/share/texmf-dist
 TEXMF_VAR_PATH=/var/lib/texmf
 
+# @FUNCTION: texlive-common_handle_config_files
+# @DESCRIPTION:
 # Has to be called in src_install after having installed the files in ${D}
 # This function will move the relevant files to /etc/texmf and symling them
 # from their original location. This is to allow easy update of texlive's
@@ -32,7 +39,8 @@ texlive-common_handle_config_files() {
 	done
 }
 
-
+# @FUNCTION: texlive-common_is_file_present_in_texmf
+# @DESCRIPTION:
 # Return if a file is present in the texmf tree
 # Call it from the directory containing texmf and texmf-dist
 
@@ -43,7 +51,11 @@ texlive-common_is_file_present_in_texmf() {
 	[ -f "${mark}" ]
 }
 
+# @FUNCTION: texlive-common_do_symlinks
+# @USAGE: < src > < dest >
+# @DESCRIPTION:
 # Mimic the install_link function of texlinks
+#
 # Should have the same behavior as the one in /usr/bin/texlinks
 # except that it is under the control of the package manager
 # Note that $1 corresponds to $src and $2 to $dest in this function
@@ -74,7 +86,11 @@ texlive-common_do_symlinks() {
 	done
 }
 
+# @FUNCTION: etexlinks
+# @USAGE: < file > 
+# @DESCRIPTION:
 # Mimic texlinks on a fmtutil format file
+#
 # $1 has to be a fmtutil format file like fmtutil.cnf
 # etexlinks foo will install the symlinks that texlinks --cnffile foo would have
 # created. We cannot use texlinks with portage as it is not DESTDIR aware.