Documentation: finishing touches to the new tutorial.
[git.git] / Makefile
blob30460560247f9e210b41207434793ce6b29b83b2
1 # The default target of this Makefile is...
2 all:
4 # Define MOZILLA_SHA1 environment variable when running make to make use of
5 # a bundled SHA1 routine coming from Mozilla. It is GPL'd and should be fast
6 # on non-x86 architectures (e.g. PowerPC), while the OpenSSL version (default
7 # choice) has very fast version optimized for i586.
9 # Define NO_OPENSSL environment variable if you do not have OpenSSL. You will
10 # miss out git-rev-list --merge-order. This also implies MOZILLA_SHA1.
12 # Define NO_CURL if you do not have curl installed. git-http-pull and
13 # git-http-push are not built, and you cannot use http:// and https://
14 # transports.
16 # Define CURLDIR=/foo/bar if your curl header and library files are in
17 # /foo/bar/include and /foo/bar/lib directories.
19 # Define NO_EXPAT if you do not have expat installed. git-http-push is
20 # not built, and you cannot push using http:// and https:// transports.
22 # Define NO_D_INO_IN_DIRENT if you don't have d_ino in your struct dirent.
24 # Define NO_D_TYPE_IN_DIRENT if your platform defines DT_UNKNOWN but lacks
25 # d_type in struct dirent (latest Cygwin -- will be fixed soonish).
27 # Define NO_STRCASESTR if you don't have strcasestr.
29 # Define NO_SETENV if you don't have setenv in the C library.
31 # Define USE_SYMLINK_HEAD if you want .git/HEAD to be a symbolic link.
32 # Don't enable it on Windows.
34 # Define PPC_SHA1 environment variable when running make to make use of
35 # a bundled SHA1 routine optimized for PowerPC.
37 # Define ARM_SHA1 environment variable when running make to make use of
38 # a bundled SHA1 routine optimized for ARM.
40 # Define NEEDS_SSL_WITH_CRYPTO if you need -lcrypto with -lssl (Darwin).
42 # Define NEEDS_LIBICONV if linking with libc is not enough (Darwin).
44 # Define NEEDS_SOCKET if linking with libc is not enough (SunOS,
45 # Patrick Mauritz).
47 # Define NO_MMAP if you want to avoid mmap.
49 # Define WITH_OWN_SUBPROCESS_PY if you want to use with python 2.3.
51 # Define NO_IPV6 if you lack IPv6 support and getaddrinfo().
53 # Define NO_SOCKADDR_STORAGE if your platform does not have struct
54 # sockaddr_storage.
56 # Define COLLISION_CHECK below if you believe that SHA1's
57 # 1461501637330902918203684832716283019655932542976 hashes do not give you
58 # sufficient guarantee that no collisions between objects will ever happen.
60 # Define USE_NSEC below if you want git to care about sub-second file mtimes
61 # and ctimes. Note that you need recent glibc (at least 2.2.4) for this, and
62 # it will BREAK YOUR LOCAL DIFFS! show-diff and anything using it will likely
63 # randomly break unless your underlying filesystem supports those sub-second
64 # times (my ext3 doesn't).
66 # Define USE_STDEV below if you want git to care about the underlying device
67 # change being considered an inode change from the update-cache perspective.
69 GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
70 @sh ./GIT-VERSION-GEN
71 -include GIT-VERSION-FILE
73 # CFLAGS and LDFLAGS are for the users to override from the command line.
75 CFLAGS = -g -O2 -Wall
76 LDFLAGS =
77 ALL_CFLAGS = $(CFLAGS)
78 ALL_LDFLAGS = $(LDFLAGS)
79 STRIP ?= strip
81 prefix = $(HOME)
82 bindir = $(prefix)/bin
83 gitexecdir = $(prefix)/bin
84 template_dir = $(prefix)/share/git-core/templates/
85 GIT_PYTHON_DIR = $(prefix)/share/git-core/python
86 # DESTDIR=
88 CC = gcc
89 AR = ar
90 TAR = tar
91 INSTALL = install
92 RPMBUILD = rpmbuild
94 # sparse is architecture-neutral, which means that we need to tell it
95 # explicitly what architecture to check for. Fix this up for yours..
96 SPARSE_FLAGS = -D__BIG_ENDIAN__ -D__powerpc__
100 ### --- END CONFIGURATION SECTION ---
102 SCRIPT_SH = \
103 git-add.sh git-bisect.sh git-branch.sh git-checkout.sh \
104 git-cherry.sh git-clone.sh git-commit.sh \
105 git-count-objects.sh git-diff.sh git-fetch.sh \
106 git-format-patch.sh git-log.sh git-ls-remote.sh \
107 git-merge-one-file.sh git-parse-remote.sh \
108 git-prune.sh git-pull.sh git-push.sh git-rebase.sh \
109 git-repack.sh git-request-pull.sh git-reset.sh \
110 git-resolve.sh git-revert.sh git-sh-setup.sh git-status.sh \
111 git-tag.sh git-verify-tag.sh git-whatchanged.sh \
112 git-applymbox.sh git-applypatch.sh git-am.sh \
113 git-merge.sh git-merge-stupid.sh git-merge-octopus.sh \
114 git-merge-resolve.sh git-merge-ours.sh git-grep.sh \
115 git-lost-found.sh
117 SCRIPT_PERL = \
118 git-archimport.perl git-cvsimport.perl git-relink.perl \
119 git-shortlog.perl git-fmt-merge-msg.perl \
120 git-svnimport.perl git-mv.perl git-cvsexportcommit.perl
122 SCRIPT_PYTHON = \
123 git-merge-recursive.py
125 SCRIPTS = $(patsubst %.sh,%,$(SCRIPT_SH)) \
126 $(patsubst %.perl,%,$(SCRIPT_PERL)) \
127 $(patsubst %.py,%,$(SCRIPT_PYTHON)) \
128 git-cherry-pick
130 # The ones that do not have to link with lcrypto nor lz.
131 SIMPLE_PROGRAMS = \
132 git-get-tar-commit-id$X git-mailinfo$X git-mailsplit$X \
133 git-stripspace$X git-daemon$X
135 # ... and all the rest that could be moved out of bindir to gitexecdir
136 PROGRAMS = \
137 git-apply$X git-cat-file$X \
138 git-checkout-index$X git-clone-pack$X git-commit-tree$X \
139 git-convert-objects$X git-diff-files$X \
140 git-diff-index$X git-diff-stages$X \
141 git-diff-tree$X git-fetch-pack$X git-fsck-objects$X \
142 git-hash-object$X git-index-pack$X git-init-db$X \
143 git-local-fetch$X git-ls-files$X git-ls-tree$X git-merge-base$X \
144 git-merge-index$X git-mktag$X git-pack-objects$X git-patch-id$X \
145 git-peek-remote$X git-prune-packed$X git-read-tree$X \
146 git-receive-pack$X git-rev-list$X git-rev-parse$X \
147 git-send-pack$X git-show-branch$X git-shell$X \
148 git-show-index$X git-ssh-fetch$X \
149 git-ssh-upload$X git-tar-tree$X git-unpack-file$X \
150 git-unpack-objects$X git-update-index$X git-update-server-info$X \
151 git-upload-pack$X git-verify-pack$X git-write-tree$X \
152 git-update-ref$X git-symbolic-ref$X git-check-ref-format$X \
153 git-name-rev$X git-pack-redundant$X git-repo-config$X git-var$X \
154 git-describe$X
156 # what 'all' will build and 'install' will install, in gitexecdir
157 ALL_PROGRAMS = $(PROGRAMS) $(SIMPLE_PROGRAMS) $(SCRIPTS)
159 # Backward compatibility -- to be removed after 1.0
160 PROGRAMS += git-ssh-pull$X git-ssh-push$X
162 # Set paths to tools early so that they can be used for version tests.
163 ifndef SHELL_PATH
164 SHELL_PATH = /bin/sh
165 endif
166 ifndef PERL_PATH
167 PERL_PATH = /usr/bin/perl
168 endif
169 ifndef PYTHON_PATH
170 PYTHON_PATH = /usr/bin/python
171 endif
173 PYMODULES = \
174 gitMergeCommon.py
176 LIB_FILE=libgit.a
178 LIB_H = \
179 blob.h cache.h commit.h count-delta.h csum-file.h delta.h \
180 diff.h epoch.h object.h pack.h pkt-line.h quote.h refs.h \
181 run-command.h strbuf.h tag.h tree.h git-compat-util.h
183 DIFF_OBJS = \
184 diff.o diffcore-break.o diffcore-order.o diffcore-pathspec.o \
185 diffcore-pickaxe.o diffcore-rename.o tree-diff.o
187 LIB_OBJS = \
188 blob.o commit.o connect.o count-delta.o csum-file.o \
189 date.o diff-delta.o entry.o exec_cmd.o ident.o index.o \
190 object.o pack-check.o patch-delta.o path.o pkt-line.o \
191 quote.o read-cache.o refs.o run-command.o \
192 server-info.o setup.o sha1_file.o sha1_name.o strbuf.o \
193 tag.o tree.o usage.o config.o environment.o ctype.o copy.o \
194 fetch-clone.o \
195 $(DIFF_OBJS)
197 LIBS = $(LIB_FILE)
198 LIBS += -lz
200 # Shell quote;
201 # Result of this needs to be placed inside ''
202 shq = $(subst ','\'',$(1))
203 # This has surrounding ''
204 shellquote = '$(call shq,$(1))'
207 # Platform specific tweaks
210 # We choose to avoid "if .. else if .. else .. endif endif"
211 # because maintaining the nesting to match is a pain. If
212 # we had "elif" things would have been much nicer...
213 uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not')
214 uname_M := $(shell sh -c 'uname -m 2>/dev/null || echo not')
215 uname_O := $(shell sh -c 'uname -o 2>/dev/null || echo not')
216 uname_R := $(shell sh -c 'uname -r 2>/dev/null || echo not')
218 ifeq ($(uname_S),Darwin)
219 NEEDS_SSL_WITH_CRYPTO = YesPlease
220 NEEDS_LIBICONV = YesPlease
221 ## fink
222 ALL_CFLAGS += -I/sw/include
223 ALL_LDFLAGS += -L/sw/lib
224 ## darwinports
225 ALL_CFLAGS += -I/opt/local/include
226 ALL_LDFLAGS += -L/opt/local/lib
227 endif
228 ifeq ($(uname_S),SunOS)
229 NEEDS_SOCKET = YesPlease
230 NEEDS_NSL = YesPlease
231 NEEDS_LIBICONV = YesPlease
232 SHELL_PATH = /bin/bash
233 NO_STRCASESTR = YesPlease
234 ifeq ($(uname_R),5.8)
235 NO_SETENV = YesPlease
236 endif
237 INSTALL = ginstall
238 TAR = gtar
239 ALL_CFLAGS += -D__EXTENSIONS__
240 endif
241 ifeq ($(uname_O),Cygwin)
242 NO_D_TYPE_IN_DIRENT = YesPlease
243 NO_D_INO_IN_DIRENT = YesPlease
244 NO_STRCASESTR = YesPlease
245 NEEDS_LIBICONV = YesPlease
246 # There are conflicting reports about this.
247 # On some boxes NO_MMAP is needed, and not so elsewhere.
248 # Try uncommenting this if you see things break -- YMMV.
249 # NO_MMAP = YesPlease
250 NO_IPV6 = YesPlease
251 X = .exe
252 endif
253 ifeq ($(uname_S),OpenBSD)
254 NO_STRCASESTR = YesPlease
255 NEEDS_LIBICONV = YesPlease
256 ALL_CFLAGS += -I/usr/local/include
257 ALL_LDFLAGS += -L/usr/local/lib
258 endif
259 ifeq ($(uname_S),NetBSD)
260 NEEDS_LIBICONV = YesPlease
261 ALL_CFLAGS += -I/usr/pkg/include
262 ALL_LDFLAGS += -L/usr/pkg/lib -Wl,-rpath,/usr/pkg/lib
263 endif
264 ifeq ($(uname_S),AIX)
265 NO_STRCASESTR=YesPlease
266 NEEDS_LIBICONV=YesPlease
267 endif
268 ifneq (,$(findstring arm,$(uname_M)))
269 ARM_SHA1 = YesPlease
270 endif
272 -include config.mak
274 ifdef WITH_OWN_SUBPROCESS_PY
275 PYMODULES += compat/subprocess.py
276 else
277 ifneq ($(shell $(PYTHON_PATH) -c 'import subprocess;print"OK"' 2>/dev/null),OK)
278 PYMODULES += compat/subprocess.py
279 endif
280 endif
282 ifdef WITH_SEND_EMAIL
283 SCRIPT_PERL += git-send-email.perl
284 endif
286 ifndef NO_CURL
287 ifdef CURLDIR
288 # This is still problematic -- gcc does not always want -R.
289 ALL_CFLAGS += -I$(CURLDIR)/include
290 CURL_LIBCURL = -L$(CURLDIR)/lib -R$(CURLDIR)/lib -lcurl
291 else
292 CURL_LIBCURL = -lcurl
293 endif
294 PROGRAMS += git-http-fetch$X
295 curl_check := $(shell (echo 070908; curl-config --vernum) | sort -r | sed -ne 2p)
296 ifeq "$(curl_check)" "070908"
297 ifndef NO_EXPAT
298 EXPAT_LIBEXPAT = -lexpat
299 PROGRAMS += git-http-push$X
300 endif
301 endif
302 endif
304 ifndef NO_OPENSSL
305 LIB_OBJS += epoch.o
306 OPENSSL_LIBSSL = -lssl
307 ifdef OPENSSLDIR
308 # Again this may be problematic -- gcc does not always want -R.
309 ALL_CFLAGS += -I$(OPENSSLDIR)/include
310 OPENSSL_LINK = -L$(OPENSSLDIR)/lib -R$(OPENSSLDIR)/lib
311 else
312 OPENSSL_LINK =
313 endif
314 else
315 ALL_CFLAGS += -DNO_OPENSSL
316 MOZILLA_SHA1 = 1
317 OPENSSL_LIBSSL =
318 endif
319 ifdef NEEDS_SSL_WITH_CRYPTO
320 LIB_4_CRYPTO = $(OPENSSL_LINK) -lcrypto -lssl
321 else
322 LIB_4_CRYPTO = $(OPENSSL_LINK) -lcrypto
323 endif
324 ifdef NEEDS_LIBICONV
325 ifdef ICONVDIR
326 # Again this may be problematic -- gcc does not always want -R.
327 ALL_CFLAGS += -I$(ICONVDIR)/include
328 ICONV_LINK = -L$(ICONVDIR)/lib -R$(ICONVDIR)/lib
329 else
330 ICONV_LINK =
331 endif
332 LIB_4_ICONV = $(ICONV_LINK) -liconv
333 else
334 LIB_4_ICONV =
335 endif
336 ifdef NEEDS_SOCKET
337 LIBS += -lsocket
338 SIMPLE_LIB += -lsocket
339 endif
340 ifdef NEEDS_NSL
341 LIBS += -lnsl
342 SIMPLE_LIB += -lnsl
343 endif
344 ifdef NO_D_TYPE_IN_DIRENT
345 ALL_CFLAGS += -DNO_D_TYPE_IN_DIRENT
346 endif
347 ifdef NO_D_INO_IN_DIRENT
348 ALL_CFLAGS += -DNO_D_INO_IN_DIRENT
349 endif
350 ifdef NO_STRCASESTR
351 COMPAT_CFLAGS += -DNO_STRCASESTR
352 COMPAT_OBJS += compat/strcasestr.o
353 endif
354 ifdef NO_SETENV
355 COMPAT_CFLAGS += -DNO_SETENV
356 COMPAT_OBJS += compat/setenv.o
357 endif
358 ifdef NO_MMAP
359 COMPAT_CFLAGS += -DNO_MMAP
360 COMPAT_OBJS += compat/mmap.o
361 endif
362 ifdef NO_IPV6
363 ALL_CFLAGS += -DNO_IPV6
364 endif
365 ifdef NO_SOCKADDR_STORAGE
366 ifdef NO_IPV6
367 ALL_CFLAGS += -Dsockaddr_storage=sockaddr_in
368 else
369 ALL_CFLAGS += -Dsockaddr_storage=sockaddr_in6
370 endif
371 endif
373 ifdef PPC_SHA1
374 SHA1_HEADER = "ppc/sha1.h"
375 LIB_OBJS += ppc/sha1.o ppc/sha1ppc.o
376 else
377 ifdef ARM_SHA1
378 SHA1_HEADER = "arm/sha1.h"
379 LIB_OBJS += arm/sha1.o arm/sha1_arm.o
380 else
381 ifdef MOZILLA_SHA1
382 SHA1_HEADER = "mozilla-sha1/sha1.h"
383 LIB_OBJS += mozilla-sha1/sha1.o
384 else
385 SHA1_HEADER = <openssl/sha.h>
386 LIBS += $(LIB_4_CRYPTO)
387 endif
388 endif
389 endif
391 ALL_CFLAGS += -DSHA1_HEADER=$(call shellquote,$(SHA1_HEADER)) $(COMPAT_CFLAGS)
392 LIB_OBJS += $(COMPAT_OBJS)
393 export prefix TAR INSTALL DESTDIR SHELL_PATH template_dir
394 ### Build rules
396 all: $(ALL_PROGRAMS) git$X gitk
398 all:
399 $(MAKE) -C templates
401 strip: $(PROGRAMS) git$X
402 $(STRIP) $(STRIP_OPTS) $(PROGRAMS) git$X
404 git$X: git.c $(LIB_FILE)
405 $(CC) -DGIT_VERSION='"$(GIT_VERSION)"' \
406 $(CFLAGS) $(COMPAT_CFLAGS) -o $@ $(filter %.c,$^) $(LIB_FILE)
408 $(patsubst %.sh,%,$(SCRIPT_SH)) : % : %.sh
409 rm -f $@
410 sed -e '1s|#!.*/sh|#!$(call shq,$(SHELL_PATH))|' \
411 -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' \
412 $@.sh >$@
413 chmod +x $@
415 $(patsubst %.perl,%,$(SCRIPT_PERL)) : % : %.perl
416 rm -f $@
417 sed -e '1s|#!.*perl|#!$(call shq,$(PERL_PATH))|' \
418 -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' \
419 $@.perl >$@
420 chmod +x $@
422 $(patsubst %.py,%,$(SCRIPT_PYTHON)) : % : %.py
423 rm -f $@
424 sed -e '1s|#!.*python|#!$(call shq,$(PYTHON_PATH))|' \
425 -e 's|@@GIT_PYTHON_PATH@@|$(call shq,$(GIT_PYTHON_DIR))|g' \
426 -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' \
427 $@.py >$@
428 chmod +x $@
430 git-cherry-pick: git-revert
431 cp $< $@
433 # These can record GIT_VERSION
434 git$X git.spec \
435 $(patsubst %.sh,%,$(SCRIPT_SH)) \
436 $(patsubst %.perl,%,$(SCRIPT_PERL)) \
437 $(patsubst %.py,%,$(SCRIPT_PYTHON)) \
438 : GIT-VERSION-FILE
440 %.o: %.c
441 $(CC) -o $*.o -c $(ALL_CFLAGS) $<
442 %.o: %.S
443 $(CC) -o $*.o -c $(ALL_CFLAGS) $<
445 exec_cmd.o: ALL_CFLAGS += -DGIT_EXEC_PATH=\"$(gitexecdir)\"
447 git-%$X: %.o $(LIB_FILE)
448 $(CC) $(ALL_CFLAGS) -o $@ $(ALL_LDFLAGS) $(filter %.o,$^) $(LIBS)
450 git-mailinfo$X : SIMPLE_LIB += $(LIB_4_ICONV)
451 $(SIMPLE_PROGRAMS) : $(LIB_FILE)
452 $(SIMPLE_PROGRAMS) : git-%$X : %.o
453 $(CC) $(ALL_CFLAGS) -o $@ $(ALL_LDFLAGS) $(filter %.o,$^) \
454 $(LIB_FILE) $(SIMPLE_LIB)
456 git-http-fetch$X: fetch.o http.o
457 git-http-push$X: http.o
458 git-local-fetch$X: fetch.o
459 git-ssh-fetch$X: rsh.o fetch.o
460 git-ssh-upload$X: rsh.o
461 git-ssh-pull$X: rsh.o fetch.o
462 git-ssh-push$X: rsh.o
464 git-http-fetch$X: LIBS += $(CURL_LIBCURL)
465 git-http-push$X: LIBS += $(CURL_LIBCURL) $(EXPAT_LIBEXPAT)
466 git-rev-list$X: LIBS += $(OPENSSL_LIBSSL)
468 init-db.o: init-db.c
469 $(CC) -c $(ALL_CFLAGS) \
470 -DDEFAULT_GIT_TEMPLATE_DIR=$(call shellquote,"$(template_dir)") $*.c
472 $(LIB_OBJS): $(LIB_H)
473 $(patsubst git-%$X,%.o,$(PROGRAMS)): $(LIB_H)
474 $(DIFF_OBJS): diffcore.h
476 $(LIB_FILE): $(LIB_OBJS)
477 $(AR) rcs $@ $(LIB_OBJS)
479 doc:
480 $(MAKE) -C Documentation all
483 ### Testing rules
485 test: all
486 $(MAKE) -C t/ all
488 test-date$X: test-date.c date.o ctype.o
489 $(CC) $(ALL_CFLAGS) -o $@ $(ALL_LDFLAGS) test-date.c date.o ctype.o
491 test-delta$X: test-delta.c diff-delta.o patch-delta.o
492 $(CC) $(ALL_CFLAGS) -o $@ $(ALL_LDFLAGS) $^
494 check:
495 for i in *.c; do sparse $(ALL_CFLAGS) $(SPARSE_FLAGS) $$i || exit; done
499 ### Installation rules
501 install: all
502 $(INSTALL) -d -m755 $(call shellquote,$(DESTDIR)$(bindir))
503 $(INSTALL) -d -m755 $(call shellquote,$(DESTDIR)$(gitexecdir))
504 $(INSTALL) $(ALL_PROGRAMS) $(call shellquote,$(DESTDIR)$(gitexecdir))
505 $(INSTALL) git$X gitk $(call shellquote,$(DESTDIR)$(bindir))
506 $(MAKE) -C templates install
507 $(INSTALL) -d -m755 $(call shellquote,$(DESTDIR)$(GIT_PYTHON_DIR))
508 $(INSTALL) $(PYMODULES) $(call shellquote,$(DESTDIR)$(GIT_PYTHON_DIR))
510 install-doc:
511 $(MAKE) -C Documentation install
516 ### Maintainer's dist rules
518 git.spec: git.spec.in
519 sed -e 's/@@VERSION@@/$(GIT_VERSION)/g' < $< > $@
521 GIT_TARNAME=git-$(GIT_VERSION)
522 dist: git.spec git-tar-tree
523 ./git-tar-tree HEAD $(GIT_TARNAME) > $(GIT_TARNAME).tar
524 @mkdir -p $(GIT_TARNAME)
525 @cp git.spec $(GIT_TARNAME)
526 @echo $(GIT_VERSION) > $(GIT_TARNAME)/version
527 $(TAR) rf $(GIT_TARNAME).tar \
528 $(GIT_TARNAME)/git.spec $(GIT_TARNAME)/version
529 @rm -rf $(GIT_TARNAME)
530 gzip -f -9 $(GIT_TARNAME).tar
532 rpm: dist
533 $(RPMBUILD) -ta $(GIT_TARNAME).tar.gz
535 ### Cleaning rules
537 clean:
538 rm -f *.o mozilla-sha1/*.o arm/*.o ppc/*.o compat/*.o $(LIB_FILE)
539 rm -f $(ALL_PROGRAMS) git$X
540 rm -f *.spec *.pyc *.pyo */*.pyc */*.pyo
541 rm -rf $(GIT_TARNAME)
542 rm -f $(GIT_TARNAME).tar.gz git-core_$(GIT_VERSION)-*.tar.gz
543 $(MAKE) -C Documentation/ clean
544 $(MAKE) -C templates clean
545 $(MAKE) -C t/ clean
546 rm -f GIT-VERSION-FILE
548 .PHONY: all install clean strip
549 .PHONY: .FORCE-GIT-VERSION-FILE