doc: use wrongdoc for documentation
[kgio.git] / GNUmakefile
blobd913176a1e99db1918ed97b5b4488dc4f3e91942
1 # use GNU Make to run tests in parallel, and without depending on RubyGems
2 all::
3 RUBY = ruby
4 RAKE = rake
5 RSYNC = rsync
7 GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
8 @./GIT-VERSION-GEN
9 -include GIT-VERSION-FILE
10 -include local.mk
11 ifeq ($(DLEXT),) # "so" for Linux
12 DLEXT := $(shell $(RUBY) -rrbconfig -e 'puts Config::CONFIG["DLEXT"]')
13 endif
14 ifeq ($(RUBY_VERSION),)
15 RUBY_VERSION := $(shell $(RUBY) -e 'puts RUBY_VERSION')
16 endif
18 install:
19 $(prep_setup_rb)
20 $(RM) -r .install-tmp
21 mkdir .install-tmp
22 $(RUBY) setup.rb all
23 $(RM) $^
24 $(RM) -r .install-tmp
25 $(prep_setup_rb)
27 setup_rb_files := .config InstalledFiles
28 prep_setup_rb := @-$(RM) $(setup_rb_files);$(MAKE) -C $(ext) clean
30 clean:
31 -$(MAKE) -C ext/kgio clean
32 $(RM) $(setup_rb_files) ext/kgio/Makefile
34 pkg_extra := GIT-VERSION-FILE NEWS ChangeLog LATEST
35 ChangeLog: GIT-VERSION-FILE .wrongdoc.yml
36 wrongdoc prepare
38 .manifest: ChangeLog
39 (git ls-files && for i in $@ $(pkg_extra); do echo $$i; done) | \
40 LC_ALL=C sort > $@+
41 cmp $@+ $@ || mv $@+ $@
42 $(RM) $@+
44 doc: .document .wrongdoc.yml
45 find lib ext -type f -name '*.rbc' -exec rm -f '{}' ';'
46 $(RM) -r doc
47 wrongdoc all
48 install -m644 COPYING doc/COPYING
49 install -m644 $(shell grep '^[A-Z]' .document) doc/
51 ifneq ($(VERSION),)
52 rfproject := rainbows
53 rfpackage := kgio
54 pkggem := pkg/$(rfpackage)-$(VERSION).gem
55 pkgtgz := pkg/$(rfpackage)-$(VERSION).tgz
56 release_notes := release_notes-$(VERSION)
57 release_changes := release_changes-$(VERSION)
59 release-notes: $(release_notes)
60 release-changes: $(release_changes)
61 $(release_changes):
62 wrongdoc release_changes > $@+
63 $(VISUAL) $@+ && test -s $@+ && mv $@+ $@
64 $(release_notes):
65 wrongdoc release_notes > $@+
66 $(VISUAL) $@+ && test -s $@+ && mv $@+ $@
68 # ensures we're actually on the tagged $(VERSION), only used for release
69 verify:
70 test x"$(shell umask)" = x0022
71 git rev-parse --verify refs/tags/v$(VERSION)^{}
72 git diff-index --quiet HEAD^0
73 test `git rev-parse --verify HEAD^0` = \
74 `git rev-parse --verify refs/tags/v$(VERSION)^{}`
76 fix-perms:
77 -git ls-tree -r HEAD | awk '/^100644 / {print $$NF}' | xargs chmod 644
78 -git ls-tree -r HEAD | awk '/^100755 / {print $$NF}' | xargs chmod 755
80 gem: $(pkggem)
82 install-gem: $(pkggem)
83 gem install $(CURDIR)/$<
85 $(pkggem): manifest fix-perms
86 gem build $(rfpackage).gemspec
87 mkdir -p pkg
88 mv $(@F) $@
90 $(pkgtgz): distdir = $(basename $@)
91 $(pkgtgz): HEAD = v$(VERSION)
92 $(pkgtgz): manifest fix-perms
93 @test -n "$(distdir)"
94 $(RM) -r $(distdir)
95 mkdir -p $(distdir)
96 tar cf - `cat .manifest` | (cd $(distdir) && tar xf -)
97 cd pkg && tar cf - $(basename $(@F)) | gzip -9 > $(@F)+
98 mv $@+ $@
100 package: $(pkgtgz) $(pkggem)
102 test-release: verify package $(release_notes) $(release_changes)
103 release: verify package $(release_notes) $(release_changes)
104 # make tgz release on RubyForge
105 rubyforge add_release -f -n $(release_notes) -a $(release_changes) \
106 $(rfproject) $(rfpackage) $(VERSION) $(pkgtgz)
107 # push gem to RubyGems.org
108 gem push $(pkggem)
109 # in case of gem downloads from RubyForge releases page
110 -rubyforge add_file \
111 $(rfproject) $(rfpackage) $(VERSION) $(pkggem)
112 $(RAKE) raa_update VERSION=$(VERSION)
113 $(RAKE) publish_news VERSION=$(VERSION)
114 else
115 gem install-gem: GIT-VERSION-FILE
116 $(MAKE) $@ VERSION=$(GIT_VERSION)
117 endif
119 ext := ext/kgio/kgio_ext.$(DLEXT)
120 ext/kgio/Makefile: ext/kgio/extconf.rb
121 cd $(@D) && $(RUBY) extconf.rb
123 $(ext): $(wildcard ext/kgio/*.[ch] ext/kgio/*/*.h) ext/kgio/Makefile
124 $(MAKE) -C $(@D)
126 all:: test
128 build: $(ext)
129 test_units := $(wildcard test/test_*.rb)
130 test: test-unit
131 test-unit: $(test_units)
132 $(test_units): build
133 $(RUBY) -I lib:ext/kgio $@
135 # this requires GNU coreutils variants
136 publish_doc:
137 -git set-file-times
138 $(MAKE) doc
139 find doc/images -type f | \
140 TZ=UTC xargs touch -d '1970-01-01 00:00:00' doc/rdoc.css
141 $(MAKE) doc_gz
142 chmod 644 $$(find doc -type f)
143 $(RSYNC) -av doc/ bogomips.org:/srv/bogomips/kgio/
144 git ls-files | xargs touch
146 # Create gzip variants of the same timestamp as the original so nginx
147 # "gzip_static on" can serve the gzipped versions directly.
148 doc_gz: docs = $(shell find doc -type f ! -regex '^.*\.\(gif\|jpg\|png\|gz\)$$')
149 doc_gz:
150 for i in $(docs); do \
151 gzip --rsyncable -9 < $$i > $$i.gz; touch -r $$i $$i.gz; done
153 .PHONY: .FORCE-GIT-VERSION-FILE doc manifest test $(test_units)