sleepy_penguin.git  about / heads / tags
Linux I/O events for Ruby
$ git log --pretty=format:'%h %s (%cs)%d' v3.2.0 --
f039e80 sleepy_penguin 3.2.0 - minor bug fixes, preliminary kqueue support (2013-07-16)
	(tag: v3.2.0)
1694820 pkg: include generated version header in distribution (2013-07-03)
aa4958b test_epoll_io: ensure subclassing Epoll::IO works (2013-05-15)
5a757f1 auto-generate SLEEPY_PENGUIN_VERSION constant (2013-05-03)
a64016a README: update with latest features (2013-05-03)
565b92d test_kqueue_io: additional test for IO-likeness (2013-05-03)
33985d3 kqueue: remove timeout handling for nevents==0 (2013-05-03)
1ba2600 doc: flesh out kqueue-related documentation (2013-05-03)
6b2c95c do not propagate Errno::EINTR into Ruby (2013-05-02)
05448f7 test_epoll: workaround race condition in test_close (2013-04-30)
...

$ git cat-file blob v3.2.0:README
= sleepy_penguin - Linux I/O events for Ruby

sleepy_penguin provides access to newer, Linux-only system calls to wait
on events from traditionally non-I/O sources.  Bindings to the eventfd,
timerfd, inotify, and epoll interfaces are provided.  Experimental support
for kqueue on FreeBSD (and likely OpenBSD/NetBSD) are also provided.

== Features

* Thread-safe blocking operations for all versions of Matz Ruby and Rubinius

* IO-like objects are backwards-compatible with IO.select.

* High-level Epoll interface is fork-safe and GC-safe

* Unlike portable event frameworks, the Linux-only epoll interfaces
  allow using edge-triggered or one-shot notifications for possibly
  improved performance.  Likewise, the kqueue interface supports
  one-shot notifiactions, too.

* Fully-documented and user-friendly API

== Install

If you're using a packaged Ruby distribution, make sure you have a C
compiler and the matching Ruby development libraries and headers.

If you use RubyGems:

    gem install sleepy_penguin

Otherwise grab the latest tarball from:

http://bogomips.org/sleepy_penguin/files/

Unpack it, and run "ruby setup.rb"

== Development

You can get the latest source via git from the following locations:

  git://bogomips.org/sleepy_penguin.git
  git://repo.or.cz/sleepy_penguin.git (mirror)

You may browse the code from the web and download the latest snapshot
tarballs here:

* http://bogomips.org/sleepy_penguin.git (cgit)
* http://repo.or.cz/w/sleepy_penguin.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 sleepy_penguin patches.

== Contact

All feedback (bug reports, user/development discussion, patches, pull
requests) go to the mailing list: mailto:sleepy.penguin@librelist.org

* http://bogomips.org/sleepy_penguin/archives/

# heads (aka `branches'):
$ git for-each-ref --sort=-creatordate refs/heads \
	--format='%(HEAD) %(refname:short) %(subject) (%(creatordate:short))'
* master       sleepy_penguin 3.5.2 (2020-02-01)
  pu           favor require_relative over require (2017-03-17)

# tags:
$ git for-each-ref --sort=-creatordate refs/tags \
	--format='%(refname:short) %(subject) (%(creatordate:short))'
v3.5.2       sleepy_penguin 3.5.2 (2020-02-01) tar.gz
v3.5.1       sleepy_penguin 3.5.1 (2018-12-15) tar.gz
v3.5.0       sleepy_penguin 3.5.0 (2017-03-22) tar.gz
v3.4.1       sleepy_penguin 3.4.1 - minor updates (2015-01-11) tar.gz
v3.4.0       sleepy_penguin 3.4.0 - minor updates (2015-01-11) tar.gz
v3.3.0       sleepy_penguin 3.3.0 - fixes and compatibility improvements (2013-12-30) tar.gz
v3.2.0       sleepy_penguin 3.2.0 - minor bug fixes, preliminary kqueue support (2013-07-16) tar.gz
v3.1.0       sleepy_penguin 3.1.0 - minor fixes and features (2012-05-02) tar.gz
v3.0.1       sleepy_penguin 3.0.1 - really avoids EINTR (2011-05-20) tar.gz
v3.0.0       sleepy_penguin 3.0.0 (2011-05-20) tar.gz
...

# associated public inboxes:
# (number on the left is used for dev purposes)
            https://yhbt.net/sleepy-penguin

git clone https://yhbt.net/sleepy_penguin.git