/[gentoo-x86]/eclass/cvs.eclass
Gentoo

Diff of /eclass/cvs.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.61 Revision 1.73
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2008 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/cvs.eclass,v 1.61 2005/09/21 23:22:56 vapier Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cvs.eclass,v 1.73 2010/08/21 19:36:45 vapier Exp $
4
5# @ECLASS: cvs.eclass
6# @MAINTAINER:
7# vapier@gentoo.org (and anyone who wants to help)
8# @BLURB: This eclass provides generic cvs fetching functions
9# @DESCRIPTION:
10# This eclass provides the generic cvs fetching functions. To use this from an
11# ebuild, set the ECLASS VARIABLES as specified below in your ebuild before
12# inheriting. Then either leave the default src_unpack or extend over
13# cvs_src_unpack. If you find that you need to call the cvs_* functions
14# directly, I'd be interested to hear about it.
4 15
5inherit eutils 16inherit eutils
6
7# This eclass provides the generic cvs fetching functions. To use
8# this from an ebuild, set the `ebuild-configurable settings' as
9# specified below in your ebuild before inheriting. Then either leave
10# the default src_unpack or extend over cvs_src_unpack. If you find
11# that you need to call the cvs_* functions directly, I'd be
12# interested to hear about it.
13 17
14# TODO: 18# TODO:
15 19
16# Implement more auth types (gserver?, kserver?) 20# Implement more auth types (gserver?, kserver?)
17 21
18# Support additional remote shells with `ext' authentication (does 22# Support additional remote shells with `ext' authentication (does
19# anyone actually need to use it with anything other than SSH?) 23# anyone actually need to use it with anything other than SSH?)
20
21 24
22 25
23# Users shouldn't change these settings! The ebuild/eclass inheriting 26# Users shouldn't change these settings! The ebuild/eclass inheriting
24# this eclass will take care of that. If you want to set the global 27# this eclass will take care of that. If you want to set the global
25# KDE cvs ebuilds' settings, see the comments in kde-source.eclass. 28# KDE cvs ebuilds' settings, see the comments in kde-source.eclass.
26 29
27# --- begin ebuild-configurable settings 30# @ECLASS-VARIABLE: ECVS_CVS_COMMAND
28 31# @DESCRIPTION:
29# ECVS_CVS_COMMAND -- CVS command to run 32# CVS command to run
30# 33#
31# You can set, for example, "cvs -t" for extensive debug information 34# You can set, for example, "cvs -t" for extensive debug information
32# on the cvs connection. The default of "cvs -q -f -z4" means to be 35# on the cvs connection. The default of "cvs -q -f -z4" means to be
33# quiet, to disregard the ~/.cvsrc config file and to use maximum 36# quiet, to disregard the ~/.cvsrc config file and to use maximum
34# compression. 37# compression.
38[[ -z ${ECVS_CVS_COMMAND} ]] && ECVS_CVS_COMMAND="cvs ${ECVS_CVS_OPTIONS} ${ECVS_CVS_COMPRESS}"
35 39
36[ -z "$ECVS_CVS_COMMAND" ] && ECVS_CVS_COMMAND="cvs -q -f -z4" 40# @ECLASS-VARIABLE: ECVS_CVS_COMPRESS
41# @DESCRIPTION:
42# Set the compression level.
43[[ -z ${ECVS_CVS_COMPRESS} ]] && ECVS_CVS_COMPRESS="-z1"
37 44
45# @ECLASS-VARIABLE: ECVS_CVS_OPTIONS
46# @DESCRIPTION:
47# Additional options to the cvs commands.
48[[ -z ${ECVS_CVS_OPTIONS} ]] && ECVS_CVS_OPTIONS="-q -f"
38 49
39# ECVS_UP_OPTS, ECVS_CO_OPTS -- CVS options given after the cvs 50# @ECLASS-VARIABLE: ECVS_UP_OPTS
40# command (update or checkout). 51# @DESCRIPTION:
41# 52# CVS options given after the cvs update command. Don't remove "-dP" or things
42# Don't remove -dP from update or things won't work. 53# won't work.
43
44[ -z "$ECVS_UP_OPTS" ] && ECVS_UP_OPTS="-dP" 54[ -z "$ECVS_UP_OPTS" ] && ECVS_UP_OPTS="-dP"
55
56# @ECLASS-VARIABLE: ECVS_CO_OPTS
57# @DESCRIPTION:
58# CVS options given after the cvs checkout command.
45[ -z "$ECVS_CO_OPTS" ] && ECVS_CO_OPTS="" 59[ -z "$ECVS_CO_OPTS" ] && ECVS_CO_OPTS=""
46 60
61# @ECLASS-VARIABLE: ECVS_OFFLINE
62# @DESCRIPTION:
63# Set this variable to a non-empty value to disable the automatic updating of
64# a CVS source tree. This is intended to be set outside the cvs source
65# tree by users.
66: ${ECVS_OFFLINE:=${ESCM_OFFLINE}}
47 67
68# @ECLASS-VARIABLE: ECVS_LOCAL
69# @DEFAULT_UNSET
70# @DESCRIPTION:
48# ECVS_LOCAL -- If this is set, the CVS module will be fetched 71# If this is set, the CVS module will be fetched non-recursively.
49# non-recursively. Refer to the information in the CVS man page 72# Refer to the information in the CVS man page regarding the -l
50# regarding the -l command option (not the -l global option). 73# command option (not the -l global option).
51 74
52 75# @ECLASS-VARIABLE: ECVS_LOCALNAME
76# @DEFAULT_UNSET
77# @DESCRIPTION:
53# ECVS_LOCALNAME -- local name of checkout directory 78# Local name of checkout directory
54# 79#
55# This is useful if the module on the server is called something 80# This is useful if the module on the server is called something
56# common like 'driver' or is nested deep in a tree, and you don't like 81# common like 'driver' or is nested deep in a tree, and you don't like
57# useless empty directories. 82# useless empty directories.
58# 83#
59# WARNING: Set this only from within ebuilds! If set in your shell or 84# WARNING: Set this only from within ebuilds! If set in your shell or
60# some such, things will break because the ebuild won't expect it and 85# some such, things will break because the ebuild won't expect it and
61# have e.g. a wrong $S setting. 86# have e.g. a wrong $S setting.
62 87
63 88# @ECLASS-VARIABLE: ECVS_TOP_DIR
89# @DESCRIPTION:
64# ECVS_TOP_DIR -- The directory under which CVS modules are checked 90# The directory under which CVS modules are checked out.
65# out.
66
67[ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${DISTDIR}/cvs-src" 91[ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}/cvs-src"
68 92
69# ECVS_SERVER -- CVS path 93# @ECLASS-VARIABLE: ECVS_SERVER
94# @DESCRIPTION:
95# CVS path
70# 96#
71# The format is "server:/dir", e.g. "anoncvs.kde.org:/home/kde". 97# The format is "server:/dir", e.g. "anoncvs.kde.org:/home/kde".
72# Remove the other parts of the full CVSROOT, which might look like 98# Remove the other parts of the full CVSROOT, which might look like
73# ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated 99# ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated
74# using other settings also. 100# using other settings also.
75# 101#
76# Set this to "offline" to disable fetching (i.e. to assume the module 102# Set this to "offline" to disable fetching (i.e. to assume the module
77# is already checked out in ECVS_TOP_DIR). 103# is already checked out in ECVS_TOP_DIR).
78
79[ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline" 104[ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline"
80 105
81 106# @ECLASS-VARIABLE: ECVS_MODULE
107# @REQUIRED
108# @DESCRIPTION:
82# ECVS_MODULE -- the name of the CVS module to be fetched 109# The name of the CVS module to be fetched
83# 110#
84# This must be set when cvs_src_unpack is called. This can include 111# This must be set when cvs_src_unpack is called. This can include
85# several directory levels, i.e. "foo/bar/baz" 112# several directory levels, i.e. "foo/bar/baz"
86 113
87#[ -z "$ECVS_MODULE" ] && die "$ECLASS: error: ECVS_MODULE not set, cannot continue" 114#[ -z "$ECVS_MODULE" ] && die "$ECLASS: error: ECVS_MODULE not set, cannot continue"
88 115
89 116# @ECLASS-VARIABLE: ECVS_BRANCH
117# @DEFAULT_UNSET
118# @DESCRIPTION:
90# ECVS_BRANCH -- the name of the branch/tag to use 119# The name of the branch/tag to use
91 120#
92# The default is "HEAD". The following default _will_ reset your 121# The default is "HEAD". The following default _will_ reset your
93# branch checkout to head if used. 122# branch checkout to head if used.
94 123
95#[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD" 124#[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD"
96 125
97 126# @ECLASS-VARIABLE: ECVS_AUTH
127# @DESCRIPTION:
98# ECVS_AUTH -- authentication method to use 128# Authentication method to use
99# 129#
100# Possible values are "pserver" and "ext". If `ext' authentication is 130# Possible values are "pserver" and "ext". If `ext' authentication is
101# used, the remote shell to use can be specified in CVS_RSH (SSH is 131# used, the remote shell to use can be specified in CVS_RSH (SSH is
102# used by default). Currently, the only supported remote shell for 132# used by default). Currently, the only supported remote shell for
103# `ext' authentication is SSH. 133# `ext' authentication is SSH.
108# e.g. 138# e.g.
109# "cvs -danoncvs@savannah.gnu.org:/cvsroot/backbone co System" 139# "cvs -danoncvs@savannah.gnu.org:/cvsroot/backbone co System"
110# ( from gnustep-apps/textedit ) 140# ( from gnustep-apps/textedit )
111[ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver" 141[ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver"
112 142
143# @ECLASS-VARIABLE: ECVS_USER
144# @DESCRIPTION:
113# ECVS_USER -- Username to use for authentication on the remote server 145# Username to use for authentication on the remote server.
114[ -z "$ECVS_USER" ] && ECVS_USER="anonymous" 146[ -z "$ECVS_USER" ] && ECVS_USER="anonymous"
115 147
116 148# @ECLASS-VARIABLE: ECVS_PASS
149# @DESCRIPTION:
117# ECVS_PASS -- Password to use for authentication on the remote server 150# Password to use for authentication on the remote server
118[ -z "$ECVS_PASS" ] && ECVS_PASS="" 151[ -z "$ECVS_PASS" ] && ECVS_PASS=""
119 152
120 153# @ECLASS-VARIABLE: ECVS_SSH_HOST_KEY
121# ECVS_SSH_HOST_KEY 154# @DEFAULT_UNSET
122# 155# @DESCRIPTION:
123# If SSH is used for `ext' authentication, use this variable to 156# If SSH is used for `ext' authentication, use this variable to
124# specify the host key of the remote server. The format of the value 157# specify the host key of the remote server. The format of the value
125# should be the same format that is used for the SSH known hosts file. 158# should be the same format that is used for the SSH known hosts file.
126# 159#
127# WARNING: If a SSH host key is not specified using this variable, the 160# WARNING: If a SSH host key is not specified using this variable, the
128# remote host key will not be verified. 161# remote host key will not be verified.
129 162
130 163# @ECLASS-VARIABLE: ECVS_CLEAN
164# @DEFAULT_UNSET
165# @DESCRIPTION:
131# ECVS_CLEAN -- Set this to get a clean copy when updating (passes the 166# Set this to get a clean copy when updating (passes the
132# -C option to cvs update) 167# -C option to cvs update)
133 168
134 169# @ECLASS-VARIABLE: ECVS_RUNAS
135# ECVS_RUNAS 170# @DEFAULT_UNSET
136# 171# @DESCRIPTION:
137# Specifies an alternate (non-root) user to use to run cvs. Currently 172# Specifies an alternate (non-root) user to use to run cvs. Currently
138# b0rked and wouldn't work with portage userpriv anyway without 173# b0rked and wouldn't work with portage userpriv anyway without
139# special magic. 174# special magic.
140 175
141# [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`" 176# [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`"
142 177
143
144# ECVS_SUBDIR -- deprecated, do not use 178# ECVS_SUBDIR -- deprecated, do not use
145[ -n "$ECVS_SUBDIR" ] && die "ERROR: deprecated ECVS_SUBDIR defined. Please fix this ebuild." 179[ -n "$ECVS_SUBDIR" ] && die "ERROR: deprecated ECVS_SUBDIR defined. Please fix this ebuild."
146
147
148# --- end ebuild-configurable settings ---
149 180
150# add cvs to deps 181# add cvs to deps
151# ssh is used for ext auth 182# ssh is used for ext auth
152# sudo is used to run as a specified user 183# sudo is used to run as a specified user
153DEPEND="dev-util/cvs" 184DEPEND="dev-vcs/cvs"
154 185
155[ -n "$ECVS_RUNAS" ] && DEPEND="$DEPEND app-admin/sudo" 186[ -n "$ECVS_RUNAS" ] && DEPEND="$DEPEND app-admin/sudo"
156 187
157if [ "$ECVS_AUTH" == "ext" ]; then 188if [ "$ECVS_AUTH" == "ext" ]; then
158 #default to ssh 189 #default to ssh
170 # not affected by modifications in this function. 201 # not affected by modifications in this function.
171 202
172 local ECVS_COMMAND="${ECVS_COMMAND}" 203 local ECVS_COMMAND="${ECVS_COMMAND}"
173 local ECVS_UP_OPTS="${ECVS_UP_OPTS}" 204 local ECVS_UP_OPTS="${ECVS_UP_OPTS}"
174 local ECVS_CO_OPTS="${ECVS_CO_OPTS}" 205 local ECVS_CO_OPTS="${ECVS_CO_OPTS}"
175
176 # Fix for sourceforge which doesnt want -z>3 anymore.
177
178 (echo $ECVS_SERVER | grep -q sourceforge) \
179 && [ "$ECVS_CVS_COMMAND" == "cvs -q -f -z4" ] \
180 && ECVS_CVS_COMMAND="cvs -q -f -z3"
181 206
182 debug-print-function $FUNCNAME $* 207 debug-print-function $FUNCNAME $*
183 208
184 # Update variables that are modified by ebuild parameters, which 209 # Update variables that are modified by ebuild parameters, which
185 # should be effective every time cvs_fetch is called, and not just 210 # should be effective every time cvs_fetch is called, and not just
271 # be put in Root 296 # be put in Root
272 if [ "$ECVS_AUTH" == "no" ] 297 if [ "$ECVS_AUTH" == "no" ]
273 then 298 then
274 local server="${ECVS_USER}@${ECVS_SERVER}" 299 local server="${ECVS_USER}@${ECVS_SERVER}"
275 else 300 else
301 local connection="${ECVS_AUTH}"
302 [[ -n ${ECVS_PROXY} ]] && connection="${connection};proxy=${ECVS_PROXY}"
303 [[ -n ${ECVS_PROXY_PORT} ]] && connection="${connection};proxyport=${ECVS_PROXY_PORT}"
276 local server=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}" 304 local server=":${connection}:${ECVS_USER}@${ECVS_SERVER}"
277 fi 305 fi
278 306
279 # Switch servers automagically if needed 307 # Switch servers automagically if needed
280 if [ "$mode" == "update" ]; then 308 if [ "$mode" == "update" ]; then
281 cd /$ECVS_TOP_DIR/$ECVS_LOCALNAME 309 cd /$ECVS_TOP_DIR/$ECVS_LOCALNAME
460 chown `whoami` "${T}/cvspass" 488 chown `whoami` "${T}/cvspass"
461 fi 489 fi
462 490
463} 491}
464 492
465 493# @FUNCTION: cvs_src_unpack
494# @DESCRIPTION:
495# The cvs src_unpack function, which will be exported
466cvs_src_unpack() { 496cvs_src_unpack() {
467 497
468 debug-print-function $FUNCNAME $* 498 debug-print-function $FUNCNAME $*
469 499
470 debug-print "$FUNCNAME: init: 500 debug-print "$FUNCNAME: init:
483 [ -z "$ECVS_MODULE" ] && die "ERROR: CVS module not set, cannot continue." 513 [ -z "$ECVS_MODULE" ] && die "ERROR: CVS module not set, cannot continue."
484 514
485 local ECVS_LOCALNAME="${ECVS_LOCALNAME}" 515 local ECVS_LOCALNAME="${ECVS_LOCALNAME}"
486 516
487 if [ -z "$ECVS_LOCALNAME" ]; then 517 if [ -z "$ECVS_LOCALNAME" ]; then
488 ECVS_LOCALNAME="$ECVS_MODULE" 518 ECVS_LOCALNAME="$ECVS_MODULE"
489 fi 519 fi
490 520
491 if [ "$ECVS_SERVER" == "offline" ]; then 521 local sanitized_pn=$(echo "${PN}" | LC_ALL=C sed -e 's:[^A-Za-z0-9_]:_:g')
522 local offline_pkg_var="ECVS_OFFLINE_${sanitized_pn}"
523 if [[ -n ${!offline_pkg_var}${ECVS_OFFLINE} ]] || [[ "$ECVS_SERVER" == "offline" ]] ; then
492 # We're not required to fetch anything; the module already 524 # We're not required to fetch anything; the module already
493 # exists and shouldn't be updated. 525 # exists and shouldn't be updated.
494 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then 526 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then
495 debug-print "$FUNCNAME: offline mode" 527 debug-print "$FUNCNAME: offline mode"
496 else 528 else
497 debug-print "$FUNCNAME: Offline mode specified but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found, exiting with error" 529 debug-print "$FUNCNAME: Offline mode specified but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found, exiting with error"
498 die "ERROR: Offline mode specified, but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found. Aborting." 530 die "ERROR: Offline mode specified, but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found. Aborting."
499 fi 531 fi

Legend:
Removed from v.1.61  
changed lines
  Added in v.1.73

  ViewVC Help
Powered by ViewVC 1.1.20