com php-src: added notes about the PECL site conformity: README.EXTENSIONS README.EXT_SKEL README.SELF-CONTAINED-EXTENSIONS

Commit: 9ccde8a41571282521c677edf2b481a526ae03c9 Author: Anatol Belski <ab@php.net> Mon, 14 Oct 2013 16:07:26 +0200 Parents: 7a038ccbe61c88b007a3a3ba1580185058792e91 Branches: PHP-5.4 PHP-5.5 master Link: http://git.php.net/?p=php-src.git;a=commitdiff;h=9ccde8a41571282521c677edf2b481a526ae03c9 Log: added notes about the PECL site conformity Changed paths: M README.EXTENSIONS M README.EXT_SKEL M README.SELF-CONTAINED-EXTENSIONS Diff: diff --git a/README.EXTENSIONS b/README.EXTENSIONS index 51e3b73..7f06c0f 100644 --- a/README.EXTENSIONS +++ b/README.EXTENSIONS @@ -30,7 +30,7 @@ zend_module_entry foo_module_entry = { PHP_RSHUTDOWN(foo), /* per-request shutdown function */ PHP_MINFO(foo), /* information function */ #if ZEND_MODULE_API_NO >= 20010901 - FOO_VERSION, /* extension version number (string) */ + PHP_FOO_VERSION, /* extension version number (string) */ #endif STANDARD_MODULE_PROPERTIES }; diff --git a/README.EXT_SKEL b/README.EXT_SKEL index b0db843..d44fcc5 100644 --- a/README.EXT_SKEL +++ b/README.EXT_SKEL @@ -31,6 +31,11 @@ HOW TO USE IT ./buildconf; ./configure --enable-module_name; make + The definition of PHP_MODULE_NAME_VERSION will be present in the + php_module_name.h and injected into the zend_module_entry definition. This + is required by the PECL website for the version string conformity checks + against package.xml + But if you already have planned the overall scheme of your module, what functions it will contain, their return types and the arguments they take (a very good idea) and don't want to bother yourself with creating function diff --git a/README.SELF-CONTAINED-EXTENSIONS b/README.SELF-CONTAINED-EXTENSIONS index e6a3753..5287230 100644 --- a/README.SELF-CONTAINED-EXTENSIONS +++ b/README.SELF-CONTAINED-EXTENSIONS @@ -153,3 +153,18 @@ ADDING SHARED MODULE SUPPORT TO A MODULE #ifdef COMPILE_DL_FOO ZEND_GET_MODULE(foo) #endif + +PECL SITE CONFORMITY + + If you plan to release an extension to the PECL website, there are several + points to be regarded. + + 1. Add LICENSE or COPYING to the package.xml + + 2. The following should be defined in one of the extension header files + + #define PHP_FOO_VERSION "1.2.3" + + This macros has to be used within your foo_module_entry to indicate the + extension version. +