git-describe: documentation.
[git.git] / Makefile
blob47e78982e0c1280b650ce3ee5a9c08b7aaeef184
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_STRCASESTR if you don't have strcasestr.
24 # Define NO_SETENV if you don't have setenv in the C library.
26 # Define PPC_SHA1 environment variable when running make to make use of
27 # a bundled SHA1 routine optimized for PowerPC.
29 # Define ARM_SHA1 environment variable when running make to make use of
30 # a bundled SHA1 routine optimized for ARM.
32 # Define NEEDS_SSL_WITH_CRYPTO if you need -lcrypto with -lssl (Darwin).
34 # Define NEEDS_LIBICONV if linking with libc is not enough (Darwin).
36 # Define NEEDS_SOCKET if linking with libc is not enough (SunOS,
37 # Patrick Mauritz).
39 # Define NO_MMAP if you want to avoid mmap.
41 # Define WITH_OWN_SUBPROCESS_PY if you want to use with python 2.3.
43 # Define NO_IPV6 if you lack IPv6 support and getaddrinfo().
45 # Define COLLISION_CHECK below if you believe that SHA1's
46 # 1461501637330902918203684832716283019655932542976 hashes do not give you
47 # sufficient guarantee that no collisions between objects will ever happen.
49 # Define USE_NSEC below if you want git to care about sub-second file mtimes
50 # and ctimes. Note that you need recent glibc (at least 2.2.4) for this, and
51 # it will BREAK YOUR LOCAL DIFFS! show-diff and anything using it will likely
52 # randomly break unless your underlying filesystem supports those sub-second
53 # times (my ext3 doesn't).
55 # Define USE_STDEV below if you want git to care about the underlying device
56 # change being considered an inode change from the update-cache perspective.
58 GIT_VERSION = 1.0.GIT
60 # CFLAGS and LDFLAGS are for the users to override from the command line.
62 CFLAGS = -g -O2 -Wall
63 LDFLAGS =
64 ALL_CFLAGS = $(CFLAGS)
65 ALL_LDFLAGS = $(LDFLAGS)
67 prefix = $(HOME)
68 bindir = $(prefix)/bin
69 template_dir = $(prefix)/share/git-core/templates/
70 GIT_PYTHON_DIR = $(prefix)/share/git-core/python
71 # DESTDIR=
73 CC = gcc
74 AR = ar
75 TAR = tar
76 INSTALL = install
77 RPMBUILD = rpmbuild
79 # sparse is architecture-neutral, which means that we need to tell it
80 # explicitly what architecture to check for. Fix this up for yours..
81 SPARSE_FLAGS = -D__BIG_ENDIAN__ -D__powerpc__
85 ### --- END CONFIGURATION SECTION ---
87 SCRIPT_SH = \
88 git-add.sh git-bisect.sh git-branch.sh git-checkout.sh \
89 git-cherry.sh git-clone.sh git-commit.sh \
90 git-count-objects.sh git-diff.sh git-fetch.sh \
91 git-format-patch.sh git-log.sh git-ls-remote.sh \
92 git-merge-one-file.sh git-parse-remote.sh \
93 git-prune.sh git-pull.sh git-push.sh git-rebase.sh \
94 git-repack.sh git-request-pull.sh git-reset.sh \
95 git-resolve.sh git-revert.sh git-sh-setup.sh git-status.sh \
96 git-tag.sh git-verify-tag.sh git-whatchanged.sh \
97 git-applymbox.sh git-applypatch.sh git-am.sh \
98 git-merge.sh git-merge-stupid.sh git-merge-octopus.sh \
99 git-merge-resolve.sh git-merge-ours.sh git-grep.sh \
100 git-lost-found.sh
102 SCRIPT_PERL = \
103 git-archimport.perl git-cvsimport.perl git-relink.perl \
104 git-shortlog.perl git-fmt-merge-msg.perl \
105 git-svnimport.perl git-mv.perl git-cvsexportcommit.perl
107 SCRIPT_PYTHON = \
108 git-merge-recursive.py
110 SCRIPTS = $(patsubst %.sh,%,$(SCRIPT_SH)) \
111 $(patsubst %.perl,%,$(SCRIPT_PERL)) \
112 $(patsubst %.py,%,$(SCRIPT_PYTHON)) \
113 gitk git-cherry-pick
115 # The ones that do not have to link with lcrypto nor lz.
116 SIMPLE_PROGRAMS = \
117 git-get-tar-commit-id$X git-mailinfo$X git-mailsplit$X \
118 git-stripspace$X git-daemon$X
120 # ... and all the rest
121 PROGRAMS = \
122 git-apply$X git-cat-file$X \
123 git-checkout-index$X git-clone-pack$X git-commit-tree$X \
124 git-convert-objects$X git-diff-files$X \
125 git-diff-index$X git-diff-stages$X \
126 git-diff-tree$X git-fetch-pack$X git-fsck-objects$X \
127 git-hash-object$X git-index-pack$X git-init-db$X \
128 git-local-fetch$X git-ls-files$X git-ls-tree$X git-merge-base$X \
129 git-merge-index$X git-mktag$X git-pack-objects$X git-patch-id$X \
130 git-peek-remote$X git-prune-packed$X git-read-tree$X \
131 git-receive-pack$X git-rev-list$X git-rev-parse$X \
132 git-send-pack$X git-show-branch$X git-shell$X \
133 git-show-index$X git-ssh-fetch$X \
134 git-ssh-upload$X git-tar-tree$X git-unpack-file$X \
135 git-unpack-objects$X git-update-index$X git-update-server-info$X \
136 git-upload-pack$X git-verify-pack$X git-write-tree$X \
137 git-update-ref$X git-symbolic-ref$X git-check-ref-format$X \
138 git-name-rev$X git-pack-redundant$X git-repo-config$X git-var$X \
139 git-describe$X
141 # what 'all' will build and 'install' will install.
142 ALL_PROGRAMS = $(PROGRAMS) $(SIMPLE_PROGRAMS) $(SCRIPTS) git$X
144 # Backward compatibility -- to be removed after 1.0
145 PROGRAMS += git-ssh-pull$X git-ssh-push$X
147 # Set paths to tools early so that they can be used for version tests.
148 ifndef SHELL_PATH
149 SHELL_PATH = /bin/sh
150 endif
151 ifndef PERL_PATH
152 PERL_PATH = /usr/bin/perl
153 endif
154 ifndef PYTHON_PATH
155 PYTHON_PATH = /usr/bin/python
156 endif
158 PYMODULES = \
159 gitMergeCommon.py
161 LIB_FILE=libgit.a
163 LIB_H = \
164 blob.h cache.h commit.h count-delta.h csum-file.h delta.h \
165 diff.h epoch.h object.h pack.h pkt-line.h quote.h refs.h \
166 run-command.h strbuf.h tag.h tree.h git-compat-util.h
168 DIFF_OBJS = \
169 diff.o diffcore-break.o diffcore-order.o diffcore-pathspec.o \
170 diffcore-pickaxe.o diffcore-rename.o tree-diff.o
172 LIB_OBJS = \
173 blob.o commit.o connect.o count-delta.o csum-file.o \
174 date.o diff-delta.o entry.o ident.o index.o \
175 object.o pack-check.o patch-delta.o path.o pkt-line.o \
176 quote.o read-cache.o refs.o run-command.o \
177 server-info.o setup.o sha1_file.o sha1_name.o strbuf.o \
178 tag.o tree.o usage.o config.o environment.o ctype.o copy.o \
179 fetch-clone.o \
180 $(DIFF_OBJS)
182 LIBS = $(LIB_FILE)
183 LIBS += -lz
185 # Shell quote;
186 # Result of this needs to be placed inside ''
187 shq = $(subst ','\'',$(1))
188 # This has surrounding ''
189 shellquote = '$(call shq,$(1))'
192 # Platform specific tweaks
195 # We choose to avoid "if .. else if .. else .. endif endif"
196 # because maintaining the nesting to match is a pain. If
197 # we had "elif" things would have been much nicer...
198 uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not')
199 uname_M := $(shell sh -c 'uname -m 2>/dev/null || echo not')
200 uname_O := $(shell sh -c 'uname -o 2>/dev/null || echo not')
201 uname_R := $(shell sh -c 'uname -r 2>/dev/null || echo not')
203 ifeq ($(uname_S),Darwin)
204 NEEDS_SSL_WITH_CRYPTO = YesPlease
205 NEEDS_LIBICONV = YesPlease
206 ## fink
207 ALL_CFLAGS += -I/sw/include
208 ALL_LDFLAGS += -L/sw/lib
209 ## darwinports
210 ALL_CFLAGS += -I/opt/local/include
211 ALL_LDFLAGS += -L/opt/local/lib
212 endif
213 ifeq ($(uname_S),SunOS)
214 NEEDS_SOCKET = YesPlease
215 NEEDS_NSL = YesPlease
216 NEEDS_LIBICONV = YesPlease
217 SHELL_PATH = /bin/bash
218 NO_STRCASESTR = YesPlease
219 ifeq ($(uname_R),5.8)
220 NO_SETENV = YesPlease
221 endif
222 INSTALL = ginstall
223 TAR = gtar
224 ALL_CFLAGS += -D__EXTENSIONS__
225 endif
226 ifeq ($(uname_O),Cygwin)
227 NO_STRCASESTR = YesPlease
228 NEEDS_LIBICONV = YesPlease
229 # There are conflicting reports about this.
230 # On some boxes NO_MMAP is needed, and not so elsewhere.
231 # Try uncommenting this if you see things break -- YMMV.
232 # NO_MMAP = YesPlease
233 NO_IPV6 = YesPlease
234 X = .exe
235 ALL_CFLAGS += -DUSE_SYMLINK_HEAD=0
236 endif
237 ifeq ($(uname_S),OpenBSD)
238 NO_STRCASESTR = YesPlease
239 NEEDS_LIBICONV = YesPlease
240 ALL_CFLAGS += -I/usr/local/include
241 ALL_LDFLAGS += -L/usr/local/lib
242 endif
243 ifeq ($(uname_S),NetBSD)
244 NEEDS_LIBICONV = YesPlease
245 ALL_CFLAGS += -I/usr/pkg/include
246 ALL_LDFLAGS += -L/usr/pkg/lib -Wl,-rpath,/usr/pkg/lib
247 endif
248 ifeq ($(uname_S),AIX)
249 NO_STRCASESTR=YesPlease
250 NEEDS_LIBICONV=YesPlease
251 endif
252 ifneq (,$(findstring arm,$(uname_M)))
253 ARM_SHA1 = YesPlease
254 endif
256 -include config.mak
258 ifdef WITH_OWN_SUBPROCESS_PY
259 PYMODULES += compat/subprocess.py
260 else
261 ifneq ($(shell $(PYTHON_PATH) -c 'import subprocess;print"OK"' 2>/dev/null),OK)
262 PYMODULES += compat/subprocess.py
263 endif
264 endif
266 ifdef WITH_SEND_EMAIL
267 SCRIPT_PERL += git-send-email.perl
268 endif
270 ifndef NO_CURL
271 ifdef CURLDIR
272 # This is still problematic -- gcc does not always want -R.
273 ALL_CFLAGS += -I$(CURLDIR)/include
274 CURL_LIBCURL = -L$(CURLDIR)/lib -R$(CURLDIR)/lib -lcurl
275 else
276 CURL_LIBCURL = -lcurl
277 endif
278 PROGRAMS += git-http-fetch$X
279 curl_check := $(shell (echo 070908; curl-config --vernum) | sort -r | sed -ne 2p)
280 ifeq "$(curl_check)" "070908"
281 ifndef NO_EXPAT
282 EXPAT_LIBEXPAT = -lexpat
283 PROGRAMS += git-http-push$X
284 endif
285 endif
286 endif
288 ifndef NO_OPENSSL
289 LIB_OBJS += epoch.o
290 OPENSSL_LIBSSL = -lssl
291 ifdef OPENSSLDIR
292 # Again this may be problematic -- gcc does not always want -R.
293 ALL_CFLAGS += -I$(OPENSSLDIR)/include
294 OPENSSL_LINK = -L$(OPENSSLDIR)/lib -R$(OPENSSLDIR)/lib
295 else
296 OPENSSL_LINK =
297 endif
298 else
299 ALL_CFLAGS += -DNO_OPENSSL
300 MOZILLA_SHA1 = 1
301 OPENSSL_LIBSSL =
302 endif
303 ifdef NEEDS_SSL_WITH_CRYPTO
304 LIB_4_CRYPTO = $(OPENSSL_LINK) -lcrypto -lssl
305 else
306 LIB_4_CRYPTO = $(OPENSSL_LINK) -lcrypto
307 endif
308 ifdef NEEDS_LIBICONV
309 ifdef ICONVDIR
310 # Again this may be problematic -- gcc does not always want -R.
311 ALL_CFLAGS += -I$(ICONVDIR)/include
312 ICONV_LINK = -L$(ICONVDIR)/lib -R$(ICONVDIR)/lib
313 else
314 ICONV_LINK =
315 endif
316 LIB_4_ICONV = $(ICONV_LINK) -liconv
317 else
318 LIB_4_ICONV =
319 endif
320 ifdef NEEDS_SOCKET
321 LIBS += -lsocket
322 SIMPLE_LIB += -lsocket
323 endif
324 ifdef NEEDS_NSL
325 LIBS += -lnsl
326 SIMPLE_LIB += -lnsl
327 endif
328 ifdef NO_STRCASESTR
329 COMPAT_CFLAGS += -DNO_STRCASESTR
330 COMPAT_OBJS += compat/strcasestr.o
331 endif
332 ifdef NO_SETENV
333 COMPAT_CFLAGS += -DNO_SETENV
334 COMPAT_OBJS += compat/setenv.o
335 endif
336 ifdef NO_MMAP
337 COMPAT_CFLAGS += -DNO_MMAP
338 COMPAT_OBJS += compat/mmap.o
339 endif
340 ifdef NO_IPV6
341 ALL_CFLAGS += -DNO_IPV6 -Dsockaddr_storage=sockaddr_in
342 endif
344 ifdef PPC_SHA1
345 SHA1_HEADER = "ppc/sha1.h"
346 LIB_OBJS += ppc/sha1.o ppc/sha1ppc.o
347 else
348 ifdef ARM_SHA1
349 SHA1_HEADER = "arm/sha1.h"
350 LIB_OBJS += arm/sha1.o arm/sha1_arm.o
351 else
352 ifdef MOZILLA_SHA1
353 SHA1_HEADER = "mozilla-sha1/sha1.h"
354 LIB_OBJS += mozilla-sha1/sha1.o
355 else
356 SHA1_HEADER = <openssl/sha.h>
357 LIBS += $(LIB_4_CRYPTO)
358 endif
359 endif
360 endif
362 ALL_CFLAGS += -DSHA1_HEADER=$(call shellquote,$(SHA1_HEADER)) $(COMPAT_CFLAGS)
363 LIB_OBJS += $(COMPAT_OBJS)
364 export prefix TAR INSTALL DESTDIR SHELL_PATH template_dir
365 ### Build rules
367 all: $(ALL_PROGRAMS)
369 all:
370 $(MAKE) -C templates
372 git$X: git.c $(LIB_FILE) Makefile
373 $(CC) -DGIT_EXEC_PATH='"$(bindir)"' -DGIT_VERSION='"$(GIT_VERSION)"' \
374 $(CFLAGS) $(COMPAT_CFLAGS) -o $@ $(filter %.c,$^) $(LIB_FILE)
376 $(patsubst %.sh,%,$(SCRIPT_SH)) : % : %.sh
377 rm -f $@
378 sed -e '1s|#!.*/sh|#!$(call shq,$(SHELL_PATH))|' \
379 -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' \
380 $@.sh >$@
381 chmod +x $@
383 $(patsubst %.perl,%,$(SCRIPT_PERL)) : % : %.perl
384 rm -f $@
385 sed -e '1s|#!.*perl|#!$(call shq,$(PERL_PATH))|' \
386 -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' \
387 $@.perl >$@
388 chmod +x $@
390 $(patsubst %.py,%,$(SCRIPT_PYTHON)) : % : %.py
391 rm -f $@
392 sed -e '1s|#!.*python|#!$(call shq,$(PYTHON_PATH))|' \
393 -e 's|@@GIT_PYTHON_PATH@@|$(call shq,$(GIT_PYTHON_DIR))|g' \
394 -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' \
395 $@.py >$@
396 chmod +x $@
398 git-cherry-pick: git-revert
399 cp $< $@
401 # format-patch records GIT_VERSION
402 git-format-patch: Makefile
404 %.o: %.c
405 $(CC) -o $*.o -c $(ALL_CFLAGS) $<
406 %.o: %.S
407 $(CC) -o $*.o -c $(ALL_CFLAGS) $<
409 git-%$X: %.o $(LIB_FILE)
410 $(CC) $(ALL_CFLAGS) -o $@ $(ALL_LDFLAGS) $(filter %.o,$^) $(LIBS)
412 git-mailinfo$X : SIMPLE_LIB += $(LIB_4_ICONV)
413 $(SIMPLE_PROGRAMS) : $(LIB_FILE)
414 $(SIMPLE_PROGRAMS) : git-%$X : %.o
415 $(CC) $(ALL_CFLAGS) -o $@ $(ALL_LDFLAGS) $(filter %.o,$^) \
416 $(LIB_FILE) $(SIMPLE_LIB)
418 git-http-fetch$X: fetch.o http.o
419 git-http-push$X: http.o
420 git-local-fetch$X: fetch.o
421 git-ssh-fetch$X: rsh.o fetch.o
422 git-ssh-upload$X: rsh.o
423 git-ssh-pull$X: rsh.o fetch.o
424 git-ssh-push$X: rsh.o
426 git-http-fetch$X: LIBS += $(CURL_LIBCURL)
427 git-http-push$X: LIBS += $(CURL_LIBCURL) $(EXPAT_LIBEXPAT)
428 git-rev-list$X: LIBS += $(OPENSSL_LIBSSL)
430 init-db.o: init-db.c
431 $(CC) -c $(ALL_CFLAGS) \
432 -DDEFAULT_GIT_TEMPLATE_DIR=$(call shellquote,"$(template_dir)") $*.c
434 $(LIB_OBJS): $(LIB_H)
435 $(patsubst git-%$X,%.o,$(PROGRAMS)): $(LIB_H)
436 $(DIFF_OBJS): diffcore.h
438 $(LIB_FILE): $(LIB_OBJS)
439 $(AR) rcs $@ $(LIB_OBJS)
441 doc:
442 $(MAKE) -C Documentation all
445 ### Testing rules
447 test: all
448 $(MAKE) -C t/ all
450 test-date$X: test-date.c date.o ctype.o
451 $(CC) $(ALL_CFLAGS) -o $@ $(ALL_LDFLAGS) test-date.c date.o ctype.o
453 test-delta$X: test-delta.c diff-delta.o patch-delta.o
454 $(CC) $(ALL_CFLAGS) -o $@ $(ALL_LDFLAGS) $^
456 check:
457 for i in *.c; do sparse $(ALL_CFLAGS) $(SPARSE_FLAGS) $$i || exit; done
461 ### Installation rules
463 install: all
464 $(INSTALL) -d -m755 $(call shellquote,$(DESTDIR)$(bindir))
465 $(INSTALL) $(ALL_PROGRAMS) $(call shellquote,$(DESTDIR)$(bindir))
466 $(MAKE) -C templates install
467 $(INSTALL) -d -m755 $(call shellquote,$(DESTDIR)$(GIT_PYTHON_DIR))
468 $(INSTALL) $(PYMODULES) $(call shellquote,$(DESTDIR)$(GIT_PYTHON_DIR))
470 install-doc:
471 $(MAKE) -C Documentation install
476 ### Maintainer's dist rules
478 git.spec: git.spec.in Makefile
479 sed -e 's/@@VERSION@@/$(GIT_VERSION)/g' < $< > $@
481 GIT_TARNAME=git-$(GIT_VERSION)
482 dist: git.spec git-tar-tree
483 ./git-tar-tree HEAD $(GIT_TARNAME) > $(GIT_TARNAME).tar
484 @mkdir -p $(GIT_TARNAME)
485 @cp git.spec $(GIT_TARNAME)
486 $(TAR) rf $(GIT_TARNAME).tar $(GIT_TARNAME)/git.spec
487 @rm -rf $(GIT_TARNAME)
488 gzip -f -9 $(GIT_TARNAME).tar
490 rpm: dist
491 $(RPMBUILD) -ta $(GIT_TARNAME).tar.gz
493 deb: dist
494 rm -rf $(GIT_TARNAME)
495 $(TAR) zxf $(GIT_TARNAME).tar.gz
496 dpkg-source -b $(GIT_TARNAME)
497 cd $(GIT_TARNAME) && fakeroot debian/rules binary
499 ### Cleaning rules
501 clean:
502 rm -f *.o mozilla-sha1/*.o arm/*.o ppc/*.o compat/*.o $(LIB_FILE)
503 rm -f $(PROGRAMS) $(SIMPLE_PROGRAMS) git$X
504 rm -f $(filter-out gitk,$(SCRIPTS))
505 rm -f *.spec *.pyc *.pyo */*.pyc */*.pyo
506 rm -rf $(GIT_TARNAME)
507 rm -f $(GIT_TARNAME).tar.gz git-core_$(GIT_VERSION)-*.tar.gz
508 rm -f git-core_$(GIT_VERSION)-*.dsc
509 rm -f git-*_$(GIT_VERSION)-*.deb
510 $(MAKE) -C Documentation/ clean
511 $(MAKE) -C templates clean
512 $(MAKE) -C t/ clean