/[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.78
1# Copyright 1999-2006 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.67 2006/12/11 00:11:46 vapier Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cvs.eclass,v 1.78 2013/01/22 07:02:06 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.
15
16if [[ ${___ECLASS_ONCE_CVS} != "recur -_+^+_- spank" ]] ; then
17___ECLASS_ONCE_CVS="recur -_+^+_- spank"
6 18
7inherit eutils 19inherit 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 20
16# TODO: 21# TODO:
17 22
18# Implement more auth types (gserver?, kserver?) 23# Implement more auth types (gserver?, kserver?)
19 24
20# Support additional remote shells with `ext' authentication (does 25# Support additional remote shells with `ext' authentication (does
21# anyone actually need to use it with anything other than SSH?) 26# anyone actually need to use it with anything other than SSH?)
22
23 27
24 28
25# Users shouldn't change these settings! The ebuild/eclass inheriting 29# 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 30# 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. 31# KDE cvs ebuilds' settings, see the comments in kde-source.eclass.
28 32
29# --- 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}
30 38
31# 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
32# 48#
33# You can set, for example, "cvs -t" for extensive debug information 49# 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 50# 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 51# quiet, to disregard the ~/.cvsrc config file and to use maximum
36# compression. 52# compression.
37
38[[ -z ${ECVS_CVS_COMPRESS} ]] && ECVS_CVS_COMPRESS="-z1"
39[[ -z ${ECVS_CVS_OPTIONS} ]] && ECVS_CVS_OPTIONS="-q -f"
40[[ -z ${ECVS_CVS_COMMAND} ]] && ECVS_CVS_COMMAND="cvs ${ECVS_CVS_OPTIONS} ${ECVS_CVS_COMPRESS}" 53: ${ECVS_CVS_COMMAND:=cvs ${ECVS_CVS_OPTIONS} ${ECVS_CVS_COMPRESS}}
41 54
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}
42 60
43# ECVS_UP_OPTS, ECVS_CO_OPTS -- CVS options given after the cvs 61# @ECLASS-VARIABLE: ECVS_CO_OPTS
44# command (update or checkout). 62# @DEFAULT_UNSET
45# 63# @DESCRIPTION:
46# Don't remove -dP from update or things won't work. 64# CVS options given after the cvs checkout command.
47 65
48[ -z "$ECVS_UP_OPTS" ] && ECVS_UP_OPTS="-dP" 66# @ECLASS-VARIABLE: ECVS_OFFLINE
49[ -z "$ECVS_CO_OPTS" ] && ECVS_CO_OPTS="" 67# @DESCRIPTION:
68# Set this variable to a non-empty value to disable the automatic updating of
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 73# @ECLASS-VARIABLE: ECVS_LOCAL
74# @DEFAULT_UNSET
75# @DESCRIPTION:
52# 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.
53# non-recursively. Refer to the information in the CVS man page 77# Refer to the information in the CVS man page regarding the -l
54# regarding the -l command option (not the -l global option). 78# command option (not the -l global option).
55 79
56 80# @ECLASS-VARIABLE: ECVS_LOCALNAME
81# @DEFAULT_UNSET
82# @DESCRIPTION:
57# ECVS_LOCALNAME -- local name of checkout directory 83# Local name of checkout directory
58# 84#
59# 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
60# 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
61# useless empty directories. 87# useless empty directories.
62# 88#
63# 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
64# 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
65# have e.g. a wrong $S setting. 91# have e.g. a wrong $S setting.
66 92
67 93# @ECLASS-VARIABLE: ECVS_TOP_DIR
94# @DESCRIPTION:
68# ECVS_TOP_DIR -- The directory under which CVS modules are checked 95# 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" 96[ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}/cvs-src"
72 97
73# ECVS_SERVER -- CVS path 98# @ECLASS-VARIABLE: ECVS_SERVER
99# @DESCRIPTION:
100# CVS path
74# 101#
75# 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".
76# 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
77# ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated 104# ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated
78# using other settings also. 105# using other settings also.
79# 106#
80# 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
81# is already checked out in ECVS_TOP_DIR). 108# is already checked out in ECVS_TOP_DIR).
82
83[ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline" 109[ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline"
84 110
85 111# @ECLASS-VARIABLE: ECVS_MODULE
112# @REQUIRED
113# @DESCRIPTION:
86# ECVS_MODULE -- the name of the CVS module to be fetched 114# The name of the CVS module to be fetched
87# 115#
88# 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
89# several directory levels, i.e. "foo/bar/baz" 117# several directory levels, i.e. "foo/bar/baz"
90 118
91#[ -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"
92 120
93 121# @ECLASS-VARIABLE: ECVS_BRANCH
122# @DEFAULT_UNSET
123# @DESCRIPTION:
94# ECVS_BRANCH -- the name of the branch/tag to use 124# The name of the branch/tag to use
95 125#
96# The default is "HEAD". The following default _will_ reset your 126# The default is "HEAD". The following default _will_ reset your
97# branch checkout to head if used. 127# branch checkout to head if used.
98 128
99#[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD" 129#[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD"
100 130
101 131# @ECLASS-VARIABLE: ECVS_AUTH
132# @DESCRIPTION:
102# ECVS_AUTH -- authentication method to use 133# Authentication method to use
103# 134#
104# Possible values are "pserver" and "ext". If `ext' authentication is 135# 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 136# 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 137# used by default). Currently, the only supported remote shell for
107# `ext' authentication is SSH. 138# `ext' authentication is SSH.
112# e.g. 143# e.g.
113# "cvs -danoncvs@savannah.gnu.org:/cvsroot/backbone co System" 144# "cvs -danoncvs@savannah.gnu.org:/cvsroot/backbone co System"
114# ( from gnustep-apps/textedit ) 145# ( from gnustep-apps/textedit )
115[ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver" 146[ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver"
116 147
148# @ECLASS-VARIABLE: ECVS_USER
149# @DESCRIPTION:
117# ECVS_USER -- Username to use for authentication on the remote server 150# Username to use for authentication on the remote server.
118[ -z "$ECVS_USER" ] && ECVS_USER="anonymous" 151[ -z "$ECVS_USER" ] && ECVS_USER="anonymous"
119 152
153# @ECLASS-VARIABLE: ECVS_PASS
154# @DESCRIPTION:
120# ECVS_PASS -- Password to use for authentication on the remote server 155# Password to use for authentication on the remote server
121[ -z "$ECVS_PASS" ] && ECVS_PASS="" 156[ -z "$ECVS_PASS" ] && ECVS_PASS=""
122 157
123 158# @ECLASS-VARIABLE: ECVS_SSH_HOST_KEY
124# ECVS_SSH_HOST_KEY 159# @DEFAULT_UNSET
125# 160# @DESCRIPTION:
126# If SSH is used for `ext' authentication, use this variable to 161# 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 162# 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. 163# should be the same format that is used for the SSH known hosts file.
129# 164#
130# 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
131# remote host key will not be verified. 166# remote host key will not be verified.
132 167
133 168# @ECLASS-VARIABLE: ECVS_CLEAN
169# @DEFAULT_UNSET
170# @DESCRIPTION:
134# 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
135# -C option to cvs update) 172# -C option to cvs update)
136 173
137 174# @ECLASS-VARIABLE: ECVS_RUNAS
138# ECVS_RUNAS 175# @DEFAULT_UNSET
139# 176# @DESCRIPTION:
140# 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
141# b0rked and wouldn't work with portage userpriv anyway without 178# b0rked and wouldn't work with portage userpriv anyway without
142# special magic. 179# special magic.
143 180
144# [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`" 181# [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`"
145 182
146
147# ECVS_SUBDIR -- deprecated, do not use 183# ECVS_SUBDIR -- deprecated, do not use
148[ -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."
149
150
151# --- end ebuild-configurable settings ---
152 185
153# add cvs to deps 186# add cvs to deps
154# ssh is used for ext auth 187# ssh is used for ext auth
155# sudo is used to run as a specified user 188# sudo is used to run as a specified user
156DEPEND="dev-util/cvs" 189DEPEND="dev-vcs/cvs"
157 190
158[ -n "$ECVS_RUNAS" ] && DEPEND="$DEPEND app-admin/sudo" 191[ -n "$ECVS_RUNAS" ] && DEPEND="$DEPEND app-admin/sudo"
159 192
160if [ "$ECVS_AUTH" == "ext" ]; then 193if [ "$ECVS_AUTH" == "ext" ]; then
161 #default to ssh 194 #default to ssh
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:
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
526 local sanitized_pn=$(echo "${PN}" | LC_ALL=C sed -e 's:[^A-Za-z0-9_]:_:g')
491 local offline_pkg_var="ECVS_OFFLINE_${PN}" 527 local offline_pkg_var="ECVS_OFFLINE_${sanitized_pn}"
492 if [ "${!offline_pkg_var}" == "1" -o "$ECVS_OFFLINE" == "1" -o "$ECVS_SERVER" == "offline" ]; then 528 if [[ -n ${!offline_pkg_var}${ECVS_OFFLINE} ]] || [[ "$ECVS_SERVER" == "offline" ]] ; then
493 # We're not required to fetch anything; the module already 529 # We're not required to fetch anything; the module already
494 # exists and shouldn't be updated. 530 # exists and shouldn't be updated.
495 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then 531 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then
496 debug-print "$FUNCNAME: offline mode" 532 debug-print "$FUNCNAME: offline mode"
497 else 533 else
514 if [ -n "$ECVS_LOCAL" ]; then 550 if [ -n "$ECVS_LOCAL" ]; then
515 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME" 551 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME"
516 else 552 else
517 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.." 553 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.."
518 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}')
519 558
520 # If the directory is empty, remove it; empty directories cannot 559 # If the directory is empty, remove it; empty directories cannot
521 # exist in cvs. This happens when, for example, kde-source 560 # exist in cvs. This happens when, for example, kde-source
522 # requests module/doc/subdir which doesn't exist. Still create 561 # requests module/doc/subdir which doesn't exist. Still create
523 # the empty directory in workdir though. 562 # the empty directory in workdir though.
540 579
541 einfo "CVS module ${ECVS_MODULE} is now in ${WORKDIR}" 580 einfo "CVS module ${ECVS_MODULE} is now in ${WORKDIR}"
542} 581}
543 582
544EXPORT_FUNCTIONS src_unpack 583EXPORT_FUNCTIONS src_unpack
584
585fi

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

  ViewVC Help
Powered by ViewVC 1.1.20