scripts/Kbuild.include: Fix portability problem of "echo -e"
[linux-2.6.git] / scripts / tags.sh
1 #!/bin/sh
2 # Generate tags or cscope files
3 # Usage tags.sh <mode>
4 #
5 # mode may be any of: tags, TAGS, cscope
6 #
7 # Uses the following environment variables:
8 # ARCH, SUBARCH, SRCARCH, srctree, src, obj
9
10 if [ "$KBUILD_VERBOSE" = "1" ]; then
11         set -x
12 fi
13
14 # This is a duplicate of RCS_FIND_IGNORE without escaped '()'
15 ignore="( -name SCCS -o -name BitKeeper -o -name .svn -o \
16           -name CVS  -o -name .pc       -o -name .hg  -o \
17           -name .git )                                   \
18           -prune -o"
19
20 # Do not use full path if we do not use O=.. builds
21 # Use make O=. {tags|cscope}
22 # to force full paths for a non-O= build
23 if [ "${KBUILD_SRC}" = "" ]; then
24         tree=
25 else
26         tree=${srctree}/
27 fi
28
29 # Find all available archs
30 find_all_archs()
31 {
32         ALLSOURCE_ARCHS=""
33         for arch in `ls ${tree}arch`; do
34                 ALLSOURCE_ARCHS="${ALLSOURCE_ARCHS} "${arch##\/}
35         done
36 }
37
38 # Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH
39 if [ "${ALLSOURCE_ARCHS}" = "" ]; then
40         ALLSOURCE_ARCHS=${SRCARCH}
41 elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then
42         find_all_archs
43 fi
44
45 # find sources in arch/$ARCH
46 find_arch_sources()
47 {
48         for i in $archincludedir; do
49                 prune="$prune -wholename $i -prune -o"
50         done
51         find ${tree}arch/$1 $ignore $prune -name "$2" -print;
52 }
53
54 # find sources in arch/$1/include
55 find_arch_include_sources()
56 {
57         include=$(find ${tree}arch/$1/ -name include -type d);
58         if [ -n "$include" ]; then
59                 archincludedir="$archincludedir $include"
60                 find $include $ignore -name "$2" -print;
61         fi
62 }
63
64 # find sources in include/
65 find_include_sources()
66 {
67         find ${tree}include $ignore -name config -prune -o -name "$1" -print;
68 }
69
70 # find sources in rest of tree
71 # we could benefit from a list of dirs to search in here
72 find_other_sources()
73 {
74         find ${tree}* $ignore \
75              \( -name include -o -name arch -o -name '.tmp_*' \) -prune -o \
76                -name "$1" -print;
77 }
78
79 find_sources()
80 {
81         find_arch_sources $1 "$2"
82 }
83
84 all_sources()
85 {
86         find_arch_include_sources ${SRCARCH} '*.[chS]'
87         if [ ! -z "$archinclude" ]; then
88                 find_arch_include_sources $archinclude '*.[chS]'
89         fi
90         find_include_sources '*.[chS]'
91         for arch in $ALLSOURCE_ARCHS
92         do
93                 find_sources $arch '*.[chS]'
94         done
95         find_other_sources '*.[chS]'
96 }
97
98 all_kconfigs()
99 {
100         for arch in $ALLSOURCE_ARCHS; do
101                 find_sources $arch 'Kconfig*'
102         done
103         find_other_sources 'Kconfig*'
104 }
105
106 all_defconfigs()
107 {
108         find_sources $ALLSOURCE_ARCHS "defconfig"
109 }
110
111 docscope()
112 {
113         (echo \-k; echo \-q; all_sources) > cscope.files
114         cscope -b -f cscope.out
115 }
116
117 dogtags()
118 {
119         all_sources | gtags -f -
120 }
121
122 exuberant()
123 {
124         all_sources | xargs $1 -a                               \
125         -I __initdata,__exitdata,__acquires,__releases          \
126         -I __read_mostly,____cacheline_aligned                  \
127         -I ____cacheline_aligned_in_smp                         \
128         -I ____cacheline_internodealigned_in_smp                \
129         -I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL                      \
130         -I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
131         --extra=+f --c-kinds=+px                                \
132         --regex-asm='/^ENTRY\(([^)]*)\).*/\1/'                  \
133         --regex-c='/^SYSCALL_DEFINE[[:digit:]]?\(([^,)]*).*/sys_\1/' \
134         --regex-c++='/^TRACE_EVENT\(([^,)]*).*/trace_\1/'               \
135         --regex-c++='/^DEFINE_EVENT\([^,)]*, *([^,)]*).*/trace_\1/'
136
137         all_kconfigs | xargs $1 -a                              \
138         --langdef=kconfig --language-force=kconfig              \
139         --regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/\2/'
140
141         all_kconfigs | xargs $1 -a                              \
142         --langdef=kconfig --language-force=kconfig              \
143         --regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/CONFIG_\2/'
144
145         all_defconfigs | xargs -r $1 -a                         \
146         --langdef=dotconfig --language-force=dotconfig          \
147         --regex-dotconfig='/^#?[[:blank:]]*(CONFIG_[[:alnum:]_]+)/\1/'
148
149 }
150
151 emacs()
152 {
153         all_sources | xargs $1 -a                               \
154         --regex='/^ENTRY(\([^)]*\)).*/\1/'                      \
155         --regex='/^SYSCALL_DEFINE[0-9]?(\([^,)]*\).*/sys_\1/'   \
156         --regex='/^TRACE_EVENT(\([^,)]*\).*/trace_\1/'          \
157         --regex='/^DEFINE_EVENT([^,)]*, *\([^,)]*\).*/trace_\1/'
158
159         all_kconfigs | xargs $1 -a                              \
160         --regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/\3/'
161
162         all_kconfigs | xargs $1 -a                              \
163         --regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/CONFIG_\3/'
164
165         all_defconfigs | xargs -r $1 -a                         \
166         --regex='/^#?[ \t]?\(CONFIG_[a-zA-Z0-9_]+\)/\1/'
167 }
168
169 xtags()
170 {
171         if $1 --version 2>&1 | grep -iq exuberant; then
172                 exuberant $1
173         elif $1 --version 2>&1 | grep -iq emacs; then
174                 emacs $1
175         else
176                 all_sources | xargs $1 -a
177         fi
178 }
179
180
181 # Support um (which uses SUBARCH)
182 if [ "${ARCH}" = "um" ]; then
183         if [ "$SUBARCH" = "i386" ]; then
184                 archinclude=x86
185         elif [ "$SUBARCH" = "x86_64" ]; then
186                 archinclude=x86
187         else
188                 archinclude=${SUBARCH}
189         fi
190 fi
191
192 case "$1" in
193         "cscope")
194                 docscope
195                 ;;
196
197         "gtags")
198                 dogtags
199                 ;;
200
201         "tags")
202                 rm -f tags
203                 xtags ctags
204                 ;;
205
206         "TAGS")
207                 rm -f TAGS
208                 xtags etags
209                 ;;
210 esac