Documentation: git-add -- do not say "cache", add examples.
[git/jrn.git] / Makefile
blob6c01dc29537a7926f1e57c4fe115334c4cdc036c
1 # Define MOZILLA_SHA1 environment variable when running make to make use of
2 # a bundled SHA1 routine coming from Mozilla. It is GPL'd and should be fast
3 # on non-x86 architectures (e.g. PowerPC), while the OpenSSL version (default
4 # choice) has very fast version optimized for i586.
6 # Define NO_OPENSSL environment variable if you do not have OpenSSL. You will
7 # miss out git-rev-list --merge-order. This also implies MOZILLA_SHA1.
9 # Define NO_CURL if you do not have curl installed. git-http-pull is not
10 # built, and you cannot use http:// and https:// transports.
12 # Define CURLDIR=/foo/bar if your curl header and library files are in
13 # /foo/bar/include and /foo/bar/lib directories.
15 # Define NO_STRCASESTR if you don't have strcasestr.
17 # Define PPC_SHA1 environment variable when running make to make use of
18 # a bundled SHA1 routine optimized for PowerPC.
20 # Define ARM_SHA1 environment variable when running make to make use of
21 # a bundled SHA1 routine optimized for ARM.
23 # Define NEEDS_SSL_WITH_CRYPTO if you need -lcrypto with -lssl (Darwin).
25 # Define NEEDS_LIBICONV if linking with libc is not enough (Darwin).
27 # Define NEEDS_SOCKET if linking with libc is not enough (SunOS,
28 # Patrick Mauritz).
30 # Define NO_MMAP if you want to avoid mmap.
32 # Define WITH_OWN_SUBPROCESS_PY if you want to use with python 2.3.
34 # Define NO_IPV6 if you lack IPv6 support and getaddrinfo().
36 # Define COLLISION_CHECK below if you believe that SHA1's
37 # 1461501637330902918203684832716283019655932542976 hashes do not give you
38 # sufficient guarantee that no collisions between objects will ever happen.
40 # DEFINES += -DCOLLISION_CHECK
42 # Define USE_NSEC below if you want git to care about sub-second file mtimes
43 # and ctimes. Note that you need recent glibc (at least 2.2.4) for this, and
44 # it will BREAK YOUR LOCAL DIFFS! show-diff and anything using it will likely
45 # randomly break unless your underlying filesystem supports those sub-second
46 # times (my ext3 doesn't).
48 # DEFINES += -DUSE_NSEC
50 # Define USE_STDEV below if you want git to care about the underlying device
51 # change being considered an inode change from the update-cache perspective.
53 # DEFINES += -DUSE_STDEV
55 GIT_VERSION = 0.99.9.GIT
57 CFLAGS = -g -O2 -Wall
58 ALL_CFLAGS = $(CFLAGS) $(PLATFORM_DEFINES) $(DEFINES)
60 prefix = $(HOME)
61 bindir = $(prefix)/bin
62 template_dir = $(prefix)/share/git-core/templates/
63 GIT_PYTHON_DIR = $(prefix)/share/git-core/python
64 # DESTDIR=
66 CC = gcc
67 AR = ar
68 TAR = tar
69 INSTALL = install
70 RPMBUILD = rpmbuild
72 # sparse is architecture-neutral, which means that we need to tell it
73 # explicitly what architecture to check for. Fix this up for yours..
74 SPARSE_FLAGS = -D__BIG_ENDIAN__ -D__powerpc__
78 ### --- END CONFIGURATION SECTION ---
80 SCRIPT_SH = \
81 git-add.sh git-bisect.sh git-branch.sh git-checkout.sh \
82 git-cherry.sh git-clone.sh git-commit.sh \
83 git-count-objects.sh git-diff.sh git-fetch.sh \
84 git-format-patch.sh git-log.sh git-ls-remote.sh \
85 git-merge-one-file.sh git-octopus.sh git-parse-remote.sh \
86 git-prune.sh git-pull.sh git-push.sh git-rebase.sh \
87 git-repack.sh git-request-pull.sh git-reset.sh \
88 git-resolve.sh git-revert.sh git-sh-setup.sh git-status.sh \
89 git-tag.sh git-verify-tag.sh git-whatchanged.sh git.sh \
90 git-applymbox.sh git-applypatch.sh git-am.sh \
91 git-merge.sh git-merge-stupid.sh git-merge-octopus.sh \
92 git-merge-resolve.sh git-merge-ours.sh git-grep.sh
94 SCRIPT_PERL = \
95 git-archimport.perl git-cvsimport.perl git-relink.perl \
96 git-rename.perl git-shortlog.perl git-fmt-merge-msg.perl \
97 git-svnimport.perl git-mv.perl
99 SCRIPT_PYTHON = \
100 git-merge-recursive.py
102 # The ones that do not have to link with lcrypto nor lz.
103 SIMPLE_PROGRAMS = \
104 git-get-tar-commit-id$X git-mailinfo$X git-mailsplit$X \
105 git-stripspace$X git-var$X git-daemon$X
107 # ... and all the rest
108 PROGRAMS = \
109 git-apply$X git-cat-file$X \
110 git-checkout-index$X git-clone-pack$X git-commit-tree$X \
111 git-convert-objects$X git-diff-files$X \
112 git-diff-index$X git-diff-stages$X \
113 git-diff-tree$X git-fetch-pack$X git-fsck-objects$X \
114 git-hash-object$X git-index-pack$X git-init-db$X \
115 git-local-fetch$X git-ls-files$X git-ls-tree$X git-merge-base$X \
116 git-merge-index$X git-mktag$X git-pack-objects$X git-patch-id$X \
117 git-peek-remote$X git-prune-packed$X git-read-tree$X \
118 git-receive-pack$X git-rev-list$X git-rev-parse$X \
119 git-send-pack$X git-show-branch$X git-shell$X \
120 git-show-index$X git-ssh-fetch$X \
121 git-ssh-upload$X git-tar-tree$X git-unpack-file$X \
122 git-unpack-objects$X git-update-index$X git-update-server-info$X \
123 git-upload-pack$X git-verify-pack$X git-write-tree$X \
124 git-update-ref$X git-symbolic-ref$X git-check-ref-format$X \
125 git-name-rev$X $(SIMPLE_PROGRAMS)
127 # Backward compatibility -- to be removed after 1.0
128 PROGRAMS += git-ssh-pull$X git-ssh-push$X
130 GIT_LIST_TWEAK =
132 PYMODULES = \
133 gitMergeCommon.py
135 ifdef WITH_OWN_SUBPROCESS_PY
136 PYMODULES += compat/subprocess.py
137 endif
139 ifdef WITH_SEND_EMAIL
140 SCRIPT_PERL += git-send-email.perl
141 else
142 GIT_LIST_TWEAK += -e '/^send-email$$/d'
143 endif
145 LIB_FILE=libgit.a
147 LIB_H = \
148 blob.h cache.h commit.h count-delta.h csum-file.h delta.h \
149 diff.h epoch.h object.h pack.h pkt-line.h quote.h refs.h \
150 run-command.h strbuf.h tag.h tree.h
152 DIFF_OBJS = \
153 diff.o diffcore-break.o diffcore-order.o diffcore-pathspec.o \
154 diffcore-pickaxe.o diffcore-rename.o tree-diff.o
156 LIB_OBJS = \
157 blob.o commit.o connect.o count-delta.o csum-file.o \
158 date.o diff-delta.o entry.o ident.o index.o \
159 object.o pack-check.o patch-delta.o path.o pkt-line.o \
160 quote.o read-cache.o refs.o run-command.o \
161 server-info.o setup.o sha1_file.o sha1_name.o strbuf.o \
162 tag.o tree.o usage.o config.o environment.o ctype.o copy.o \
163 $(DIFF_OBJS)
165 LIBS = $(LIB_FILE)
166 LIBS += -lz
168 # Shell quote;
169 # Result of this needs to be placed inside ''
170 shq = $(subst ','\'',$(1))
171 # This has surrounding ''
172 shellquote = '$(call shq,$(1))'
175 # Platform specific tweaks
178 # We choose to avoid "if .. else if .. else .. endif endif"
179 # because maintaining the nesting to match is a pain. If
180 # we had "elif" things would have been much nicer...
181 uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not')
182 uname_M := $(shell sh -c 'uname -m 2>/dev/null || echo not')
183 uname_O := $(shell sh -c 'uname -o 2>/dev/null || echo not')
185 ifeq ($(uname_S),Darwin)
186 NEEDS_SSL_WITH_CRYPTO = YesPlease
187 NEEDS_LIBICONV = YesPlease
188 endif
189 ifeq ($(uname_S),SunOS)
190 NEEDS_SOCKET = YesPlease
191 NEEDS_NSL = YesPlease
192 NEEDS_LIBICONV = YesPlease
193 SHELL_PATH = /bin/bash
194 NO_STRCASESTR = YesPlease
195 INSTALL = ginstall
196 TAR = gtar
197 PLATFORM_DEFINES += -D__EXTENSIONS__
198 endif
199 ifeq ($(uname_O),Cygwin)
200 NO_STRCASESTR = YesPlease
201 NEEDS_LIBICONV = YesPlease
202 NO_IPV6 = YesPlease
203 X = .exe
204 PLATFORM_DEFINES += -DUSE_SYMLINK_HEAD=0
205 endif
206 ifeq ($(uname_S),OpenBSD)
207 NO_STRCASESTR = YesPlease
208 NEEDS_LIBICONV = YesPlease
209 PLATFORM_DEFINES += -I/usr/local/include -L/usr/local/lib
210 endif
211 ifneq (,$(findstring arm,$(uname_M)))
212 ARM_SHA1 = YesPlease
213 endif
215 -include config.mak
217 ifndef NO_CURL
218 ifdef CURLDIR
219 # This is still problematic -- gcc does not want -R.
220 CFLAGS += -I$(CURLDIR)/include
221 CURL_LIBCURL = -L$(CURLDIR)/lib -R$(CURLDIR)/lib -lcurl
222 else
223 CURL_LIBCURL = -lcurl
224 endif
225 PROGRAMS += git-http-fetch$X
226 endif
228 ifndef SHELL_PATH
229 SHELL_PATH = /bin/sh
230 endif
231 ifndef PERL_PATH
232 PERL_PATH = /usr/bin/perl
233 endif
234 ifndef PYTHON_PATH
235 PYTHON_PATH = /usr/bin/python
236 endif
238 ifndef NO_OPENSSL
239 LIB_OBJS += epoch.o
240 OPENSSL_LIBSSL = -lssl
241 ifdef OPENSSLDIR
242 # Again this may be problematic -- gcc does not always want -R.
243 CFLAGS += -I$(OPENSSLDIR)/include
244 OPENSSL_LINK = -L$(OPENSSLDIR)/lib -R$(OPENSSLDIR)/lib
245 else
246 OPENSSL_LINK =
247 endif
248 else
249 DEFINES += -DNO_OPENSSL
250 MOZILLA_SHA1 = 1
251 OPENSSL_LIBSSL =
252 endif
253 ifdef NEEDS_SSL_WITH_CRYPTO
254 LIB_4_CRYPTO = $(OPENSSL_LINK) -lcrypto -lssl
255 else
256 LIB_4_CRYPTO = $(OPENSSL_LINK) -lcrypto
257 endif
258 ifdef NEEDS_LIBICONV
259 ifdef ICONVDIR
260 # Again this may be problematic -- gcc does not always want -R.
261 CFLAGS += -I$(ICONVDIR)/include
262 ICONV_LINK = -L$(ICONVDIR)/lib -R$(ICONVDIR)/lib
263 else
264 ICONV_LINK =
265 endif
266 LIB_4_ICONV = $(ICONV_LINK) -liconv
267 else
268 LIB_4_ICONV =
269 endif
270 ifdef NEEDS_SOCKET
271 LIBS += -lsocket
272 SIMPLE_LIB += -lsocket
273 endif
274 ifdef NEEDS_NSL
275 LIBS += -lnsl
276 SIMPLE_LIB += -lnsl
277 endif
278 ifdef NO_STRCASESTR
279 DEFINES += -Dstrcasestr=gitstrcasestr -DNO_STRCASESTR=1
280 LIB_OBJS += compat/strcasestr.o
281 endif
282 ifdef NO_MMAP
283 DEFINES += -Dmmap=gitfakemmap -Dmunmap=gitfakemunmap -DNO_MMAP
284 LIB_OBJS += compat/mmap.o
285 endif
286 ifdef NO_IPV6
287 DEFINES += -DNO_IPV6 -Dsockaddr_storage=sockaddr_in
288 endif
290 ifdef PPC_SHA1
291 SHA1_HEADER = "ppc/sha1.h"
292 LIB_OBJS += ppc/sha1.o ppc/sha1ppc.o
293 else
294 ifdef ARM_SHA1
295 SHA1_HEADER = "arm/sha1.h"
296 LIB_OBJS += arm/sha1.o arm/sha1_arm.o
297 else
298 ifdef MOZILLA_SHA1
299 SHA1_HEADER = "mozilla-sha1/sha1.h"
300 LIB_OBJS += mozilla-sha1/sha1.o
301 else
302 SHA1_HEADER = <openssl/sha.h>
303 LIBS += $(LIB_4_CRYPTO)
304 endif
305 endif
306 endif
308 DEFINES += -DSHA1_HEADER=$(call shellquote,$(SHA1_HEADER))
310 SCRIPTS = $(patsubst %.sh,%,$(SCRIPT_SH)) \
311 $(patsubst %.perl,%,$(SCRIPT_PERL)) \
312 $(patsubst %.py,%,$(SCRIPT_PYTHON)) \
313 gitk git-cherry-pick
315 export prefix TAR INSTALL DESTDIR SHELL_PATH template_dir
316 ### Build rules
318 all: $(PROGRAMS) $(SCRIPTS)
320 all:
321 $(MAKE) -C templates
323 git: git.sh Makefile
324 rm -f $@+ $@
325 sed -e '1s|#!.*/sh|#!$(call shq,$(SHELL_PATH))|' \
326 -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' \
327 -e 's/@@X@@/$(X)/g' \
328 $(GIT_LIST_TWEAK) <$@.sh >$@+
329 chmod +x $@+
330 mv $@+ $@
332 $(filter-out git,$(patsubst %.sh,%,$(SCRIPT_SH))) : % : %.sh
333 rm -f $@
334 sed -e '1s|#!.*/sh|#!$(call shq,$(SHELL_PATH))|' \
335 -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' \
336 $@.sh >$@
337 chmod +x $@
339 $(patsubst %.perl,%,$(SCRIPT_PERL)) : % : %.perl
340 rm -f $@
341 sed -e '1s|#!.*perl|#!$(call shq,$(PERL_PATH))|' \
342 -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' \
343 $@.perl >$@
344 chmod +x $@
346 $(patsubst %.py,%,$(SCRIPT_PYTHON)) : % : %.py
347 rm -f $@
348 sed -e '1s|#!.*python|#!$(call shq,$(PYTHON_PATH))|' \
349 -e 's|@@GIT_PYTHON_PATH@@|$(call shq,$(GIT_PYTHON_DIR))|g' \
350 -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' \
351 $@.py >$@
352 chmod +x $@
354 git-cherry-pick: git-revert
355 cp $< $@
357 %.o: %.c
358 $(CC) -o $*.o -c $(ALL_CFLAGS) $<
359 %.o: %.S
360 $(CC) -o $*.o -c $(ALL_CFLAGS) $<
362 git-%$X: %.o $(LIB_FILE)
363 $(CC) $(ALL_CFLAGS) -o $@ $(filter %.o,$^) $(LIBS)
365 git-mailinfo$X : SIMPLE_LIB += $(LIB_4_ICONV)
366 $(SIMPLE_PROGRAMS) : $(LIB_FILE)
367 $(SIMPLE_PROGRAMS) : git-%$X : %.o
368 $(CC) $(ALL_CFLAGS) -o $@ $(filter %.o,$^) $(LIB_FILE) $(SIMPLE_LIB)
370 git-http-fetch$X: fetch.o
371 git-local-fetch$X: fetch.o
372 git-ssh-fetch$X: rsh.o fetch.o
373 git-ssh-upload$X: rsh.o
374 git-ssh-pull$X: rsh.o fetch.o
375 git-ssh-push$X: rsh.o
377 git-http-fetch$X: LIBS += $(CURL_LIBCURL)
378 git-rev-list$X: LIBS += $(OPENSSL_LIBSSL)
380 init-db.o: init-db.c
381 $(CC) -c $(ALL_CFLAGS) \
382 -DDEFAULT_GIT_TEMPLATE_DIR=$(call shellquote,"$(template_dir)") $*.c
384 $(LIB_OBJS): $(LIB_H)
385 $(patsubst git-%$X,%.o,$(PROGRAMS)): $(LIB_H)
386 $(DIFF_OBJS): diffcore.h
388 $(LIB_FILE): $(LIB_OBJS)
389 $(AR) rcs $@ $(LIB_OBJS)
391 doc:
392 $(MAKE) -C Documentation all
395 ### Testing rules
397 test: all
398 $(MAKE) -C t/ all
400 test-date$X: test-date.c date.o ctype.o
401 $(CC) $(ALL_CFLAGS) -o $@ test-date.c date.o ctype.o
403 test-delta$X: test-delta.c diff-delta.o patch-delta.o
404 $(CC) $(ALL_CFLAGS) -o $@ $^
406 check:
407 for i in *.c; do sparse $(ALL_CFLAGS) $(SPARSE_FLAGS) $$i; done
411 ### Installation rules
413 install: $(PROGRAMS) $(SCRIPTS)
414 $(INSTALL) -d -m755 $(call shellquote,$(DESTDIR)$(bindir))
415 $(INSTALL) $(PROGRAMS) $(SCRIPTS) $(call shellquote,$(DESTDIR)$(bindir))
416 $(MAKE) -C templates install
417 $(INSTALL) -d -m755 $(call shellquote,$(DESTDIR)$(GIT_PYTHON_DIR))
418 $(INSTALL) $(PYMODULES) $(call shellquote,$(DESTDIR)$(GIT_PYTHON_DIR))
420 install-doc:
421 $(MAKE) -C Documentation install
426 ### Maintainer's dist rules
428 git-core.spec: git-core.spec.in Makefile
429 sed -e 's/@@VERSION@@/$(GIT_VERSION)/g' < $< > $@
431 GIT_TARNAME=git-core-$(GIT_VERSION)
432 dist: git-core.spec git-tar-tree
433 ./git-tar-tree HEAD $(GIT_TARNAME) > $(GIT_TARNAME).tar
434 @mkdir -p $(GIT_TARNAME)
435 @cp git-core.spec $(GIT_TARNAME)
436 $(TAR) rf $(GIT_TARNAME).tar $(GIT_TARNAME)/git-core.spec
437 @rm -rf $(GIT_TARNAME)
438 gzip -f -9 $(GIT_TARNAME).tar
440 rpm: dist
441 $(RPMBUILD) -ta git-core-$(GIT_VERSION).tar.gz
443 deb: dist
444 rm -rf $(GIT_TARNAME)
445 $(TAR) zxf $(GIT_TARNAME).tar.gz
446 dpkg-source -b $(GIT_TARNAME)
447 cd $(GIT_TARNAME) && fakeroot debian/rules binary
449 ### Cleaning rules
451 clean:
452 rm -f *.o mozilla-sha1/*.o ppc/*.o compat/*.o $(PROGRAMS) $(LIB_FILE)
453 rm -f $(filter-out gitk,$(SCRIPTS))
454 rm -f git-core.spec *.pyc *.pyo
455 rm -rf $(GIT_TARNAME)
456 rm -f $(GIT_TARNAME).tar.gz git-core_$(GIT_VERSION)-*.tar.gz
457 rm -f git-core_$(GIT_VERSION)-*.deb git-core_$(GIT_VERSION)-*.dsc
458 rm -f git-tk_$(GIT_VERSION)-*.deb
459 $(MAKE) -C Documentation/ clean
460 $(MAKE) -C templates clean
461 $(MAKE) -C t/ clean