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

Diff of /eclass/cvs.eclass

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

Revision 1.59 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.59 2005/08/13 08:10:53 phreak Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cvs.eclass,v 1.78 2013/01/22 07:02:06 vapier Exp $
4 4
5# Current Maintainer: Tal Peer <coredumb@gentoo.org> 5# @ECLASS: cvs.eclass
6# Original Author: Dan Armak <danarmak@gentoo.org> 6# @MAINTAINER:
7 7# vapier@gentoo.org (and anyone who wants to help)
8# SSH auth code by Danny <danny.milo@gmx.net> 8# @BLURB: This eclass provides generic cvs fetching functions
9 9# @DESCRIPTION:
10# SSH password authentication support and host key verification
11# support by Jeremy Maitin-Shepard <jbms@gentoo.org>
12
13
14# This eclass provides the generic cvs fetching functions. To use 10# This eclass provides the generic cvs fetching functions. To use this from an
15# this from an ebuild, set the `ebuild-configurable settings' as 11# ebuild, set the ECLASS VARIABLES as specified below in your ebuild before
16# specified below in your ebuild before inheriting. Then either leave 12# inheriting. Then either leave the default src_unpack or extend over
17# the default src_unpack or extend over cvs_src_unpack. If you find 13# cvs_src_unpack. If you find that you need to call the cvs_* functions
18# that you need to call the cvs_* functions directly, I'd be
19# interested to hear about it. 14# directly, I'd be interested to hear about it.
15
16if [[ ${___ECLASS_ONCE_CVS} != "recur -_+^+_- spank" ]] ; then
17___ECLASS_ONCE_CVS="recur -_+^+_- spank"
18
19inherit eutils
20 20
21# TODO: 21# TODO:
22 22
23# Implement more auth types (gserver?, kserver?) 23# Implement more auth types (gserver?, kserver?)
24 24
25# Support additional remote shells with `ext' authentication (does 25# Support additional remote shells with `ext' authentication (does
26# anyone actually need to use it with anything other than SSH?) 26# anyone actually need to use it with anything other than SSH?)
27
28 27
29 28
30# Users shouldn't change these settings! The ebuild/eclass inheriting 29# Users shouldn't change these settings! The ebuild/eclass inheriting
31# 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
32# KDE cvs ebuilds' settings, see the comments in kde-source.eclass. 31# KDE cvs ebuilds' settings, see the comments in kde-source.eclass.
33 32
34# --- 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}
35 38
36# 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
37# 48#
38# You can set, for example, "cvs -t" for extensive debug information 49# You can set, for example, "cvs -t" for extensive debug information
39# 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
40# quiet, to disregard the ~/.cvsrc config file and to use maximum 51# quiet, to disregard the ~/.cvsrc config file and to use maximum
41# compression. 52# compression.
53: ${ECVS_CVS_COMMAND:=cvs ${ECVS_CVS_OPTIONS} ${ECVS_CVS_COMPRESS}}
42 54
43[ -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}
44 60
61# @ECLASS-VARIABLE: ECVS_CO_OPTS
62# @DEFAULT_UNSET
63# @DESCRIPTION:
64# CVS options given after the cvs checkout command.
45 65
46# ECVS_UP_OPTS, ECVS_CO_OPTS -- CVS options given after the cvs 66# @ECLASS-VARIABLE: ECVS_OFFLINE
47# command (update or checkout). 67# @DESCRIPTION:
48# 68# Set this variable to a non-empty value to disable the automatic updating of
49# 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}}
50 72
51[ -z "$ECVS_UP_OPTS" ] && ECVS_UP_OPTS="-dP" 73# @ECLASS-VARIABLE: ECVS_LOCAL
52[ -z "$ECVS_CO_OPTS" ] && ECVS_CO_OPTS="" 74# @DEFAULT_UNSET
53 75# @DESCRIPTION:
54
55# 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.
56# non-recursively. Refer to the information in the CVS man page 77# Refer to the information in the CVS man page regarding the -l
57# regarding the -l command option (not the -l global option). 78# command option (not the -l global option).
58 79
59 80# @ECLASS-VARIABLE: ECVS_LOCALNAME
81# @DEFAULT_UNSET
82# @DESCRIPTION:
60# ECVS_LOCALNAME -- local name of checkout directory 83# Local name of checkout directory
61# 84#
62# 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
63# 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
64# useless empty directories. 87# useless empty directories.
65# 88#
66# 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
67# 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
68# have e.g. a wrong $S setting. 91# have e.g. a wrong $S setting.
69 92
70 93# @ECLASS-VARIABLE: ECVS_TOP_DIR
94# @DESCRIPTION:
71# ECVS_TOP_DIR -- The directory under which CVS modules are checked 95# The directory under which CVS modules are checked out.
72# out.
73
74[ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${DISTDIR}/cvs-src" 96[ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}/cvs-src"
75 97
76# ECVS_SERVER -- CVS path 98# @ECLASS-VARIABLE: ECVS_SERVER
99# @DESCRIPTION:
100# CVS path
77# 101#
78# 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".
79# 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
80# ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated 104# ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated
81# using other settings also. 105# using other settings also.
82# 106#
83# 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
84# is already checked out in ECVS_TOP_DIR). 108# is already checked out in ECVS_TOP_DIR).
85
86[ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline" 109[ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline"
87 110
88 111# @ECLASS-VARIABLE: ECVS_MODULE
112# @REQUIRED
113# @DESCRIPTION:
89# ECVS_MODULE -- the name of the CVS module to be fetched 114# The name of the CVS module to be fetched
90# 115#
91# 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
92# several directory levels, i.e. "foo/bar/baz" 117# several directory levels, i.e. "foo/bar/baz"
93 118
94#[ -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"
95 120
96 121# @ECLASS-VARIABLE: ECVS_BRANCH
122# @DEFAULT_UNSET
123# @DESCRIPTION:
97# ECVS_BRANCH -- the name of the branch/tag to use 124# The name of the branch/tag to use
98 125#
99# The default is "HEAD". The following default _will_ reset your 126# The default is "HEAD". The following default _will_ reset your
100# branch checkout to head if used. 127# branch checkout to head if used.
101 128
102#[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD" 129#[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD"
103 130
104 131# @ECLASS-VARIABLE: ECVS_AUTH
132# @DESCRIPTION:
105# ECVS_AUTH -- authentication method to use 133# Authentication method to use
106# 134#
107# Possible values are "pserver" and "ext". If `ext' authentication is 135# Possible values are "pserver" and "ext". If `ext' authentication is
108# 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
109# used by default). Currently, the only supported remote shell for 137# used by default). Currently, the only supported remote shell for
110# `ext' authentication is SSH. 138# `ext' authentication is SSH.
115# e.g. 143# e.g.
116# "cvs -danoncvs@savannah.gnu.org:/cvsroot/backbone co System" 144# "cvs -danoncvs@savannah.gnu.org:/cvsroot/backbone co System"
117# ( from gnustep-apps/textedit ) 145# ( from gnustep-apps/textedit )
118[ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver" 146[ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver"
119 147
148# @ECLASS-VARIABLE: ECVS_USER
149# @DESCRIPTION:
120# ECVS_USER -- Username to use for authentication on the remote server 150# Username to use for authentication on the remote server.
121[ -z "$ECVS_USER" ] && ECVS_USER="anonymous" 151[ -z "$ECVS_USER" ] && ECVS_USER="anonymous"
122 152
123 153# @ECLASS-VARIABLE: ECVS_PASS
154# @DESCRIPTION:
124# ECVS_PASS -- Password to use for authentication on the remote server 155# Password to use for authentication on the remote server
125[ -z "$ECVS_PASS" ] && ECVS_PASS="" 156[ -z "$ECVS_PASS" ] && ECVS_PASS=""
126 157
127 158# @ECLASS-VARIABLE: ECVS_SSH_HOST_KEY
128# ECVS_SSH_HOST_KEY 159# @DEFAULT_UNSET
129# 160# @DESCRIPTION:
130# If SSH is used for `ext' authentication, use this variable to 161# If SSH is used for `ext' authentication, use this variable to
131# 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
132# 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.
133# 164#
134# 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
135# remote host key will not be verified. 166# remote host key will not be verified.
136 167
137 168# @ECLASS-VARIABLE: ECVS_CLEAN
169# @DEFAULT_UNSET
170# @DESCRIPTION:
138# 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
139# -C option to cvs update) 172# -C option to cvs update)
140 173
141 174# @ECLASS-VARIABLE: ECVS_RUNAS
142# ECVS_RUNAS 175# @DEFAULT_UNSET
143# 176# @DESCRIPTION:
144# 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
145# b0rked and wouldn't work with portage userpriv anyway without 178# b0rked and wouldn't work with portage userpriv anyway without
146# special magic. 179# special magic.
147 180
148# [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`" 181# [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`"
149 182
150
151# ECVS_SUBDIR -- deprecated, do not use 183# ECVS_SUBDIR -- deprecated, do not use
152[ -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."
153
154
155# --- end ebuild-configurable settings ---
156 185
157# add cvs to deps 186# add cvs to deps
158# ssh is used for ext auth 187# ssh is used for ext auth
159# sudo is used to run as a specified user 188# sudo is used to run as a specified user
160DEPEND="dev-util/cvs app-admin/sudo" 189DEPEND="dev-vcs/cvs"
190
191[ -n "$ECVS_RUNAS" ] && DEPEND="$DEPEND app-admin/sudo"
161 192
162if [ "$ECVS_AUTH" == "ext" ]; then 193if [ "$ECVS_AUTH" == "ext" ]; then
163 #default to ssh 194 #default to ssh
164 [ -z "$CVS_RSH" ] && export CVS_RSH="ssh" 195 [ -z "$CVS_RSH" ] && export CVS_RSH="ssh"
165 if [ "$CVS_RSH" != "ssh" ]; then 196 if [ "$CVS_RSH" != "ssh" ]; then
175 # not affected by modifications in this function. 206 # not affected by modifications in this function.
176 207
177 local ECVS_COMMAND="${ECVS_COMMAND}" 208 local ECVS_COMMAND="${ECVS_COMMAND}"
178 local ECVS_UP_OPTS="${ECVS_UP_OPTS}" 209 local ECVS_UP_OPTS="${ECVS_UP_OPTS}"
179 local ECVS_CO_OPTS="${ECVS_CO_OPTS}" 210 local ECVS_CO_OPTS="${ECVS_CO_OPTS}"
180
181 # Fix for sourceforge which doesnt want -z>3 anymore.
182
183 (echo $ECVS_SERVER | grep -q sourceforge) \
184 && [ "$ECVS_CVS_COMMAND" == "cvs -q -f -z4" ] \
185 && ECVS_CVS_COMMAND="cvs -q -f -z3"
186 211
187 debug-print-function $FUNCNAME $* 212 debug-print-function $FUNCNAME $*
188 213
189 # Update variables that are modified by ebuild parameters, which 214 # Update variables that are modified by ebuild parameters, which
190 # 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
276 # be put in Root 301 # be put in Root
277 if [ "$ECVS_AUTH" == "no" ] 302 if [ "$ECVS_AUTH" == "no" ]
278 then 303 then
279 local server="${ECVS_USER}@${ECVS_SERVER}" 304 local server="${ECVS_USER}@${ECVS_SERVER}"
280 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}"
281 local server=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}" 309 local server=":${connection}:${ECVS_USER}@${ECVS_SERVER}"
282 fi 310 fi
283 311
284 # Switch servers automagically if needed 312 # Switch servers automagically if needed
285 if [ "$mode" == "update" ]; then 313 if [ "$mode" == "update" ]; then
286 cd /$ECVS_TOP_DIR/$ECVS_LOCALNAME 314 cd /$ECVS_TOP_DIR/$ECVS_LOCALNAME
465 chown `whoami` "${T}/cvspass" 493 chown `whoami` "${T}/cvspass"
466 fi 494 fi
467 495
468} 496}
469 497
470 498# @FUNCTION: cvs_src_unpack
499# @DESCRIPTION:
500# The cvs src_unpack function, which will be exported
471cvs_src_unpack() { 501cvs_src_unpack() {
472 502
473 debug-print-function $FUNCNAME $* 503 debug-print-function $FUNCNAME $*
474 504
475 debug-print "$FUNCNAME: init: 505 debug-print "$FUNCNAME: init:
488 [ -z "$ECVS_MODULE" ] && die "ERROR: CVS module not set, cannot continue." 518 [ -z "$ECVS_MODULE" ] && die "ERROR: CVS module not set, cannot continue."
489 519
490 local ECVS_LOCALNAME="${ECVS_LOCALNAME}" 520 local ECVS_LOCALNAME="${ECVS_LOCALNAME}"
491 521
492 if [ -z "$ECVS_LOCALNAME" ]; then 522 if [ -z "$ECVS_LOCALNAME" ]; then
493 ECVS_LOCALNAME="$ECVS_MODULE" 523 ECVS_LOCALNAME="$ECVS_MODULE"
494 fi 524 fi
495 525
496 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
497 # We're not required to fetch anything; the module already 529 # We're not required to fetch anything; the module already
498 # exists and shouldn't be updated. 530 # exists and shouldn't be updated.
499 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then 531 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then
500 debug-print "$FUNCNAME: offline mode" 532 debug-print "$FUNCNAME: offline mode"
501 else 533 else
502 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"
503 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."
504 fi 536 fi
518 if [ -n "$ECVS_LOCAL" ]; then 550 if [ -n "$ECVS_LOCAL" ]; then
519 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME" 551 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME"
520 else 552 else
521 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.." 553 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.."
522 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}')
523 558
524 # If the directory is empty, remove it; empty directories cannot 559 # If the directory is empty, remove it; empty directories cannot
525 # exist in cvs. This happens when, for example, kde-source 560 # exist in cvs. This happens when, for example, kde-source
526 # requests module/doc/subdir which doesn't exist. Still create 561 # requests module/doc/subdir which doesn't exist. Still create
527 # the empty directory in workdir though. 562 # the empty directory in workdir though.
533 # Implement some of base_src_unpack's functionality; note however 568 # Implement some of base_src_unpack's functionality; note however
534 # that base.eclass may not have been inherited! 569 # that base.eclass may not have been inherited!
535 if [ -n "$PATCHES" ]; then 570 if [ -n "$PATCHES" ]; then
536 debug-print "$FUNCNAME: PATCHES=$PATCHES, S=$S, autopatching" 571 debug-print "$FUNCNAME: PATCHES=$PATCHES, S=$S, autopatching"
537 cd "$S" 572 cd "$S"
538 for x in $PATCHES; do 573 epatch ${PATCHES}
539 debug-print "patching from $x"
540 patch -p0 < "$x"
541 done
542 # Make sure we don't try to apply patches more than once, 574 # Make sure we don't try to apply patches more than once,
543 # since cvs_src_unpack is usually called several times from 575 # since cvs_src_unpack is usually called several times from
544 # e.g. kde-source_src_unpack 576 # e.g. kde-source_src_unpack
545 export PATCHES="" 577 export PATCHES=""
546 fi 578 fi
547 579
548 einfo "CVS module ${ECVS_MODULE} is now in ${WORKDIR}" 580 einfo "CVS module ${ECVS_MODULE} is now in ${WORKDIR}"
549} 581}
550 582
551EXPORT_FUNCTIONS src_unpack 583EXPORT_FUNCTIONS src_unpack
584
585fi

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

  ViewVC Help
Powered by ViewVC 1.1.20