Update ChangeLog and bump version for v1.3.0 release

Signed-off-by: Joachim Nilsson <troglobit@gmail.com>

.gitignore

@@ -1,7 +1,25 @@
-bench
+*~
-test
 *.d
 *.o
-*~
+*.so
-libuev.a
+*.so.*
-libuev.so.1
+*.a
+.deps
+.libs
+compile
+config.*
+configure
+depcomp
+install-sh
+libtool
+ltmain.sh
+missing
+stamp-h1
+Makefile
+Makefile.in
+aclocal.m4
+ar-lib
+autom4te.cache
+bench
+test
+libuev*

.travis.yml

@@ -1,7 +1,9 @@
 # Travis CI integration -- https://travis-ci.org/troglobit/libuev
+# Defaults to GNU GCC and autotools: ./configure && make && make test
 language: c
-compiler:
+
-  - gcc
+# We don't need to install packages, use dockerized build, quicker
+sudo: false
 
 env:
   global:
@@ -15,7 +17,14 @@ addons:
       name: "troglobit/libuev"
       description: "libuEv | Simple event loop for Linux"
     notification_email: troglobit@gmail.com
-    build_command: "make"
+    build_command_prepend: "./autogen && ./configure --enable-examples"
+    build_command: "make clean all"
     branch_pattern: dev
 
-script: make
+# We don't use configure, so we must define our own build script.
+script:
+  - ./autogen.sh
+  - ./configure --disable-silent-rules --enable-examples
+  - make clean
+  - make -j5
+  - make test

CHANGELOG

@@ -1 +0,0 @@
-CHANGELOG.md

ChangeLog

@@ -0,0 +1 @@
+ChangeLog.md

ChangeLog.md

@@ -3,8 +3,62 @@ Change Log
 
 All notable changes to the project are documented in this file.
 
-[v1.2.1] - 2015-07-02
+
----------------------
+[v1.3.0][] - 2016-01-22
+-----------------------
+
+### Changes
+- Change to GNU configure and build system
+- Default optimization is now -O2, not -Os, which can be a bit
+  unpredictable with some cross compiler toolchains.  -O2 is
+  the tried and tested path, and default in autotools
+- Added `-Wextra` to the previous `-W -Wall`, drop `-Werror`
+  which is supposed to be used by maintainer(s) only.
+
+
+[v1.2.4][] - 2015-11-23
+-----------------------
+
+### Fixes
+
+- Do not allow `VERSION` to be overloaded by build system.
+- Make sure we don't inherit `LDFLAGS` from environment.
+
+
+[v1.2.3][] - 2015-09-17
+-----------------------
+
+Very minor release.
+
+### Changes
+- [README.md][] updates, mostly cleanup and readability improvements
+- `make test` now runs the test case, on behalf of Travis-CI
+- Renamed CHANGELOG.md to [ChangeLog.md][]
+- Dropped [TODO.md][] from distribution archives, only for devs
+
+### Fixes
+- Lots of Markdown syntax fixes in both README and ChangeLog
+- Silence annoying warning from newer GNU ar in Ubuntu 15.10
+
+
+[v1.2.2][] - 2015-08-30
+-----------------------
+
+Minor bugfix release.
+
+### Changes
+- The `ifdef STATIC` in the Makefile has been removed.  Now both the
+  .a and .so libraries are built.  The user may then select what to
+  install.  This is a change for convenience when using libuEv from
+  a GNU Configure & Build based project.
+
+### Fixes
+- Fix odd data ordering issue on Debian Jessie in new `uev_private_t`
+- Fix issue #6: Segfault when stopping timer before calling `uev_exit()`
+
+
+[v1.2.1][] - 2015-07-02
+-----------------------
 
 ### Changes
 - Private data members in `uev.h` have now been moved to a new file
@@ -23,8 +77,8 @@ All notable changes to the project are documented in this file.
   should use.  Thank you @vonj!
 
 
-[v1.2.0] - 2015-06-09
+[v1.2.0][] - 2015-06-09
----------------------
+-----------------------
 
 API change in event callbacks and fix timers that never start.
 
@@ -33,12 +87,12 @@ API change in event callbacks and fix timers that never start.
   change!  Please update all your callbacks if you upgrade.
 
 ### Fixes
-- Fix timers that accidentally broke in [v1.1.0].
+- Fix timers that accidentally broke in [v1.1.0][].
 - Fixes to `bench.c`, it now actually listens to the pipe/socket.
 
 
-[v1.1.0] - 2015-03-04
+[v1.1.0][] - 2015-03-04
----------------------
+-----------------------
 
 Massively improved error handling.
 
@@ -48,18 +102,18 @@ Massively improved error handling.
   all watchers when an error count reaches a MAX value -- handles stale
   descriptors or cases when kernel does not notice updated descriptors.
 - Return error when stopping a watcher fails.
-- Update [README.md] with new `uev_*_start()` functions.
+- Update [README.md][] with new `uev_*_start()` functions.
 - Bump dev version to 1.1 due to the number of significant changes.
 
 ### Fixes
 - Remove `test.c` from `DISTFILES` in `Makefile`.  You need the
   comeplete sources to build the examples now.  Thanks to @karasz for
   the heads up on this and the musl libc issue with missing `queue.h`!
-- Fix broken link to [v1.0.5] in this file.
+- Fix broken link to [v1.0.5][] in this file.
 
 
-[v1.0.5] - 2015-02-15
+[v1.0.5][] - 2015-02-15
----------------------
+-----------------------
 
 ### Changes
 - Add `uev_*_start()` functions.
@@ -68,13 +122,13 @@ Massively improved error handling.
 - Renamed `main.c` to `uev.c`
 - Move examples to `examples/` subdirectory
 - Simplify automatic dependency calculation
-- Add [TODO.md] for wishlist items
+- Add [TODO.md][] for wishlist items
-- Add [CHANGELOG.md], attempt to align with http://keepachangelog.com
+- Add [CHANGELOG.md][ChangeLog.md], to align with http://keepachangelog.com
-- Further updates to [README.md]
+- Further updates to [README.md][]
 
 
-[v1.0.4] - 2015-01-24
+[v1.0.4][] - 2015-01-24
----------------------
+-----------------------
 
 Minor documentation and build fixes.
 
@@ -82,42 +136,42 @@ Release mainly targeted for [Finit development](https://github.com/troglobit/fin
 
 ### Changes
 * `test.c` has been simplified/clarified
-* Further updates to [README.md]
+* Further updates to [README.md][]
 * Minor update to Makefile, change how build progress is echoed
 
 
-[v1.0.3] - 2015-01-24
+[v1.0.3][] - 2015-01-24
----------------------
+-----------------------
 
 This is a very minor release, with a strong focus on documentation. 
 
 ### Changes
-- [README.md], massively updated
+- [README.md][], massively updated
 - API documentation, updated
 - Travis CI integration added, https://travis-ci.org/troglobit/libuev
 - Coverity Scan integration, https://scan.coverity.com/projects/3846
 - Clang scan-build support added
 
 
-[v1.0.2] - 2015-01-07
+[v1.0.2][] - 2015-01-07
----------------------
+-----------------------
 
 ### Fixes
-- Fix broken `make dist` target in [v1.0.1].
+- Fix broken `make dist` target in [v1.0.1][].
 
 
-[v1.0.1] - 2015-01-07
+[v1.0.1][] - 2015-01-07
----------------------
+-----------------------
 
 ### Changes
-- Cleanup and rewrite of [README.md] after first audit by @vonj
+- Cleanup and rewrite of [README.md][] after first audit by @vonj
-- Added API and example section to [README.md]
+- Added API and example section to [README.md][]
-- New [joystick.c] example added
+- New [joystick.c][] example added
 - `main.c:uev_run()`: Document mysterious flags parameter
 
 
-[v1.0.0] - 2013-08-06
+[v1.0.0][] - 2013-08-06
----------------------
+-----------------------
 
 First release in the new guise and API.
 
@@ -130,18 +184,21 @@ First release in the new guise and API.
 - Reindent to use Linux KNF
 - Change library name to libuev
 - Lua support removed
-- Make sure to state the [MIT license] correctly in all files
+- Make sure to state the [MIT license][] correctly in all files
-- Import [Niels Provos]' `bench.c`, the [libev version]
+- Import [Niels Provos][]' `bench.c`, the [libev version][]
 
 
 v0.0.1 - 2012-03-17
 -------------------
 
-[Initial announcement] of [libuevent] by [Flemming Madsen] to the Lua
+[Initial announcement][] of [libuevent][] by [Flemming Madsen][] to the
-users mailing list.
+Lua users mailing list.
 
-[UNRELEASED]: https://github.com/troglobit/libuev/compare/v1.2.1...HEAD
+
-[v1.2.0]: https://github.com/troglobit/libuev/compare/v1.2.0...v1.2.1
+[UNRELEASED]: https://github.com/troglobit/libuev/compare/v1.2.3...HEAD
+[v1.2.3]: https://github.com/troglobit/libuev/compare/v1.2.2...v1.2.3
+[v1.2.2]: https://github.com/troglobit/libuev/compare/v1.2.1...v1.2.2
+[v1.2.1]: https://github.com/troglobit/libuev/compare/v1.2.0...v1.2.1
 [v1.2.0]: https://github.com/troglobit/libuev/compare/v1.1.0...v1.2.0
 [v1.1.0]: https://github.com/troglobit/libuev/compare/v1.0.5...v1.1.0
 [v1.0.5]: https://github.com/troglobit/libuev/compare/v1.0.4...v1.0.5
@@ -152,7 +209,7 @@ users mailing list.
 [v1.0.0]: https://github.com/troglobit/libuev/compare/v0.0.1...v1.0.0
 [TODO.md]: https://github.com/troglobit/libuev/blob/master/TODO.md
 [README.md]: https://github.com/troglobit/libuev/blob/master/README.md
-[CHANGLOG.md]: https://github.com/troglobit/libuev/blob/master/CHANGELOG.md
+[ChangeLog.md]: https://github.com/troglobit/libuev/blob/master/ChangeLog.md
 [joystick.c]: https://github.com/troglobit/libuev/blob/master/joystick.c
 [Niels Provos]: http://en.wikipedia.org/wiki/Niels_Provos
 [MIT license]: http://en.wikipedia.org/wiki/MIT_License

Makefile

@@ -1,158 +0,0 @@
-# libuEv -- Simple event loop for Linux
-#
-# Copyright (c) 2012       Flemming Madsen <flemming!madsen()madsensoft!dk>
-# Copyright (c) 2013-2015  Joachim Nilsson <troglobit()gmail!com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-.PHONY: all test clean joystick test examples bench
-
-# Figure out root of library, unless used as submodule
-ROOTDIR    ?= $(shell pwd)
-
-#VERSION    = $(shell git tag -l | tail -1)
-VERSION    ?= 1.2.1
-NAME        = libuev
-PKG         = $(NAME)-$(VERSION)
-ARCHIVE     = $(PKG).tar.xz
-
-CC         ?= $(CROSS)gcc
-AR         ?= $(CROSS)ar
-STRIP      ?= $(CROSS)strip
-MAKE       := @$(MAKE)
-INSTALL    := install --backup=off
-STRIPINST  := $(INSTALL) -s --strip-program=$(CROSS)strip -m 0755
-
-CFLAGS     += -fPIC
-CFLAGS     += -Os
-CPPFLAGS   += -W -Wall -Werror
-ARFLAGS     = crus
-MAKEFLAGS   = --no-print-directory --silent
-
-DISTFILES   = README CHANGELOG TODO LICENSE
-HEADERS     = uev.h private.h queue.h
-OBJS       := uev.o io.o timer.o signal.o
-SRCS       := $(OBJS:.o=.c)
-DEPS       := $(SRCS:.c=.d)
-JUNK        = *~ *.bak *.map .*.d DEADJOE *.gdb *.elf core core.* *.html
-
-VER         = 1
-LIBNAME     = $(NAME)
-SOLIB       = $(LIBNAME).so.$(VER)
-SYMLIB      = $(LIBNAME).so
-STATICLIB   = $(LIBNAME).a
-ifdef STATIC
-TARGET      = $(STATICLIB)
-else
-TARGET      = $(SOLIB)
-endif
-
-# Default install paths
-prefix     ?= /usr/local
-libdir     ?= $(prefix)/lib
-datadir    ?= $(prefix)/share/doc/$(LIBNAME)
-incdir     ?= $(prefix)/include
-
-export STATICLIB JUNK ROOTDIR CFLAGS CPPFLAGS
-
-# This magic trick looks like a comment, but works on BSD PMake
-#include <rules.mk>
-include rules.mk
-
-# Build rules
-all: $(TARGET)
-
-$(OBJS): Makefile
-
-$(SOLIB): Makefile $(OBJS)
-	@printf "  LINK    $@\n"
-	@$(CC) $(LDFLAGS) -shared -Wl,-soname=$@ -o $@ $(OBJS)
-
-$(STATICLIB): Makefile $(OBJS)
-	@printf "  ARCHIVE $@\n"
-	@$(AR) $(ARFLAGS) $@ $(OBJS)
-
-install-exec: all
-ifndef STATIC
-	@printf "  INSTALL $(DESTDIR)$(libdir)/$(SOLIB)\n"
-	@install -d $(DESTDIR)$(libdir)
-	@install $(SOLIB) $(DESTDIR)$(libdir)/$(SOLIB)
-	@ln -sf $(SOLIB) $(DESTDIR)$(libdir)/$(SYMLIB)
-endif
-
-install-dev:
-	@install -d $(DESTDIR)$(incdir)/$(LIBNAME)
-	@for file in $(HEADERS); do						\
-		printf "  INSTALL $(DESTDIR)$(incdir)/$(LIBNAME)/$$file\n";	\
-		install -m 0644 $$file $(DESTDIR)$(incdir)/$(LIBNAME)/$$file;	\
-	done
-ifdef STATIC
-	@printf "  INSTALL $(DESTDIR)$(libdir)/$(STATICLIB)\n"
-	@install -d $(DESTDIR)$(libdir)
-	@install $(STATICLIB) $(DESTDIR)$(libdir)/$(STATICLIB)
-endif
-	@install -d $(DESTDIR)$(datadir)
-	@for file in $(DISTFILES); do					\
-		printf "  INSTALL $(DESTDIR)$(datadir)/$$file\n";	\
-		install -m 0644 $$file $(DESTDIR)$(datadir)/$$file;	\
-	done
-
-install: install-exec install-dev
-
-uninstall:
-	-@$(RM) -r $(DESTDIR)$(datadir)
-	-@$(RM) -r $(DESTDIR)$(incdir)/$(LIBNAME)
-	-@$(RM) $(DESTDIR)$(libdir)/$(SOLIB)
-	-@$(RM) $(DESTDIR)$(libdir)/$(SYMLIB)
-	-@$(RM) $(DESTDIR)$(libdir)/$(STATICLIB)
-
-strip: $(TARGET)
-	@printf "  STRIP   %s\n" $(TARGET)
-	@$(STRIP) --strip-unneeded $(TARGET)
-	@size $(TARGET)
-
-bench: Makefile $(STATICLIB)
-	@printf "  RUN     %s\n" $@
-	@$(CC) $(CPPFLAGS) -D_GNU_SOURCE -g -o bench bench.c $(STATICLIB) && ./bench
-
-examples: all
-	@$(MAKE) -C examples
-
-test joystick:
-	@$(MAKE) -C examples $@
-
-# Runs Clang scan-build on the whole tree
-check: clean
-	@scan-build $(MAKE) all
-
-clean:
-	-@$(MAKE) -C examples $@
-	-@$(RM) $(TARGET) *.o test joystick bench
-
-distclean: clean
-	-@$(MAKE) -C examples $@
-	-@$(RM) $(DEPS) $(JUNK)
-
-dist:
-	@echo "Building .xz tarball of $(PKG) in parent dir..."
-	git archive --format=tar --prefix=$(PKG)/ v$(VERSION) | xz >../$(ARCHIVE)
-	@(cd ..; md5sum $(ARCHIVE) | tee $(ARCHIVE).md5)
-
-# Include automatically generated rules
--include $(DEPS)

Makefile.am

@@ -0,0 +1,66 @@
+ACLOCAL_AMFLAGS     = -I m4
+
+lib_LTLIBRARIES     = libuev.la
+pkginclude_HEADERS  = uev.h private.h queue.h
+libuev_la_SOURCES   = uev.c io.c timer.c signal.c
+
+check_PROGRAMS      = bench
+bench_CPPFLAGS      = -D_GNU_SOURCE
+bench_LDADD         = $(top_srcdir)/libuev.la
+
+libuev_la_CPPFLAGS  = -D_GNU_SOURCE
+libuev_la_CFLAGS    = -W -Wall -Wextra
+libuev_la_LDFLAGS   = $(AM_LDFLAGS) -version-info 1:0:0
+
+doc_DATA            = README LICENSE
+#EXTRA_DIST          = README.md AUTHORS LICENSE ChangeLog.md
+
+DIST_SUBDIRS        = examples
+SUBDIRS             = .
+if ENABLE_EXAMPLES
+  SUBDIRS          += examples
+endif
+
+test joystick: all-recursive
+	./examples/$@
+
+check-local:
+	@echo "  BENCH    $(PACKAGE)"
+	@./bench
+if ENABLE_EXAMPLES
+	@echo "  TEST     $(PACKAGE)"
+	@./examples/test
+endif
+
+## Generate MD5 checksum file
+MD5 = md5sum
+md5-dist:
+	@for file in $(DIST_ARCHIVES); do	\
+		$(MD5) $$file > $$file.md5;	\
+	done
+
+## Check if tagged in git
+release-hook:
+	if [ ! `git tag | grep $(PACKAGE_VERSION)` ]; then				\
+		echo;									\
+		printf "\e[1m\e[41mCannot find release tag $(PACKAGE_VERSION)\e[0m\n";	\
+		printf "\e[1m\e[5mDo release anyway?\e[0m "; read yorn;			\
+		if [ "$$yorn" != "y" -a "$$yorn" != "Y" ]; then				\
+			printf "OK, aborting release.\n";				\
+			exit 1;								\
+		fi;									\
+		echo;									\
+	else										\
+		echo;									\
+		printf "\e[1m\e[42mFound GIT release tag $(PACKAGE_VERSION)\e[0m\n";	\
+		printf "\e[1m\e[44m>>Remember to push tags!\e[0m\n";			\
+		echo;									\
+	fi
+
+## Target to run when building a release
+release: dist release-hook md5-dist
+	@for file in $(DIST_ARCHIVES); do						\
+		printf "$$file    \tDistribution tarball\n";				\
+		printf "$$file.md5\t"; cat $$file.md5 | cut -f1 -d' ';			\
+		mv $$file* ../;								\
+	done

README.md

@@ -1,6 +1,6 @@
 libuEv | Simple event loop for Linux
 ====================================
-[![Travis Status]][Travis] [![Coverity Status]][Coverity Scan]
+[![Travis Status][]][Travis] [![Coverity Status][]][Coverity Scan]
 
 
 Table of Contents
@@ -8,7 +8,11 @@ Table of Contents
 
 * [Introduction](#introduction)
 * [API](#api)
-* [Example](#example)
+  * [Create an Event Context](#create-an-event-context)
+  * [Register an Event Watcher](#register-an-event-watcher)
+  * [Start Event Loop](#start-event-loop)
+  * [Summary](#summary)
+* [Joystick Example](#joystick-example)
 * [Build & Install](#build--install)
 * [Origin & References](#origin--references)
 
@@ -44,13 +48,13 @@ core, even though they run Linux, with multiple threads a program may
 actually run slower!  Always profile your program, and if possible, test
 it on different architectures.
 
-[libuEv] is a simple event loop in the style of the more established
+[libuEv][] is a simple event loop in the style of the more established
 [libevent][1], [libev][2] and the venerable [Xt(3)][3] event loop.  The
 *u* (micro) in the name refers to both the small feature set and the
 small size overhead impact of the library.  The primary target of
-[libuEv] is a modern Linux system.
+[libuEv][] is a modern Linux system.
 
-Experienced developers may appreciate that [libuEv] is built on top of
+Experienced developers may appreciate that [libuEv][] is built on top of
 modern Linux APIs: epoll, timerfd and signalfd.  Note, a certain amount
 of care is needed when dealing with APIs that employ signalfd.  For
 details, see [this article][4] at [lwn.net](http://lwn.net).
@@ -61,18 +65,19 @@ details, see [this article][4] at [lwn.net](http://lwn.net).
 API
 ---
 
-The C interface to [libuEv] is very simple.  It handles three different
+The C interface to [libuEv][] is very simple.  It handles three different
 types of events: I/O (files, sockets, message queues, etc.), timers, and
 signals.  With a slight caveat on signals
 
 ```C
+
     /* Callback example, arg is passed from watcher's *_init()
      * w->fd holds the file descriptor, events is set by libuEv
      * to indicate if any of UEV_READ and/or UEV_WRITE is ready.
      */
     void callback       (uev_t *w, void *arg, int events);
 
-    /* Event loop functions, notice use of flags! */
+    /* Event loop:      Notice the use of flags! */
     int uev_init        (uev_ctx_t *ctx);
     int uev_exit        (uev_ctx_t *ctx);
     int uev_run         (uev_ctx_t *ctx, int flags);         /* UEV_NONE, UEV_ONCE, and/or UEV_NONBLOCK */
@@ -94,57 +99,85 @@ signals.  With a slight caveat on signals
     int uev_signal_set  (uev_t *w, int signo);               /* Change signal to wait for */
     int uev_signal_start(uev_t *w);                          /* Restart a stopped signal watcher */
     int uev_signal_stop (uev_t *w);                          /* Stop signal watcher */
+
 ```
 
+### Create an Event Context
+
 To monitor events the developer first creates an *event context*, this
 is achieved by calling `uev_init()` with a pointer to a (thread) local
 `uev_ctx_t` variable.
 
 ```C
-    uev_ctx_t ctx;
 
+    uev_ctx_t ctx;
+    
     uev_init(&ctx);
+
 ```
 
-Then, for each event to be monitored, a *watcher* is registered with the
+
-event context.  The watcher, an `uev_t`, is initialized with the proper
+### Register an Event Watcher
-file descriptor to monitor, and an event callback function, by calling
+
-the event type's `_init()` function with the `uev_ctx_t` context.
+For each event to monitor, be it a signal, timer or file descriptor, a
+*watcher* must be registered with the event context.  The watcher, an
+`uev_t`, is registered by calling the event type's `_init()` function
+with the `uev_ctx_t` context, the callback, and an optional argument.
+
+Here is a signal example:
 
 ```C
+
     void cleanup_exit(uev_t *w, void *arg, int events)
     {
         /* Graceful exit, with optional cleanup ... */
         uev_exit(w->ctx);
     }
     
-    uev_t termw;
+    int main(void)
+	{
+	    uev_t sigterm_watcher;
+        .
+		.
+		.
+        uev_signal_init(&ctx, &sigterm_watcher, cleanup_exit, NULL, SIGTERM);
+		.
+		.
+		.
+	}
 
-    uev_signal_init(&ctx, &term, cleanup_exit, NULL, SIGTERM);
 ```
 
+
+### Start Event Loop
+
 When all watchers are registered, call the *event loop* with `uev_run()`
 and the argument to the event context.  The `flags` parameter can be
-used to integrate [libuEv] into another event loop.  With `flags` set to
+used to integrate [libuEv][] into another event loop.
-`UEV_ONCE` the event loop returns after having served the first event.
+
-If `flags` is set to `UEV_ONCE | UEV_NONBLOCK` the event loop returns
+In this example we set `flags` to none:
-immediately if no event is available.
 
 ```C
+
     uev_run(&ctx, UEV_NONE);
+
 ```
 
-In case of errors, stream close, or peer shutdown, libuEv handles much
+With `flags` set to `UEV_ONCE` the event loop returns as soon as it has
-internally, but also lets the callback run.  This is useful for stateful
+served the first event.  If `flags` is set to `UEV_ONCE | UEV_NONBLOCK`
-connections to be able to detect EOF.
+the event loop returns immediately if no event is available.
 
-Summary:
+**Note:** libuEv handles many types of errors, stream close, or peer
+shutdowns internally, but also lets the callback run.  This is useful
+for stateful connections to be able to detect EOF.
 
-1. Prepare an event context with `uev_init()`
+### Summary
-2. Register event callbacks with `uev_io_init()`, `uev_signal_init()`
+
-   or `uev_timer_init()`
+1. Set up an event context with `uev_init()`
-3. Enter the event loop with `uev_run()`
+2. Register event callbacks with the event context using
-4. Leave the event loop with `uev_exit()`, possibly from a callback
+   `uev_io_init()`, `uev_signal_init()` or `uev_timer_init()`
+3. Start the event loop with `uev_run()`
+4. Exit the event loop with `uev_exit()`, possibly from a callback
 
 **Note 1:** Make sure to use non-blocking stream I/O!  Most hard to find
 bugs in event driven applications are due to sockets and files being
@@ -164,61 +197,63 @@ of this, from [finit][6], implementing `run()` as a better replacement
 to `system()`, which sucks anyawy :)
 
 
-Example
+Joystick Example
--------
+----------------
 
-Here follows a very brief example to illustrate how one can use [libuEv]
+Here follows a very brief example to illustrate how one can use
-to act upon joystick input.
+[libuEv][] to act upon joystick input.
 
 ```C
-#include <err.h>
-#include <errno.h>
-#include <stdio.h>
-#include <stdint.h>
-#include <fcntl.h>
-#include <unistd.h>
 
-#include "uev.h"
+    #include <err.h>
+    #include <errno.h>
+    #include <stdio.h>
+    #include <stdint.h>
+    #include <fcntl.h>
+    #include <unistd.h>
+    
+    #include "uev.h"
+    
+    struct js_event {
+    	uint32_t time;		/* event timestamp in milliseconds */
+    	int16_t  value;		/* value */
+    	uint8_t  type;		/* event type */
+    	uint8_t  number;	/* axis/button number */
+    } e;
+    
+    static void joystick_cb(uev_t *w, void *arg, int events)
+    {
+    	read (w->fd, &e, sizeof(e));
+    
+    	switch (e.type) {
+    	case 1:
+    		if (e.value) printf("Button %d pressed\n", e.number);
+    		else 	     printf("Button %d released\n", e.number);
+    		break;
+    
+    	case 2:
+    		printf("Joystick axis %d moved, value %d!\n", e.number, e.value);
+    		break;
+    	}
+    }
+    
+    int main(void)
+    {
+    	int       fd = open("/dev/input/js1", O_RDONLY, O_NONBLOCK);
+    	uev_t     js1_watcher;
+    	uev_ctx_t ctx;
+    
+    	if (fd < 0)
+    		errx(errno, "Cannot find a joystick attached.");
+    
+    	uev_init(&ctx);
+    	uev_io_init(&ctx, &js1_watcher, joystick_cb, NULL, fd, UEV_READ);
+    
+    	puts("Starting, press Ctrl-C to exit.");
+    
+    	return uev_run(&ctx, 0);
+    }
 
-struct js_event {
-	uint32_t time;		/* event timestamp in milliseconds */
-	int16_t  value;		/* value */
-	uint8_t  type;		/* event type */
-	uint8_t  number;	/* axis/button number */
-} e;
-
-static void joystick_cb(uev_t *w, void *arg, int events)
-{
-	read (w->fd, &e, sizeof(e));
-
-	switch (e.type) {
-	case 1:
-		if (e.value) printf("Button %d pressed\n", e.number);
-		else 	     printf("Button %d released\n", e.number);
-		break;
-
-	case 2:
-		printf("Joystick axis %d moved, value %d!\n", e.number, e.value);
-		break;
-	}
-}
-
-int main(void)
-{
-	int       fd = open("/dev/input/js1", O_RDONLY, O_NONBLOCK);
-	uev_t     js1_watcher;
-	uev_ctx_t ctx;
-
-	if (fd < 0)
-		errx(errno, "Cannot find a joystick attached.");
-
-	uev_init(&ctx);
-	uev_io_init(&ctx, &js1_watcher, joystick_cb, NULL, fd, UEV_READ);
-
-	puts("Starting, press Ctrl-C to exit.");
-
-	return uev_run(&ctx, 0);
-}
 ```
 
 To compile the program, save the code as `joystick.c` and call GCC with
@@ -226,52 +261,42 @@ To compile the program, save the code as `joystick.c` and call GCC with
 directory, skips using a Makefile altogether.  Alternatively, call the
 `Makefile` with <kbd>make joystick</kbd> from this directory.
 
-More complete and relevant example uses of [libuEv] is the TFTP/FTP
+More complete and relevant example uses of [libuEv][] is the FTP/TFTP
 server [uftpd][5], and the Linux `/sbin/init` replacement [finit][6].
-Both use [libuEv] as a GIT submodule.
+Both successfully employ [libuEv][].
 
-Also, see the `bench.c` program (<kbd>make bench</kbd> from within the
+Also see the `bench.c` program (<kbd>make bench</kbd> from within the
-library) for [reference benchmarks][7] against libevent and libev.
+library) for [reference benchmarks][7] against [libevent][1] and
+[libev][2].
 
 
 Build & Install
 ---------------
 
-The library is built for and developed on GNU/Linux systems, so it may
+The library is built for and developed on GNU/Linux systems, patches to
-use GCC and GNU Make specific extensions here and there.  This is not on
+support *BSD and its kqueue interface are most welcome.
-purpose and patches to correct this are most welcome.  Particularly
-patches to support *BSD and its kqueue interface.
 
-* <kbd>make all</kbd>: The library
+libuEv use the GNU configure and build system.  To try out the bundled
-* <kbd>make test</kbd>: Test and showcase
+examples, use the `--enable-examples` switch to the `configure` script.
-* <kbd>make install</kbd>: Honors `$prefix` and `$DESTDIR` environment variables
 
-Size of [libuEv]:
+    ./configure
+    make all
+    make test
+    make install
 
-    $ make strip
+The resulting .so file is ~14 kiB when stripped (`make install-strip`).
-    CC      main.o
-    CC      io.o
-    CC      timer.o
-    CC      signal.o
-    ARCHIVE libuev.a
-    LINK    libuev.so.1
-    STRIP   libuev.a
-    STRIP   libuev.so.1
-    text	   data	    bss	    dec	    hex	filename
-    1177	      0	      0	   1177	    499	main.o     (ex libuev.a)
-     308	      0	      0	    308	    134	io.o       (ex libuev.a)
-     682	      0	      0	    682	    2aa	timer.o    (ex libuev.a)
-     563	      0	      0	    563	    233	signal.o   (ex libuev.a)
-    6306	    768	      8	   7082	   1baa	libuev.so.1
 
 
 Origin & References
---------------------
+-------------------
 
-[libuEv] was originally based on [LibUEvent][8] by [Flemming Madsen] but
+[libuEv][] was originally based on [LibUEvent][8] by [Flemming Madsen][]
-has been completely rewritten with a much clearer API.  Now more similar
+but has been completely rewritten with a much clearer API.  Now more
-to the famous [libev][2] by [Mark Lehmann].  Another small event library
+similar to the famous [libev][2] by [Mark Lehmann][].  Another small
-used for inspiration is the very small [Picoev][9] by [Oku Kazuho].
+event library used for inspiration is the very small [Picoev][9] by
+[Oku Kazuho][].
+
+[libuEv][] is developed and maintained by [Joachim Nilsson][].
 
 [1]: http://libevent.org
 [2]: http://software.schmorp.de/pkg/libev.html
@@ -286,15 +311,13 @@ used for inspiration is the very small [Picoev][9] by [Oku Kazuho].
 [Travis Status]:   https://travis-ci.org/troglobit/libuev.png?branch=master
 [Coverity Scan]:   https://scan.coverity.com/projects/3846
 [Coverity Status]: https://scan.coverity.com/projects/3846/badge.svg
-[LibuEV]:          https://github.com/troglobit/libuev
+[LibuEv]:          https://github.com/troglobit/libuev
 [Oku Kazuho]:      https://github.com/kazuho
 [Mark Lehmann]:    http://software.schmorp.de
 [Joachim Nilsson]: http://troglobit.com
 [Flemming Madsen]: http://www.madsensoft.dk
 [Dave Zarzycki, Apple]: http://www.youtube.com/watch?v=cD_s6Fjdri8
 
-[libuEv] is developed and maintained by [Joachim Nilsson]
-
 <!--
   -- Local Variables:
   --  mode: markdown

autogen.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+autoreconf -W portability -visfm

configure.ac

@@ -0,0 +1,24 @@
+# Use v2.61 for backwards compat with Ubuntu 12.04 LTS
+AC_PREREQ([2.61])
+AC_INIT(libuEv, 1.3.0, https://github.com/troglobit/libuev/issues, libuev)
+AM_INIT_AUTOMAKE([1.11 foreign no-dist-gzip dist-xz])
+AM_SILENT_RULES([yes])
+
+AC_CONFIG_SRCDIR(uev.c)
+AM_CONFIG_HEADER(config.h)
+AC_CONFIG_FILES([Makefile examples/Makefile])
+AC_CONFIG_MACRO_DIR([m4])
+
+AC_PROG_CC
+AM_PROG_AR
+LT_INIT
+
+AC_ARG_ENABLE([examples],
+	[AS_HELP_STRING([--enable-examples], [build examples])],
+	[enable_examples=yes], [])
+AM_CONDITIONAL([ENABLE_EXAMPLES], [test "$enable_examples" = yes])
+
+AC_HEADER_STDC
+AC_C_CONST
+
+AC_OUTPUT

examples/Makefile

@@ -1,54 +0,0 @@
-# libuEv examples
-#
-# Copyright (c) 2012       Flemming Madsen <flemming!madsen()madsensoft!dk>
-# Copyright (c) 2013-2015  Joachim Nilsson <troglobit()gmail!com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#
-.PHONY: all clean
-
-TARGET      = signal test joystick
-OBJS       := $(addsuffix .o, $(TARGET))
-SRCS       := $(OBJS:.o=.c)
-DEPS       := $(SRCS:.c=.d)
-CPPFLAGS   += -I../
-LDFLAGS    := -L../
-LDLIBS     := ../$(STATICLIB)
-
-# This magic trick looks like a comment, but works on BSD PMake
-#include <../rules.mk>
-include ../rules.mk
-
-all: $(TARGET)
-
-signal: signal.o
-
-test: test.o
-
-joystick: joystick.o
-
-clean:
-	-@$(RM) $(TARGET) *.o
-
-distclean: clean
-	-@$(RM) $(DEPS) $(JUNK)
-
-# Include automatically generated rules
--include $(DEPS)

examples/Makefile.am

@@ -0,0 +1,5 @@
+noinst_PROGRAMS = signal test joystick
+AM_CPPFLAGS     = -I$(top_srcdir)
+AM_LDFLAGS      = -L$(top_srcdir)
+LIBS            = $(LTLIBINTL)
+LDADD           = $(top_srcdir)/libuev.la

m4/.gitignore

@@ -0,0 +1 @@
+*.m4

rules.mk

@@ -1,9 +0,0 @@
-# Pretty printing and GCC -M for auto dep files
-%.o: %.c
-	@printf "  CC      $(subst $(ROOTDIR)/,,$(shell pwd)/)$@\n"
-	@$(CC) $(CFLAGS) $(CPPFLAGS) -c -MMD -MP -o $@ $<
-
-%: %.o
-	@printf "  LINK    $(subst $(ROOTDIR)/,,$(shell pwd)/)$@\n"
-	@$(CC) $(CFLAGS) $(LDFLAGS) -Wl,-Map,$@.map -o $@ $^ $(LDLIBS$(LDLIBS-$(@)))
-

timer.c

@@ -154,12 +154,12 @@ int uev_timer_start(uev_t *w)
  */
 int uev_timer_stop(uev_t *w)
 {
-	if (uev_watcher_stop(w))
-		return -1;
-
 	/* Stop kernel timer */
 	uev_timer_set(w, 0, 0);
 
+	if (uev_watcher_stop(w))
+		return -1;
+
 	/* Close timerfd, will have to be reopened again on reset */
 	close(w->fd);
 	w->fd = -1;

uev.h

@@ -41,10 +41,12 @@
 
 /* Event watcher */
 typedef struct uev {
+	/* Private data for libuEv internal engine */
+	uev_private_t   type;
+
+	/* Public data for users to reference  */
 	int             fd;
 	uev_ctx_t      *ctx;
-
-	uev_private_t   type;
 } uev_t;
 
 /* Generic callback for watchers */