看一個開源項目最好的方法就是先看一下該項目根目錄下的Makefile文件,Makefile文件是整個項目的提綱,裡面詳細說明了生成目標文件需要的依賴關系,以及項目下各文件之間的依賴關系,同樣讓我們來看一下Redis項目下的Makefile文件,Makefile文件的源代碼如下所示:
# Redis Makefile
# Copyright (C) 2009 Salvatore Sanfilippo <antirez at gmail dot com>
# This file is released under the BSD license, see the COPYING file
#此條語句是Makefile中的條件賦值
# -g表示產生調試信息
# -rdynamic用來通知鏈接器將所有的符號添加到動態符號表中
# -ggdb表未要讓gcc為GDB生成專用的更為豐富的調試信息
DEBUG?= -g -rdynamic -ggdb
# -std=c99表示C語言的版本采用的是C99標准
# -pedantic打開完全服從ANSI C標准所需的全部警告診斷;拒絕接受采用了被禁止的語法擴展的程序
# -O2表示程序代碼的優化級別
# -Wall表示打開警告開關
# -W不生成任何警告信息
CFLAGS?= -std=c99 -pedantic -O2 -Wall -W
# CC在Makefile中表示的是編譯器,這裡就是編譯器的選項
CCOPT= $(CFLAGS)
# 這些OBJ基本上都是服務器端的
OBJ = adlist.o ae.o anet.o dict.o redis.o sds.o zmalloc.o lzf_c.o lzf_d.o pqsort.o
# 與性能測試相關的
BENCHOBJ = ae.o anet.o benchmark.o sds.o adlist.o zmalloc.o
# 這些OBJ基本上都是客戶端的
CLIOBJ = anet.o sds.o adlist.o redis-cli.o zmalloc.o
# 服務器端
PRGNAME = redis-server
# 性能測試相關
BENCHPRGNAME = redis-benchmark
# 客戶端
CLIPRGNAME = redis-cli
# 偽目標,make會將第一個出現的目標作為默認目標,就是只執行make不加目標名的時候,第一個目標名通常是all
all: redis-server redis-benchmark redis-cli
# Deps (use make dep to generate this)
# 下面是各種依賴
adlist.o: adlist.c adlist.h zmalloc.h
ae.o: ae.c ae.h zmalloc.h
anet.o: anet.c fmacros.h anet.h
benchmark.o: benchmark.c fmacros.h ae.h anet.h sds.h adlist.h zmalloc.h
dict.o: dict.c fmacros.h dict.h zmalloc.h
lzf_c.o: lzf_c.c lzfP.h
lzf_d.o: lzf_d.c lzfP.h
pqsort.o: pqsort.c
redis-cli.o: redis-cli.c fmacros.h anet.h sds.h adlist.h zmalloc.h
redis.o: redis.c fmacros.h ae.h sds.h anet.h dict.h adlist.h zmalloc.h lzf.h pqsort.h config.h
sds.o: sds.c sds.h zmalloc.h
zmalloc.o: zmalloc.c config.h
# $(OBJ)表示要生成redis-server需要依賴的文件
redis-server: $(OBJ)
$(CC) -o $(PRGNAME) $(CCOPT) $(DEBUG) $(OBJ)
@echo ""
@echo "Hint: To run the test-redis.tcl script is a good idea."
@echo "Launch the redis server with ./redis-server, then in another"
@echo "terminal window enter this directory and run 'make test'."
@echo ""
# 編譯生成性能測試工具,$(BENCHOBJ)表示生成性能測試工具時依賴的文件
redis-benchmark: $(BENCHOBJ)
$(CC) -o $(BENCHPRGNAME) $(CCOPT) $(DEBUG) $(BENCHOBJ)
# 編譯生成redis客戶端程序
redis-cli: $(CLIOBJ)
$(CC) -o $(CLIPRGNAME) $(CCOPT) $(DEBUG) $(CLIOBJ)
# 其實和%o:%c等價,是Makefile裡的舊格式
# gcc -o test.o test.c
# 在該規則的作用下,會變成gcc -c $(CCOPT) $(DEBUG) $(COMPILE_TIME) test.c
# -c選項表示是只編譯不鏈接
.c.o:
$(CC) -c $(CCOPT) $(DEBUG) $(COMPILE_TIME) $<
# 刪除生成的目標程序以及所有的中間目標文件
clean:
rm -rf $(PRGNAME) $(BENCHPRGNAME) $(CLIPRGNAME) *.o
# -MM選項表示的是是列出源文件對其他文件的依賴關系
dep:
$(CC) -MM *.c
# 開啟對服務器端進行測試
test:
tclsh test-redis.tcl
# 開啟性能測試
bench:
./redis-benchmark
# 將工程的更新日志信息輸出到本地的Changelog裡
log:
git log '--pretty=format:%ad %s' --date=short > Changelog
在這裡注釋我已經寫的很清楚了,從Makefile文件裡可以看出各種依賴關系,在這裡這些依賴關系可以由make dep自動生成,在執行make dep時實際上執行的是gcc -MM *.c,在gcc中有兩種選項可以生成依賴關系,-M與-MM,所不同的是-MM選項不會列出對於系統頭文件的依賴關系。
Redis1.0源碼以及相關注釋
Github:https://github.com/zwjlpeng/redis_source_anntation