kgio RubyGem user+dev discussion/patches/pulls/bugs/help
 help / color / mirror / code / Atom feed
From: Eric Wong <>
Subject: [PATCH] minor doc updates
Date: Wed, 12 Aug 2015 13:04:38 +0000	[thread overview]
Message-ID: <> (raw)

Ruby version changes, dropping Rubinius and MRI 1.8 support,
and clarifying a few other things.

"Linux kernel" coding style is probably a more accurate of what
we've always used as the style is probably better known than K&R
nowadays (and we do try to track Linux kernel changes (and
email-oriented development style) closely).
 HACKING | 16 +++++++---------
 README  |  3 ++-
 TODO    |  1 +
 3 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/HACKING b/HACKING
index 0a13e84..7aa3b7c 100644
@@ -14,15 +14,14 @@ remains searchable even if Gmane becomes unavailable.
 === Code Compatibility
-We target Ruby 1.8.6+, 1.9.1+ and Rubinius 1.1+ and their
-respective C APIs.
+We target mainline Ruby 1.9.3 and later.
 All of our C code should be compatible with all reasonably modern Unices
 and should run on compilers supported by the versions of Ruby we target.
-We will NEVER directly support non-Free platforms under any circumstances.
+We will NEVER support non-Free platforms under any circumstances.
-Our C code follows K&R indentation style (hard tabs, tabs are always 8
+Our C code follows Linux kernel coding style (hard tabs, tabs are always 8
 characters wide) and NOT the indentation style of Matz Ruby.
 == Contributing
@@ -51,7 +50,7 @@ don't email the git mailing list or maintainer with kgio patches :)
 It is easy to install the contents of your git working directory:
-Via RubyGems (RubyGems 1.3.5+ recommended for prerelease versions):
+Via RubyGems:
   gmake install-gem
@@ -64,10 +63,9 @@ installation done without RubyGems, however.
 === Tests
-We use GNU make to run tests in parallel.  test/unit/parallel didn't
-exist for old versions of Ruby before 1.9.3.  Users of GNU-based systems
-(such as GNU/Linux) usually have GNU make installed as "make" instead of
+We use GNU make to run tests in parallel for historical reasons.  Users
+of GNU-based systems (such as GNU/Linux) usually have GNU make installed
+as "make" instead of "gmake".
 Running the entire test suite with 4 tests in parallel:
diff --git a/README b/README
index a4edf57..9465fbd 100644
--- a/README
+++ b/README
@@ -10,7 +10,8 @@ Unix-like platforms).
 * Can avoid expensive exceptions on common EAGAIN/EINPROGRESS errors,
   returning :wait_readable or :wait_writable instead.
   These exceptions got more expensive to hit under Ruby 1.9.2
-  (but were fixed in Ruby 1.9.3 and later to 1.9.1 performance levels)
+  (but were fixed in Ruby 1.9.3 and later to 1.9.1 performance levels,
+   which were still bad)
 * Returns the unwritten portion of the string on partial writes,
   making it ideal for buffering unwritten data.
diff --git a/TODO b/TODO
index 898c0e7..c6560b2 100644
--- a/TODO
+++ b/TODO
@@ -1,2 +1,3 @@
 * remove old autopush interface (for kgio 3.x)
 * obsolete kgio by improving *_nonblock methods in Ruby itself
+  (Mostly done Ruby 2.3.0)

                 reply	other threads:[~2015-08-12 13:04 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:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \

* 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

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).