johannes Tue Sep 4 23:55:17 2007 UTC
Modified files:
/phpdoc/en/internals2/structure files.xml
Log:
- Some more details about extension files
http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/structure/files.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/internals2/structure/files.xml
diff -u phpdoc/en/internals2/structure/files.xml:1.2
phpdoc/en/internals2/structure/files.xml:1.3
--- phpdoc/en/internals2/structure/files.xml:1.2 Wed Jun 27 21:31:12 2007
+++ phpdoc/en/internals2/structure/files.xml Tue Sep 4 23:55:17 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="ISO-8859-1" ?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<sect1 xml:id="internals2.structure.files"
xmlns="http://docbook.org/ns/docbook";
xmlns:xlink="http://www.w3.org/1999/xlink";>
<title>Files which make up an extension</title>
<para>
@@ -34,10 +34,11 @@
<term><filename>php_example.h</filename></term>
<listitem>
<para>
- Main extension header file. By convention, the name of this file is
- <literal>php_</literal> prepended to the extension name, but this is not
- a requirement. This file contains macros, prototypes, and globals, just
- like any header.
+ When building an extension as static module into the PHP binary the
+ build system expects a header file with <literal>php_</literal>
+ prepended to the extension name which includes a declaration for a
+ pointer to the extension's module structure. This file usually contains
+ additional macros, prototypes, and globals, just like any header.
</para>
</listitem>
</varlistentry>
@@ -46,8 +47,8 @@
<term><filename>example.c</filename></term>
<listitem>
<para>
- Main extension source file. Again by convention, this name of this file
- is the extension name, but again this is not a requirement. This file
+ Main extension source file. By convention, the name of this file
+ is the extension name, but this is not a requirement. This file
contains the module structure declaration, INI entries, management
functions, userspace functions, and other requirements of an extension.
</para>
@@ -113,9 +114,12 @@
<para>
The <filename>CREDITS</filename> file lists the contributors and/or
- maintainers of the extension in plain text format, preferably including
- contact information, and sometimes a website for the extension. This file
- is only one way to document this information. In a &link.pecl; package,
+ maintainers of the extension in plain text format. The main purpose of
+ this file is generating the credits information for bundled extensions as
+ used by <function>phpcredits</function>. By convention the first line of
+ the file should hold the name of the extension, the second a comma
+ separated list of contributors. The contributors are usually ordered by the
+ chronological order of their contributions. In a &link.pecl; package,
this information is already maintained in <filename>package.xml</filename>,
for example. This is another file which can be omitted without ill effect.
</para>
