Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:30051
Return-Path: <andi@zend.com>
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Delivered-To: mailing list internals@lists.php.net
Received: (qmail 99955 invoked by uid 1010); 5 Jun 2007 02:40:25 -0000
Delivered-To: ezmlm-scan-internals@lists.php.net
Delivered-To: ezmlm-internals@lists.php.net
Received: (qmail 99940 invoked from network); 5 Jun 2007 02:40:25 -0000
Received: from unknown (HELO lists.php.net) (127.0.0.1)
  by localhost with SMTP; 5 Jun 2007 02:40:25 -0000
Authentication-Results: pb1.pair.com smtp.mail=andi@zend.com; spf=pass; sender-id=pass
Authentication-Results: pb1.pair.com header.from=andi@zend.com; sender-id=pass
Received-SPF: pass (pb1.pair.com: domain zend.com designates 63.205.162.114 as permitted sender)
X-PHP-List-Original-Sender: andi@zend.com
X-Host-Fingerprint: 63.205.162.114 unknown Windows 2000 SP4, XP SP1
Received: from [63.205.162.114] ([63.205.162.114:63409] helo=us-ex1.zend.com)
	by pb1.pair.com (ecelerity 2.1.1.9-wez r(12769M)) with ESMTP
	id FC/B9-57078-81DC4664 for <internals@lists.php.net>; Mon, 04 Jun 2007 22:40:24 -0400
X-MimeOLE: Produced By Microsoft Exchange V6.5
Content-class: urn:content-classes:message
MIME-Version: 1.0
Content-Type: text/plain;
	charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
Date: Mon, 4 Jun 2007 19:40:19 -0700
Message-ID: <698DE66518E7CA45812BD18E807866CE418E1B@us-ex1.zend.net>
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
Thread-Topic: [PHP-DEV] Documenting the Zend2 extension API
Thread-Index: Acekz0/p/05A58atSKSAl2F+OVCDKQCSqUJw
References: <97180F0D-CB4C-4071-A859-38059C0DD1FF@wanderingknights.org> <Pine.LNX.4.62.0704252131190.1454@localhost> <0DFF3A59-3419-4A25-B907-E0E71FD41360@wanderingknights.org> <462FD093.90402@zend.com> <C74FB334-3BAF-4324-A439-235723F2EB3A@wanderingknights.org> <462FDB7B.8000907@zend.com> <8F6E78F4-9B53-43FA-8E7E-3460800F9AAD@wanderingknights.org> <4850AC0C-7268-4CE2-A192-771F459A2CB5@roshambo.org> <A1C3ADF2-0D60-4746-ACDF-6A1BDFCB1A81@wanderingknights.org> <6DD3AF62-A773-4015-ACBE-B5178C4B2F03@roshambo.org>
To: "Philip Olson" <philip@roshambo.org>,
	"Gwynne Raskind" <gwynne@wanderingknights.org>
Cc: <internals@lists.php.net>
Subject: RE: [PHP-DEV] Documenting the Zend2 extension API
From: andi@zend.com ("Andi Gutmans")

Btw, the book Derick, Stig and I wrote ("PHP 5 Power Programming") also
has a chapter re: writing extensions. While it covers only a subset and
has not been updated, I think it does a good job in explaining some of
the fundamentals.=20
Reason why I bring this up is because the book is under the open
publication license and I believe it might allow you to steal some
pieces for the PHP manual. I can get you the exact license if you need
(it's been a while so I don't remember exactly which clauses we chose
but I think it can be used).

Andi

> -----Original Message-----
> From: Philip Olson [mailto:philip@roshambo.org]=20
> Sent: Friday, June 01, 2007 9:31 PM
> To: Gwynne Raskind
> Cc: internals@lists.php.net
> Subject: Re: [PHP-DEV] Documenting the Zend2 extension API
>=20
> >
> > <part id=3D"internals2">
> >   <title>&Internals2;</title>
> >   &internals2.intro;
> >   &internals2.buildsys.index;   <!-- configure options, ext_skel, =20
> > config.m4, config.w32, static vs dynamic builds -->
> >   &internals2.structure.index;  <!-- ext_skel, module structure,=20
> > globals, lifecycle, tests -->
> >   &internals2.memory.index;     <!-- management,=20
> persistence, TSRM -->
> >   &internals2.variables.index;  <!-- zval, hashtable, references,=20
> > constants -->
> >   &internals2.functions.index;  <!-- defining, arguments, return=20
> > values, passthru, aliasing -->
> >   &internals2.objects.index;    <!-- classes, inheritance, =20
> > properties, methods, method-function mapping -->
> >   &internals2.resources.index;  <!-- defining, creating,=20
> retrieving,=20
> > destroying -->
> >   &internals2.ini.index;        <!-- defining, retrieving,=20
> changing =20
> > -->
> >   &internals2.streams.index;    <!-- using, wrappers, contexts, =20
> > filters -->
> >   <!-- grab the PDO section from &Internals; here? -->
> >   &internals2.apiref.index;     <!-- full index of all APIs, =20
> > constants, macros, etc. -->
> >   &internals2.ze1.index;        <!-- quick list of major =20
> > differences, short discussion re: OOP -->
> >   &internals2.ze3.index;        <!-- quick discussion of major =20
> > changes, some details on Unicode -->
> > </part>
> >
> > My thinking is to document ZE2 completely, since the differences=20
> > between 1 and 2 are small enough for the existing internals=20
> section to=20
> > be of use to anyone writing for 1, and 3 can be more fully=20
> documented=20
> > later (something I'm willing to take on as well).
> >
> > If I'm given a thumbs-down on this way of doing things,=20
> I'll take the=20
> > material I've written already and use it to update the existing=20
> > internals section, but I think this method has the best chance of=20
> > giving people the truly comprehensive online reference we've lacked=20
> > for extension writing up to this point.
>=20
> Hello Gwynne,
>=20
> Sounds good. Many times silence on this list means "Sounds=20
> good" and internals isn't too keen on defining a structure=20
> for documentation... :) So, go for it! Always feel free to=20
> ask questions while documenting this and as it all progresses=20
> let's be sure internals reviews the information too. Once the=20
> information is in manageable and smaller pieces you'll likely=20
> have more success getting feedback. And don't be a stranger=20
> on #php.pecl @ efnet (IRC) either.
>=20
> Regards,
> Philip
>=20
> --
> PHP Internals - PHP Runtime Development Mailing List To=20
> unsubscribe, visit: http://www.php.net/unsub.php
>=20
>=20