CVS.ECLASS(5)

NAME
cvs - provides generic cvs fetching functions

DESCRIPTION
The cvs eclass contains a suite of functions that are used to create 'live' cvs ebuilds. These ebuilds are called 'live' because they will checkout a cvs repository at the time of emerge and compile the source from the checkout. This eclass usually generates pretty unstable ebuilds ... but you can't get anymore bleeding edge than a live cvs checkout :).
Common usage of this eclass involves setting ECVS_SERVER and ECVS_MODULE to grab the relevant cvs sources, and then letting the eclass define src_unpack for you.

VARIABLES

ECVS_CVS_COMMAND = "cvs -q -f -z4"
    The command to run in order to checkout the module from the cvs repository. You should not need to change this.

ECVS_UP_OPTS = "-dP"
    Options to pass to ECVS_CVS_COMMAND when running an update. You should not have to modify this.

ECVS_CO_OPTS = ""
    Options to pass to ECVS_CVS_COMMAND when running a checkout. You should not have to modify this.

ECVS_TOP_DIR = "${DISTDIR}/cvs-src"
    Where the cvs modules will be stored and then accessed. You should not have to modify this.

ECVS_SERVER = "offline"
    Set this to the server that you will be checking the sources out of. If you set this to 'offline' then the eclass will assume the module is already checked out and in ECVS_TOP_DIR. You almost always will set this variable.

ECVS_AUTH = "pserver"
    The authentication method to use to checkout the sources. Please note that the only method currently supported is 'pserver'. You should not need to modify this variable.

ECVS_USER = "anonymous"
    The user to log into the server with.

ECVS_PASS = ""
    The password to log into the server with.

ECVS_MODULE = ""
    The module to checkout from the cvs server. Please note that you *must* set this variable.

ECVS_BRANCH = "HEAD"
    The branch to checkout the sources from. The common targets are HEAD (current 'stable' cvs code) and SPLIT (current 'unstable' cvs code).

FUNCTIONS

cvs_fetch
    This function will setup ECVS_TOP_DIR and any other pre-checkout steps that may need to be taken. Then it will login into the server and finally checkout the sources from cvs. You usually do not call this function yourself, but rather let it be handled by cvs_src_unpack.

cvs_src_unpack
    This function will determine where the cvs files need to be saved and then where they need to be placed after the checkout. The final result is that you will have a copy of ECVS_MODULE in ${WORKDIR}. Thus you will usually set ${S} to be ${WORKDIR}/${ECVS_MODULE}.

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

SEE ALSO
ebuild(5)

FILES
/usr/portage/eclass/cvs.eclass

AUTHORS
Mike Frysinger <vapier@gentoo.org>

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