From: Eric Wong <e@80x24.org>
To: clogger-public@bogomips.org
Subject: [PATCH] switch docs + website to olddoc
Date: Tue, 13 Jan 2015 02:16:37 +0000 [thread overview]
Message-ID: <1421115399-9327-1-git-send-email-e@80x24.org> (raw)
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.
The presence of images and CSS on the old (Darkfish-based) site
probably set unreasonable expectations as to my ability and
willingness to view such things. No more, the new website is
entirely simple HTML which renders well with even the wimpiest
browser.
---
.document | 2 --
.gitignore | 3 +-
.wrongdoc.yml => .olddoc.yml | 1 -
GNUmakefile | 5 ----
clogger.gemspec | 10 +++----
pkg.mk | 71 ++++++++++++++------------------------------
6 files changed, 28 insertions(+), 64 deletions(-)
rename .wrongdoc.yml => .olddoc.yml (89%)
diff --git a/.document b/.document
index 08e903f..1c0bd47 100644
--- a/.document
+++ b/.document
@@ -1,7 +1,5 @@
README
NEWS
-ChangeLog
lib
ext/clogger_ext/clogger.c
LICENSE
-LATEST
diff --git a/.gitignore b/.gitignore
index 8597889..65e627b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,8 +12,7 @@ Makefile
/local.mk
/pkg
/.manifest
-/ChangeLog
-/NEWS
+/NEWS*
/GIT-VERSION-FILE
/LATEST
/tmp
diff --git a/.wrongdoc.yml b/.olddoc.yml
similarity index 89%
rename from .wrongdoc.yml
rename to .olddoc.yml
index 5c28444..cf72cc6 100644
--- a/.wrongdoc.yml
+++ b/.olddoc.yml
@@ -4,4 +4,3 @@ cgit_url: http://bogomips.org/clogger.git
git_url: git://bogomips.org/clogger.git
public_email: clogger@librelist.org
private_email: clogger@bogomips.org
-changelog_since: 0.4.0
diff --git a/GNUmakefile b/GNUmakefile
index 49a7c17..35a07bc 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -1,6 +1,5 @@
all::
RSYNC_DEST := clogger.bogomips.org:/srv/clogger/
-rfproject := clogger
rfpackage := clogger
include pkg.mk
test-ext:
@@ -11,7 +10,3 @@ test-pure:
test: test-ext test-pure
.PHONY: test-ext test-pure
-ifneq ($(VERSION),)
-release::
- $(RAKE) publish_news VERSION=$(VERSION)
-endif
diff --git a/clogger.gemspec b/clogger.gemspec
index 8ad26d0..ebbf2ec 100644
--- a/clogger.gemspec
+++ b/clogger.gemspec
@@ -1,26 +1,24 @@
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{clogger}
s.version = ENV["VERSION"].dup
- s.homepage = Wrongdoc.config[:rdoc_url]
+ s.homepage = Olddoc.config['rdoc_url']
s.authors = ["cloggers"]
s.description = readme_description
s.email = %q{clogger@librelist.org}
s.extra_rdoc_files = extra_rdoc_files(manifest)
s.files = manifest
- s.rdoc_options = rdoc_options
- s.rubyforge_project = %q{clogger}
s.summary = summary
s.test_files = %w(test/test_clogger.rb test/test_clogger_to_path.rb)
# HeaderHash wasn't case-insensitive in old versions
s.add_dependency(%q<rack>, ["~> 1.0"])
- s.add_development_dependency(%q<wrongdoc>, "~> 1.8")
+ s.add_development_dependency(%q<olddoc>, "~> 1.0")
s.extensions = %w(ext/clogger_ext/extconf.rb)
s.licenses = %w(LGPLv2.1+)
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
--
2.2.1.203.g624e5c2
reply other threads:[~2015-01-13 2:16 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://yhbt.net/clogger/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1421115399-9327-1-git-send-email-e@80x24.org \
--to=e@80x24.org \
--cc=clogger-public@bogomips.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhbt.net/clogger.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).