summaryrefslogtreecommitdiff
path: root/eclass
diff options
context:
space:
mode:
authorDonnie Berkholz <spyderous@gentoo.org>2005-12-12 01:56:08 +0000
committerDonnie Berkholz <spyderous@gentoo.org>2005-12-12 01:56:08 +0000
commit5f2241ceea35cfe979d1521a492a57ab950f8b83 (patch)
tree94e81bf0b6d0c5c4eb576da77d30964eb7262cda /eclass
parentfix CROSS again #80698 (diff)
downloadgentoo-2-5f2241ceea35cfe979d1521a492a57ab950f8b83.tar.gz
gentoo-2-5f2241ceea35cfe979d1521a492a57ab950f8b83.tar.bz2
gentoo-2-5f2241ceea35cfe979d1521a492a57ab950f8b83.zip
Add some documentation on how to use the eclass.
Diffstat (limited to 'eclass')
-rw-r--r--eclass/x-modular.eclass18
1 files changed, 17 insertions, 1 deletions
diff --git a/eclass/x-modular.eclass b/eclass/x-modular.eclass
index c9ca2da7b6da..f8f434b1e544 100644
--- a/eclass/x-modular.eclass
+++ b/eclass/x-modular.eclass
@@ -1,11 +1,27 @@
# Copyright 1999-2005 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Header: /var/cvsroot/gentoo-x86/eclass/x-modular.eclass,v 1.31 2005/12/12 01:43:28 spyderous Exp $
+# $Header: /var/cvsroot/gentoo-x86/eclass/x-modular.eclass,v 1.32 2005/12/12 01:56:08 spyderous Exp $
#
# Author: Donnie Berkholz <spyderous@gentoo.org>
#
# This eclass is designed to reduce code duplication in the modularized X11
# ebuilds.
+#
+# Using this eclass:
+#
+# Inherit it. If you need to run autoreconf for any reason (e.g., your patches
+# apply to the autotools files rather than configure), set SNAPSHOT="yes". Set
+# CONFIGURE_OPTIONS to everything you want to pass to the configure script.
+#
+# If you have any patches to apply, set PATCHES to their locations and epatch
+# will apply them. It also handles epatch-style bulk patches, if you know how to
+# use them and set the correct variables. If you don't, read eutils.eclass.
+#
+# If you're creating a font package and the suffix of PN is not equal to the
+# subdirectory of /usr/share/fonts/ it should install into, set FONT_DIR to that
+# directory or directories.
+#
+# Pretty much everything else should be automatic.
EXPORT_FUNCTIONS src_unpack src_compile src_install pkg_preinst pkg_postinst pkg_postrm