* [PATCH] various documentation updates
@ 2019-01-05 20:36 Eric Wong
0 siblings, 0 replies; only message in thread
From: Eric Wong @ 2019-01-05 20:36 UTC (permalink / raw)
To: rainbows-public
Point to HTTPS to discourage sniffable traffic.
olddoc and pandoc are only necessary for packaging
gems/updating-the-website, not development.
Update some references to other projects.
---
.olddoc.yml | 2 +-
HACKING | 6 +++---
README | 20 ++++++++++----------
rainbows.gemspec | 33 ++++++++++++++++++++-------------
4 files changed, 34 insertions(+), 27 deletions(-)
diff --git a/.olddoc.yml b/.olddoc.yml
index d9bb974..3e776ef 100644
--- a/.olddoc.yml
+++ b/.olddoc.yml
@@ -1,6 +1,6 @@
---
cgit_url: https://bogomips.org/rainbows.git
-git_url: git://bogomips.org/rainbows.git
+git_url: https://bogomips.org/rainbows.git
rdoc_url: https://bogomips.org/rainbows/
merge_html:
rainbows_1: Documentation/rainbows.1.html
diff --git a/HACKING b/HACKING
index 39a68ef..31f2111 100644
--- a/HACKING
+++ b/HACKING
@@ -44,12 +44,12 @@ Please Cc: everyone on replies, as not everyone is subscribed.
== Building a Gem
-In order to build the gem, you must install the following components:
+In order to build the gem, you must install the following components
+for documentation:
- * olddoc (RubyGem)
* pandoc
-You can build the Unicorn gem with the following command:
+You can build the Rainbows! gem with the following command:
gmake gem
diff --git a/README b/README
index 027f58a..178990d 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-= Rainbows! - unicorn for sleepy apps and slow clients
+= Rainbows! - Rack app server for sleepy apps and slow clients
\Rainbows! is an HTTP server for sleepy Rack applications. It is based on
unicorn, but designed to handle applications that expect long
@@ -51,7 +51,7 @@ network concurrency.
* Designed for {Rack}[http://rack.github.io/], the standard for
modern Ruby HTTP applications.
-* Built on {Unicorn}[https://bogomips.org/unicorn/], inheriting its
+* Built on {unicorn}[https://bogomips.org/unicorn/], inheriting its
process/socket management features such as transparent upgrades and
Ruby configuration DSL.
@@ -81,7 +81,6 @@ network concurrency.
* HTTP server push
* Long polling
* Reverse AJAX
-* real-time upload processing (via {upr}[http://upr.bogomips.org/])
\Rainbows! can also be used to service slow clients directly even with
fast applications.
@@ -123,7 +122,7 @@ config file:
worker_processes 4 # assuming four CPU cores
Rainbows! do
- use :FiberSpawn
+ use :ThreadSpawn
worker_connections 100
end
@@ -136,23 +135,24 @@ for more details.
You can get the latest source via git from the following locations
(these versions may not be stable):
- git://bogomips.org/rainbows.git
- git://repo.or.cz/rainbows.git (mirror)
+ https://bogomips.org/rainbows.git
+ https://repo.or.cz/rainbows.git (mirror)
You may browse the code from the web and download the latest snapshot
tarballs here:
* https://bogomips.org/rainbows.git
-* http://repo.or.cz/w/rainbows.git (gitweb)
+* https://repo.or.cz/rainbows.git (gitweb)
Inline patches (from "git format-patch") to the mailing list are
preferred because they allow code review and comments in the reply to
the patch.
We will adhere to mostly the same conventions for patch submissions as
-git itself. See the Documentation/SubmittingPatches document
-distributed with git on on patch submission guidelines to follow. Just
-don't email the git mailing list or maintainer with \Rainbows! patches.
+git itself. See the
+https://80x24.org/mirrors/git.git/tree/Documentation/SubmittingPatches?h=v2.20.1
+document distributed with git on on patch submission guidelines to follow.
+Just don't email the git mailing list or maintainer with \Rainbows! patches.
== Disclaimer
diff --git a/rainbows.gemspec b/rainbows.gemspec
index 4283a85..259e2ab 100644
--- a/rainbows.gemspec
+++ b/rainbows.gemspec
@@ -1,22 +1,21 @@
# -*- encoding: binary -*-
-ENV["VERSION"] or abort "VERSION= must be specified"
-manifest = File.readlines('.manifest').map! { |x| x.chomp! }
-require 'olddoc'
-extend Olddoc::Gemspec
-name, summary, title = readme_metadata
+manifest = File.exist?('.manifest') ?
+ IO.readlines('.manifest').map!(&:chomp!) : `git ls-files`.split("\n")
Gem::Specification.new do |s|
s.name = %q{rainbows}
- s.version = ENV["VERSION"].dup
+ s.version = (ENV["VERSION"] || '5.1.1').dup
- s.authors = ["#{name} hackers"]
- s.description = readme_description
+ s.authors = ['Rainbows! hackers']
+ s.description = File.read('README').split("\n\n")[1]
s.email = %q{rainbows-public@bogomips.org}
s.executables = %w(rainbows)
- s.extra_rdoc_files = extra_rdoc_files(manifest)
+ s.extra_rdoc_files = IO.readlines('.document').map!(&:chomp!).keep_if do |f|
+ File.exist?(f)
+ end
s.files = manifest
- s.homepage = Olddoc.config['rdoc_url']
- s.summary = summary
+ s.homepage = 'https://bogomips.org/rainbows/'
+ s.summary = 'Rack app server for sleepy apps and slow clients'
# we want a newer Rack for a valid HeaderHash#each
s.add_dependency(%q<rack>, ['>= 1.1', '< 3.0'])
@@ -29,7 +28,6 @@
s.add_dependency(%q<unicorn>, ["~> 5.1"])
s.add_development_dependency(%q<isolate>, "~> 3.1")
- s.add_development_dependency(%q<olddoc>, "~> 1.2")
# optional runtime dependencies depending on configuration
# see t/test_isolate.rb for the exact versions we've tested with
@@ -58,5 +56,14 @@
# We cannot automatically switch licenses when Ruby changes their license,
# so we remain optionally-licensed under the terms of Ruby 1.8 despite
# not having a good way to specify this in an SPDX-compatible way...
- s.licenses = ['GPL-2.0+', 'Nonstandard'] # Nonstandard = 'Ruby 1.8'
+ ruby_1_8 = 'Nonstandard'
+ s.licenses = [ 'GPL-2.0+', ruby_1_8 ]
+ s.metadata = {
+ 'bug_tracker_uri' => 'https://bogomips.org/rainbows/#label-Contact',
+ 'changelog_uri' => 'https://bogomips.org/rainbows/NEWS.html',
+ 'documentation_uri' => 'https://bogomips.org/rainbows/',
+ 'homepage_uri' => 'https://bogomips.org/rainbows/',
+ 'mailing_list_uri' => 'https://bogomips.org/rainbows-public/',
+ 'source_code_uri' => 'https://bogomips.org/rainbows.git',
+ }
end
--
EW
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2019-01-05 20:36 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-01-05 20:36 [PATCH] various documentation updates Eric Wong
Rainbows! Rack HTTP server user/dev discussion
This inbox may be cloned and mirrored by anyone:
git clone --mirror https://yhbt.net/rainbows-public
git clone --mirror http://ou63pmih66umazou.onion/rainbows-public
# If you have public-inbox 1.1+ installed, you may
# initialize and index your mirror using the following commands:
public-inbox-init -V1 rainbows-public rainbows-public/ https://yhbt.net/rainbows-public \
rainbows-public@yhbt.net rainbows-public@bogomips.org rainbows-talk@rubyforge.org rainbows-talk-GrnCvJ7WPxnNLxjTenLetw@public.gmane.org
public-inbox-index rainbows-public
Example config snippet for mirrors.
Newsgroups are available over NNTP:
nntp://news.public-inbox.org/inbox.comp.lang.ruby.rainbows
nntp://ou63pmih66umazou.onion/inbox.comp.lang.ruby.rainbows
note: .onion URLs require Tor: https://www.torproject.org/
code repositories for project(s) associated with this inbox:
../../../rainbows.git
AGPL code for this site: git clone http://ou63pmih66umazou.onion/public-inbox.git