From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-3.0 required=3.0 tests=ALL_TRUSTED,AWL,BAYES_00, RP_MATCHES_RCVD shortcircuit=no autolearn=unavailable version=3.3.2 X-Original-To: kgio-public@bogomips.org Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 2CAC51F540 for ; Wed, 12 Aug 2015 13:04:38 +0000 (UTC) From: Eric Wong To: kgio-public@bogomips.org Subject: [PATCH] minor doc updates Date: Wed, 12 Aug 2015 13:04:38 +0000 Message-Id: <1439384678-31814-1-git-send-email-e@80x24.org> List-Id: 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 --- a/HACKING +++ b/HACKING @@ -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 -"gmake". +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) -- EW