[PATCH 0/4] various doc updates

[PATCH 0/4] various doc updates

[Eric Wong]

4 doc changes:

      update URLS to HTTPS
      README: explain removal of NFS support
      doc: remove private email address linkage
      gemspec: remove olddoc development dependency

 .olddoc.yml             |  7 +++----
 README                  | 28 +++++++++++++---------------
 mogilefs-client.gemspec | 20 ++++++++++----------
 3 files changed, 26 insertions(+), 29 deletions(-)

[PATCH 1/4] update URLS to HTTPS

[Eric Wong]

This helps somewhat with user privacy; since reading about
distributed systems can get people tagged as anti-authoritarian :P
---
 .olddoc.yml |  6 +++---
 README      | 10 +++++-----
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/.olddoc.yml b/.olddoc.yml
index 49df8c5..aa4d4dc 100644
--- a/.olddoc.yml
+++ b/.olddoc.yml
@@ -1,9 +1,9 @@
 ---
-cgit_url: http://bogomips.org/mogilefs-client.git
+cgit_url: https://bogomips.org/mogilefs-client.git
 git_url: git://bogomips.org/mogilefs-client.git
-rdoc_url: http://bogomips.org/mogilefs-client
+rdoc_url: https://bogomips.org/mogilefs-client
 changelog_start: v1.2.1
 private_email: e@80x24.org
 public_email: mogilefs-client-public@bogomips.org
 nntp_url: nntp://news.public-inbox.org/inbox.comp.file-systems.mogilefs.ruby
-ml_url: http://bogomips.org/mogilefs-client-public/
+ml_url: https://bogomips.org/mogilefs-client-public/
diff --git a/README b/README
index fa37814..ca08312 100644
--- a/README
+++ b/README
@@ -7,16 +7,16 @@ MogileFS instance.
 
 == Links
 
-rdoc :: http://bogomips.org/mogilefs-client
+rdoc :: https://bogomips.org/mogilefs-client
 mogilefs :: http://mogilefs.org/
 list :: mailto:mogilefs-client-public@bogomips.org
 list-cc :: mailto:mogile@googlegroups.com
-list-archive :: http://bogomips.org/mogilefs-client-public
+list-archive :: https://bogomips.org/mogilefs-client-public
 email :: mailto:e@80x24.org
 repo :: git://bogomips.org/mogilefs-client.git
-	http://bogomips.org/mogilefs-client.git
+	https://bogomips.org/mogilefs-client.git
 gitweb :: http://repo.or.cz/w/ruby-mogilefs-client.git
-download :: http://bogomips.org/mogilefs-client/files/
+download :: https://bogomips.org/mogilefs-client/files/
 
 == Install
 
@@ -43,7 +43,7 @@ is required or available to post:
 
 	mogilefs-client-public@bogomips.org
 
-List archives: http://bogomips.org/mogilefs-client-public/
+List archives: https://bogomips.org/mogilefs-client-public/
 
 We may also piggy-back onto the public MogileFS mailing list at
 mogile@googlegroups.com for feedback (subscription required,
-- 
EW

[PATCH 2/4] README: explain removal of NFS support

[Eric Wong]

Hopefully nobody complains about us dropping the feature, then.
---
 README | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README b/README
index ca08312..73fdbd3 100644
--- a/README
+++ b/README
@@ -58,5 +58,5 @@ Do not expect us to read HTML mail under any circumstances.
 == WARNING!
 
 This client is only supported in HTTP mode.  NFS mode was previously
-supported in 1.3.x, but since MogileFS 2.x has dropped support for
-NFS, this client has removed support for it.
+supported in 1.3.x, but since MogileFS 2.x dropped support for NFS
+in in 2006, this client does not support it.
-- 
EW

[PATCH 3/4] doc: remove private email address linkage

[Eric Wong]

Instead, promote anonymous remailers and put users in
charge of their own anonymity.
---
 .olddoc.yml             | 1 -
 README                  | 8 +++-----
 mogilefs-client.gemspec | 2 +-
 3 files changed, 4 insertions(+), 7 deletions(-)

diff --git a/.olddoc.yml b/.olddoc.yml
index aa4d4dc..d6c89ef 100644
--- a/.olddoc.yml
+++ b/.olddoc.yml
@@ -3,7 +3,6 @@ cgit_url: https://bogomips.org/mogilefs-client.git
 git_url: git://bogomips.org/mogilefs-client.git
 rdoc_url: https://bogomips.org/mogilefs-client
 changelog_start: v1.2.1
-private_email: e@80x24.org
 public_email: mogilefs-client-public@bogomips.org
 nntp_url: nntp://news.public-inbox.org/inbox.comp.file-systems.mogilefs.ruby
 ml_url: https://bogomips.org/mogilefs-client-public/
diff --git a/README b/README
index 73fdbd3..ab84111 100644
--- a/README
+++ b/README
@@ -12,7 +12,6 @@ mogilefs :: http://mogilefs.org/
 list :: mailto:mogilefs-client-public@bogomips.org
 list-cc :: mailto:mogile@googlegroups.com
 list-archive :: https://bogomips.org/mogilefs-client-public
-email :: mailto:e@80x24.org
 repo :: git://bogomips.org/mogilefs-client.git
 	https://bogomips.org/mogilefs-client.git
 gitweb :: http://repo.or.cz/w/ruby-mogilefs-client.git
@@ -43,16 +42,15 @@ is required or available to post:
 
 	mogilefs-client-public@bogomips.org
 
+Users of anonymous remailers and other anonymity tools are welcome.
+Participants will never be asked to reveal their identity.
+
 List archives: https://bogomips.org/mogilefs-client-public/
 
 We may also piggy-back onto the public MogileFS mailing list at
 mogile@googlegroups.com for feedback (subscription required,
 unfortunately)
 
-If you wish to keep your issue secret, feel free to email the author at:
-
-		e@80x24.org
-
 Do not expect us to read HTML mail under any circumstances.
 
 == WARNING!
diff --git a/mogilefs-client.gemspec b/mogilefs-client.gemspec
index c6adc4f..d5ce96b 100644
--- a/mogilefs-client.gemspec
+++ b/mogilefs-client.gemspec
@@ -12,7 +12,7 @@
   s.authors = ["#{s.name} hackers"]
   s.summary = summary
   s.description = readme_description
-  s.email = Olddoc.config['private_email']
+  s.email = 'mogilefs-client-public@bogomips.org'
   s.files = manifest
   s.add_development_dependency('olddoc', '~> 1.0')
   s.homepage = Olddoc.config['rdoc_url']
-- 
EW

[PATCH 4/4] gemspec: remove olddoc development dependency

[Eric Wong]

At least it should not be needed for rebuilding the gem,
anymore.  This will hopefully make it easier to package
and hack.
---
 README                  |  6 +++---
 mogilefs-client.gemspec | 18 +++++++++---------
 2 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/README b/README
index ab84111..a3f1ae4 100644
--- a/README
+++ b/README
@@ -1,9 +1,9 @@
 = mogilefs-client - MogileFS client library for Ruby
 
 A MogileFS client library for Ruby.  MogileFS is an open source
-distributed filesystem, see: http://mogilefs.org for more details.  This
-library allows any Ruby application to read, write and delete files in a
-MogileFS instance.
+distributed filesystem, see: http://mogilefs.org for more details.
+This library allows any Ruby application to read, write and delete
+files in a MogileFS instance.
 
 == Links
 
diff --git a/mogilefs-client.gemspec b/mogilefs-client.gemspec
index d5ce96b..fb6a2d5 100644
--- a/mogilefs-client.gemspec
+++ b/mogilefs-client.gemspec
@@ -1,20 +1,20 @@
-ENV["VERSION"] or abort "VERSION= must be specified"
-require 'olddoc'
 $LOAD_PATH << 'lib'
-require 'mogilefs'
-extend Olddoc::Gemspec
-name, summary, title = readme_metadata
+require 'mogilefs' # for MogileFS::VERSION
 Gem::Specification.new do |s|
   manifest = File.read('.manifest').split(/\n/)
   s.name = 'mogilefs-client'
   s.version = MogileFS::VERSION
   s.executables = %w(mog)
   s.authors = ["#{s.name} hackers"]
-  s.summary = summary
-  s.description = readme_description
+  s.summary = 'MogileFS client library for Ruby'
+  s.description = <<EOF
+A MogileFS client library for Ruby.  MogileFS is an open source
+distributed filesystem, see: http://mogilefs.org for more details.
+This library allows any Ruby application to read, write and delete
+files in a MogileFS instance.
+EOF
   s.email = 'mogilefs-client-public@bogomips.org'
   s.files = manifest
-  s.add_development_dependency('olddoc', '~> 1.0')
-  s.homepage = Olddoc.config['rdoc_url']
+  s.homepage = 'https://bogomips.org/mogilefs-client/'
   s.license = 'BSD-3-Clause'
 end
-- 
EW