sleepy_penguin.git  about / heads / tags
Linux I/O events for Ruby
$ git log --pretty=format:'%h %s (%cs)%d' v3.5.0 --
00492c4 sleepy_penguin 3.5.0 (2017-03-22)
	(tag: v3.5.0)
0a2e904 doc: avoid incorrect links to Epoll::IO (2017-03-22)
8b7e3ea doc: tests and examples for changing pipe size in Linux (2017-03-22)
fa2cde7 copy_file_range: add documentation (2017-03-22)
6a72975 build: remove build-time olddoc dependency (2017-03-22)
9d95452 sp_copy: remove dummy 1.8 code for non-native threaded Ruby (2017-03-22)
58c3886 kqueue: remove IO#autoclose= and 1.8-related checks (2017-03-22)
67217af epoll: add EPOLLEXCLUSIVE constant and documentation (2017-03-18)
a4c4165 favor require_relative over require (2017-03-17)
	(pu)
29b3001 epoll: add newline to Kernel#warn messages for atomicity (2017-03-17)
...

$ git cat-file blob v3.5.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) is also provided.

== Features

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

* 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:

https://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:

* https://bogomips.org/sleepy_penguin.git
* 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@bogomips.org

* Mailing list archives: https://bogomips.org/sleepy-penguin/

* Also available over NNTP:
  nntp://news.public-inbox.org/inbox.comp.lang.ruby.sleepy-penguin

# 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