From e67ae9880f252800f15f22e8fe45f19e2b3b8e6e Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Fri, 9 Jan 2015 03:53:45 +0000 Subject: switch documentation to olddoc 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 | 1 - .gitignore | 3 +-- .olddoc.yml | 7 +++++++ .wrongdoc.yml | 7 ------- GNUmakefile | 9 +-------- Rakefile | 33 --------------------------------- pkg.mk | 54 ++++++++++++++++++------------------------------------ posix_mq.gemspec | 8 ++++---- 8 files changed, 31 insertions(+), 91 deletions(-) create mode 100644 .olddoc.yml delete mode 100644 .wrongdoc.yml delete mode 100644 Rakefile diff --git a/.document b/.document index c43f92c..31cce4e 100644 --- a/.document +++ b/.document @@ -1,7 +1,6 @@ README LICENSE NEWS -ChangeLog lib ext/posix_mq/posix_mq.c posix-mq-rb_1 diff --git a/.gitignore b/.gitignore index 671dd35..6c393a5 100644 --- a/.gitignore +++ b/.gitignore @@ -5,8 +5,7 @@ Makefile /GIT-VERSION-FILE /local.mk -/NEWS -/ChangeLog +/NEWS* /.manifest /GIT-VERSION-FILE /man diff --git a/.olddoc.yml b/.olddoc.yml new file mode 100644 index 0000000..5527d0b --- /dev/null +++ b/.olddoc.yml @@ -0,0 +1,7 @@ +--- +rdoc_url: http://bogomips.org/ruby_posix_mq/ +cgit_url: http://bogomips.org/ruby_posix_mq.git +git_url: git://bogomips.org/ruby_posix_mq.git +changelog_since: 0.4.0 +merge_html: + posix-mq-rb_1: Documentation/posix-mq-rb.1.html diff --git a/.wrongdoc.yml b/.wrongdoc.yml deleted file mode 100644 index 5527d0b..0000000 --- a/.wrongdoc.yml +++ /dev/null @@ -1,7 +0,0 @@ ---- -rdoc_url: http://bogomips.org/ruby_posix_mq/ -cgit_url: http://bogomips.org/ruby_posix_mq.git -git_url: git://bogomips.org/ruby_posix_mq.git -changelog_since: 0.4.0 -merge_html: - posix-mq-rb_1: Documentation/posix-mq-rb.1.html diff --git a/GNUmakefile b/GNUmakefile index ef19cb3..7565dda 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -1,15 +1,8 @@ all:: +PLACEHOLDERS = posix-mq-rb_1 RSYNC_DEST := bogomips.org:/srv/bogomips/ruby_posix_mq -rfproject := qrp rfpackage := posix_mq -man-rdoc: man html - for i in $(man1_rdoc); do echo > $$i; done -doc:: man-rdoc include pkg.mk -ifneq ($(VERSION),) -release:: - $(RAKE) publish_news VERSION=$(VERSION) -endif base_bins := posix-mq-rb bins := $(addprefix bin/, $(base_bins)) diff --git a/Rakefile b/Rakefile deleted file mode 100644 index af1ad34..0000000 --- a/Rakefile +++ /dev/null @@ -1,33 +0,0 @@ -# -*- encoding: binary -*- -require 'wrongdoc' -cgit_url = Wrongdoc.config[:cgit_url] -git_url = Wrongdoc.config[:git_url] - -desc "post news article to rubyforge" -task :publish_news do - require 'rubyforge' - spec = Gem::Specification.load('posix_mq.gemspec') - tmp = Tempfile.new('rf-news') - _, subject, body = `git cat-file tag v#{spec.version}`.split(/\n\n/, 3) - tmp.puts subject - tmp.puts - tmp.puts spec.description.strip - tmp.puts "" - tmp.puts "* #{spec.homepage}" - tmp.puts "* #{spec.email}" - tmp.puts "* #{git_url}" - tmp.print "\nChanges:\n\n" - tmp.puts body - tmp.flush - system(ENV["VISUAL"], tmp.path) or abort "#{ENV["VISUAL"]} failed: #$?" - msg = File.readlines(tmp.path) - subject = msg.shift - blank = msg.shift - blank == "\n" or abort "no newline after subject!" - subject.strip! - body = msg.join("").strip! - - rf = RubyForge.new.configure - rf.login - rf.post_news('qrp', subject, body) -end diff --git a/pkg.mk b/pkg.mk index 4cd5bef..3c2e910 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 @@ -48,10 +49,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 +64,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,23 +113,9 @@ $(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) @@ -154,8 +133,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 +140,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 +148,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$$' || : +ifneq ($(PLACEHOLDERS),) +$(PLACEHOLDERS): + echo olddoc_placeholder > $@ +endif + .PHONY: all .FORCE-GIT-VERSION-FILE doc test $(test_units) manifest .PHONY: check-warnings diff --git a/posix_mq.gemspec b/posix_mq.gemspec index ee236f3..25ff9fa 100644 --- a/posix_mq.gemspec +++ b/posix_mq.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| @@ -16,12 +16,12 @@ Gem::Specification.new do |s| s.extensions = %w(ext/posix_mq/extconf.rb) s.extra_rdoc_files = extra_rdoc_files(manifest) s.files = manifest - s.homepage = Wrongdoc.config[:rdoc_url] + s.homepage = Olddoc.config['rdoc_url'] s.summary = summary s.rdoc_options = rdoc_options s.rubyforge_project = %q{qrp} s.test_files = manifest.grep(%r{\Atest/test_.*\.rb\z}) - s.add_development_dependency(%q, "~> 1.5") + s.add_development_dependency(%q, "~> 1.0") # s.licenses = %w(LGPLv3) # accessor not compatible with older RubyGems end -- cgit v1.2.3-24-ge0c7