From 87f01b049e62d31eba57d91580876b30066b1e99 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Wed, 14 Jan 2015 08:31:18 +0000 Subject: doc: switch to olddoc for the website wrongdoc was difficult to maintain because of the tidy-ffi dependency and the HTML5 changes in Darkfish could not be handled well by Tidy. olddoc is superior as it generates leaner HTML which loads faster, requires less scrolling and less processing power to render. Aesthetic comparisons are subjective of course but completely unimportant compared to speed and accessibility. --- .document | 2 -- .gitignore | 3 +-- .olddoc.yml | 7 ++++++ .wrongdoc.yml | 7 ------ GNUmakefile | 1 - pkg.mk | 71 +++++++++++++++++++---------------------------------------- tdb.gemspec | 9 ++++---- 7 files changed, 35 insertions(+), 65 deletions(-) create mode 100644 .olddoc.yml delete mode 100644 .wrongdoc.yml diff --git a/.document b/.document index dde87b5..7521d69 100644 --- a/.document +++ b/.document @@ -3,7 +3,5 @@ README Hash_Functions TODO NEWS -ChangeLog lib ext/tdb/tdb.c -LATEST diff --git a/.gitignore b/.gitignore index 34de2c6..ed04b6b 100644 --- a/.gitignore +++ b/.gitignore @@ -10,8 +10,7 @@ Makefile log/ pkg/ -/NEWS -/ChangeLog +/NEWS* /.manifest /GIT-VERSION-FILE /man diff --git a/.olddoc.yml b/.olddoc.yml new file mode 100644 index 0000000..d2259b1 --- /dev/null +++ b/.olddoc.yml @@ -0,0 +1,7 @@ +--- +cgit_url: http://bogomips.org/ruby-tdb.git +git_url: git://bogomips.org/ruby-tdb.git +rdoc_url: http://bogomips.org/ruby-tdb/ +ml_url: http://bogomips.org/ruby-tdb-public/ +public_email: ruby-tdb-public@bogomips.org +private_email: ruby-tdb@bogomips.org diff --git a/.wrongdoc.yml b/.wrongdoc.yml deleted file mode 100644 index d2259b1..0000000 --- a/.wrongdoc.yml +++ /dev/null @@ -1,7 +0,0 @@ ---- -cgit_url: http://bogomips.org/ruby-tdb.git -git_url: git://bogomips.org/ruby-tdb.git -rdoc_url: http://bogomips.org/ruby-tdb/ -ml_url: http://bogomips.org/ruby-tdb-public/ -public_email: ruby-tdb-public@bogomips.org -private_email: ruby-tdb@bogomips.org diff --git a/GNUmakefile b/GNUmakefile index 8b02476..22138c8 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -1,6 +1,5 @@ all:: RSYNC_DEST := bogomips.org:/srv/bogomips/ruby-tdb -rfproject := qrp rfpackage := tdb include pkg.mk diff --git a/pkg.mk b/pkg.mk index 4cd5bef..1e40915 100644 --- a/pkg.mk +++ b/pkg.mk @@ -1,7 +1,8 @@ RUBY = ruby RAKE = rake RSYNC = rsync -WRONGDOC = wrongdoc +OLDDOC = olddoc +RDOC = rdoc GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE @./GIT-VERSION-GEN @@ -12,14 +13,6 @@ RUBY_VERSION := $(shell $(RUBY) -e 'puts RUBY_VERSION') RUBY_ENGINE := $(shell $(RUBY) -e 'puts((RUBY_ENGINE rescue "ruby"))') lib := lib -ifeq ($(shell test -f script/isolate_for_tests && echo t),t) -isolate_libs := tmp/isolate/$(RUBY_ENGINE)-$(RUBY_VERSION)/isolate.mk -$(isolate_libs): script/isolate_for_tests - @$(RUBY) script/isolate_for_tests --include $(isolate_libs) -lib := $(lib):$(ISOLATE_LIBS) -endif - ext := $(firstword $(wildcard ext/*)) ifneq ($(ext),) ext_pfx := tmp/ext/$(RUBY_ENGINE)-$(RUBY_VERSION) @@ -36,7 +29,7 @@ $(ext_pfx)/$(ext)/%: $(ext)/% $(ext_d) install -m 644 $< $@ $(ext_pfx)/$(ext)/Makefile: $(ext)/extconf.rb $(ext_d) $(ext_h) $(RM) -f $(@D)/*.o - cd $(@D) && $(RUBY) $(CURDIR)/$(ext)/extconf.rb + cd $(@D) && $(RUBY) $(CURDIR)/$(ext)/extconf.rb $(EXTCONF_ARGS) ext_sfx := _ext.$(DLEXT) ext_dl := $(ext_pfx)/$(ext)/$(notdir $(ext)_ext.$(DLEXT)) $(ext_dl): $(ext_src) $(ext_pfx_src) $(ext_pfx)/$(ext)/Makefile @@ -48,10 +41,10 @@ else build: endif -pkg_extra += GIT-VERSION-FILE NEWS ChangeLog LATEST -ChangeLog: GIT-VERSION-FILE .wrongdoc.yml - $(WRONGDOC) prepare -NEWS LATEST: ChangeLog +pkg_extra += GIT-VERSION-FILE NEWS LATEST +NEWS: GIT-VERSION-FILE .olddoc.yml + $(OLDDOC) prepare +LATEST: NEWS manifest: $(RM) .manifest @@ -63,28 +56,20 @@ manifest: cmp $@+ $@ || mv $@+ $@ $(RM) $@+ -doc:: .document .wrongdoc.yml $(pkg_extra) +doc:: .document .olddoc.yml $(pkg_extra) $(PLACEHOLDERS) -find lib -type f -name '*.rbc' -exec rm -f '{}' ';' -find ext -type f -name '*.rbc' -exec rm -f '{}' ';' $(RM) -r doc - $(WRONGDOC) all + $(RDOC) -f oldweb + $(OLDDOC) merge install -m644 COPYING doc/COPYING + install -m644 NEWS doc/NEWS + install -m644 NEWS.atom.xml doc/NEWS.atom.xml install -m644 $(shell LC_ALL=C grep '^[A-Z]' .document) doc/ ifneq ($(VERSION),) pkggem := pkg/$(rfpackage)-$(VERSION).gem pkgtgz := pkg/$(rfpackage)-$(VERSION).tgz -release_notes := release_notes-$(VERSION) -release_changes := release_changes-$(VERSION) - -release-notes: $(release_notes) -release-changes: $(release_changes) -$(release_changes): - $(WRONGDOC) release_changes > $@+ - $(VISUAL) $@+ && test -s $@+ && mv $@+ $@ -$(release_notes): - $(WRONGDOC) release_notes > $@+ - $(VISUAL) $@+ && test -s $@+ && mv $@+ $@ # ensures we're actually on the tagged $(VERSION), only used for release verify: @@ -120,31 +105,18 @@ $(pkgtgz): manifest fix-perms package: $(pkgtgz) $(pkggem) -test-release:: verify package $(release_notes) $(release_changes) - # make tgz release on RubyForge - @echo rubyforge add_release -f \ - -n $(release_notes) -a $(release_changes) \ - $(rfproject) $(rfpackage) $(VERSION) $(pkgtgz) - @echo gem push $(pkggem) - @echo rubyforge add_file \ - $(rfproject) $(rfpackage) $(VERSION) $(pkggem) -release:: verify package $(release_notes) $(release_changes) - # make tgz release on RubyForge - rubyforge add_release -f -n $(release_notes) -a $(release_changes) \ - $(rfproject) $(rfpackage) $(VERSION) $(pkgtgz) +release:: verify package # push gem to RubyGems.org gem push $(pkggem) - # in case of gem downloads from RubyForge releases page - rubyforge add_file \ - $(rfproject) $(rfpackage) $(VERSION) $(pkggem) else gem install-gem: GIT-VERSION-FILE $(MAKE) $@ VERSION=$(GIT_VERSION) endif -all:: test +all:: check test_units := $(wildcard test/test_*.rb) -test: test-unit +test: check +check: test-unit test-unit: $(test_units) $(test_units): build $(RUBY) -I $(lib) $@ $(RUBY_TEST_OPTS) @@ -154,8 +126,6 @@ ifneq ($(RSYNC_DEST),) publish_doc: -git set-file-times $(MAKE) doc - find doc/images -type f | \ - TZ=UTC xargs touch -d '1970-01-01 00:00:06' doc/rdoc.css $(MAKE) doc_gz $(RSYNC) -av doc/ $(RSYNC_DEST)/ git ls-files | xargs touch @@ -163,7 +133,7 @@ endif # Create gzip variants of the same timestamp as the original so nginx # "gzip_static on" can serve the gzipped versions directly. -doc_gz: docs = $(shell find doc -type f ! -regex '^.*\.\(gif\|jpg\|png\|gz\)$$') +doc_gz: docs = $(shell find doc -type f ! -regex '^.*\.gz$$') doc_gz: for i in $(docs); do \ gzip --rsyncable -9 < $$i > $$i.gz; touch -r $$i $$i.gz; done @@ -171,5 +141,10 @@ check-warnings: @(for i in $$(git ls-files '*.rb'| grep -v '^setup\.rb$$'); \ do $(RUBY) -d -W2 -c $$i; done) | grep -v '^Syntax OK$$' || : -.PHONY: all .FORCE-GIT-VERSION-FILE doc test $(test_units) manifest +ifneq ($(PLACEHOLDERS),) +$(PLACEHOLDERS): + echo olddoc_placeholder > $@ +endif + +.PHONY: all .FORCE-GIT-VERSION-FILE doc check test $(test_units) manifest .PHONY: check-warnings diff --git a/tdb.gemspec b/tdb.gemspec index bad795a..c472e16 100644 --- a/tdb.gemspec +++ b/tdb.gemspec @@ -1,7 +1,7 @@ ENV["VERSION"] or abort "VERSION= must be specified" manifest = File.readlines('.manifest').map! { |x| x.chomp! } -require 'wrongdoc' -extend Wrongdoc::Gemspec +require 'olddoc' +extend Olddoc::Gemspec name, summary, title = readme_metadata Gem::Specification.new do |s| @@ -13,11 +13,10 @@ Gem::Specification.new do |s| s.email = %q{ruby-tdb@bogomips.org} s.extra_rdoc_files = extra_rdoc_files(manifest) s.files = manifest - s.rdoc_options = rdoc_options s.summary = summary s.test_files = Dir['test/test_*.rb'] s.extensions = %w(ext/tdb/extconf.rb) - s.add_development_dependency('wrongdoc', '~> 1.8', '>= 1.8.1') + s.add_development_dependency('olddoc', '~> 1.0') s.add_development_dependency('test-unit', '>= 2.0', '< 4.0') - s.licenses = %w(LGPLv2.1+) + s.licenses = %w(LGPL-2.1+) end -- cgit v1.2.3-24-ge0c7