VIM.ECLASS(5)

NAME
vim - common build routines for vim-core, vim and gvim

DESCRIPTION
The vim eclass contains a suite of functions that are used to build vim-core, vim and gvim. The vim-core ebuild contains the common files installed in /usr/share/vim, /usr/share/doc and /etc/vim, as well as the binaries xxd and vimtutor. The vim ebuild contains the terminal-based version of vim. The gvim ebuild contains the graphical version of vim. All three of these are built from common source, common patches and using mostly-common configure options.

There are no functions to define in an ebuild using vim.eclass because the eclass does all the unpacking, compilation and installation.

VARIABLES

VIM_VERSION = "version string"
    This variable is important because the ebuild version (for example 6.2_pre5) corresponds to a vim version (for example 6.2e) but there is no way to make that jump without help from the ebuild author. Historically there was a method in the vim.eclass to calculate the vim version from the ebuild version, but that meant that the ebuild author had to make sure the ebuild was correctly versioned each time. To avoid that headache, it became easier to simply specify VIM_VERSION in the ebuild itself.

VIM_GENTOO_PATCHES = "filename"
    The filename of the Gentoo patches to apply. It's not always necessary to update the Gentoo patches for a new version of vim, so this variable separates the ebuild and vim versions from the patch tarball version. Take a look at vim-6.2.011-gentoo-patches.tar.bz2 for an example of the patch directory layout.

VIM_ORG_PATCHES = "filename"
    The filename of the vim patches to apply. This is a tarball of patches from ftp://ftp.vim.org/pub/vim/patches/ which apply to the current version. See vim-6.2.011-patches.tar.bz2 for an example of the vim.org patch tarballs.

REPORTING BUGS
Please report bugs via http://bugs.gentoo.org/

SEE ALSO
ebuild(5) vim(1)

FILES
/usr/portage/eclass/vim.eclass

AUTHORS
Aron Griffis <agriffis@gentoo.org>
Ryan Phillips <rphillips@gentoo.org>
Seemant Kulleen <seemant@gentoo.org>

CVS HEADER
$Header: /var/cvsroot/gentoo-src/portage/man/vim.eclass.5,v 1.3 2004/09/17 00:17:10 vapier Exp $