* [PATCH 1/3] doc: switch to olddoc
2015-01-09 2:00 [PATCH 0/3] documentation + website updates Eric Wong
@ 2015-01-09 2:00 ` Eric Wong
2015-01-09 2:00 ` [PATCH 2/3] remove references to rubyforge and ancient Rubies Eric Wong
2015-01-09 2:00 ` [PATCH 3/3] TODO: updates for the future of kgio Eric Wong
2 siblings, 0 replies; 4+ messages in thread
From: Eric Wong @ 2015-01-09 2:00 UTC (permalink / raw)
To: kgio-public; +Cc: e, Eric Wong
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 | 2 +-
.wrongdoc.yml => .olddoc.yml | 4 ++++
HACKING | 2 +-
Rakefile | 32 --------------------------------
kgio.gemspec | 8 ++++----
pkg.mk | 19 +++++++++++--------
7 files changed, 21 insertions(+), 47 deletions(-)
rename .wrongdoc.yml => .olddoc.yml (74%)
delete mode 100644 Rakefile
diff --git a/.document b/.document
index 93e7dba..c7e09c6 100644
--- a/.document
+++ b/.document
@@ -3,7 +3,6 @@ README
TODO
NEWS
LATEST
-ChangeLog
ISSUES
HACKING
lib
diff --git a/.gitignore b/.gitignore
index 2368011..2646313 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,7 +12,6 @@ Makefile
log/
pkg/
/NEWS
-/ChangeLog
/.manifest
/GIT-VERSION-FILE
/man
@@ -20,3 +19,4 @@ tags
TAGS
/LATEST
/tmp
+/NEWS.atom.xml
diff --git a/.wrongdoc.yml b/.olddoc.yml
similarity index 74%
rename from .wrongdoc.yml
rename to .olddoc.yml
index 2617ddc..83f2398 100644
--- a/.wrongdoc.yml
+++ b/.olddoc.yml
@@ -1,6 +1,10 @@
---
cgit_url: http://bogomips.org/kgio.git
git_url: git://bogomips.org/kgio.git
+ml_url: http://bogomips.org/kgio-public/
rdoc_url: http://bogomips.org/kgio/
public_email: kgio-public@bogomips.org
private_email: kgio@bogomips.org
+noindex:
+- LATEST
+- TODO
diff --git a/HACKING b/HACKING
index 6cc225f..0a13e84 100644
--- a/HACKING
+++ b/HACKING
@@ -2,7 +2,7 @@
=== Documentation
-We use the latest version of {wrongdoc}[http://bogomips.org/wrongdoc] as
+We use the latest version of {olddoc}[http://80x24.org/olddoc/] as
much as possible.
Please wrap documentation at 72 characters-per-line or less (long URLs
diff --git a/Rakefile b/Rakefile
deleted file mode 100644
index cbeb7a0..0000000
--- a/Rakefile
+++ /dev/null
@@ -1,32 +0,0 @@
-# -*- encoding: binary -*-
-cgit_url = "http://bogomips.org/kgio.git"
-git_url = 'git://bogomips.org/kgio.git'
-
-desc "post news article to rubyforge"
-task :publish_news do
- require 'rubyforge'
- spec = Gem::Specification.load('kgio.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('rainbows', subject, body)
-end
diff --git a/kgio.gemspec b/kgio.gemspec
index 03b8a8c..32217e7 100644
--- a/kgio.gemspec
+++ b/kgio.gemspec
@@ -1,13 +1,13 @@
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|
s.name = %q{kgio}
s.version = ENV["VERSION"].dup
- s.homepage = Wrongdoc.config[:rdoc_url]
+ s.homepage = Olddoc.config['rdoc_url']
s.authors = ["#{name} hackers"]
s.description = readme_description
s.email = %q{kgio-public@bogomips.org}
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
# development dependencies commented out for folks stuck on
# old Ruby/RubyGems versions
- # s.add_development_dependency('wrongdoc', '~> 1.8')
+ s.add_development_dependency('olddoc', '~> 1.0')
# s.add_development_dependency('strace_me', '~> 1.0') # Linux only
s.licenses = %w(LGPLv2.1+)
diff --git a/pkg.mk b/pkg.mk
index 4cd5bef..dd09703 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,12 +64,14 @@ manifest:
cmp $@+ $@ || mv $@+ $@
$(RM) $@+
-doc:: .document .wrongdoc.yml $(pkg_extra)
+doc:: .document .olddoc.yml $(pkg_extra)
-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
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),)
@@ -163,7 +166,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
--
2.2.1.203.g624e5c2
^ permalink raw reply related [flat|nested] 4+ messages in thread* [PATCH 2/3] remove references to rubyforge and ancient Rubies
2015-01-09 2:00 [PATCH 0/3] documentation + website updates Eric Wong
2015-01-09 2:00 ` [PATCH 1/3] doc: switch to olddoc Eric Wong
@ 2015-01-09 2:00 ` Eric Wong
2015-01-09 2:00 ` [PATCH 3/3] TODO: updates for the future of kgio Eric Wong
2 siblings, 0 replies; 4+ messages in thread
From: Eric Wong @ 2015-01-09 2:00 UTC (permalink / raw)
To: kgio-public; +Cc: e, Eric Wong
---
README | 7 ++-----
kgio.gemspec | 3 +--
pkg.mk | 27 +--------------------------
3 files changed, 4 insertions(+), 33 deletions(-)
diff --git a/README b/README
index d3f4804..8236300 100644
--- a/README
+++ b/README
@@ -10,7 +10,7 @@ applications (that run on Unix-like platforms).
* Can avoid expensive exceptions on common EAGAIN/EINPROGRESS errors,
returning :wait_readable or :wait_writable instead.
These exceptions got more expensive to hit under Ruby 1.9.2
- (but should be fixed in Ruby 1.9.3 to 1.9.1 performance levels)
+ (but were fixed in Ruby 1.9.3 and later to 1.9.1 performance levels)
* Returns the unwritten portion of the string on partial writes,
making it ideal for buffering unwritten data.
@@ -32,10 +32,7 @@ applications (that run on Unix-like platforms).
The library consists of a C extension so you'll need a Unix-like system
with a C compiler and Ruby development libraries/headers.
-
-http://rubyforge.org/frs/?group_id=8977
-
-You may also install it via RubyGems.org:
+You may install it via RubyGems.org:
gem install kgio
diff --git a/kgio.gemspec b/kgio.gemspec
index 32217e7..39a9c3c 100644
--- a/kgio.gemspec
+++ b/kgio.gemspec
@@ -18,9 +18,8 @@ Gem::Specification.new do |s|
s.test_files = Dir['test/test_*.rb']
s.extensions = %w(ext/kgio/extconf.rb)
- # development dependencies commented out for folks stuck on
- # old Ruby/RubyGems versions
s.add_development_dependency('olddoc', '~> 1.0')
+ s.add_development_dependency('test-unit', '~> 3.0')
# s.add_development_dependency('strace_me', '~> 1.0') # Linux only
s.licenses = %w(LGPLv2.1+)
diff --git a/pkg.mk b/pkg.mk
index dd09703..a913451 100644
--- a/pkg.mk
+++ b/pkg.mk
@@ -77,17 +77,6 @@ doc:: .document .olddoc.yml $(pkg_extra)
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:
@@ -123,23 +112,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)
--
2.2.1.203.g624e5c2
^ permalink raw reply related [flat|nested] 4+ messages in thread