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

Diff of /eclass/cvs.eclass

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

Revision 1.67 Revision 1.75
1# Copyright 1999-2006 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.67 2006/12/11 00:11:46 vapier Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cvs.eclass,v 1.75 2010/08/24 21:00:15 vapier Exp $
4# 4
5# @ECLASS: cvs.eclass
6# @MAINTAINER:
5# Maintainer: vapier@gentoo.org (and anyone who wants to help) 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.
6 15
7inherit eutils 16inherit eutils
8
9# This eclass provides the generic cvs fetching functions. To use
10# this from an ebuild, set the `ebuild-configurable settings' as
11# specified below in your ebuild before inheriting. Then either leave
12# the default src_unpack or extend over cvs_src_unpack. If you find
13# that you need to call the cvs_* functions directly, I'd be
14# interested to hear about it.
15 17
16# TODO: 18# TODO:
17 19
18# Implement more auth types (gserver?, kserver?) 20# Implement more auth types (gserver?, kserver?)
19 21
20# Support additional remote shells with `ext' authentication (does 22# Support additional remote shells with `ext' authentication (does
21# anyone actually need to use it with anything other than SSH?) 23# anyone actually need to use it with anything other than SSH?)
22
23 24
24 25
25# Users shouldn't change these settings! The ebuild/eclass inheriting 26# Users shouldn't change these settings! The ebuild/eclass inheriting
26# 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
27# KDE cvs ebuilds' settings, see the comments in kde-source.eclass. 28# KDE cvs ebuilds' settings, see the comments in kde-source.eclass.
28 29
29# --- begin ebuild-configurable settings 30# @ECLASS-VARIABLE: ECVS_CVS_COMMAND
30 31# @DESCRIPTION:
31# ECVS_CVS_COMMAND -- CVS command to run 32# CVS command to run
32# 33#
33# You can set, for example, "cvs -t" for extensive debug information 34# You can set, for example, "cvs -t" for extensive debug information
34# 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
35# quiet, to disregard the ~/.cvsrc config file and to use maximum 36# quiet, to disregard the ~/.cvsrc config file and to use maximum
36# compression. 37# compression.
38[[ -z ${ECVS_CVS_COMMAND} ]] && ECVS_CVS_COMMAND="cvs ${ECVS_CVS_OPTIONS} ${ECVS_CVS_COMPRESS}"
37 39
40# @ECLASS-VARIABLE: ECVS_CVS_COMPRESS
41# @DESCRIPTION:
42# Set the compression level.
38[[ -z ${ECVS_CVS_COMPRESS} ]] && ECVS_CVS_COMPRESS="-z1" 43[[ -z ${ECVS_CVS_COMPRESS} ]] && ECVS_CVS_COMPRESS="-z1"
44
45# @ECLASS-VARIABLE: ECVS_CVS_OPTIONS
46# @DESCRIPTION:
47# Additional options to the cvs commands.
39[[ -z ${ECVS_CVS_OPTIONS} ]] && ECVS_CVS_OPTIONS="-q -f" 48[[ -z ${ECVS_CVS_OPTIONS} ]] && ECVS_CVS_OPTIONS="-q -f"
40[[ -z ${ECVS_CVS_COMMAND} ]] && ECVS_CVS_COMMAND="cvs ${ECVS_CVS_OPTIONS} ${ECVS_CVS_COMPRESS}"
41 49
42 50# @ECLASS-VARIABLE: ECVS_UP_OPTS
43# ECVS_UP_OPTS, ECVS_CO_OPTS -- CVS options given after the cvs 51# @DESCRIPTION:
44# command (update or checkout). 52# CVS options given after the cvs update command. Don't remove "-dP" or things
45# 53# won't work.
46# Don't remove -dP from update or things won't work.
47
48[ -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.
49[ -z "$ECVS_CO_OPTS" ] && ECVS_CO_OPTS="" 59[ -z "$ECVS_CO_OPTS" ] && ECVS_CO_OPTS=""
50 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}}
51 67
68# @ECLASS-VARIABLE: ECVS_LOCAL
69# @DEFAULT_UNSET
70# @DESCRIPTION:
52# 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.
53# non-recursively. Refer to the information in the CVS man page 72# Refer to the information in the CVS man page regarding the -l
54# regarding the -l command option (not the -l global option). 73# command option (not the -l global option).
55 74
56 75# @ECLASS-VARIABLE: ECVS_LOCALNAME
76# @DEFAULT_UNSET
77# @DESCRIPTION:
57# ECVS_LOCALNAME -- local name of checkout directory 78# Local name of checkout directory
58# 79#
59# 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
60# 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
61# useless empty directories. 82# useless empty directories.
62# 83#
63# 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
64# 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
65# have e.g. a wrong $S setting. 86# have e.g. a wrong $S setting.
66 87
67 88# @ECLASS-VARIABLE: ECVS_TOP_DIR
89# @DESCRIPTION:
68# ECVS_TOP_DIR -- The directory under which CVS modules are checked 90# The directory under which CVS modules are checked out.
69# out.
70
71[ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}/cvs-src" 91[ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}/cvs-src"
72 92
73# ECVS_SERVER -- CVS path 93# @ECLASS-VARIABLE: ECVS_SERVER
94# @DESCRIPTION:
95# CVS path
74# 96#
75# 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".
76# 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
77# ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated 99# ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated
78# using other settings also. 100# using other settings also.
79# 101#
80# 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
81# is already checked out in ECVS_TOP_DIR). 103# is already checked out in ECVS_TOP_DIR).
82
83[ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline" 104[ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline"
84 105
85 106# @ECLASS-VARIABLE: ECVS_MODULE
107# @REQUIRED
108# @DESCRIPTION:
86# ECVS_MODULE -- the name of the CVS module to be fetched 109# The name of the CVS module to be fetched
87# 110#
88# 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
89# several directory levels, i.e. "foo/bar/baz" 112# several directory levels, i.e. "foo/bar/baz"
90 113
91#[ -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"
92 115
93 116# @ECLASS-VARIABLE: ECVS_BRANCH
117# @DEFAULT_UNSET
118# @DESCRIPTION:
94# ECVS_BRANCH -- the name of the branch/tag to use 119# The name of the branch/tag to use
95 120#
96# The default is "HEAD". The following default _will_ reset your 121# The default is "HEAD". The following default _will_ reset your
97# branch checkout to head if used. 122# branch checkout to head if used.
98 123
99#[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD" 124#[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD"
100 125
101 126# @ECLASS-VARIABLE: ECVS_AUTH
127# @DESCRIPTION:
102# ECVS_AUTH -- authentication method to use 128# Authentication method to use
103# 129#
104# Possible values are "pserver" and "ext". If `ext' authentication is 130# Possible values are "pserver" and "ext". If `ext' authentication is
105# 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
106# used by default). Currently, the only supported remote shell for 132# used by default). Currently, the only supported remote shell for
107# `ext' authentication is SSH. 133# `ext' authentication is SSH.
112# e.g. 138# e.g.
113# "cvs -danoncvs@savannah.gnu.org:/cvsroot/backbone co System" 139# "cvs -danoncvs@savannah.gnu.org:/cvsroot/backbone co System"
114# ( from gnustep-apps/textedit ) 140# ( from gnustep-apps/textedit )
115[ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver" 141[ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver"
116 142
143# @ECLASS-VARIABLE: ECVS_USER
144# @DESCRIPTION:
117# ECVS_USER -- Username to use for authentication on the remote server 145# Username to use for authentication on the remote server.
118[ -z "$ECVS_USER" ] && ECVS_USER="anonymous" 146[ -z "$ECVS_USER" ] && ECVS_USER="anonymous"
119 147
148# @ECLASS-VARIABLE: ECVS_PASS
149# @DESCRIPTION:
120# ECVS_PASS -- Password to use for authentication on the remote server 150# Password to use for authentication on the remote server
121[ -z "$ECVS_PASS" ] && ECVS_PASS="" 151[ -z "$ECVS_PASS" ] && ECVS_PASS=""
122 152
123 153# @ECLASS-VARIABLE: ECVS_SSH_HOST_KEY
124# ECVS_SSH_HOST_KEY 154# @DEFAULT_UNSET
125# 155# @DESCRIPTION:
126# If SSH is used for `ext' authentication, use this variable to 156# If SSH is used for `ext' authentication, use this variable to
127# 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
128# 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.
129# 159#
130# 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
131# remote host key will not be verified. 161# remote host key will not be verified.
132 162
133 163# @ECLASS-VARIABLE: ECVS_CLEAN
164# @DEFAULT_UNSET
165# @DESCRIPTION:
134# 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
135# -C option to cvs update) 167# -C option to cvs update)
136 168
137 169# @ECLASS-VARIABLE: ECVS_RUNAS
138# ECVS_RUNAS 170# @DEFAULT_UNSET
139# 171# @DESCRIPTION:
140# 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
141# b0rked and wouldn't work with portage userpriv anyway without 173# b0rked and wouldn't work with portage userpriv anyway without
142# special magic. 174# special magic.
143 175
144# [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`" 176# [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`"
145 177
146
147# ECVS_SUBDIR -- deprecated, do not use 178# ECVS_SUBDIR -- deprecated, do not use
148[ -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."
149
150
151# --- end ebuild-configurable settings ---
152 180
153# add cvs to deps 181# add cvs to deps
154# ssh is used for ext auth 182# ssh is used for ext auth
155# sudo is used to run as a specified user 183# sudo is used to run as a specified user
156DEPEND="dev-util/cvs" 184DEPEND="dev-vcs/cvs"
157 185
158[ -n "$ECVS_RUNAS" ] && DEPEND="$DEPEND app-admin/sudo" 186[ -n "$ECVS_RUNAS" ] && DEPEND="$DEPEND app-admin/sudo"
159 187
160if [ "$ECVS_AUTH" == "ext" ]; then 188if [ "$ECVS_AUTH" == "ext" ]; then
161 #default to ssh 189 #default to ssh
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:
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
521 local sanitized_pn=$(echo "${PN}" | LC_ALL=C sed -e 's:[^A-Za-z0-9_]:_:g')
491 local offline_pkg_var="ECVS_OFFLINE_${PN}" 522 local offline_pkg_var="ECVS_OFFLINE_${sanitized_pn}"
492 if [ "${!offline_pkg_var}" == "1" -o "$ECVS_OFFLINE" == "1" -o "$ECVS_SERVER" == "offline" ]; then 523 if [[ -n ${!offline_pkg_var}${ECVS_OFFLINE} ]] || [[ "$ECVS_SERVER" == "offline" ]] ; then
493 # We're not required to fetch anything; the module already 524 # We're not required to fetch anything; the module already
494 # exists and shouldn't be updated. 525 # exists and shouldn't be updated.
495 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then 526 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then
496 debug-print "$FUNCNAME: offline mode" 527 debug-print "$FUNCNAME: offline mode"
497 else 528 else
514 if [ -n "$ECVS_LOCAL" ]; then 545 if [ -n "$ECVS_LOCAL" ]; then
515 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME" 546 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME"
516 else 547 else
517 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.." 548 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.."
518 fi 549 fi
550
551 # Not exactly perfect, but should be pretty close #333773
552 export ECVS_VERSION=$(find "$ECVS_TOP_DIR/$ECVS_LOCALNAME/" -ipath '*/CVS/Entries' -exec cat {} + | LC_ALL=C sort | sha1sum | awk '{print $1}')
553 export ESCM_VERSION=${ECVS_VERSION}
519 554
520 # If the directory is empty, remove it; empty directories cannot 555 # If the directory is empty, remove it; empty directories cannot
521 # exist in cvs. This happens when, for example, kde-source 556 # exist in cvs. This happens when, for example, kde-source
522 # requests module/doc/subdir which doesn't exist. Still create 557 # requests module/doc/subdir which doesn't exist. Still create
523 # the empty directory in workdir though. 558 # the empty directory in workdir though.

Legend:
Removed from v.1.67  
changed lines
  Added in v.1.75

  ViewVC Help
Powered by ViewVC 1.1.20