/[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.78
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2013 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.78 2013/01/22 07:02:06 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.
15
16if [[ ${___ECLASS_ONCE_CVS} != "recur -_+^+_- spank" ]] ; then
17___ECLASS_ONCE_CVS="recur -_+^+_- spank"
4 18
5inherit eutils 19inherit 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 20
14# TODO: 21# TODO:
15 22
16# Implement more auth types (gserver?, kserver?) 23# Implement more auth types (gserver?, kserver?)
17 24
18# Support additional remote shells with `ext' authentication (does 25# Support additional remote shells with `ext' authentication (does
19# anyone actually need to use it with anything other than SSH?) 26# anyone actually need to use it with anything other than SSH?)
20
21 27
22 28
23# Users shouldn't change these settings! The ebuild/eclass inheriting 29# 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 30# 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. 31# KDE cvs ebuilds' settings, see the comments in kde-source.eclass.
26 32
27# --- begin ebuild-configurable settings 33# @ECLASS-VARIABLE: ECVS_CVS_COMPRESS
34# @DESCRIPTION:
35# Set the default compression level. Has no effect when ECVS_CVS_COMMAND
36# is defined by ebuild/user.
37: ${ECVS_CVS_COMPRESS:=-z1}
28 38
29# ECVS_CVS_COMMAND -- CVS command to run 39# @ECLASS-VARIABLE: ECVS_CVS_OPTIONS
40# @DESCRIPTION:
41# Additional options to the cvs commands. Has no effect when ECVS_CVS_COMMAND
42# is defined by ebuild/user.
43: ${ECVS_CVS_OPTIONS:=-q -f}
44
45# @ECLASS-VARIABLE: ECVS_CVS_COMMAND
46# @DESCRIPTION:
47# CVS command to run
30# 48#
31# You can set, for example, "cvs -t" for extensive debug information 49# 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 50# 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 51# quiet, to disregard the ~/.cvsrc config file and to use maximum
34# compression. 52# compression.
53: ${ECVS_CVS_COMMAND:=cvs ${ECVS_CVS_OPTIONS} ${ECVS_CVS_COMPRESS}}
35 54
36[ -z "$ECVS_CVS_COMMAND" ] && ECVS_CVS_COMMAND="cvs -q -f -z4" 55# @ECLASS-VARIABLE: ECVS_UP_OPTS
56# @DESCRIPTION:
57# CVS options given after the cvs update command. Don't remove "-dP" or things
58# won't work.
59: ${ECVS_UP_OPTS:=-dP}
37 60
61# @ECLASS-VARIABLE: ECVS_CO_OPTS
62# @DEFAULT_UNSET
63# @DESCRIPTION:
64# CVS options given after the cvs checkout command.
38 65
39# ECVS_UP_OPTS, ECVS_CO_OPTS -- CVS options given after the cvs 66# @ECLASS-VARIABLE: ECVS_OFFLINE
40# command (update or checkout). 67# @DESCRIPTION:
41# 68# Set this variable to a non-empty value to disable the automatic updating of
42# Don't remove -dP from update or things won't work. 69# a CVS source tree. This is intended to be set outside the cvs source
70# tree by users.
71: ${ECVS_OFFLINE:=${EVCS_OFFLINE}}
43 72
44[ -z "$ECVS_UP_OPTS" ] && ECVS_UP_OPTS="-dP" 73# @ECLASS-VARIABLE: ECVS_LOCAL
45[ -z "$ECVS_CO_OPTS" ] && ECVS_CO_OPTS="" 74# @DEFAULT_UNSET
46 75# @DESCRIPTION:
47
48# ECVS_LOCAL -- If this is set, the CVS module will be fetched 76# If this is set, the CVS module will be fetched non-recursively.
49# non-recursively. Refer to the information in the CVS man page 77# Refer to the information in the CVS man page regarding the -l
50# regarding the -l command option (not the -l global option). 78# command option (not the -l global option).
51 79
52 80# @ECLASS-VARIABLE: ECVS_LOCALNAME
81# @DEFAULT_UNSET
82# @DESCRIPTION:
53# ECVS_LOCALNAME -- local name of checkout directory 83# Local name of checkout directory
54# 84#
55# This is useful if the module on the server is called something 85# 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 86# common like 'driver' or is nested deep in a tree, and you don't like
57# useless empty directories. 87# useless empty directories.
58# 88#
59# WARNING: Set this only from within ebuilds! If set in your shell or 89# 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 90# some such, things will break because the ebuild won't expect it and
61# have e.g. a wrong $S setting. 91# have e.g. a wrong $S setting.
62 92
63 93# @ECLASS-VARIABLE: ECVS_TOP_DIR
94# @DESCRIPTION:
64# ECVS_TOP_DIR -- The directory under which CVS modules are checked 95# The directory under which CVS modules are checked out.
65# out.
66
67[ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${DISTDIR}/cvs-src" 96[ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}/cvs-src"
68 97
69# ECVS_SERVER -- CVS path 98# @ECLASS-VARIABLE: ECVS_SERVER
99# @DESCRIPTION:
100# CVS path
70# 101#
71# The format is "server:/dir", e.g. "anoncvs.kde.org:/home/kde". 102# 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 103# Remove the other parts of the full CVSROOT, which might look like
73# ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated 104# ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated
74# using other settings also. 105# using other settings also.
75# 106#
76# Set this to "offline" to disable fetching (i.e. to assume the module 107# Set this to "offline" to disable fetching (i.e. to assume the module
77# is already checked out in ECVS_TOP_DIR). 108# is already checked out in ECVS_TOP_DIR).
78
79[ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline" 109[ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline"
80 110
81 111# @ECLASS-VARIABLE: ECVS_MODULE
112# @REQUIRED
113# @DESCRIPTION:
82# ECVS_MODULE -- the name of the CVS module to be fetched 114# The name of the CVS module to be fetched
83# 115#
84# This must be set when cvs_src_unpack is called. This can include 116# This must be set when cvs_src_unpack is called. This can include
85# several directory levels, i.e. "foo/bar/baz" 117# several directory levels, i.e. "foo/bar/baz"
86 118
87#[ -z "$ECVS_MODULE" ] && die "$ECLASS: error: ECVS_MODULE not set, cannot continue" 119#[ -z "$ECVS_MODULE" ] && die "$ECLASS: error: ECVS_MODULE not set, cannot continue"
88 120
89 121# @ECLASS-VARIABLE: ECVS_BRANCH
122# @DEFAULT_UNSET
123# @DESCRIPTION:
90# ECVS_BRANCH -- the name of the branch/tag to use 124# The name of the branch/tag to use
91 125#
92# The default is "HEAD". The following default _will_ reset your 126# The default is "HEAD". The following default _will_ reset your
93# branch checkout to head if used. 127# branch checkout to head if used.
94 128
95#[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD" 129#[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD"
96 130
97 131# @ECLASS-VARIABLE: ECVS_AUTH
132# @DESCRIPTION:
98# ECVS_AUTH -- authentication method to use 133# Authentication method to use
99# 134#
100# Possible values are "pserver" and "ext". If `ext' authentication is 135# 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 136# 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 137# used by default). Currently, the only supported remote shell for
103# `ext' authentication is SSH. 138# `ext' authentication is SSH.
108# e.g. 143# e.g.
109# "cvs -danoncvs@savannah.gnu.org:/cvsroot/backbone co System" 144# "cvs -danoncvs@savannah.gnu.org:/cvsroot/backbone co System"
110# ( from gnustep-apps/textedit ) 145# ( from gnustep-apps/textedit )
111[ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver" 146[ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver"
112 147
148# @ECLASS-VARIABLE: ECVS_USER
149# @DESCRIPTION:
113# ECVS_USER -- Username to use for authentication on the remote server 150# Username to use for authentication on the remote server.
114[ -z "$ECVS_USER" ] && ECVS_USER="anonymous" 151[ -z "$ECVS_USER" ] && ECVS_USER="anonymous"
115 152
116 153# @ECLASS-VARIABLE: ECVS_PASS
154# @DESCRIPTION:
117# ECVS_PASS -- Password to use for authentication on the remote server 155# Password to use for authentication on the remote server
118[ -z "$ECVS_PASS" ] && ECVS_PASS="" 156[ -z "$ECVS_PASS" ] && ECVS_PASS=""
119 157
120 158# @ECLASS-VARIABLE: ECVS_SSH_HOST_KEY
121# ECVS_SSH_HOST_KEY 159# @DEFAULT_UNSET
122# 160# @DESCRIPTION:
123# If SSH is used for `ext' authentication, use this variable to 161# 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 162# 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. 163# should be the same format that is used for the SSH known hosts file.
126# 164#
127# WARNING: If a SSH host key is not specified using this variable, the 165# WARNING: If a SSH host key is not specified using this variable, the
128# remote host key will not be verified. 166# remote host key will not be verified.
129 167
130 168# @ECLASS-VARIABLE: ECVS_CLEAN
169# @DEFAULT_UNSET
170# @DESCRIPTION:
131# ECVS_CLEAN -- Set this to get a clean copy when updating (passes the 171# Set this to get a clean copy when updating (passes the
132# -C option to cvs update) 172# -C option to cvs update)
133 173
134 174# @ECLASS-VARIABLE: ECVS_RUNAS
135# ECVS_RUNAS 175# @DEFAULT_UNSET
136# 176# @DESCRIPTION:
137# Specifies an alternate (non-root) user to use to run cvs. Currently 177# Specifies an alternate (non-root) user to use to run cvs. Currently
138# b0rked and wouldn't work with portage userpriv anyway without 178# b0rked and wouldn't work with portage userpriv anyway without
139# special magic. 179# special magic.
140 180
141# [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`" 181# [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`"
142 182
143
144# ECVS_SUBDIR -- deprecated, do not use 183# ECVS_SUBDIR -- deprecated, do not use
145[ -n "$ECVS_SUBDIR" ] && die "ERROR: deprecated ECVS_SUBDIR defined. Please fix this ebuild." 184[ -n "$ECVS_SUBDIR" ] && die "ERROR: deprecated ECVS_SUBDIR defined. Please fix this ebuild."
146
147
148# --- end ebuild-configurable settings ---
149 185
150# add cvs to deps 186# add cvs to deps
151# ssh is used for ext auth 187# ssh is used for ext auth
152# sudo is used to run as a specified user 188# sudo is used to run as a specified user
153DEPEND="dev-util/cvs" 189DEPEND="dev-vcs/cvs"
154 190
155[ -n "$ECVS_RUNAS" ] && DEPEND="$DEPEND app-admin/sudo" 191[ -n "$ECVS_RUNAS" ] && DEPEND="$DEPEND app-admin/sudo"
156 192
157if [ "$ECVS_AUTH" == "ext" ]; then 193if [ "$ECVS_AUTH" == "ext" ]; then
158 #default to ssh 194 #default to ssh
170 # not affected by modifications in this function. 206 # not affected by modifications in this function.
171 207
172 local ECVS_COMMAND="${ECVS_COMMAND}" 208 local ECVS_COMMAND="${ECVS_COMMAND}"
173 local ECVS_UP_OPTS="${ECVS_UP_OPTS}" 209 local ECVS_UP_OPTS="${ECVS_UP_OPTS}"
174 local ECVS_CO_OPTS="${ECVS_CO_OPTS}" 210 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 211
182 debug-print-function $FUNCNAME $* 212 debug-print-function $FUNCNAME $*
183 213
184 # Update variables that are modified by ebuild parameters, which 214 # Update variables that are modified by ebuild parameters, which
185 # should be effective every time cvs_fetch is called, and not just 215 # should be effective every time cvs_fetch is called, and not just
271 # be put in Root 301 # be put in Root
272 if [ "$ECVS_AUTH" == "no" ] 302 if [ "$ECVS_AUTH" == "no" ]
273 then 303 then
274 local server="${ECVS_USER}@${ECVS_SERVER}" 304 local server="${ECVS_USER}@${ECVS_SERVER}"
275 else 305 else
306 local connection="${ECVS_AUTH}"
307 [[ -n ${ECVS_PROXY} ]] && connection="${connection};proxy=${ECVS_PROXY}"
308 [[ -n ${ECVS_PROXY_PORT} ]] && connection="${connection};proxyport=${ECVS_PROXY_PORT}"
276 local server=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}" 309 local server=":${connection}:${ECVS_USER}@${ECVS_SERVER}"
277 fi 310 fi
278 311
279 # Switch servers automagically if needed 312 # Switch servers automagically if needed
280 if [ "$mode" == "update" ]; then 313 if [ "$mode" == "update" ]; then
281 cd /$ECVS_TOP_DIR/$ECVS_LOCALNAME 314 cd /$ECVS_TOP_DIR/$ECVS_LOCALNAME
460 chown `whoami` "${T}/cvspass" 493 chown `whoami` "${T}/cvspass"
461 fi 494 fi
462 495
463} 496}
464 497
465 498# @FUNCTION: cvs_src_unpack
499# @DESCRIPTION:
500# The cvs src_unpack function, which will be exported
466cvs_src_unpack() { 501cvs_src_unpack() {
467 502
468 debug-print-function $FUNCNAME $* 503 debug-print-function $FUNCNAME $*
469 504
470 debug-print "$FUNCNAME: init: 505 debug-print "$FUNCNAME: init:
483 [ -z "$ECVS_MODULE" ] && die "ERROR: CVS module not set, cannot continue." 518 [ -z "$ECVS_MODULE" ] && die "ERROR: CVS module not set, cannot continue."
484 519
485 local ECVS_LOCALNAME="${ECVS_LOCALNAME}" 520 local ECVS_LOCALNAME="${ECVS_LOCALNAME}"
486 521
487 if [ -z "$ECVS_LOCALNAME" ]; then 522 if [ -z "$ECVS_LOCALNAME" ]; then
488 ECVS_LOCALNAME="$ECVS_MODULE" 523 ECVS_LOCALNAME="$ECVS_MODULE"
489 fi 524 fi
490 525
491 if [ "$ECVS_SERVER" == "offline" ]; then 526 local sanitized_pn=$(echo "${PN}" | LC_ALL=C sed -e 's:[^A-Za-z0-9_]:_:g')
527 local offline_pkg_var="ECVS_OFFLINE_${sanitized_pn}"
528 if [[ -n ${!offline_pkg_var}${ECVS_OFFLINE} ]] || [[ "$ECVS_SERVER" == "offline" ]] ; then
492 # We're not required to fetch anything; the module already 529 # We're not required to fetch anything; the module already
493 # exists and shouldn't be updated. 530 # exists and shouldn't be updated.
494 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then 531 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then
495 debug-print "$FUNCNAME: offline mode" 532 debug-print "$FUNCNAME: offline mode"
496 else 533 else
497 debug-print "$FUNCNAME: Offline mode specified but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found, exiting with error" 534 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." 535 die "ERROR: Offline mode specified, but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found. Aborting."
499 fi 536 fi
513 if [ -n "$ECVS_LOCAL" ]; then 550 if [ -n "$ECVS_LOCAL" ]; then
514 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME" 551 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME"
515 else 552 else
516 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.." 553 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.."
517 fi 554 fi
555
556 # Not exactly perfect, but should be pretty close #333773
557 export ECVS_VERSION=$(find "$ECVS_TOP_DIR/$ECVS_LOCALNAME/" -ipath '*/CVS/Entries' -exec cat {} + | LC_ALL=C sort | sha1sum | awk '{print $1}')
518 558
519 # If the directory is empty, remove it; empty directories cannot 559 # If the directory is empty, remove it; empty directories cannot
520 # exist in cvs. This happens when, for example, kde-source 560 # exist in cvs. This happens when, for example, kde-source
521 # requests module/doc/subdir which doesn't exist. Still create 561 # requests module/doc/subdir which doesn't exist. Still create
522 # the empty directory in workdir though. 562 # the empty directory in workdir though.
539 579
540 einfo "CVS module ${ECVS_MODULE} is now in ${WORKDIR}" 580 einfo "CVS module ${ECVS_MODULE} is now in ${WORKDIR}"
541} 581}
542 582
543EXPORT_FUNCTIONS src_unpack 583EXPORT_FUNCTIONS src_unpack
584
585fi

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

  ViewVC Help
Powered by ViewVC 1.1.20