cvs: phpdoc /en/internals2/structure files.xml modstruct.xml
| From: | Gwynne Raskind | Date: | Tue, 29 Apr 2008 14:32:00 +0000 |
| Subject: | cvs: phpdoc /en/internals2/structure files.xml modstruct.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-1573@lists.php.net to get a copy of this message | ||
gwynne Tue Apr 29 14:32:00 2008 UTC
Modified files:
/phpdoc/en/internals2/structure files.xml modstruct.xml
Log:
updated previously written docs to know about the counter example. Also fix the $ keyword. Depends
on a pending PhD bug fix and will look odd until then
http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/structure/files.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/internals2/structure/files.xml
diff -u phpdoc/en/internals2/structure/files.xml:1.3 phpdoc/en/internals2/structure/files.xml:1.4
--- phpdoc/en/internals2/structure/files.xml:1.3 Tue Sep 4 23:55:17 2007
+++ phpdoc/en/internals2/structure/files.xml Tue Apr 29 14:32:00 2008
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="ISO-8859-1" ?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<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>
@@ -31,7 +31,7 @@
</varlistentry>
<varlistentry>
- <term><filename>php_example.h</filename></term>
+ <term><filename>php_counter.h</filename></term>
<listitem>
<para>
When building an extension as static module into the PHP binary the
@@ -44,7 +44,7 @@
</varlistentry>
<varlistentry>
- <term><filename>example.c</filename></term>
+ <term><filename>counter.c</filename></term>
<listitem>
<para>
Main extension source file. By convention, the name of this file
@@ -60,23 +60,23 @@
The buildsystem files are discussed elsewhere; this section concentrates on
the rest. These four files make up the bare minimum for an extension, which
may also contain any number of headers, source files, unit tests, and other
- support files. The list of files in a realistic extension might look like
+ support files. The list of files in the counter extension might look like
this:
</para>
<example xml:id="internals2.structure.files.ex1">
- <title>Files in an example "real" extension, in no particular
order</title>
+ <title>Files in the counter extension, in no particular order</title>
<screen>
<![CDATA[
ext/
- example/
+ counter/
.cvsignore
config.m4
config.w32
- example_util.h
- example_util.c
- php_example.h
- example.c
+ counter_util.h
+ counter_util.c
+ php_counter.h
+ counter.c
package.xml
CREDITS
tests/
http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/structure/modstruct.xml?r1=1.8&r2=1.9&diff_format=u
Index: phpdoc/en/internals2/structure/modstruct.xml
diff -u phpdoc/en/internals2/structure/modstruct.xml:1.8
phpdoc/en/internals2/structure/modstruct.xml:1.9
--- phpdoc/en/internals2/structure/modstruct.xml:1.8 Wed Apr 9 07:00:27 2008
+++ phpdoc/en/internals2/structure/modstruct.xml Tue Apr 29 14:32:00 2008
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="ISO-8859-1" ?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
<sect1 xml:id="internals2.structure.modstruct" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>The zend_module structure</title>
<para>
@@ -15,27 +15,27 @@
<para>
The <literal>zend_module</literal> declaration from
- <filename>example.c</filename> looks like this before any code has been
+ <filename>counter.c</filename> looks like this before any code has been
written. The example file was generated by
- <command>ext_skel --extname=example</command>, with some obsolete constructs
+ <command>ext_skel --extname=counter</command>, with some obsolete constructs
removed:
</para>
<example xml:id="internals2.structure.modstruct.example-decl">
- <title>zend_module declaration in an example extension</title>
+ <title>zend_module declaration in the counter extension</title>
<programlisting role="c">
<![CDATA[
-/* {{{ example_module_entry
+/* {{{ counter_module_entry
*/
-zend_module_entry example_module_entry = {
+zend_module_entry counter_module_entry = {
STANDARD_MODULE_HEADER,
- "example",
- example_functions,
- PHP_MINIT(example),
- PHP_MSHUTDOWN(example),
- PHP_RINIT(example), /* Replace with NULL if there's nothing to do at request start
*/
- PHP_RSHUTDOWN(example), /* Replace with NULL if there's nothing to do at request end */
- PHP_MINFO(example),
+ "counter",
+ counter_functions,
+ PHP_MINIT(counter),
+ PHP_MSHUTDOWN(counter),
+ PHP_RINIT(counter), /* Replace with NULL if there's nothing to do at request start
*/
+ PHP_RSHUTDOWN(counter), /* Replace with NULL if there's nothing to do at request end */
+ PHP_MINFO(counter),
"0.1", /* Replace with version number for your extension */
STANDARD_MODULE_PROPERTIES
};
@@ -463,7 +463,7 @@
<para>
With all these fields to play with, it can be confusing to know which to use
for what purpose. Here is the <literal>zend_module</literal> definition from
- the "counter" example extension.
+ the "counter" example extension after updating it to its final form.
</para>
<example xml:id="internals2.structure.modstruct.filling-it-in.counter-mod-ex">