Commits

Ruslan Osmanov  committed 226d926

Doc

  • Participants
  • Parent commits e25d316

Comments (0)

Files changed (9)

File EXPERIMENTAL

-eventfd file descriptor exported to userpasce in order to bind to libevent
-extension and similar extensions; access is acquired with eio_get_event_stream().

File INSTALL

-INSTALLATION OF EIO PECL EXTENSION
-==================================
-
-Currently this extension supports GNU/Linux and BSD platforms only. But you can
-try it on any UNIX OS.
-
-
-AUTOMATIC INSTALLATION
-----------------------
-
-To download and install eio automatically you need the following commands
-for stable release:
-
-	# pecl install eio
-
-, and the following for beta release:
-
-	# pecl install eio-beta
-
-If you have the package archive, unpack it and run: 
-
-	# pecl install package.xml
-
-Note, these commands(started with '#') most likely need root priveleges.
-
-Since version 0.4.0 beta libeio is embedded. So you don't need to install the
-library separately.
-
-
-MANUAL INSTALLATION
--------------------
-
-Easy way, if you want just install it as root:
-
-	# pecl install eio
-
-If you want to tweak or debug it, checkout the project or download it as
-archive. In the package directory run: 
-
-	$ phpize
-	$ ./configure --with-eio --enable-eio-sockets --enable-eio-debug
-	$ make 
-
-Optionally test the extension in CLI:
-
-	$ make test
-
-Do install with root priveleges:
-
-	# make install
-
-In php.ini, or some other configuration like
-</usr/local/etc/php/conf.d/eio.ini> write:
-
-	extension=eio.so
-
-NOTES
------
-
-Since version 0.5.0 beta you're able to pass PHP streams, sockets(`socket_create`,
-`socket_accept`), or numeric file descriptors to functions like `eio_sendfile`,
-`eio_readahead`, `eio_read` etc.
-
-
-AUTHOR
-------
-
-Ruslan Osmanov <osmanov@php.net>
-<http://megagroup.ru/>
-
-
-vim: tw=80 ft=markdown
+INSTALLATION OF EIO PECL EXTENSION
+==================================
+
+Currently this extension supports GNU/Linux and BSD platforms only. But you can
+try it on any UNIX OS.
+
+
+AUTOMATIC INSTALLATION
+----------------------
+
+To download and install eio automatically you need the following commands
+for stable release:
+
+	# pecl install eio
+
+, and the following for beta release:
+
+	# pecl install eio-beta
+
+If you have the package archive, unpack it and run: 
+
+	# pecl install package.xml
+
+Note, these commands(started with '#') most likely need root priveleges.
+
+Since version 0.4.0 beta libeio is embedded. So you don't need to install the
+library separately.
+
+
+MANUAL INSTALLATION
+-------------------
+
+Easy way, if you want just install it as root:
+
+	# pecl install eio
+
+If you want to tweak or debug it, checkout the project or download it as
+archive. In the package directory run: 
+
+	$ phpize
+	$ ./configure --with-eio --enable-eio-sockets --enable-eio-debug
+	$ make 
+
+Optionally test the extension in CLI:
+
+	$ make test
+
+Do install with root priveleges:
+
+	# make install
+
+In php.ini, or some other configuration like
+</usr/local/etc/php/conf.d/eio.ini> write:
+
+	extension=eio.so
+
+NOTES
+-----
+
+Since version 0.5.0 beta you're able to pass PHP streams, sockets(`socket_create`,
+`socket_accept`), or numeric file descriptors to functions like `eio_sendfile`,
+`eio_readahead`, `eio_read` etc.
+
+
+AUTHOR
+------
+
+Ruslan Osmanov <osmanov@php.net>
+<http://megagroup.ru/>
 -------------------------------------------------------------------- 
                   The PHP License, version 3.01
-Copyright (c) 1999 - 2013 The PHP Group. All rights reserved.
+Copyright (c) 1999 - 2014 The PHP Group. All rights reserved.
 -------------------------------------------------------------------- 
 
 Redistribution and use in source and binary forms, with or without
 COPYRIGHT
 ---------
 
-Copyright (C) 2011-2013 Ruslan Osmanov <osmanov@php.net>
-
-This project is subject to version 3.01 of the PHP license, that is bundled with
-this package in the file LICENSE, and is available through the world-wide-web at
-the following url: <http://www.php.net/license/3_01.txt>. If you did not receive
-a copy of the PHP license and are unable to obtain it through the
-world-wide-web, please send a note to <license@php.net> so we can mail you a
-copy immediately.
-
-
-vim: noet tw=80 ft=markdown:
+	Copyright (C) 2011-2014 Ruslan Osmanov <osmanov@php.net>
+
+	This project is subject to version 3.01 of the PHP license, that is bundled with
+	this package in the file LICENSE, and is available through the world-wide-web at
+	the following url: <http://www.php.net/license/3_01.txt>. If you did not receive
+	a copy of the PHP license and are unable to obtain it through the
+	world-wide-web, please send a note to <license@php.net> so we can mail you a
+	copy immediately.
    +----------------------------------------------------------------------+
    | PHP Version 5                                                        |
    +----------------------------------------------------------------------+
-   | Copyright (c) 1997-2013 The PHP Group                                |
+   | Copyright (c) 1997-2014 The PHP Group                                |
    +----------------------------------------------------------------------+
    | This source file is subject to version 3.01 of the PHP license,      |
    | that is bundled with this package in the file LICENSE, and is        |
    +----------------------------------------------------------------------+
    | PHP Version 5                                                        |
    +----------------------------------------------------------------------+
-   | Copyright (c) 1997-2013 The PHP Group                                |
+   | Copyright (c) 1997-2014 The PHP Group                                |
    +----------------------------------------------------------------------+
    | This source file is subject to version 3.01 of the PHP license,      |
    | that is bundled with this package in the file LICENSE, and is        |
     <email>osmanov@php.net</email>
     <active>yes</active>
   </lead>
-  <date>2013-07-19</date>
+  <date>2014-01-18</date>
   <!--{{{ Current version -->
   <version>
     <release>1.2.3</release>
   <contents>
     <dir name="/">
       <file role="doc" name="CREDITS"/>
-      <file role="doc" name="EXPERIMENTAL"/>
-      <file role="doc" name="INSTALL"/>
+      <file role="doc" name="INSTALL.md"/>
       <file role="doc" name="LICENSE"/>
-      <file role="doc" name="README"/>
+      <file role="doc" name="README.md"/>
       <file role="src" name="config.m4"/>
       <file role="src" name="php_eio.c"/>
       <file role="src" name="eio_fe.c"/>
         eventfd; the same descriptor exported to userspace to bind with existing
         event loops
         Add: eio_get_eventfd function to get eventfd descriptor
-        Add: header checks in configuration 
+        Add: header checks in configuration
         Change: libeio initialization moved to the MINIT phase, but unfinished
         requests are still handled in the RSHUTDOWN phase
         Change: simplified libeio callbacks
       </stability>
       <license uri="http://www.php.net/license">PHP</license>
       <notes>
-        Change: Shared memory permissions are set to 0660 by default 
+        Change: Shared memory permissions are set to 0660 by default
         Change: Removed redundant code and comments
         Add: Tests: eio_read_basic.phpt, eio_stat_basic.phpt
         Fix: the package XML
   </changelog>
   <!--}}}-->
 </package>
-<!-- 
+<!--
 vim: et sts=2 ts=2 sw=2 fdm=marker
 -->
    +----------------------------------------------------------------------+
    | PHP Version 5                                                        |
    +----------------------------------------------------------------------+
-   | Copyright (c) 1997-2013 The PHP Group                                |
+   | Copyright (c) 1997-2014 The PHP Group                                |
    +----------------------------------------------------------------------+
    | This source file is subject to version 3.01 of the PHP license,      |
    | that is bundled with this package in the file LICENSE, and is        |