From f62ef19a4aa3d3e4ce1aa37a499907ff776a8964 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Fri, 24 Dec 2010 08:37:22 +0000 Subject: doc: use wrongdoc for documentation wrongdoc factors out a bunch of common code from this project into its own and removes JavaScript from RDoc to boot. --- GNUmakefile | 89 +++++++++++++++++-------------------------------------------- 1 file changed, 24 insertions(+), 65 deletions(-) (limited to 'GNUmakefile') diff --git a/GNUmakefile b/GNUmakefile index ef0a26c..f2cd1c3 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -1,8 +1,6 @@ # use GNU Make to run tests in parallel, and without depending on RubyGems all:: test -GIT_URL = git://git.bogomips.org/unicorn.git -CGIT_URL = http://git.bogomips.org/cgit/unicorn.git RLFLAGS = -G2 MRI = ruby @@ -157,78 +155,39 @@ clean: $(RM) $(setup_rb_files) $(t_log) $(RM) -r $(test_prefix) man -man: - $(MAKE) -C Documentation install-man +man html: + $(MAKE) -C Documentation install-$@ -pkg_extra := GIT-VERSION-FILE NEWS ChangeLog $(ext)/unicorn_http.c -manifest: $(pkg_extra) man - $(RM) .manifest - $(MAKE) .manifest +pkg_extra := GIT-VERSION-FILE Changelog LATEST NEWS \ + $(ext)/unicorn_http.c $(man1_paths) -.manifest: - (git ls-files && \ - for i in $@ $(pkg_extra) $(man1_paths); \ - do echo $$i; done) | LC_ALL=C sort > $@+ +ChangeLog: GIT-VERSION-FILE .wrongdoc.yml + wrongdoc prepare + +.manifest: ChangeLog $(ext)/unicorn_http.c + (git ls-files && for i in $@ $(pkg_extra); do echo $$i; done) | \ + LC_ALL=C sort > $@+ cmp $@+ $@ || mv $@+ $@ $(RM) $@+ -NEWS: GIT-VERSION-FILE .manifest - $(RAKE) -s news_rdoc > $@+ - mv $@+ $@ - -SINCE = 1.1.5 -ChangeLog: LOG_VERSION = \ - $(shell git rev-parse -q "$(GIT_VERSION)" >/dev/null 2>&1 && \ - echo $(GIT_VERSION) || git describe) -ChangeLog: log_range = v$(SINCE)..$(LOG_VERSION) -ChangeLog: GIT-VERSION-FILE - @echo "ChangeLog from $(GIT_URL) ($(log_range))" > $@+ - @echo >> $@+ - git log $(log_range) | sed -e 's/^/ /' >> $@+ - mv $@+ $@ - -news_atom := http://unicorn.bogomips.org/NEWS.atom.xml -cgit_atom := $(CGIT_URL)/atom/?h=master -atom = - -# using rdoc 2.5.x+ -doc: .document $(ext)/unicorn_http.c NEWS ChangeLog +doc: .document $(ext)/unicorn_http.c man html .wrongdoc.yml for i in $(man1_rdoc); do echo > $$i; done find bin lib -type f -name '*.rbc' -exec rm -f '{}' ';' - rdoc --webcvs=$(CGIT_URL)/tree/%s \ - -t "$(shell sed -ne '1s/^= //p' README)" + $(RM) -r doc + wrongdoc all install -m644 COPYING doc/COPYING - install -m644 $(shell grep '^[A-Z]' .document) doc/ - $(MAKE) -C Documentation install-html install-man + install -m644 $(shell grep '^[A-Z]' .document) doc/ install -m644 $(man1_paths) doc/ - cd doc && for i in $(base_bins); do \ - $(RM) 1.html $${i}.1.html; \ - sed -e '/"documentation">/r man1/'$$i'.1.html' \ - < $${i}_1.html > tmp && mv tmp $${i}_1.html; \ - ln $${i}_1.html $${i}.1.html; \ - done - $(RUBY) -i -p -e \ - '$$_.gsub!("",%q{\&$(call atom,$(cgit_atom))})' \ - doc/ChangeLog.html - $(RUBY) -i -p -e \ - '$$_.gsub!("",%q{\&$(call atom,$(news_atom))})' \ - doc/NEWS.html doc/README.html - $(RAKE) -s news_atom OUT=doc/NEWS.atom.xml - cd doc && ln README.html tmp && mv tmp index.html + tar cf - $$(git ls-files examples/) | (cd doc && tar xf -) $(RM) $(man1_rdoc) # publishes docs to http://unicorn.bogomips.org publish_doc: -git set-file-times - $(RM) -r doc ChangeLog NEWS - $(MAKE) doc LOG_VERSION=$(shell git tag -l | tail -1) - @awk 'BEGIN{RS="=== ";ORS=""}NR==2{sub(/\n$$/,"");print RS""$$0 }' \ - < NEWS > doc/LATEST - find doc/images doc/js -type f | \ - TZ=UTC xargs touch -d '1970-01-01 00:00:00' doc/rdoc.css + $(MAKE) doc + find doc/images -type f | \ + TZ=UTC xargs touch -d '1970-01-01 00:00:02' doc/rdoc.css $(MAKE) doc_gz - tar cf - $$(git ls-files examples/) | (cd doc && tar xf -) chmod 644 $$(find doc -type f) $(RSYNC) -av doc/ unicorn.bogomips.org:/srv/unicorn/ git ls-files | xargs touch @@ -275,10 +234,10 @@ release_changes := release_changes-$(VERSION) release-notes: $(release_notes) release-changes: $(release_changes) $(release_changes): - $(RAKE) -s release_changes > $@+ + wrongdoc release_changes > $@+ $(VISUAL) $@+ && test -s $@+ && mv $@+ $@ $(release_notes): - GIT_URL=$(GIT_URL) $(RAKE) -s release_notes > $@+ + wrongdoc release_notes > $@+ $(VISUAL) $@+ && test -s $@+ && mv $@+ $@ # ensures we're actually on the tagged $(VERSION), only used for release @@ -298,18 +257,18 @@ gem: $(pkggem) install-gem: $(pkggem) gem install $(CURDIR)/$< -$(pkggem): manifest fix-perms +$(pkggem): .manifest fix-perms gem build $(rfpackage).gemspec mkdir -p pkg mv $(@F) $@ $(pkgtgz): distdir = $(basename $@) $(pkgtgz): HEAD = v$(VERSION) -$(pkgtgz): manifest fix-perms +$(pkgtgz): .manifest fix-perms @test -n "$(distdir)" $(RM) -r $(distdir) mkdir -p $(distdir) - tar cf - `cat .manifest` | (cd $(distdir) && tar xf -) + tar cf - $$(cat .manifest) | (cd $(distdir) && tar xf -) cd pkg && tar cf - $(basename $(@F)) | gzip -9 > $(@F)+ mv $@+ $@ @@ -331,5 +290,5 @@ gem install-gem: GIT-VERSION-FILE $(MAKE) $@ VERSION=$(GIT_VERSION) endif -.PHONY: .FORCE-GIT-VERSION-FILE doc $(T) $(slow_tests) manifest man +.PHONY: .FORCE-GIT-VERSION-FILE doc $(T) $(slow_tests) man .PHONY: test-install -- cgit v1.2.3-24-ge0c7