diff options
author | Eric Wong <e@80x24.org> | 2015-01-09 00:55:08 +0000 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2015-01-09 00:55:08 +0000 |
commit | 40d0ad0cedc0b4389ec86f247edf8681b330037c (patch) | |
tree | 8519fc357ff5f8841f2df41bb2cb9fef964ab31d | |
parent | 4ffa14b8d8aa58276ffcf4ed839a6f4c6c1c836d (diff) | |
download | olddoc-40d0ad0cedc0b4389ec86f247edf8681b330037c.tar.gz |
Nowadays, RDoc 4.x expects GNU-style ChangeLog files and cannot seem to parse them verbatim anymore. Since I've long been against GNU-style ChangeLogs, we'll leave them out and tell folks to read "git log" instead.
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | Documentation/olddoc.1.txt | 2 | ||||
-rw-r--r-- | GNUmakefile | 4 | ||||
-rw-r--r-- | README | 4 | ||||
-rw-r--r-- | Rakefile | 2 | ||||
-rw-r--r-- | lib/olddoc.rb | 1 | ||||
-rw-r--r-- | lib/olddoc/changelog.rb | 28 | ||||
-rw-r--r-- | lib/olddoc/prepare.rb | 3 |
8 files changed, 6 insertions, 39 deletions
@@ -1,5 +1,4 @@ /GIT-VERSION-FILE -ChangeLog olddoc_1 olddoc_5 LATEST diff --git a/Documentation/olddoc.1.txt b/Documentation/olddoc.1.txt index e7b31d8..c294cdb 100644 --- a/Documentation/olddoc.1.txt +++ b/Documentation/olddoc.1.txt @@ -14,7 +14,7 @@ olddoc - old-fashioned RDoc HTML generator olddoc features oldweb, and old-fashioned RDoc HTML generator. You can also use "olddoc prepare" to generate NEWS files from -git tags and ChangeLog entries from "git log". +git tags. # SEE ALSO diff --git a/GNUmakefile b/GNUmakefile index b6007d8..1087882 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -16,7 +16,7 @@ fix-perms: gem-man: $(MAKE) -C Documentation/ gem-man -pkg_extra := NEWS ChangeLog +pkg_extra := NEWS .manifest: fix-perms $(RUBY) -I lib bin/olddoc prepare @@ -55,5 +55,5 @@ $(pkggem): fix-perms .gem-manifest package: $(pkggem) -.PHONY: all .FORCE-GIT-VERSION-FILE NEWS ChangeLog +.PHONY: all .FORCE-GIT-VERSION-FILE NEWS .PHONY: check-warnings fix-perms doc @@ -40,8 +40,8 @@ missing out! cd $ANY_RDOC_USING_RUBY_PROJECT rdoc -f oldweb -You can also use olddoc to generate NEWS and ChangeLog entries -assuming you have a README file and .olddoc.yml +You can also use olddoc to generate NEWS entries +assuming you have git tags, a README file and .olddoc.yml olddoc prepare @@ -23,7 +23,7 @@ task :rsync_docs do files = `git ls-files Documentation/*.txt`.split(/\n/) files.concat(top) - files.concat(%w(NEWS NEWS.atom.xml ChangeLog)) + files.concat(%w(NEWS NEWS.atom.xml)) gzfiles = files.map { |txt| do_gzip.call(txt) } files.concat(gzfiles) sh("rsync --chmod=Fugo=r -av #{files.join(' ')} #{dest}") diff --git a/lib/olddoc.rb b/lib/olddoc.rb index f230cbf..7b8affa 100644 --- a/lib/olddoc.rb +++ b/lib/olddoc.rb @@ -3,7 +3,6 @@ module Olddoc VERSION = '1.0.0' - autoload :Changelog, 'olddoc/changelog' autoload :Gemspec, 'olddoc/gemspec' autoload :History, 'olddoc/history' autoload :Merge, 'olddoc/merge' diff --git a/lib/olddoc/changelog.rb b/lib/olddoc/changelog.rb deleted file mode 100644 index 7a7fe96..0000000 --- a/lib/olddoc/changelog.rb +++ /dev/null @@ -1,28 +0,0 @@ -# helper method for generating the ChangeLog in RDoc format atomically -require 'tempfile' - -module Olddoc::Changelog - include Olddoc::History - - def changelog - fp = Tempfile.new('ChangeLog', '.') - fp.write "ChangeLog from #@cgit_uri" - cmd = %w(git log) - if @changelog_start && tags[0] - range = "#@changelog_start..#{tags[0][:tag]}" - fp.write(" (#{range})") - cmd << range - end - fp.write("\n\n") - prefix = " " - IO.popen(cmd.join(' ')) do |io| - io.each { |line| - fp.write prefix - fp.write line - } - end - fp.chmod(0666 & ~File.umask) - File.rename(fp.path, 'ChangeLog') - fp.close! - end -end diff --git a/lib/olddoc/prepare.rb b/lib/olddoc/prepare.rb index f760bd3..1ed66a0 100644 --- a/lib/olddoc/prepare.rb +++ b/lib/olddoc/prepare.rb @@ -5,7 +5,6 @@ require 'uri' class Olddoc::Prepare include Olddoc::NewsRdoc include Olddoc::NewsAtom - include Olddoc::Changelog include Olddoc::Readme def initialize(opts) @@ -15,13 +14,11 @@ class Olddoc::Prepare abort "rdoc_url and cgit_url required in .olddoc.yml for `prepare'" @rdoc_uri = URI.parse(rdoc_url) @cgit_uri = URI.parse(cgit_url) - @changelog_start = opts['changelog_start'] @name, @short_desc = readme_metadata end def run news_rdoc - changelog news_atom end end |