From 65bb4baf0e479ff7cfbf0a8422824834c9f06ab1 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Tue, 20 Jan 2015 01:33:38 +0000 Subject: doc: describe most classes a bit Hopefully this makes the code less daunting to newcomers --- lib/dtas/sigevent/efd.rb | 3 +++ lib/dtas/sigevent/pipe.rb | 3 +++ 2 files changed, 6 insertions(+) (limited to 'lib/dtas/sigevent') diff --git a/lib/dtas/sigevent/efd.rb b/lib/dtas/sigevent/efd.rb index dc526f2..26c8025 100644 --- a/lib/dtas/sigevent/efd.rb +++ b/lib/dtas/sigevent/efd.rb @@ -1,5 +1,8 @@ # Copyright (C) 2013-2015 all contributors # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt) + +# used in various places for safe wakeups from IO.select via signals +# This requires a modern Linux system and the "sleepy_penguin" RubyGem class DTAS::Sigevent < SleepyPenguin::EventFD # :nodoc: def self.new super(0, :CLOEXEC) diff --git a/lib/dtas/sigevent/pipe.rb b/lib/dtas/sigevent/pipe.rb index f510385..4f42909 100644 --- a/lib/dtas/sigevent/pipe.rb +++ b/lib/dtas/sigevent/pipe.rb @@ -1,5 +1,8 @@ # Copyright (C) 2013-2015 all contributors # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt) + +# used in various places for safe wakeups from IO.select via signals +# A fallback for non-Linux systems lacking the "sleepy_penguin" RubyGem class DTAS::Sigevent # :nodoc: attr_reader :to_io -- cgit v1.2.3-24-ge0c7