[PATCH 0/3] minor updates in preparation for olddoc 1.1.0

[PATCH 0/3] minor updates in preparation for olddoc 1.1.0

[Eric Wong]

Eric Wong (3):
      support for nntp_url, make private_email optional
      gemspec: use SPDX-compatible license
      readme: relax dependency on RDoc formatting

 .olddoc.yml                | 3 ++-
 Documentation/olddoc.5.txt | 6 +++++-
 lib/olddoc.rb              | 2 +-
 lib/olddoc/readme.rb       | 4 ++--
 lib/oldweb/_tail.rhtml     | 8 ++++++--
 olddoc.gemspec             | 4 ++--
 6 files changed, 18 insertions(+), 9 deletions(-)

[PATCH 1/3] support for nntp_url, make private_email optional

[Eric Wong]

Not every project needs private email.  Maybe none do.
While we're at it, fix our own .olddoc.yml to show ml_url.
---
 .olddoc.yml                | 3 ++-
 Documentation/olddoc.5.txt | 6 +++++-
 lib/oldweb/_tail.rhtml     | 8 ++++++--
 olddoc.gemspec             | 2 +-
 4 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/.olddoc.yml b/.olddoc.yml
index 0b37154..41f3cf8 100644
--- a/.olddoc.yml
+++ b/.olddoc.yml
@@ -2,8 +2,9 @@
 cgit_url: http://bogomips.org/olddoc.git
 git_url: git://80x24.org/olddoc.git
 rdoc_url: http://80x24.org/olddoc/
+ml_url: http://80x24.org/olddoc-public/
+nntp_url: nntp://news.public-inbox.org/inbox.comp.lang.ruby.olddoc
 merge_html:
   olddoc_1: Documentation/olddoc.1.html
   olddoc_5: Documentation/olddoc.5.html
 public_email: olddoc-public@80x24.org
-private_email: olddoc@80x24.org
diff --git a/Documentation/olddoc.5.txt b/Documentation/olddoc.5.txt
index 0b95578..50b6713 100644
--- a/Documentation/olddoc.5.txt
+++ b/Documentation/olddoc.5.txt
@@ -15,12 +15,16 @@ configuration to deal with.
 
 # KEYS
 
-`rdoc_url`, `cgit_url` should be obvious
+`rdoc_url`, `cgit_url`, and `nntp_url` should be obvious
 
 `merge_html` is a key-value mapping of (empty) RDoc source files to an
 HTML file that will be merged into RDoc after-the-fact.  It is useful
 for merging non-RDoc generated HTML into the project.
 
+`ml_url` is the mailing list archive location.
+`public_email` is the email address of a publically archived mailing list
+at `ml_url`
+
 # SEE ALSO
 
 olddoc(1)
diff --git a/lib/oldweb/_tail.rhtml b/lib/oldweb/_tail.rhtml
index d1fc7e5..522c312 100644
--- a/lib/oldweb/_tail.rhtml
+++ b/lib/oldweb/_tail.rhtml
@@ -2,11 +2,12 @@
 public_email = @old_cfg['public_email']
 private_email = @old_cfg['private_email']
 ml_url = @old_cfg['ml_url']
+nntp_url = @old_cfg['nntp_url']
 git_doc = 'https://kernel.org/pub/software/scm/git/docs/'
 se_url = "#{git_doc}git-send-email.html"
 rp_url = "#{git_doc}git-request-pull.html"
 
-if public_email && private_email && ml_url %><hr /><p>
+if public_email && ml_url %><hr /><p>
 We love to hear from you!<br />
 Email patches (using <a
 href="<%= se_url %>">git send-email</a>),
@@ -19,7 +20,10 @@ href="<%= ml_url %>"><%= ml_url %></a><br />
 Please send plain-text email only and do not waste bandwidth on HTML mail,
 HTML mail will not be read.<br />
 Quote as little as reasonable and do not <a
-href="http://catb.org/jargon/html/T/top-post.html">top post</a>.<br />
+href="http://catb.org/jargon/html/T/top-post.html">top post</a>.<br /><% end
+if nntp_url %>NNTP archives are available at: <a
+href="<%= nntp_url %>"><%= nntp_url %></a><% end
+if private_email %>
 For sensitive topics, email us privately at:
 <a
 href="mailto:<%= private_email %>"><%= private_email %></a><% end %>
diff --git a/olddoc.gemspec b/olddoc.gemspec
index 17b5fa8..11e0a29 100644
--- a/olddoc.gemspec
+++ b/olddoc.gemspec
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.authors = ["#{s.name} hackers"]
   s.summary = summary
   s.description = readme_description
-  s.email = Olddoc.config['private_email']
+  s.email = 'e@80x24.org'
   s.files = manifest
   s.add_dependency('rdoc', '~> 4.2')
   s.add_dependency('builder', '~> 3.2')
-- 
EW

[PATCH 2/3] gemspec: use SPDX-compatible license

[Eric Wong]

Well, not according to current Rubygems, but the '+' is explicitly
allowed by SPDX.
---
 olddoc.gemspec | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/olddoc.gemspec b/olddoc.gemspec
index 11e0a29..79f4579 100644
--- a/olddoc.gemspec
+++ b/olddoc.gemspec
@@ -17,5 +17,5 @@ Gem::Specification.new do |s|
   s.add_dependency('rdoc', '~> 4.2')
   s.add_dependency('builder', '~> 3.2')
   s.homepage = Olddoc.config['rdoc_url']
-  s.licenses = 'GPLv3+'
+  s.licenses = 'GPL-3.0+'
 end
-- 
EW

[PATCH 3/3] readme: relax dependency on RDoc formatting

[Eric Wong]

Some projects I maintain do not use RDoc and rely entirely on
plain-text documentation.  This allows "olddoc prepare" to
run properly on projects which do not use RDoc but still use
a README file where the title is the first line.
---
 lib/olddoc/readme.rb | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lib/olddoc/readme.rb b/lib/olddoc/readme.rb
index 18f0205..e593517 100644
--- a/lib/olddoc/readme.rb
+++ b/lib/olddoc/readme.rb
@@ -16,9 +16,9 @@ def readme_description
   # parses the README file in the top-level directory for project metadata
   def readme_metadata
     l = File.readlines(readme_path)[0].strip!
-    l.gsub!(/^=\s+/, '') or abort "#{l.inspect} doesn't start with '='"
+    l.gsub!(/^=\s+/, '')
     title = l.dup
-    if l.gsub!(/^(\w+\!)\s+/, '') # Rainbows!
+    if l.gsub!(/^(\w+\!)\s+/, '') # special case for Rainbows!
       return $1, l, title
     else
       return (l.split(/\s*[:-]\s*/, 2)).push(title)
-- 
EW