From cba967458df157f3e4aa2dc885eb87013bece175 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sat, 5 Feb 2011 03:25:47 -0800 Subject: [PATCH] clean up packaging and use pkg.mk --- .gitignore | 1 + .wrongdoc.yml | 4 +- GNUmakefile | 177 +++++------------------------------------------------- README | 4 +- Rakefile | 12 ++-- io_splice.gemspec | 10 +-- pkg.mk | 168 +++++++++++++++++++++++++++++++++++++++++++++++++++ 7 files changed, 195 insertions(+), 181 deletions(-) rewrite GNUmakefile (96%) create mode 100644 pkg.mk diff --git a/.gitignore b/.gitignore index 228b730..8054019 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,4 @@ Makefile /doc /coverage LATEST +/tmp diff --git a/.wrongdoc.yml b/.wrongdoc.yml index 8bc0c66..4cda800 100644 --- a/.wrongdoc.yml +++ b/.wrongdoc.yml @@ -1,5 +1,5 @@ --- -cgit_url: http://git.bogomips.org/cgit/ruby_io_splice.git -git_url: git://git.bogomips.org/ruby_io_splice.git +cgit_url: http://bogomips.org/ruby_io_splice.git +git_url: git://bogomips.org/ruby_io_splice.git rdoc_url: http://bogomips.org/ruby_io_splice/ changelog_start: v1.0.0 diff --git a/GNUmakefile b/GNUmakefile dissimilarity index 96% index f58028c..e3b0136 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -1,163 +1,14 @@ -# use GNU Make to run tests in parallel, and without depending on RubyGems -all:: -RUBY = ruby -RAKE = rake -RSYNC = rsync -RCOV = rcov - -GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE - @./GIT-VERSION-GEN --include GIT-VERSION-FILE --include local.mk -ifeq ($(DLEXT),) # "so" for Linux - DLEXT := $(shell $(RUBY) -rrbconfig -e 'puts Config::CONFIG["DLEXT"]') -endif -ifeq ($(RUBY_VERSION),) - RUBY_VERSION := $(shell $(RUBY) -e 'puts RUBY_VERSION') -endif - -install: $(bins) - $(prep_setup_rb) - $(RM) -r .install-tmp - mkdir .install-tmp - cp -p bin/* .install-tmp - $(RUBY) setup.rb all - $(RM) $^ - mv .install-tmp/* bin/ - $(RM) -r .install-tmp - $(prep_setup_rb) - -setup_rb_files := .config InstalledFiles -prep_setup_rb := @-$(RM) $(setup_rb_files);$(MAKE) -C $(ext) clean - -clean: - -$(MAKE) -C ext/io_splice clean - $(RM) $(setup_rb_files) ext/io_splice/Makefile - -pkg_extra := GIT-VERSION-FILE NEWS ChangeLog LATEST -manifest: $(pkg_extra) - $(RM) .manifest - $(MAKE) .manifest - -.manifest: - (git ls-files && \ - for i in $@ $(pkg_extra); \ - do echo $$i; done) | LC_ALL=C sort > $@+ - cmp $@+ $@ || mv $@+ $@ - $(RM) $@+ - -ChangeLog: GIT-VERSION-FILE - wrongdoc prepare - -# using rdoc 2.5.x + workaround patch here: -# rubyforge.org/tracker/index.php?func=detail&aid=28230&group_id=627&atid=2472 -doc: .document ChangeLog - wrongdoc all - install -m644 COPYING doc/COPYING - install -m644 $(shell grep '^[A-Z]' .document) doc/ - tar cf - $$(git ls-files examples/) | (cd doc && tar xf -) - -# publishes docs to http://bogomips.org/ruby_io_splice/, -publish_doc: - -git set-file-times - $(RM) -r doc - $(MAKE) doc - find doc/images -type f | \ - TZ=UTC xargs touch -d '1970-01-01 00:00:02' doc/rdoc.css - $(MAKE) doc_gz - $(RSYNC) -av doc/ bogomips.org:/srv/bogomips/ruby_io_splice/ - git ls-files | xargs touch - -# 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: - for i in $(docs); do \ - gzip --rsyncable -9 < $$i > $$i.gz; touch -r $$i $$i.gz; done - -ifneq ($(VERSION),) -rfproject := qrp -rfpackage := io_splice -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: - test x"$(shell umask)" = x0022 - git rev-parse --verify refs/tags/v$(VERSION)^{} - git diff-index --quiet HEAD^0 - test `git rev-parse --verify HEAD^0` = \ - `git rev-parse --verify refs/tags/v$(VERSION)^{}` - -fix-perms: - -git ls-tree -r HEAD | awk '/^100644 / {print $$NF}' | xargs chmod 644 - -git ls-tree -r HEAD | awk '/^100755 / {print $$NF}' | xargs chmod 755 - -gem: $(pkggem) - -install-gem: $(pkggem) - gem install $(CURDIR)/$< - -$(pkggem): manifest fix-perms - gem build $(rfpackage).gemspec - mkdir -p pkg - mv $(@F) $@ - -$(pkgtgz): distdir = $(basename $@) -$(pkgtgz): HEAD = v$(VERSION) -$(pkgtgz): manifest fix-perms - @test -n "$(distdir)" - $(RM) -r $(distdir) - mkdir -p $(distdir) - tar c `cat .manifest` | (cd $(distdir) && tar x) - cd pkg && tar c $(basename $(@F)) | gzip -9 > $(@F)+ - mv $@+ $@ - -package: $(pkgtgz) $(pkggem) - -test-release: verify package $(release_notes) $(release_changes) -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) - # push gem to Gemcutter - gem push $(pkggem) - # in case of gem downloads from RubyForge releases page - -rubyforge add_file \ - $(rfproject) $(rfpackage) $(VERSION) $(pkggem) - $(RAKE) raa_update VERSION=$(VERSION) -else -gem install-gem: GIT-VERSION-FILE - $(MAKE) $@ VERSION=$(GIT_VERSION) -endif - -ext := ext/io_splice/io_splice_ext.$(DLEXT) -ext/io_splice/Makefile: ext/io_splice/extconf.rb - cd $(@D) && $(RUBY) extconf.rb -$(ext): $(wildcard $(addprefix ext/io_splice/,*.c *.h)) ext/io_splice/Makefile - $(MAKE) -C $(@D) - -all:: test - -build: $(ext) -test: test-unit -rcov: build - $(RCOV) -I lib:ext/io_splice $(test_unit) - -test_unit := $(wildcard test/test_*.rb) -$(test_unit): build - $(RUBY) -I lib:ext/io_splice $@ $(TEST_UNIT_OPTS) -test-unit: $(test_unit) - -.PHONY: .FORCE-GIT-VERSION-FILE doc manifest man test $(test_unit) +all:: +RCOV = rcov +RSYNC_DEST := bogomips.org:/srv/bogomips/ruby_io_splice +rfproject := qrp +rfpackage := io_splice +include pkg.mk +ifneq ($(VERSION),) +release:: + $(RAKE) raa_update VERSION=$(VERSION) + $(RAKE) publish_news VERSION=$(VERSION) +endif +rcov: build + $(RCOV) -I lib:ext/io_splice $(test_unit) +.PHONY: rcov diff --git a/README b/README index 0b33ab5..de64627 100644 --- a/README +++ b/README @@ -66,13 +66,13 @@ standardized and available in non-Linux kernels some day. You can get the latest source via git from the following locations: - git://git.bogomips.org/ruby_io_splice.git + git://bogomips.org/ruby_io_splice.git git://repo.or.cz/ruby_io_splice.git (mirror) You may browse the code from the web and download the latest snapshot tarballs here: -* http://git.bogomips.org/cgit/ruby_io_splice.git (cgit) +* http://bogomips.org/cgit/ruby_io_splice.git (cgit) * http://repo.or.cz/w/ruby_io_splice.git (gitweb) Inline patches (from "git format-patch") to the mailing list are diff --git a/Rakefile b/Rakefile index 628256c..117a03e 100644 --- a/Rakefile +++ b/Rakefile @@ -1,11 +1,9 @@ # -*- encoding: binary -*- -autoload :Gem, 'rubygems' -autoload :Tempfile, 'tempfile' -cgit_url = "http://git.bogomips.org/cgit/ruby_io_splice.git" -git_url = 'git://git.bogomips.org/ruby_io_splice.git' -web_url = "http://bogomips.org/ruby_io_splice/" +require 'wrongdoc' +cgit_url = Wrongdoc.config[:cgit_url] +git_url = Wrongdoc.config[:git_url] -desc "read news article from STDIN and post to rubyforge" +desc "post news article to rubyforge" task :publish_news do require 'rubyforge' spec = Gem::Specification.load('io_splice.gemspec') @@ -60,7 +58,7 @@ task :raa_update do :category_minor => 'System', :url => s.homepage, :download => 'http://rubyforge.org/frs/?group_id=5626', - :license => 'LGPL', + :license => "LGPL", :description_style => 'Plain', :description => desc, :pass => password, diff --git a/io_splice.gemspec b/io_splice.gemspec index 342a62b..c098a63 100644 --- a/io_splice.gemspec +++ b/io_splice.gemspec @@ -1,30 +1,26 @@ # -*- encoding: binary -*- ENV["VERSION"] or abort "VERSION= must be specified" manifest = File.readlines('.manifest').map! { |x| x.chomp! } -test_files = manifest.grep(%r{\Atest/test_.*\.rb\z}) require 'wrongdoc' extend Wrongdoc::Gemspec name, summary, title = readme_metadata Gem::Specification.new do |s| s.name = %q{io_splice} - s.version = ENV["VERSION"] - + s.version = ENV["VERSION"].dup s.authors = ["Ruby io_splice hackers"] s.date = Time.now.utc.strftime('%Y-%m-%d') s.description = readme_description s.email = %q{ruby.io.splice@librelist.com} s.extensions = %w(ext/io_splice/extconf.rb) - s.extra_rdoc_files = extra_rdoc_files(manifest) s.files = manifest s.homepage = Wrongdoc.config[:rdoc_url] s.summary = summary s.rdoc_options = rdoc_options - s.require_paths = %w(lib) s.rubyforge_project = %q{qrp} - s.test_files = test_files - s.add_development_dependency('wrongdoc', '~> 1.0') + s.test_files = Dir['test/test_*.rb'] + s.add_development_dependency('wrongdoc', '~> 1.5') # s.licenses = %w(LGPL) # accessor not compatible with older RubyGems end diff --git a/pkg.mk b/pkg.mk new file mode 100644 index 0000000..247fa69 --- /dev/null +++ b/pkg.mk @@ -0,0 +1,168 @@ +RUBY = ruby +RAKE = rake +RSYNC = rsync +WRONGDOC = wrongdoc + +GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE + @./GIT-VERSION-GEN +-include GIT-VERSION-FILE +-include local.mk +DLEXT := $(shell $(RUBY) -rrbconfig -e 'puts RbConfig::CONFIG["DLEXT"]') +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) +ext_h := $(wildcard $(ext)/*/*.h $(ext)/*.h) +ext_src := $(wildcard $(ext)/*.c $(ext_h)) +ext_pfx_src := $(addprefix $(ext_pfx)/,$(ext_src)) +ext_d := $(ext_pfx)/$(ext)/.d +$(ext)/extconf.rb: $(wildcard $(ext)/*.h) + @>> $@ +$(ext_d): + @mkdir -p $(@D) + @> $@ +$(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 +ext_sfx := _ext.$(DLEXT) +ext_dl := $(ext_pfx)/$(ext)/$(notdir $(ext)_ext.$(DLEXT)) +$(ext_dl): $(ext_src) $(ext_pfx_src) $(ext_pfx)/$(ext)/Makefile + @echo $^ == $@ + $(MAKE) -C $(@D) +lib := $(lib):$(ext_pfx)/$(ext) +build: $(ext_dl) +endif + +pkg_extra := GIT-VERSION-FILE NEWS ChangeLog LATEST +ChangeLog: GIT-VERSION-FILE .wrongdoc.yml + $(WRONGDOC) prepare + +manifest: + $(RM) .manifest + $(MAKE) .manifest + +.manifest: ChangeLog + (git ls-files && for i in $@ $(pkg_extra); do echo $$i; done) | \ + LC_ALL=C sort > $@+ + cmp $@+ $@ || mv $@+ $@ + $(RM) $@+ + +doc:: .document .wrongdoc.yml + find lib -type f -name '*.rbc' -exec rm -f '{}' ';' + -find ext -type f -name '*.rbc' -exec rm -f '{}' ';' + $(RM) -r doc + $(WRONGDOC) all + install -m644 COPYING doc/COPYING + install -m644 $(shell 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: + test x"$(shell umask)" = x0022 + git rev-parse --verify refs/tags/v$(VERSION)^{} + git diff-index --quiet HEAD^0 + test $$(git rev-parse --verify HEAD^0) = \ + $$(git rev-parse --verify refs/tags/v$(VERSION)^{}) + +fix-perms: + -git ls-tree -r HEAD | awk '/^100644 / {print $$NF}' | xargs chmod 644 + -git ls-tree -r HEAD | awk '/^100755 / {print $$NF}' | xargs chmod 755 + +gem: $(pkggem) + +install-gem: $(pkggem) + gem install $(CURDIR)/$< + +$(pkggem): manifest fix-perms + gem build $(rfpackage).gemspec + mkdir -p pkg + mv $(@F) $@ + +$(pkgtgz): distdir = $(basename $@) +$(pkgtgz): HEAD = v$(VERSION) +$(pkgtgz): manifest fix-perms + @test -n "$(distdir)" + $(RM) -r $(distdir) + mkdir -p $(distdir) + tar cf - $$(cat .manifest) | (cd $(distdir) && tar xf -) + cd pkg && tar cf - $(basename $(@F)) | gzip -9 > $(@F)+ + mv $@+ $@ + +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) + # 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 +test_units := $(wildcard test/test_*.rb) +test: test-unit +test-unit: $(test_units) +$(test_units): build + $(RUBY) -I $(lib) $@ + +# this requires GNU coreutils variants +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 +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: + for i in $(docs); do \ + gzip --rsyncable -9 < $$i > $$i.gz; touch -r $$i $$i.gz; done + +.PHONY: all .FORCE-GIT-VERSION-FILE doc test $(test_units) manifest -- 2.11.4.GIT