Re: Subversion Documentation 0.5
| From: | Edward Z. Yang | Date: | Sun, 03 Jun 2007 01:03:39 +0000 |
| Subject: | Re: Subversion Documentation 0.5 | ||
| References: | 1 2 3 4 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969376524@lists.php.net to get a copy of this message | ||
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Philip Olson wrote:
> Also be sure
> to use &warn.experimental; for this extension in reference.xml as it
> helps users realize these issues exist. And use &warn.experimental.func;
> in each function. [snip]
Done. I placed each them under a new section called "Notes", hopefully
that is the convention.
> I meant don't hard link the anchor tags and use something like this:
> <link linkend="svn.constants.auth">foo</link>
Done.
> Looks good. A few URL entities left
Done.
> and after some configure.xml cleanup
> it looks commit worthy.
The extra information I placed in configure.xml came out of personal
experience. It took me a good two hours to figure out how to compile the
extension from a custom SVN installation, because the PHP_SVN
environment variable didn't exactly work with the configure script.
Also, the 1.3 vs. 1.4 problem with PECL4WIN is a very common issue
encountered by people currently using the extension.
How would you recommend cleaning up configure.xml?
> Maybe add skeletons for those svn_fs* functions
> too as a few other functions link (See Also) to them.
What would be the bare minimum for a skeleton? As they stand, "Return
values" and "Parameters" needs to have its boilerplate text removed,
anything else?
> And for the
> svn-client-version.xml example remove the reference to PECL4WIN, and in
> most ref.svn examples use &example.outputs.similar; instead of
> &example.outputs;.
Done.
(note: I forgot to sent this to the mailing list, this is a re-send)
- --
Edward Z. Yang GnuPG: 0x869C48DA
HTML Purifier <htmlpurifier.org> Anti-XSS HTML Filter
[[ 3FA8 E9A9 7385 B691 A6FC B3CB A933 BE7D 869C 48DA ]]
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (MingW32)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org
iD8DBQFGYhNrqTO+fYacSNoRAstdAKCApguRM7CxSdMiiqHACLCToPsfMwCgh1DO
0+GuHvl7n3/Yn1xvFnYMa2U=
=278/
-----END PGP SIGNATURE-----