From ce03e1fb74bb3654b73792a58598813809dbf6df Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Thu, 15 Jan 2015 02:57:36 +0000 Subject: switch documentation over to olddoc wrongdoc was difficult to maintain for various reasons, and olddoc is more complete and maintainable, and generates faster websites. ref: http://80x24.org/olddoc/ --- .document | 1 - .gitignore | 3 +-- .olddoc.yml | 6 +++++ .wrongdoc.yml | 6 ----- pkg.mk | 71 +++++++++++++++++++-------------------------------------- wordexp.gemspec | 12 ++++------ 6 files changed, 35 insertions(+), 64 deletions(-) create mode 100644 .olddoc.yml delete mode 100644 .wrongdoc.yml diff --git a/.document b/.document index af6bd65..50bd824 100644 --- a/.document +++ b/.document @@ -1,3 +1,2 @@ -ChangeLog NEWS README diff --git a/.gitignore b/.gitignore index 39fd1c6..50cb71d 100644 --- a/.gitignore +++ b/.gitignore @@ -5,8 +5,7 @@ log/ pkg/ /vendor -/NEWS -/ChangeLog +/NEWS* /.manifest /GIT-VERSION-FILE /man diff --git a/.olddoc.yml b/.olddoc.yml new file mode 100644 index 0000000..8f125f7 --- /dev/null +++ b/.olddoc.yml @@ -0,0 +1,6 @@ +--- +cgit_url: http://bogomips.org/ruby-wordexp.git +git_url: git://bogomips.org/ruby-wordexp.git +rdoc_url: http://bogomips.org/ruby-wordexp/README +private_email: normalperson@yhbt.net +public_email: ruby.wordexp@librelist.org diff --git a/.wrongdoc.yml b/.wrongdoc.yml deleted file mode 100644 index 8f125f7..0000000 --- a/.wrongdoc.yml +++ /dev/null @@ -1,6 +0,0 @@ ---- -cgit_url: http://bogomips.org/ruby-wordexp.git -git_url: git://bogomips.org/ruby-wordexp.git -rdoc_url: http://bogomips.org/ruby-wordexp/README -private_email: normalperson@yhbt.net -public_email: ruby.wordexp@librelist.org 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/wordexp.gemspec b/wordexp.gemspec index 8487a19..21fb802 100644 --- a/wordexp.gemspec +++ b/wordexp.gemspec @@ -1,8 +1,8 @@ # -*- encoding: binary -*- 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| @@ -10,16 +10,14 @@ Gem::Specification.new do |s| s.version = ENV["VERSION"].dup s.authors = ["Eric Wong"] - s.date = Time.now.utc.strftime('%Y-%m-%d') s.description = readme_description s.email = %q{normalperson@yhbt.net} s.extra_rdoc_files = extra_rdoc_files(manifest) s.extensions = %w(ext/wordexp/extconf.rb) s.files = manifest - s.homepage = Wrongdoc.config[:rdoc_url] + s.homepage = Olddoc.config['rdoc_url'] s.summary = summary - s.rdoc_options = rdoc_options s.test_files = Dir['test/test_*.rb'] - s.licenses = %w(LGPLv2.1+) - s.add_development_dependency('wrongdoc', '~> 1.7') + s.licenses = %w(LGPL-2.1+) + s.add_development_dependency('olddoc', '~> 1.0') end -- cgit v1.2.3-24-ge0c7