author | Todd Zullinger <tmz@pobox.com> | 2010-09-06 13:31:22 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2010-09-19 17:11:45 (UTC) |
commit | 679f7ef4f3f31dca8c8ac5536c3e18a5188e051a (patch) (unidiff) | |
tree | 2f0085a1858cbf4f7f3534d6af0f0f7c6f604ce5 | |
parent | a9d6e6e695da6c6ed7f4bb32630ab2f3d9314806 (diff) | |
download | cgit-679f7ef4f3f31dca8c8ac5536c3e18a5188e051a.zip cgit-679f7ef4f3f31dca8c8ac5536c3e18a5188e051a.tar.gz cgit-679f7ef4f3f31dca8c8ac5536c3e18a5188e051a.tar.bz2 |
Generalize doc generation
This borrows from the git Documentation/Makefile. The goal is to make
it easier to add new man pages and other documentation as well as to
prevent make from re-generating the documentation needlessly.
Signed-off-by: Todd Zullinger <tmz@pobox.com>
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
-rw-r--r-- | Makefile | 23 |
1 files changed, 16 insertions, 7 deletions
@@ -1,26 +1,31 @@ | |||
1 | CGIT_VERSION = v0.8.3.3 | 1 | CGIT_VERSION = v0.8.3.3 |
2 | CGIT_SCRIPT_NAME = cgit.cgi | 2 | CGIT_SCRIPT_NAME = cgit.cgi |
3 | CGIT_SCRIPT_PATH = /var/www/htdocs/cgit | 3 | CGIT_SCRIPT_PATH = /var/www/htdocs/cgit |
4 | CGIT_DATA_PATH = $(CGIT_SCRIPT_PATH) | 4 | CGIT_DATA_PATH = $(CGIT_SCRIPT_PATH) |
5 | CGIT_CONFIG = /etc/cgitrc | 5 | CGIT_CONFIG = /etc/cgitrc |
6 | CACHE_ROOT = /var/cache/cgit | 6 | CACHE_ROOT = /var/cache/cgit |
7 | SHA1_HEADER = <openssl/sha.h> | 7 | SHA1_HEADER = <openssl/sha.h> |
8 | GIT_VER = 1.7.3 | 8 | GIT_VER = 1.7.3 |
9 | GIT_URL = http://www.kernel.org/pub/software/scm/git/git-$(GIT_VER).tar.bz2 | 9 | GIT_URL = http://www.kernel.org/pub/software/scm/git/git-$(GIT_VER).tar.bz2 |
10 | INSTALL = install | 10 | INSTALL = install |
11 | MAN5_TXT = $(wildcard *.5.txt) | ||
12 | MAN_TXT = $(MAN5_TXT) | ||
13 | DOC_MAN5 = $(patsubst %.txt,%,$(MAN5_TXT)) | ||
14 | DOC_HTML = $(patsubst %.txt,%.html,$(MAN_TXT)) | ||
15 | DOC_PDF = $(patsubst %.txt,%.pdf,$(MAN_TXT)) | ||
11 | 16 | ||
12 | # Define NO_STRCASESTR if you don't have strcasestr. | 17 | # Define NO_STRCASESTR if you don't have strcasestr. |
13 | # | 18 | # |
14 | # Define NO_OPENSSL to disable linking with OpenSSL and use bundled SHA1 | 19 | # Define NO_OPENSSL to disable linking with OpenSSL and use bundled SHA1 |
15 | # implementation (slower). | 20 | # implementation (slower). |
16 | # | 21 | # |
17 | # Define NEEDS_LIBICONV if linking with libc is not enough (eg. Darwin). | 22 | # Define NEEDS_LIBICONV if linking with libc is not enough (eg. Darwin). |
18 | # | 23 | # |
19 | # Define NO_C99_FORMAT if your formatted IO functions (printf/scanf et.al.) | 24 | # Define NO_C99_FORMAT if your formatted IO functions (printf/scanf et.al.) |
20 | # do not support the 'size specifiers' introduced by C99, namely ll, hh, | 25 | # do not support the 'size specifiers' introduced by C99, namely ll, hh, |
21 | # j, z, t. (representing long long int, char, intmax_t, size_t, ptrdiff_t). | 26 | # j, z, t. (representing long long int, char, intmax_t, size_t, ptrdiff_t). |
22 | # some C compilers supported these specifiers prior to C99 as an extension. | 27 | # some C compilers supported these specifiers prior to C99 as an extension. |
23 | # | 28 | # |
24 | 29 | ||
25 | #-include config.mak | 30 | #-include config.mak |
26 | 31 | ||
@@ -97,33 +102,33 @@ OBJECTS += ui-plain.o | |||
97 | OBJECTS += ui-refs.o | 102 | OBJECTS += ui-refs.o |
98 | OBJECTS += ui-repolist.o | 103 | OBJECTS += ui-repolist.o |
99 | OBJECTS += ui-shared.o | 104 | OBJECTS += ui-shared.o |
100 | OBJECTS += ui-snapshot.o | 105 | OBJECTS += ui-snapshot.o |
101 | OBJECTS += ui-ssdiff.o | 106 | OBJECTS += ui-ssdiff.o |
102 | OBJECTS += ui-stats.o | 107 | OBJECTS += ui-stats.o |
103 | OBJECTS += ui-summary.o | 108 | OBJECTS += ui-summary.o |
104 | OBJECTS += ui-tag.o | 109 | OBJECTS += ui-tag.o |
105 | OBJECTS += ui-tree.o | 110 | OBJECTS += ui-tree.o |
106 | 111 | ||
107 | ifdef NEEDS_LIBICONV | 112 | ifdef NEEDS_LIBICONV |
108 | EXTLIBS += -liconv | 113 | EXTLIBS += -liconv |
109 | endif | 114 | endif |
110 | 115 | ||
111 | 116 | ||
112 | .PHONY: all libgit test install uninstall clean force-version get-git \ | 117 | .PHONY: all libgit test install uninstall clean force-version get-git \ |
113 | doc man-doc html-doc clean-doc | 118 | doc clean-doc |
114 | 119 | ||
115 | all: cgit | 120 | all: cgit |
116 | 121 | ||
117 | VERSION: force-version | 122 | VERSION: force-version |
118 | @./gen-version.sh "$(CGIT_VERSION)" | 123 | @./gen-version.sh "$(CGIT_VERSION)" |
119 | -include VERSION | 124 | -include VERSION |
120 | 125 | ||
121 | 126 | ||
122 | CFLAGS += -g -Wall -Igit | 127 | CFLAGS += -g -Wall -Igit |
123 | CFLAGS += -DSHA1_HEADER='$(SHA1_HEADER)' | 128 | CFLAGS += -DSHA1_HEADER='$(SHA1_HEADER)' |
124 | CFLAGS += -DCGIT_VERSION='"$(CGIT_VERSION)"' | 129 | CFLAGS += -DCGIT_VERSION='"$(CGIT_VERSION)"' |
125 | CFLAGS += -DCGIT_CONFIG='"$(CGIT_CONFIG)"' | 130 | CFLAGS += -DCGIT_CONFIG='"$(CGIT_CONFIG)"' |
126 | CFLAGS += -DCGIT_SCRIPT_NAME='"$(CGIT_SCRIPT_NAME)"' | 131 | CFLAGS += -DCGIT_SCRIPT_NAME='"$(CGIT_SCRIPT_NAME)"' |
127 | CFLAGS += -DCGIT_CACHE_ROOT='"$(CACHE_ROOT)"' | 132 | CFLAGS += -DCGIT_CACHE_ROOT='"$(CACHE_ROOT)"' |
128 | 133 | ||
129 | ifdef NO_ICONV | 134 | ifdef NO_ICONV |
@@ -157,35 +162,39 @@ libgit: | |||
157 | 162 | ||
158 | test: all | 163 | test: all |
159 | $(QUIET_SUBDIR0)tests $(QUIET_SUBDIR1) all | 164 | $(QUIET_SUBDIR0)tests $(QUIET_SUBDIR1) all |
160 | 165 | ||
161 | install: all | 166 | install: all |
162 | $(INSTALL) -m 0755 -d $(DESTDIR)$(CGIT_SCRIPT_PATH) | 167 | $(INSTALL) -m 0755 -d $(DESTDIR)$(CGIT_SCRIPT_PATH) |
163 | $(INSTALL) -m 0755 cgit $(DESTDIR)$(CGIT_SCRIPT_PATH)/$(CGIT_SCRIPT_NAME) | 168 | $(INSTALL) -m 0755 cgit $(DESTDIR)$(CGIT_SCRIPT_PATH)/$(CGIT_SCRIPT_NAME) |
164 | $(INSTALL) -m 0755 -d $(DESTDIR)$(CGIT_DATA_PATH) | 169 | $(INSTALL) -m 0755 -d $(DESTDIR)$(CGIT_DATA_PATH) |
165 | $(INSTALL) -m 0644 cgit.css $(DESTDIR)$(CGIT_DATA_PATH)/cgit.css | 170 | $(INSTALL) -m 0644 cgit.css $(DESTDIR)$(CGIT_DATA_PATH)/cgit.css |
166 | $(INSTALL) -m 0644 cgit.png $(DESTDIR)$(CGIT_DATA_PATH)/cgit.png | 171 | $(INSTALL) -m 0644 cgit.png $(DESTDIR)$(CGIT_DATA_PATH)/cgit.png |
167 | 172 | ||
168 | uninstall: | 173 | uninstall: |
169 | rm -f $(CGIT_SCRIPT_PATH)/$(CGIT_SCRIPT_NAME) | 174 | rm -f $(CGIT_SCRIPT_PATH)/$(CGIT_SCRIPT_NAME) |
170 | rm -f $(CGIT_DATA_PATH)/cgit.css | 175 | rm -f $(CGIT_DATA_PATH)/cgit.css |
171 | rm -f $(CGIT_DATA_PATH)/cgit.png | 176 | rm -f $(CGIT_DATA_PATH)/cgit.png |
172 | 177 | ||
173 | doc: man-doc html-doc pdf-doc | 178 | doc: doc-man doc-html doc-pdf |
179 | doc-man: doc-man5 | ||
180 | doc-man5: $(DOC_MAN5) | ||
181 | doc-html: $(DOC_HTML) | ||
182 | doc-pdf: $(DOC_PDF) | ||
174 | 183 | ||
175 | man-doc: cgitrc.5.txt | 184 | %.5 : %.5.txt |
176 | a2x -f manpage cgitrc.5.txt | 185 | a2x -f manpage $< |
177 | 186 | ||
178 | html-doc: cgitrc.5.txt | 187 | $(DOC_HTML): %.html : %.txt |
179 | a2x -f xhtml --stylesheet=cgit-doc.css cgitrc.5.txt | 188 | a2x -f xhtml --stylesheet=cgit-doc.css $< |
180 | 189 | ||
181 | pdf-doc: cgitrc.5.txt | 190 | $(DOC_PDF): %.pdf : %.txt |
182 | a2x -f pdf cgitrc.5.txt | 191 | a2x -f pdf cgitrc.5.txt |
183 | 192 | ||
184 | clean: clean-doc | 193 | clean: clean-doc |
185 | rm -f cgit VERSION *.o *.d | 194 | rm -f cgit VERSION *.o *.d |
186 | 195 | ||
187 | clean-doc: | 196 | clean-doc: |
188 | rm -f cgitrc.5 cgitrc.5.html cgitrc.5.pdf cgitrc.5.xml cgitrc.5.fo | 197 | rm -f cgitrc.5 cgitrc.5.html cgitrc.5.pdf cgitrc.5.xml cgitrc.5.fo |
189 | 198 | ||
190 | get-git: | 199 | get-git: |
191 | curl $(GIT_URL) | tar -xj && rm -rf git && mv git-$(GIT_VER) git | 200 | curl $(GIT_URL) | tar -xj && rm -rf git && mv git-$(GIT_VER) git |