[PHP-DOC] Documenting bugs (was: [DOC-CVS] svn: /phpdoc/en/trunk/reference/mysqli/mysqli/ options.xml)

2009-11-20 Thread Sean Coates
> We don't document bugs.

Honest question: why not?

S



Re: [PHP-DOC] phpdoc unfrozen!

2007-12-26 Thread Sean Coates

First of all, I'd like to apologize for how long phpdoc has been
frozen, I got unexpectedly really busy with work the first days and
then got sick for few days :|
Anyway. The merge is now over and phpdoc-en now validates again;
phpdoc is therefore officially unfrozen as of now \o/


Awesome, guys. Great work! I've seen a flood of commits come through  
my inbox in the last few days, and I suspected we were close, but I  
haven't had time to find out HOW close.


Nor have I had much/any time to help in the past few weeks. I really  
appreciate that you guys found/made the time to change the structure  
and merge the changes, as well as support the changes with the build  
system. This is probably the greatest single project in phpdoc history  
since the Banana Split.


Again, thank you for spending the time, and for doing such a great  
job! I hope to get back into the game in the new year.


S


Re: [PHP-DOC] The Swedish manual lags behind

2007-11-04 Thread Sean Coates

I suspect that your complaint will be the tipping point and these
"translations" will be removed in the next few days :)


Philip and I had dinner on Wed night, and we discussed this.

The point that seems to be bothering him is a toss-up between exactly  
what this thread is about and killing off old translations that may  
or may not have some valuable translated content (plus the fact that  
it looks nice to have a ton of translations).


(Philip, feel free to jump in any time and correct me if I'm  
misrepresenting the situation.)


Anyway, an idea I came up with as a compromise is to have a list of  
"recommended" translations that would be easily selectable on  
my.php.net, and a list of "at your own risk" translations that would  
be slightly more difficult to select.


That way, we could push the 8(?) good translations and back-burner  
the others without taking anything away or insulting people who've  
worked hard on those now-dead (or at least hibernating) translations.


S


[PHP-DOC] Re: [DOC-WEB] how to write documentation for PHP?

2007-10-16 Thread Sean Coates
I want to work on PHP Documentation. How can i do it? I need to  
send email

to somebody, join some mailing list?


Voila!

http://php.net/dochowto

If you have any specific questions, we're (generally) a friendly  
bunch, so feel free to ask.


S


Re: [PHP-DOC] Patch for mysql_escape_string

2007-09-23 Thread Sean Coates
Please find a patch for mysql_escape_string attached, I'd like to  
commit so

people know which characters
are actually getting escaped, it took me a long time to figgure it  
out :)


Awesome idea.

"a backslash before before characters"...
I'd move the depreciation note into the 'notes' section while you  
are at it.


I didn't know ^Z was "substitute" I thought it was EOF.. ?

Also, you have extraneous spaces at the ends of your lines. Not a big  
deal, but they should be removed before commit.


S


Re: [PHP-DOC] splitting pages

2007-08-21 Thread Sean Coates

For what it's worth, the PDO reference page is the result of taking
the existing OO doc approach and trying to include an introductory
tutorial within the only logical spot.


In Dan's defense, it was also groundbreaking, as one of the first  
documented OO extensions/sections.


S


Re: [PHP-DOC] Missing: mysql_set_charset

2007-06-09 Thread Sean Coates

How come there isn't any documentation for the new mysql_set_charset
function?


Nobody's written it yet.
Note your use of the word "new."

http://php.net/dochowto
Send a patch (-:

S


Re: [PHP-DOC] a request to become editor

2007-05-20 Thread Sean Coates

Yes, please! ;)


+1 from me, too


Re: [PHP-DOC] Re: String length property (avoid strlen)

2007-05-02 Thread Sean Coates
> Makes sense. As I was looking for PHP coding guidelines that lead to this 
> page, I misunderstood the intend (which isn't clearly specified).

Here are some generally-accepted PHP style guidelines:
http://pear.php.net/manual/en/standards.php

S


Re: [PHP-DOC] moving doc.php.net to pb11

2007-04-28 Thread Sean Coates
As everyone may or may not have noticed, doc.php.net now points to pb11.

> btw, the phpweb rsync isn't probably working as this page is broken:
> http://doc.php.net.phpdoc.info/php/orphan_notes.php

Fixed. This was a permissions problem

So, I think everything is working now.
Cronjobs were juggled a bit, today, and I fixed permissions and moved
old cvs cruft out of the way.

Please let me (us) know if you notice anything broken.

S


Re: [PHP-DOC] Helping with PHP documentation

2007-04-25 Thread Sean Coates
> Please finish up POSIX and when it looks good we'll move towards getting
> you karma. In your CVS request* you might then say "To work on the
> documentation, I already created patches that were accepted for the
> POSIX extension."

IMO, request karma now, but please continue to submit patches to the
list if you happen to get it before POSIX is done.

Sometimes it takes a while to get an account and karma, so you should
probably get the ball rolling.

S


[PHP-DOC] cvs: phpdoc /entities global.ent

2007-04-15 Thread Sean Coates
seanMon Apr 16 02:01:38 2007 UTC

  Modified files:  
/phpdoc/entitiesglobal.ent 
  Log:
  fix APD link
  
http://cvs.php.net/viewvc.cgi/phpdoc/entities/global.ent?r1=1.290&r2=1.291&diff_format=u
Index: phpdoc/entities/global.ent
diff -u phpdoc/entities/global.ent:1.290 phpdoc/entities/global.ent:1.291
--- phpdoc/entities/global.ent:1.290Tue Apr 10 13:32:19 2007
+++ phpdoc/entities/global.ent  Mon Apr 16 02:01:38 2007
@@ -1,6 +1,6 @@
 

[PHP-DOC] moving doc.php.net to pb11

2007-04-15 Thread Sean Coates
Hi All,

We've finally finished the move and sync of everything to pb11 for
docweb (see http://doc.php.net.phpdoc.info/).

Everything seems to be working. Please test that everything matches
doc.php.net.

Note: because of the domain difference, anything related to the MAGIC
cookie isn't going to work.

If all is good, I'll ask someone with karma to switch the CNAME from
Jacques server, to the php.net one.

S


Re: [PHP-DOC] Documentation for SVN extension

2007-04-03 Thread Sean Coates
>  - Whitespace is always one space, not two

Except in examples. Then use the pear standards:
http://pear.php.net/manual/en/standards.php

S


[PHP-DOC] phpdoc to SVN (was: Re: PHP Function List)

2007-03-17 Thread Sean Coates
> Somebody has deleted all templates in xsl/ and no history left. When I
> was writing my previous letter they were there. That bloody CVS is no
> more useful than plain FTP if I constantly need to use mail list and
> archives to get the idea of "what the heck is going on"? FTP at least
> works through my web proxy.

What files are you looking for? If they are actually _gone_ from CVS,
then someone meddled with the CVS server. There are very few people who
have access to the repository, directly. If someone did this, I'll
complain to the systems people, and it won't happen again (and if you
can pinpoint a time when it happened, I'll check the logs on y1 and find
out who did it).

That said, I suspect that nobody deleted anything from the rcs tree.

> The problem with CVS is that those who was capable to setup it are fed
> up with the process and do not want to dip into another VCS and those
> who failed are just not here. If not the precious time I could argue
> on the topic endlessly, so I better leave a proposal to discuss.
> http://doc.php.net/rfc/rfc-proposal-show.php?id=8

Um no. You're misinterpreting the situation.
Let me state for the record that I personally vastly prefer SVN over
CVS. I've moved all of my personal projects to svn (a long time ago),
and over the next few weeks will be moving my professional (team-driven)
projects—I finally managed to convince the rest of the team.

Now that that's out of the way, let me clarify the situation with PHP CVS.

There are hundreds (thousands?) of people (and dozens of scripts) that
access php.net CVS. Last time the CVS->SVN migration issue was brought
up, I remember Rasmus shooting it down because of this very fact, and
not because of a technical issue. It would be too much work to move
thousands of people from one SCM to another.

Yes, large projects have already made the change, but I don't think
_anyone_ with the appropriate karma at php.net has the time and energy
to see this through. It's very unlikely to happen in the foreseeable future.

All of this to say that I think it's a tremendously bad idea to port
_part_ of the php.net source code base. CVS may have its problems, but
it's worked for the past ~10 years for us.

BTW, if someone did screw with the files on the CVS server, there's
nothing stopping them from doing the exact same thing to a SVN repository.

S


Re: [PHP-DOC] grep -ri ' a [aeiou]'... correcting or ignoring?

2007-03-12 Thread Sean Coates
Martin Samesch wrote:
> Hi,
>
> grep -ri ' a [aeiou]'... gets a lot of hits. Should they be
> corrected or not?

Most of these are hard-vowel sounds, so "a user" (for example) is correct.

I see a few places where there are mistakes ("a Apache" for example),
though, and yes, those should be fixed.

(hopefully this will actually go through without my mail client eating
it this time. Sorry if this shows up double/triple)

S


[PHP-DOC] cvs: phpdoc /en/reference/filesystem/functions fwrite.xml

2007-03-03 Thread Sean Coates
seanSat Mar  3 18:24:01 2007 UTC

  Modified files:  
/phpdoc/en/reference/filesystem/functions   fwrite.xml 
  Log:
  add note about atomic fwrites in append mode
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/fwrite.xml?r1=1.14&r2=1.15&diff_format=u
Index: phpdoc/en/reference/filesystem/functions/fwrite.xml
diff -u phpdoc/en/reference/filesystem/functions/fwrite.xml:1.14 
phpdoc/en/reference/filesystem/functions/fwrite.xml:1.15
--- phpdoc/en/reference/filesystem/functions/fwrite.xml:1.14Sat Feb  3 
08:13:44 2007
+++ phpdoc/en/reference/filesystem/functions/fwrite.xml Sat Mar  3 18:24:00 2007
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -41,6 +41,17 @@
 fopen mode parameter.

   
+  
+   
+If handle was fopened in
+append mode, fwrites are atomic (unless the size of
+string exceeds the filesystem's block size, on some
+platforms, and as long as the file is on a local filesystem). That is,
+there is no need to flock a resource before calling
+fwrite; all of the data will be written without
+interruption.
+   
+  
   

 A simple fwrite example


[PHP-DOC] cvs: phpdoc /en/reference/apc/functions apc-define-constants.xml

2007-03-02 Thread Sean Coates
seanSat Mar  3 02:17:59 2007 UTC

  Modified files:  
/phpdoc/en/reference/apc/functions  apc-define-constants.xml 
  Log:
  tyop
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apc/functions/apc-define-constants.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/apc/functions/apc-define-constants.xml
diff -u phpdoc/en/reference/apc/functions/apc-define-constants.xml:1.3 
phpdoc/en/reference/apc/functions/apc-define-constants.xml:1.4
--- phpdoc/en/reference/apc/functions/apc-define-constants.xml:1.3  Sat Mar 
 3 02:10:26 2007
+++ phpdoc/en/reference/apc/functions/apc-define-constants.xml  Sat Mar  3 
02:17:58 2007
@@ -1,5 +1,5 @@
 
-
+
 
  
   apc_define_constants
@@ -20,7 +20,7 @@
define is notoriously slow. Since the main benefit of
APC is to increase the performance of scripts/applications, this mechanism
is provided to streamline the process of mass constant definition. However,
-   This function does not perform as well as anticipated.
+   this function does not perform as well as anticipated.
   
 
   


[PHP-DOC] cvs: phpdoc /en/reference/apc/functions apc-define-constants.xml

2007-03-02 Thread Sean Coates
seanSat Mar  3 02:10:26 2007 UTC

  Modified files:  
/phpdoc/en/reference/apc/functions  apc-define-constants.xml 
  Log:
  concede and link to hidef
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apc/functions/apc-define-constants.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/apc/functions/apc-define-constants.xml
diff -u phpdoc/en/reference/apc/functions/apc-define-constants.xml:1.2 
phpdoc/en/reference/apc/functions/apc-define-constants.xml:1.3
--- phpdoc/en/reference/apc/functions/apc-define-constants.xml:1.2  Fri Aug 
19 15:11:25 2005
+++ phpdoc/en/reference/apc/functions/apc-define-constants.xml  Sat Mar  3 
02:10:26 2007
@@ -1,10 +1,10 @@
 
-
+
 
  
   apc_define_constants
   
-   Defines a set of constants for later retrieval and mass-definition 
+   Defines a set of constants for retrieval and mass-definition 
   
  
  
@@ -19,7 +19,13 @@
   
define is notoriously slow. Since the main benefit of
APC is to increase the performance of scripts/applications, this mechanism
-   is provided to streamline the process of mass constant definition.
+   is provided to streamline the process of mass constant definition. However,
+   This function does not perform as well as anticipated.
+  
+
+  
+   For a better-performing solution, try the
+   hidef extension from PECL.
   
 
   
@@ -92,7 +98,6 @@
 'THREE' => 3,
 );
 apc_define_constants('numbers', $constants);
-apc_load_constants('numbers');
 echo ONE, TWO, THREE;
 ?>
 ]]>


[PHP-DOC] cvs: phpdoc /en/reference/apc/functions apc-add.xml apc-store.xml

2007-03-02 Thread Sean Coates
seanSat Mar  3 01:17:35 2007 UTC

  Added files: 
/phpdoc/en/reference/apc/functions  apc-add.xml 

  Modified files:  
/phpdoc/en/reference/apc/functions  apc-store.xml 
  Log:
  apc_add
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apc/functions/apc-store.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/apc/functions/apc-store.xml
diff -u phpdoc/en/reference/apc/functions/apc-store.xml:1.3 
phpdoc/en/reference/apc/functions/apc-store.xml:1.4
--- phpdoc/en/reference/apc/functions/apc-store.xml:1.3 Fri Aug 19 15:11:25 2005
+++ phpdoc/en/reference/apc/functions/apc-store.xml Sat Mar  3 01:17:35 2007
@@ -1,5 +1,5 @@
 
-
+
 
  
   apc_store
@@ -99,6 +99,7 @@
   &reftitle.seealso;
   

+apc_add
 apc_fetch
 apc_delete


http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apc/functions/apc-add.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/apc/functions/apc-add.xml
+++ phpdoc/en/reference/apc/functions/apc-add.xml



 
  apc_add
  
   Cache a variable in the data store (only if it's not stored)
  
 
 
  &reftitle.description;
  
   boolapc_add
   stringkey
   mixedvar
   intttl
  

  
   
Unlike many other mechanisms in PHP, variables stored using
apc_add will persist between requests (until the
value is removed from the cache).
   
  
 
 
  &reftitle.parameters;
  
   

 key
 
  
   Store the variable using this name. keys are
   cache-unique, so attempting to use apc_add to
   store data with a key that already exists will not overwrite the
   existing data, and will instead return &false;. (This is the only
   difference between apc_add and
   apc_store.)
  
 


 var
 
  
   The variable to store
  
 


 ttl
 
  
   Time To Live; store var in the cache for
   ttl seconds. After the
   ttl has passed, the stored variable will be
   expunged from the cache (on the next request). If no 
ttl
   is supplied (or if the ttl is
   0), the value will persist until it is removed from
   the cache manually, or otherwise fails to exist in the cache (clear,
   restart, etc.).
  
 

   
  
 
 
  &reftitle.returnvalues;
  
   &return.success;
  
 

 
  &reftitle.examples;
  
   
A apc_add example



&example.outputs;



   
  
 

 
  &reftitle.seealso;
  
   
apc_store
apc_fetch
apc_delete
   
  
 






Re: [PHP-DOC] RFE on function signatures and PHP versions

2007-02-19 Thread Sean Coates
Ruud Steltenpool, http://svg.startpagina.nl wrote:
> If the signature of the PHP4 version of a function is different than the
> PHP5 version i have to find that among a number of notes a bit down in
> the docs.
> 
> I think it would improve read- and searchability a lot if you would just
> show the different signatures on top, for example:

There's a note on that page that indicates that the offset parameter was
added in 5.0.0.

I hear what you're saying, I just don't know if it would make much of a
difference.

S


Re: [PHP-DOC] need a changelog?

2007-02-06 Thread Sean Coates
> an optional parameter has been added to Phar::canCompress() as of
> 1.0.0RC2, is there any objection if I simply add the documentation, and
> don't put in a changelog for the method?  1.0.0RC1 was released today,
> and RC2 will follow in a few days, so it won't likely confuse users (the
> manual will not even build before the next release)

I don't think you need to log changes for non-stable releases.

S


[PHP-DOC] cvs: phpdoc /scripts functable.php

2007-02-05 Thread Sean Coates
seanTue Feb  6 07:11:06 2007 UTC

  Modified files:  
/phpdoc/scripts functable.php 
  Log:
  fix broken identifiers (thanks philip)
  
http://cvs.php.net/viewvc.cgi/phpdoc/scripts/functable.php?r1=1.12&r2=1.13&diff_format=u
Index: phpdoc/scripts/functable.php
diff -u phpdoc/scripts/functable.php:1.12 phpdoc/scripts/functable.php:1.13
--- phpdoc/scripts/functable.php:1.12   Tue Feb  6 06:32:56 2007
+++ phpdoc/scripts/functable.phpTue Feb  6 07:11:06 2007
@@ -15,7 +15,7 @@
 +--+
 | Authors:    Sean Coates <[EMAIL PROTECTED]>   |
 +--+
-$Id: functable.php,v 1.12 2007/02/06 06:32:56 sean Exp $
+$Id: functable.php,v 1.13 2007/02/06 07:11:06 sean Exp $
 */
 
 // direct the output of this file into phpdoc/phpbook/phpbook-xsl/version.xml
@@ -87,10 +87,7 @@
 }
 } while (1);
 
-if (!$standalone) {
-$tags = array();
-}
-
+$tags = array();
 foreach ($log as $l) {
 if (substr($l, 0, 1) != "\t") {
 break;
@@ -205,7 +202,7 @@
 foreach ($protos AS $line => $p) {
 preg_match($protoRegex, $p, $m);
 $thisProto = array(
-'file' => substr($f, strlen(SRC_DIR) + 1),
+'file' => substr($f, strlen(PATH_TMP) + 1),
 'type' => $m[1],
 'func' => strtolower($m[2]),
 'params' => $m[3],
@@ -241,7 +238,7 @@
 if (!in_array($matches[2], $protoFuncs)) {
 fwrite(STDERR, "Missing proto: $func\n");
 $funcs[] = array(
-'file' => substr($f, strlen(SRC_DIR) + 1),
+'file' => substr($f, strlen(PATH_TMP) + 1),
 'func' => $func,
 );
 }




Re: [PHP-DOC] cvs: phpdoc /scripts functable.php

2007-02-05 Thread Sean Coates
> Can someone point me at a pecl release that's missing protos--I'll fix
> it (if it's broken, which it probably is).

FWIW, classkit_import() is a good example of this.


(note that multiple PECL packages with the same function are supported)

Think I'll rebuild my whole database tonight (if I ever manage to sleep
(-; )

S


[PHP-DOC] cvs: phpdoc /scripts functable.php

2007-02-05 Thread Sean Coates
seanTue Feb  6 06:32:56 2007 UTC

  Modified files:  
/phpdoc/scripts functable.php 
  Log:
  testing is good, mmkay? (seems to be working now, but please test with fresh 
eyes)
  
http://cvs.php.net/viewvc.cgi/phpdoc/scripts/functable.php?r1=1.11&r2=1.12&diff_format=u
Index: phpdoc/scripts/functable.php
diff -u phpdoc/scripts/functable.php:1.11 phpdoc/scripts/functable.php:1.12
--- phpdoc/scripts/functable.php:1.11   Tue Feb  6 05:36:24 2007
+++ phpdoc/scripts/functable.phpTue Feb  6 06:32:56 2007
@@ -15,7 +15,7 @@
 +--+
 | Authors:    Sean Coates <[EMAIL PROTECTED]>   |
 +--+
-$Id: functable.php,v 1.11 2007/02/06 05:36:24 sean Exp $
+$Id: functable.php,v 1.12 2007/02/06 06:32:56 sean Exp $
 */
 
 // direct the output of this file into phpdoc/phpbook/phpbook-xsl/version.xml
@@ -192,8 +192,8 @@
 ([^*;{]*)   # suffix
 /ix';   // }}} annoying folding
 $ZendFB_regex  = "`^[ \t]*(?:static)?[ 
\t]*(?:zend_)?function_entry\s*(?!php_hw_api_)\w+(? $mv) {
-$block_titles[$mk] = strtok($mv, "\n");
-}
-$tok = strtok($matches[1], "\n");
+$tok = strtok($matches[1][0], "\n");
 while ($tok) {
 if (preg_match($FB_instance_regex, $tok, $matches)) {
+$func = strtolower($matches[2]);
 if (!in_array($matches[2], $protoFuncs)) {
+fwrite(STDERR, "Missing proto: $func\n");
 $funcs[] = array(
 'file' => substr($f, strlen(SRC_DIR) + 1),
-'func' => strtolower($matches[2]),
+'func' => $func,
 );
 }
 }


Re: [PHP-DOC] MySQLi extension

2007-02-05 Thread Sean Coates
>> This was already fixed in the English translation, so it's up 
>> to the Germans to catch up (-:

On that note, Philip just said to me "i wonder if we can create a way to
store "important" items across translations, like for example,
deprecated status (ex. mysqli from that thread)"

After a bit of brainstorming, we came up with the idea of creating
extension-specific status entities that reference an extension's status,
globally (because this sort of thing isn't translation specific).

For example, we'd add new global entities:


etc.

(remember, &warn.experimental; is translated)

That way, this sort of thing would never happen (once the &status.foo;
entities make it into the various reference.xml files.

Thoughts?

S


Re: [PHP-DOC] cvs: phpdoc /scripts functable.php

2007-02-05 Thread Sean Coates
Sean Coates wrote:
> sean  Tue Feb  6 05:36:24 2007 UTC
> 
>   Modified files:  
> /phpdoc/scripts   functable.php 
>   Log:
>   parse source

Um. Sorry.
I may have been a bit premature in committing this.. I don't seem to
have a valid test case.

Can someone point me at a pecl release that's missing protos--I'll fix
it (if it's broken, which it probably is).

S


Re: [PHP-DOC] MySQLi extension

2007-02-05 Thread Sean Coates
Hi,

> http://de3.php.net/manual/de/ref.mysqli.php
> MySQLi isn't experimental to the best of my knowledge. This was probably 
> never removed.

This was already fixed in the English translation, so it's up to the
Germans to catch up (-:

S


[PHP-DOC] cvs: phpdoc /scripts functable.php

2007-02-05 Thread Sean Coates
seanTue Feb  6 05:36:24 2007 UTC

  Modified files:  
/phpdoc/scripts functable.php 
  Log:
  parse source
  
http://cvs.php.net/viewvc.cgi/phpdoc/scripts/functable.php?r1=1.10&r2=1.11&diff_format=u
Index: phpdoc/scripts/functable.php
diff -u phpdoc/scripts/functable.php:1.10 phpdoc/scripts/functable.php:1.11
--- phpdoc/scripts/functable.php:1.10   Sun Feb  4 21:45:01 2007
+++ phpdoc/scripts/functable.phpTue Feb  6 05:36:24 2007
@@ -15,7 +15,7 @@
 +--+
 | Authors:    Sean Coates <[EMAIL PROTECTED]>   |
 +--+
-$Id: functable.php,v 1.10 2007/02/04 21:45:01 sean Exp $
+$Id: functable.php,v 1.11 2007/02/06 05:36:24 sean Exp $
 */
 
 // direct the output of this file into phpdoc/phpbook/phpbook-xsl/version.xml
@@ -184,17 +184,22 @@
 $funcs = array();
 $protoFuncs = array();
 
+$protoRegex = '/
+{{{\s*proto\s+  # proto identifier
+(.*?)\s+# type
+([^(\s]+?)\s?   # functon name
+\((.*)\)\s* # params
+([^*;{]*)   # suffix
+/ix';   // }}} annoying folding
+$ZendFB_regex  = "`^[ \t]*(?:static)?[ 
\t]*(?:zend_)?function_entry\s*(?!php_hw_api_)\w+(? $p) {
@@ -217,7 +222,34 @@
 $protoFuncs[] = $m[2];
 
 }
-   }
+}
+
+// check source
+// this section from phpdoc/scripts/genfunclist.php, see that file for 
(c) info
+// same goes for ZendFB_regex, above
+// macronames and FB_instance_regex
+
+// this could probably be optimized -- please feel free
+
+// function blocks
+$file_contents = file_get_contents($f);
+if (preg_match_all($ZendFB_regex, $file_contents, $matches)) {
+foreach ($matches[0] as $mk => $mv) {
+$block_titles[$mk] = strtok($mv, "\n");
+}
+$tok = strtok($matches[1], "\n");
+while ($tok) {
+if (preg_match($FB_instance_regex, $tok, $matches)) {
+if (!in_array($matches[2], $protoFuncs)) {
+$funcs[] = array(
+'file' => substr($f, strlen(SRC_DIR) + 1),
+'func' => strtolower($matches[2]),
+);
+}
+}
+$tok = strtok("\n");
+}
+}
 }
 return $funcs;
 }


[PHP-DOC] cvs: phpdoc /scripts functable.php

2007-02-04 Thread Sean Coates
seanSun Feb  4 21:45:01 2007 UTC

  Modified files:  
/phpdoc/scripts functable.php 
  Log:
  and reverse the wrong negative
  
http://cvs.php.net/viewvc.cgi/phpdoc/scripts/functable.php?r1=1.9&r2=1.10&diff_format=u
Index: phpdoc/scripts/functable.php
diff -u phpdoc/scripts/functable.php:1.9 phpdoc/scripts/functable.php:1.10
--- phpdoc/scripts/functable.php:1.9Sun Feb  4 21:41:57 2007
+++ phpdoc/scripts/functable.phpSun Feb  4 21:45:01 2007
@@ -15,7 +15,7 @@
 +--+
 | Authors:    Sean Coates <[EMAIL PROTECTED]>   |
 +--+
-$Id: functable.php,v 1.9 2007/02/04 21:41:57 sean Exp $
+$Id: functable.php,v 1.10 2007/02/04 21:45:01 sean Exp $
 */
 
 // direct the output of this file into phpdoc/phpbook/phpbook-xsl/version.xml
@@ -346,7 +346,7 @@
 }
 }
 
-if (getenv('DO_PECL')) {
+if (!getenv('DO_PECL')) {
fwrite(STDERR, "Skipping PECL\n");
 } else {
fwrite(STDERR, "Using PECL\n");


[PHP-DOC] cvs: phpdoc /scripts functable.php

2007-02-04 Thread Sean Coates
seanSun Feb  4 21:41:57 2007 UTC

  Modified files:  
/phpdoc/scripts functable.php 
  Log:
  remove superfluous insensitivity -- (thanks colder)
  
http://cvs.php.net/viewvc.cgi/phpdoc/scripts/functable.php?r1=1.8&r2=1.9&diff_format=u
Index: phpdoc/scripts/functable.php
diff -u phpdoc/scripts/functable.php:1.8 phpdoc/scripts/functable.php:1.9
--- phpdoc/scripts/functable.php:1.8Sun Feb  4 19:31:45 2007
+++ phpdoc/scripts/functable.phpSun Feb  4 21:41:57 2007
@@ -15,7 +15,7 @@
 +--+
 | Authors:    Sean Coates <[EMAIL PROTECTED]>   |
 +--+
-$Id: functable.php,v 1.8 2007/02/04 19:31:45 sean Exp $
+$Id: functable.php,v 1.9 2007/02/04 21:41:57 sean Exp $
 */
 
 // direct the output of this file into phpdoc/phpbook/phpbook-xsl/version.xml
@@ -122,7 +122,7 @@
 $XE = @new 
SimpleXMLElement("http://pecl.php.net/rest/r/$package/allreleases.xml";, NULL, 
true); //@ sucks, but the XML doesn't like me
 foreach ($XE as $Element) {
 if ($Element->getName() == 'r') {
-if (preg_match('/[0-9]+\.[0-9]+(\.[0-9]+)?$/i', (string) 
$Element->v)) {
+if (preg_match('/[0-9]+\.[0-9]+(\.[0-9]+)?$/', (string) 
$Element->v)) {
 $releases[] = (string) $Element->v;
 }
 }


[PHP-DOC] cvs: phpdoc /scripts functable.php

2007-02-04 Thread Sean Coates
seanSun Feb  4 19:31:45 2007 UTC

  Modified files:  
/phpdoc/scripts functable.php 
  Log:
  first stab at PECL support
  http://cvs.php.net/viewvc.cgi/phpdoc/scripts/functable.php?r1=1.7&r2=1.8&diff_format=u
Index: phpdoc/scripts/functable.php
diff -u phpdoc/scripts/functable.php:1.7 phpdoc/scripts/functable.php:1.8
--- phpdoc/scripts/functable.php:1.7Sat Feb  3 14:22:25 2007
+++ phpdoc/scripts/functable.phpSun Feb  4 19:31:45 2007
@@ -15,7 +15,7 @@
 +--+
 | Authors:    Sean Coates <[EMAIL PROTECTED]>   |
 +--+
-$Id: functable.php,v 1.7 2007/02/03 14:22:25 sean Exp $
+$Id: functable.php,v 1.8 2007/02/04 19:31:45 sean Exp $
 */
 
 // direct the output of this file into phpdoc/phpbook/phpbook-xsl/version.xml
@@ -23,12 +23,16 @@
 
 // To do:
 //  - TEST, please
-//  - PECL support
+//  - someone should really make this code parse the source and not just look
+//at the protos
 
 // You'll need to set up an SQLite DB (see PATH_DB, below) with the following:
 // CREATE TABLE func_tag (func_name VARCHAR(50), tag_name VARCHAR(50),
 //   has_proto INT, is_alias INT, unicode_safe INT, source VARCHAR(255));
 
+// set $_ENV['DO_CVS'] to use php-src
+// set $_ENV['DO_PECL'] to use PECL
+
 // set up config:
 
 // set $_ENV['PATH_TMP'] to change the temporary directory
@@ -47,6 +51,9 @@
 
 function rm_recursive($path)
 {
+if (!is_dir($path)) {
+return;
+}
 $dir = new DirectoryIterator($path);
 while($dir->valid()) {
 if(!$dir->isDot()) {
@@ -61,7 +68,7 @@
 rmdir($path);
 }
 
-function get_release_tags()
+function get_php_release_tags()
 {
 rm_recursive(PATH_TMP);
 mkdir(PATH_TMP);
@@ -96,6 +103,51 @@
 return array_reverse($tags);
 }
 
+function get_pecl_packages()
+{
+$packages = array();
+$XE = @new SimpleXMLElement('http://pecl.php.net/rest/p/packages.xml', 
NULL, true); //@ sucks, but the XML doesn't like me
+foreach ($XE as $Element) {
+if ($Element->getName() == 'p') {
+$packages[] = strtolower((string) $Element);
+}
+}
+return $packages;
+}
+
+function get_pecl_releases($package)
+{
+$releases = array();
+try {
+$XE = @new 
SimpleXMLElement("http://pecl.php.net/rest/r/$package/allreleases.xml";, NULL, 
true); //@ sucks, but the XML doesn't like me
+foreach ($XE as $Element) {
+if ($Element->getName() == 'r') {
+if (preg_match('/[0-9]+\.[0-9]+(\.[0-9]+)?$/i', (string) 
$Element->v)) {
+$releases[] = (string) $Element->v;
+}
+}
+}
+sort($releases);
+return $releases;
+} catch (Exception $e) {
+fwrite(STDERR, " WARN: NO RELEASES\n");
+return false;
+}
+}
+
+function grab_pecl_release($package, $release)
+{
+rm_recursive(PATH_TMP);
+mkdir(PATH_TMP);
+chdir(PATH_TMP);
+
+$remoteTarball = 'http://pecl.php.net/get/'. urlencode($package) . '-' . 
urlencode($release);
+file_put_contents(PATH_TMP . '/pecl_tarball.tgz', 
file_get_contents($remoteTarball));
+
+// should probably do this as natively as possible.. @@@fixme
+exec('/bin/tar zxf pecl_tarball.tgz');
+}
+
 function checkout_tag($tag)
 {
 rm_recursive(PATH_TMP);
@@ -170,34 +222,34 @@
 return $funcs;
 }
 
-function convert_array_to_words($func)
+function convert_array_to_words($func, $tags4, $tags5, $tagsPECL)
 {
-// globals suck )-:
-global $tags4, $tags5;
+// this functions should be refactored
 
-static $regex = '/PHP_([45])_([0-9])_([0-9])/';
+static $phpRegex = '/PHP_([45])_([0-9])_([0-9])/';
 static $rep = '$1.$2.$3';
 
+// function exists in PHP 4?
 $text4 = '';
 $ft4 = array();
 foreach ($tags4 as $t) {
 if (isset($func[$t])) {
 $ft4[] = $t;
 }
-}
-
+}
 if (!$ft4) {
 $text4 = '';
 } elseif ($ft4 == $tags4) {
 $text4 = "PHP 4";
 } else {
 if ($ft4[0] == $tags4[0]) {
-$text4 = "PHP 4 <= " . preg_replace($regex, $rep, $ft4[count($ft4) 
- 1]);
+$text4 = "PHP 4 <= " . preg_replace($phpRegex, $rep, 
$ft4[count($ft4) - 1]);
 } else {
-$text4 = "PHP 4 >= " . preg_replace($regex, $rep, $ft4[0]);
+$text4 = "PHP 4 >= " . preg_replace($phpRegex, $rep, $ft4[0]);
 }
 }
 
+// function exists in PHP 5?
 $text5 = '';
 $ft5 = array();
 foreach ($tags5 as $t) {
@@ -205,6

[PHP-DOC] cvs: phpdoc /scripts functable.php

2007-02-03 Thread Sean Coates
seanSat Feb  3 14:22:25 2007 UTC

  Modified files:  
/phpdoc/scripts functable.php 
  Log:
  typo, separate functions and code, remove stray tag2ver()
  
http://cvs.php.net/viewvc.cgi/phpdoc/scripts/functable.php?r1=1.6&r2=1.7&diff_format=u
Index: phpdoc/scripts/functable.php
diff -u phpdoc/scripts/functable.php:1.6 phpdoc/scripts/functable.php:1.7
--- phpdoc/scripts/functable.php:1.6Sat Feb  3 12:07:21 2007
+++ phpdoc/scripts/functable.phpSat Feb  3 14:22:25 2007
@@ -15,10 +15,10 @@
 +--+
 | Authors:    Sean Coates <[EMAIL PROTECTED]>   |
 +--+
-$Id: functable.php,v 1.6 2007/02/03 12:07:21 bjori Exp $
+$Id: functable.php,v 1.7 2007/02/03 14:22:25 sean Exp $
 */
 
-// direct the output of this fiel into phpdoc/phpbook/phpbook-xsl/version.xml
+// direct the output of this file into phpdoc/phpbook/phpbook-xsl/version.xml
 // errors go to STDERR
 
 // To do:
@@ -170,13 +170,6 @@
 return $funcs;
 }
 
-function tag2ver($tag, $vertical)
-{
-if ($vertical) {
-return chunk_split(str_replace('_', ' ', $tag), 1, "\n");
-}
-}
-
 function convert_array_to_words($func)
 {
 // globals suck )-:
@@ -236,6 +229,9 @@
 }
 }
 
+///
+///
+
 if (getenv('SKIP_CVS')) {
fwrite(STDERR, "Skipping CVS\n");
 } else {


[PHP-DOC] cvs: phpdoc /scripts functable.php

2007-02-01 Thread Sean Coates
seanFri Feb  2 00:31:05 2007 UTC

  Modified files:  
/phpdoc/scripts functable.php 
  Log:
  sqlite create statement for db schema
  
http://cvs.php.net/viewvc.cgi/phpdoc/scripts/functable.php?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/scripts/functable.php
diff -u phpdoc/scripts/functable.php:1.4 phpdoc/scripts/functable.php:1.5
--- phpdoc/scripts/functable.php:1.4Wed Jan 31 11:53:38 2007
+++ phpdoc/scripts/functable.phpFri Feb  2 00:31:05 2007
@@ -15,7 +15,7 @@
 +--+
 | Authors:    Sean Coates <[EMAIL PROTECTED]>   |
 +--+
-$Id: functable.php,v 1.4 2007/01/31 11:53:38 nlopess Exp $
+$Id: functable.php,v 1.5 2007/02/02 00:31:05 sean Exp $
 */
 
 // direct the output of this fiel into phpdoc/phpbook/phpbook-xsl/version.xml
@@ -25,6 +25,10 @@
 //  - TEST, please
 //  - PECL support
 
+// You'll need to set up an SQLite DB (see PATH_DB, below) with the following:
+// CREATE TABLE func_tag (func_name VARCHAR(50), tag_name VARCHAR(50),
+//   has_proto INT, is_alias INT, unicode_safe INT, source VARCHAR(255));
+
 // set up config:
 
 // set $_ENV['PATH_TMP'] to change the temporary directory


Re: [PHP-DOC] cvs: phpdoc /scripts functable.php

2007-01-31 Thread Sean Coates
> no, because the files were moved, so when you checkout php-src you won't
> get the files. Only if you are considering adding "advanced pecl
> support" that will parse 'cvs log's of the pecl files and checkout each
> revision, but that seems too hardcore for now :)

That's what the script does for php-src. I don't see it as a problem.

> Anyway, reducing the load on the cvs server is always a good thing (tm)
> (so that developers don't have excuses to work :P)

I'm not the least bit worried about the load on the CVS server, now that
it's on Y1:

96.24% idle: cpu0
95.02% idle: cpu2
93.80% idle: cpu1
90.67% idle: cpu3


Plus, we shouldn't be running this script very regularly (-:

S


Re: [PHP-DOC] cvs: phpdoc /scripts functable.php

2007-01-31 Thread Sean Coates
Nuno Lopes wrote:
> just a side note: we should use museum.php.net instead of cvs to
> download older PHP releases, as cvs got history broken with some pecl
> moves.

What do you mean? Like when the files got physically moved from php-src
to pecl?

If so, once the script supports PECL, those tags should still exist.

S


[PHP-DOC] cvs: phpdoc /scripts functable.php

2007-01-30 Thread Sean Coates
seanWed Jan 31 04:00:25 2007 UTC

  Modified files:  
/phpdoc/scripts functable.php 
  Log:
  trailing PHP close tag.. gone
  
http://cvs.php.net/viewvc.cgi/phpdoc/scripts/functable.php?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/scripts/functable.php
diff -u phpdoc/scripts/functable.php:1.2 phpdoc/scripts/functable.php:1.3
--- phpdoc/scripts/functable.php:1.2Wed Jan 31 03:43:11 2007
+++ phpdoc/scripts/functable.phpWed Jan 31 04:00:25 2007
@@ -15,10 +15,10 @@
 +--+
 | Authors:    Sean Coates <[EMAIL PROTECTED]>   |
 +--+
-$Id: functable.php,v 1.2 2007/01/31 03:43:11 sean Exp $
+$Id: functable.php,v 1.3 2007/01/31 04:00:25 sean Exp $
 */
 
-// direct the output of this file into phpdoc/phpbook/phpbook-xsl/version.xml
+// direct the output of this fiel into phpdoc/phpbook/phpbook-xsl/version.xml
 // errors go to STDERR
 
 // To do:
@@ -345,6 +345,4 @@
echo " \n";
 }
 ?>
-
-
-?>
\ No newline at end of file
+
\ No newline at end of file


[PHP-DOC] cvs: phpdoc /scripts functable.php

2007-01-30 Thread Sean Coates
seanWed Jan 31 03:43:12 2007 UTC

  Modified files:  
/phpdoc/scripts functable.php 
  Log:
  fine->file (freud? (-: ) and add CVS ID tag
  
http://cvs.php.net/viewvc.cgi/phpdoc/scripts/functable.php?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/scripts/functable.php
diff -u phpdoc/scripts/functable.php:1.1 phpdoc/scripts/functable.php:1.2
--- phpdoc/scripts/functable.php:1.1Wed Jan 31 03:00:21 2007
+++ phpdoc/scripts/functable.phpWed Jan 31 03:43:11 2007
@@ -15,9 +15,10 @@
 +--+
 | Authors:Sean Coates <[EMAIL PROTECTED]>   |
 +--+
+$Id: functable.php,v 1.2 2007/01/31 03:43:11 sean Exp $
 */
 
-// direct the output of this fine into phpdoc/phpbook/phpbook-xsl/version.xml
+// direct the output of this file into phpdoc/phpbook/phpbook-xsl/version.xml
 // errors go to STDERR
 
 // To do:


[PHP-DOC] cvs: phpdoc /scripts functable.php

2007-01-30 Thread Sean Coates
seanWed Jan 31 03:00:21 2007 UTC

  Added files: 
/phpdoc/scripts functable.php 
  Log:
  new functable -- all PHP; needs testing
  
http://cvs.php.net/viewvc.cgi/phpdoc/scripts/functable.php?view=markup&rev=1.1
Index: phpdoc/scripts/functable.php
+++ phpdoc/scripts/functable.php
http://www.php.net/license/3_0.txt.  |
| If you did not receive a copy of the PHP license and are unable to   |
| obtain it through the world-wide-web, please send a note to  |
| [EMAIL PROTECTED] so we can mail you a copy immediately.   |
+--+
| Authors:Sean Coates <[EMAIL PROTECTED]>   |
+--+
*/

// direct the output of this fine into phpdoc/phpbook/phpbook-xsl/version.xml
// errors go to STDERR

// To do:
//  - TEST, please
//  - PECL support

// set up config:

// set $_ENV['PATH_TMP'] to change the temporary directory
define('PATH_TMP', getenv('PATH_TMP') ? getenv('PATH_TMP') : '/tmp/functable');
fwrite(STDERR, 'PATH_TMP=' . PATH_TMP ."\n");

// set $_ENV['PATH_DB'] to change the sqlite db file
define('PATH_DB', getenv('PATH_DB') ? getenv('PATH_DB') : dirname(__FILE__) 
.'/functable.sqlite');
fwrite(STDERR, 'PATH_DB=' . PATH_DB ."\n");

// set $_ENV['PATH_CVS'] to change the path to your cvs binary
define('PATH_CVS', getenv('PATH_CVS') ? getenv('PATH_CVS') : '/usr/bin/cvs');
fwrite(STDERR, 'PATH_CVS=' . PATH_CVS ."\n");

// set $_ENV['FUNCTABLE_TAGS'] if you'd like to only grab specific tags

function rm_recursive($path)
{
$dir = new DirectoryIterator($path);
while($dir->valid()) {
if(!$dir->isDot()) {
if ($dir->isDir()) {
rm_recursive($path . DIRECTORY_SEPARATOR . $dir->current());
} else {
unlink($path . DIRECTORY_SEPARATOR . $dir->current());
}
}
$dir->next();
}
rmdir($path);
}

function get_release_tags()
{
rm_recursive(PATH_TMP);
mkdir(PATH_TMP);
chdir(PATH_TMP);

$cmd = PATH_CVS .' -q -d :pserver:[EMAIL PROTECTED]:/repository co 
php-src/ChangeLog';
exec($cmd);
chdir(PATH_TMP . '/php-src');
$cmd = PATH_CVS .' log ChangeLog';

$log = explode("\n", `$cmd`);
do {
$l = array_shift($log);
if ($l == 'symbolic names:') {
break;
}
} while (1);

if (!$standalone) {
$tags = array();
}

foreach ($log as $l) {
if (substr($l, 0, 1) != "\t") {
break;
}
list($tag,) = explode(': ', trim($l));
if (preg_match('/^PHP_[456]_[0-9]+_[0-9+]$/i', $tag)) {
$tags[] = $tag;
}
}
return array_reverse($tags);
}

function checkout_tag($tag)
{
rm_recursive(PATH_TMP);
mkdir(PATH_TMP);
chdir(PATH_TMP);

$cmd = PATH_CVS .' -d :pserver:[EMAIL PROTECTED]:/repository co -r '.
escapeshellarg($tag) . ' php-src';
exec($cmd);
}

function get_src_files($path, $depth=0)
{
if ($depth > 100) {
die("TOO DEEP\n");
}
$files = array();
$dir = scandir($path);
foreach ($dir AS $f) {
if ($f != '.' && $f != '..') {
$p = $path . DIRECTORY_SEPARATOR . $f;
if (is_dir($p)) {
$files = array_merge($files, get_src_files($p, $depth+1));
} elseif (substr($f, -2) == '.c') {
$files[] = $p;
}
}
}
return $files;
}

function parse_protos($path)
{
$funcs = array();
$protoFuncs = array();

$files = get_src_files($path);
foreach ($files AS $f) {

$protoRegex = '/
{{{\s*proto\s+  # proto identifier
(.*?)\s+# type
([^(\s]+?)\s?   # functon name
\((.*)\)\s* # params
([^*;{]*)   # suffix
/ix';

$protos = preg_grep($protoRegex, file($f));
if ($protos) {
foreach ($protos AS $line => $p) {
preg_match($protoRegex, $p, $m);
$thisProto = array(
'file' => substr($f, strlen(SRC_DIR) + 1),
'type' => $m[1],
'func' => $m[2],
'params' => $m[3],
'suffix' => $m[4],
'line' => $lin

[PHP-DOC] doc.php.net

2007-01-07 Thread Sean Coates
Hi Jacques (and others),

An excerpt, for some context:
[20:33]  i request you build the doc howto :)
...
[20:35]  prometheus% ./howto
[20:35]  autoconf: not found
[20:35]  ./howto: ./configure: not found
[20:35]  make: don't know how to make howtophp. Stop
[20:35]  cp: howto/php/*: No such file or directory
[20:35]  make: don't know how to make howtotgz. Stop
[20:35]  cp: howto/howto.html.tar.gz: No such file or directory
[20:35]  that's be why
[20:36]  unfortunate
[20:41]  yeah
[20:41]  I don't have root
[20:42]  do you feel having doc on pb11 would make our lives
easier?
[20:42]  probably. how stable is pb11, now?
[20:43]  bash-2.05b# uptime
[20:43]  8:34PM  up 107 days, 10:06, 1 user, load averages:
0.00, 0.00, 0.00
[20:43]  like a rock! :)
[20:43]  that looks good (-:
[20:44]  what have we tried to do to contact jacques?
[20:50]  i've tried 2-3 times on my own, no responses
[20:50]  it's been 6 or so months however

So...

Jacques: we need to hear from you.
Everyone else: if we don't -- do you want to move doc.php.net to pb11?
Putting the stuff on Jacques' server was only because we didn't have a
spare box back then, IIRC.

Opinions?

S


[PHP-DOC] cvs: phpdoc /en/reference/session ini.xml

2006-12-19 Thread Sean Coates
seanTue Dec 19 22:00:01 2006 UTC

  Modified files:  
/phpdoc/en/reference/sessionini.xml 
  Log:
  document handlers can be found in phpinfo()
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/session/ini.xml?r1=1.44&r2=1.45&diff_format=u
Index: phpdoc/en/reference/session/ini.xml
diff -u phpdoc/en/reference/session/ini.xml:1.44 
phpdoc/en/reference/session/ini.xml:1.45
--- phpdoc/en/reference/session/ini.xml:1.44Fri Dec  8 08:17:14 2006
+++ phpdoc/en/reference/session/ini.xml Tue Dec 19 22:00:01 2006
@@ -1,5 +1,5 @@
 
-
+
 
  &reftitle.runtime;
  &extension.runtime;
@@ -193,7 +193,10 @@
  session.save_handler defines the name of the
  handler which is used for storing and retrieving data
  associated with a session. Defaults to
- files. See also
+ files. Note that individual extensions may register
+ their own save_handlers; registered handlers can be
+ obtained on a per-installation basis by referring to
+ phpinfo. See also
  session_set_save_handler.
 



[PHP-DOC] Re: DocBook skeletons.

2006-11-27 Thread Sean Coates
Hi,

Replying to the list--it's a list question.

> I'm in the process of converting the UODBC extension dox to the new style.
> 
> I have a 2 quick questions on the templates.
> 
> 1 - In http://wiki.phpdoc.info/DocSkel/IniDotXml, should the tgroup
> cols value be 4 and not 3?

Yes, I think so.

> 2 - In http://wiki.phpdoc.info/DocSkel/ConstantsDotXml, it is
> sometimes useful to know the constant value. Is this what the
>  tag is for?

The  block is for a description of the constant. I don't think
that the value should ever be documented--the whole point of the
constant is to create an easy-to-use abstraction.

> As I'm just starting on this, I don't want to make a whole load of
> changes just to find that they are wrong later on.
> 
> Either a reply to this or comments on the appropriate pages would be
> great for me!

Good luck. (-:
If I'm wrong, hopefully someone else will chime in.

S


[PHP-DOC] install.unix --prefix=/www

2006-11-16 Thread Sean Coates
Anyone know why the install.unix page would have you build apache with a
/www prefix?

This seems just wrong to me... either /usr/local/apache2 or /opt/apache2
(omit 2 if 1) seems more appropriate.

S


[PHP-DOC] New Functable Scripts

2006-11-04 Thread Sean Coates
Hi all,

I've mentioned this on IRC, but it's now time to bring it over to the
list (I hope).

I've started rewriting functable; I've got a mostly-working version
written, entirely in PHP, so we can finally kiss that big blob of AWK
goodbye. No offense, but most of us have no idea how to maintain it, and
we've ported most (all?) of our other tools to PHP for this reason.

Take a look:
http://www.phpdoc.info/newfunctable.tgz
http://www.phpdoc.info/newfunctable-nodb.tgz
  the latter is much smaller, but isn't bootstrapped

It only generates the XSL (see gen_xsl.php), and not DSSSL, yet.
It also only knows of php-src, and not of PECL (yet).

So... thoughts? bugs? complaints? sanity check?

S


[PHP-DOC] cvs: phpdoc /en/reference/filesystem/functions file-get-contents.xml file-put-contents.xml file.xml fopen.xml

2006-10-25 Thread Sean Coates
seanThu Oct 26 02:17:15 2006 UTC

  Modified files:  
/phpdoc/en/reference/filesystem/functions   file-get-contents.xml 
file-put-contents.xml 
file.xml fopen.xml 
  Log:
  add links to stream_context_create
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/file-get-contents.xml?r1=1.24&r2=1.25&diff_format=u
Index: phpdoc/en/reference/filesystem/functions/file-get-contents.xml
diff -u phpdoc/en/reference/filesystem/functions/file-get-contents.xml:1.24 
phpdoc/en/reference/filesystem/functions/file-get-contents.xml:1.25
--- phpdoc/en/reference/filesystem/functions/file-get-contents.xml:1.24 Fri Jun 
17 08:33:56 2005
+++ phpdoc/en/reference/filesystem/functions/file-get-contents.xml  Thu Oct 
26 02:17:14 2006
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -90,6 +90,7 @@
   readfile
   file_put_contents
   stream_get_contents
+  stream_context_create
  
 

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/file-put-contents.xml?r1=1.10&r2=1.11&diff_format=u
Index: phpdoc/en/reference/filesystem/functions/file-put-contents.xml
diff -u phpdoc/en/reference/filesystem/functions/file-put-contents.xml:1.10 
phpdoc/en/reference/filesystem/functions/file-put-contents.xml:1.11
--- phpdoc/en/reference/filesystem/functions/file-put-contents.xml:1.10 Sat Aug 
26 11:30:09 2006
+++ phpdoc/en/reference/filesystem/functions/file-put-contents.xml  Thu Oct 
26 02:17:14 2006
@@ -1,5 +1,5 @@
 
-
+
 
  
   file_put_contents 
@@ -126,6 +126,7 @@
 fopen
 fwrite
 file_get_contents
+stream_context_create

   
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/file.xml?r1=1.17&r2=1.18&diff_format=u
Index: phpdoc/en/reference/filesystem/functions/file.xml
diff -u phpdoc/en/reference/filesystem/functions/file.xml:1.17 
phpdoc/en/reference/filesystem/functions/file.xml:1.18
--- phpdoc/en/reference/filesystem/functions/file.xml:1.17  Fri Oct 14 
07:11:15 2005
+++ phpdoc/en/reference/filesystem/functions/file.xml   Thu Oct 26 02:17:14 2006
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -71,7 +71,8 @@
  See also readfile,
  fopen, fsockopen, 
  popen, file_get_contents,
- and include.
+ include, and
+ steream_context_create  
 

   
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/fopen.xml?r1=1.28&r2=1.29&diff_format=u
Index: phpdoc/en/reference/filesystem/functions/fopen.xml
diff -u phpdoc/en/reference/filesystem/functions/fopen.xml:1.28 
phpdoc/en/reference/filesystem/functions/fopen.xml:1.29
--- phpdoc/en/reference/filesystem/functions/fopen.xml:1.28 Thu Oct 26 
02:11:57 2006
+++ phpdoc/en/reference/filesystem/functions/fopen.xml  Thu Oct 26 02:17:14 2006
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -264,8 +264,9 @@
  file,
  file_exists,
  is_readable,
- stream_set_timeout, and
- popen.
+ stream_set_timeout,
+ popen, and
+ stream_context_create.
 

   


[PHP-DOC] cvs: phpdoc /en/reference/filesystem/functions fopen.xml

2006-10-25 Thread Sean Coates
seanThu Oct 26 02:11:58 2006 UTC

  Modified files:  
/phpdoc/en/reference/filesystem/functions   fopen.xml 
  Log:
  zcontext is inconsistent with the rest of the manual
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/fopen.xml?r1=1.27&r2=1.28&diff_format=u
Index: phpdoc/en/reference/filesystem/functions/fopen.xml
diff -u phpdoc/en/reference/filesystem/functions/fopen.xml:1.27 
phpdoc/en/reference/filesystem/functions/fopen.xml:1.28
--- phpdoc/en/reference/filesystem/functions/fopen.xml:1.27 Thu Mar 31 
15:01:43 2005
+++ phpdoc/en/reference/filesystem/functions/fopen.xml  Thu Oct 26 02:11:57 2006
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -13,7 +13,7 @@
   
stringfilename
   stringmode
   booluse_include_path
-  resourcezcontext
+  resourcecontext
  
 
  fopen binds a named resource, specified


[PHP-DOC] cvs: phpdoc /en/reference/pcre/functions preg-replace.xml

2006-09-30 Thread Sean Coates
seanSat Sep 30 18:20:02 2006 UTC

  Modified files:  
/phpdoc/en/reference/pcre/functions preg-replace.xml 
  Log:
  bug #38999; fix language
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pcre/functions/preg-replace.xml?r1=1.17&r2=1.18&diff_format=u
Index: phpdoc/en/reference/pcre/functions/preg-replace.xml
diff -u phpdoc/en/reference/pcre/functions/preg-replace.xml:1.17 
phpdoc/en/reference/pcre/functions/preg-replace.xml:1.18
--- phpdoc/en/reference/pcre/functions/preg-replace.xml:1.17Fri Jun 16 
13:44:09 2006
+++ phpdoc/en/reference/pcre/functions/preg-replace.xml Sat Sep 30 18:20:02 2006
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -79,12 +79,12 @@
   
The string or an array with strings to replace. If this parameter is a
string and the pattern parameter is an array,
-   all pattens will be replaced by that string. If both
+   all patterns will be replaced by that string. If both
pattern and replacement
parameters are arrays, each pattern will be
replaced by the replacement counterpart. If
-   there are less keys in the replacement array
-   than in the pattern array, the excedent
+   there are fewer elements in the replacement
+   array than in the pattern array, any extra
patterns will be replaced by an empty string.
   
  


[PHP-DOC] cvs: phpdoc /en/reference/strings/functions explode.xml

2006-09-19 Thread Sean Coates
seanWed Sep 20 03:37:27 2006 UTC

  Modified files:  
/phpdoc/en/reference/strings/functions  explode.xml 
  Log:
  change separator to delimiter to better match internal error messages
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/strings/functions/explode.xml?r1=1.12&r2=1.13&diff_format=u
Index: phpdoc/en/reference/strings/functions/explode.xml
diff -u phpdoc/en/reference/strings/functions/explode.xml:1.12 
phpdoc/en/reference/strings/functions/explode.xml:1.13
--- phpdoc/en/reference/strings/functions/explode.xml:1.12  Tue Mar 14 
03:32:02 2006
+++ phpdoc/en/reference/strings/functions/explode.xml   Wed Sep 20 03:37:27 2006
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -10,23 +10,23 @@
 Description
  
   arrayexplode
-  
stringseparator
+  
stringdelimiter
   
stringstring
   intlimit
  
 
  Returns an array of strings, each of which is a substring of
  string formed by splitting it on
- boundaries formed by the string separator.
+ boundaries formed by the string delimiter.
  If limit is set, the returned array will
  contain a maximum of limit elements with
  the last element containing the rest of
  string.
 
 
- If separator is an empty string (""),
+ If delimiter is an empty string (""),
  explode will return &false;.  If
- separator contains a value that is not contained
+ delimiter contains a value that is not contained
  in string, then explode will
  return an array containing string.
 
@@ -39,7 +39,7 @@
  Although implode can, for historical reasons,
  accept its parameters in either order,
  explode cannot. You must ensure that the
- separator argument comes before the
+ delimiter argument comes before the
  string argument.
 
 


[PHP-DOC] Re: [PHP-DEV] ibm_db2 documentation update.

2006-09-11 Thread Sean Coates
> There is a missing function from the ibm_db2 driver documentation.  I would
> like to add this to the documentation package.  This is my first try at
> this, I hope this is done correctly.
> If one of you kind folks can take a moment and add this to the
> documentation, it would be greatly appreciated.

Hi Kitman.

First, you should send this to [EMAIL PROTECTED] Next, the MLM
software strips non-text attachments. Can you post the patch on the Web,
somewhere? I'd be happy to take a look/commit.

S


Re: [PHP-DOC] A proposed new/changed role for errors

2006-09-06 Thread Sean Coates
Sean Coates wrote:
>> Extra, Extra, Read all about it... the exceptions role has officially
>> been renamed errors. Let the flood gates open!
> 
> http://www.phpdoc.info/patches/massive-role-exceptions-errors.txt.gz
> 
> Incoming bigass change..
> 
> Please object by tomorrow (-:
> 
> ( If I don't respond right away, it's because I'm setting up a procmail
> filter to fend off death threats from translators. )

FYI, I just committed this.
First, I tagged with PRE_EXCEPTIONS_ROLL_CHANGE, then after commit with
POST_EXCEPTIONS_ROLL_CHANGE, in case I broke something.

I suspect the commit was too big to come through to the mailing list.

S


Re: [PHP-DOC] A proposed new/changed role for errors

2006-09-05 Thread Sean Coates
> Extra, Extra, Read all about it... the exceptions role has officially
> been renamed errors. Let the flood gates open!

http://www.phpdoc.info/patches/massive-role-exceptions-errors.txt.gz

Incoming bigass change..

Please object by tomorrow (-:

( If I don't respond right away, it's because I'm setting up a procmail
filter to fend off death threats from translators. )

S


[PHP-DOC] cvs: phpdoc /en/language operators.xml

2006-09-01 Thread Sean Coates
seanFri Sep  1 15:37:21 2006 UTC

  Modified files:  
/phpdoc/en/language operators.xml 
  Log:
  WS
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/operators.xml?r1=1.103&r2=1.104&diff_format=u
Index: phpdoc/en/language/operators.xml
diff -u phpdoc/en/language/operators.xml:1.103 
phpdoc/en/language/operators.xml:1.104
--- phpdoc/en/language/operators.xml:1.103  Fri Sep  1 15:33:53 2006
+++ phpdoc/en/language/operators.xmlFri Sep  1 15:37:21 2006
@@ -1,5 +1,5 @@
 
-
+
  
   Operators
   
@@ -654,20 +654,20 @@
  
   Assigning a default value
   
- 
+?>
+]]>
   
   
  The expression (expr1) ? (expr2) : (expr3)


[PHP-DOC] cvs: phpdoc /en/language operators.xml

2006-09-01 Thread Sean Coates
seanFri Sep  1 15:33:53 2006 UTC

  Modified files:  
/phpdoc/en/language operators.xml 
  Log:
  note about non-obvious ternary evaluation (and recommend to avoid stacking); 
bug #38679
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/operators.xml?r1=1.102&r2=1.103&diff_format=u
Index: phpdoc/en/language/operators.xml
diff -u phpdoc/en/language/operators.xml:1.102 
phpdoc/en/language/operators.xml:1.103
--- phpdoc/en/language/operators.xml:1.102  Tue May  9 18:18:34 2006
+++ phpdoc/en/language/operators.xmlFri Sep  1 15:33:53 2006
@@ -1,5 +1,5 @@
 
-
+
  
   Operators
   
@@ -686,6 +686,34 @@
   issued in later PHP versions.
  
 
+
+ 
+  Is is recomended that you avoid "stacking" ternary expressions. PHP's
+  behaviour when using more than one ternary operator within a single
+  statement is non-obvious:
+  
+   Non-obvious Ternary Behaviour
+   
+
+   
+  
+ 
+

 
   


Re: [PHP-DOC] A proposed new/changed role for errors

2006-08-31 Thread Sean Coates
> This is a proposal to rename 'exceptions' to 'errors' so it may cover,
> for example, when functions emit E_* level errors.  Currently this
> information is either in the description,  returnvalues, or notes roles
> but none of those are fully appropriate.  Exception information would be
> put into the errors role.  We could have both (errors and exceptions
> roles) but that doesn't seem needed.  Thoughts?

+1

[EMAIL PROTECTED]:~/php/cvs/phpdoc$ egrep "role=.exception" -r * | wc -l
637

That's quite a few changes, but they should be simple with some perl pie.

S


Re: [PHP-DOC] Doc for PECL geoip module

2006-08-22 Thread Sean Coates
Olivier Hill wrote:
> On 8/22/06, Sean Coates <[EMAIL PROTECTED]> wrote:
>> Can you post it somewhere?
> 
> XML DocBook Sources: http://www.olivierhill.ca/geoip-xml.tar.gz

I'm not concerned about grammar/spelling/etc. That stuff is easy to fix
later.

Looks good to me:
http://livedocs.phpdoc.info/geoip

S


Re: [PHP-DOC] Doc for PECL geoip module

2006-08-22 Thread Sean Coates
> IMHO you should keep it within the extension itself, phpdocs
> configure script has a --with-pecl-source=... option that will
> pick it up from PECL ...

PECL documentation has been stored in the phpdoc repository for a long
time now.

There are a few problems with putting the documentation in PECL:
 - it won't get built with the manual (unless I'm mistaken... Derick?)
 - normal documenter-types don't have karma for most of pecl (the doc
team won't be able to fix bugs, etc)
 - there's no translation infrastructure
 - no tool infrastructure (http://doc.php.net/)

Opinions?

S


Re: [PHP-DOC] Doc for PECL geoip module

2006-08-22 Thread Sean Coates
> I will soon make a release for the PECL geoip module. As such, I have
> written documentation about the different functions and provided some
> code examples.
> 
> Should I commit this to phpdoc? Everything is inside references/geoip.
> I have done a make test as well as test_xml, everything seems fine.

Can you post it somewhere?
If it passes make test(_xml), it's probably fine, but some things are
much easier to catch before the translators (read: the French
translators) jump on your commit.

S


[PHP-DOC] cvs: phpdoc /en/appendices userlandnaming.xml

2006-08-12 Thread Sean Coates
seanSat Aug 12 20:14:32 2006 UTC

  Modified files:  
/phpdoc/en/appendices   userlandnaming.xml 
  Log:
  grammar and markup
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/appendices/userlandnaming.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/appendices/userlandnaming.xml
diff -u phpdoc/en/appendices/userlandnaming.xml:1.1 
phpdoc/en/appendices/userlandnaming.xml:1.2
--- phpdoc/en/appendices/userlandnaming.xml:1.1 Thu Jul 27 20:59:29 2006
+++ phpdoc/en/appendices/userlandnaming.xml Sat Aug 12 20:14:32 2006
@@ -1,12 +1,13 @@
 
-
+
 
  Userland Naming Guide
  
   The following is a guide for how to best choose names for identifiers
-  in PHP userland code. When choosing names for any code that creates symbols
-  in the global namespace it is important to take into account the following
-  guide lines to prevent future version of PHP to clash with userland code.
+  in userland PHP code. When choosing names for any code that creates symbols
+  in the global namespace, it is important to take into account the following
+  guidelines to prevent future versions of PHP from clashing with your
+  symbols.
  
 
  
@@ -29,9 +30,9 @@
  
   Rules
   
-   The following list gives an overview of what rights the PHP project
-   reserves itself when choosing names for new internal identifiers. Note
-   that the definitive guide is the official
+   The following list gives an overview of which rights the PHP project
+   reserves for itself, when choosing names for new internal identifiers.
+   The definitive guide is the official
CODING STANDARDS:
   
 
@@ -52,8 +53,8 @@

 
  PHP will prefix any global symbols of an extension with the name of
- the extension (note that in the past there have been numerous
- exceptions to this rule). Examples:
+ the extension. (In the past, there have been numerous
+ exceptions to this rule.) Examples:
 
 
 
@@ -71,19 +72,21 @@


 
- Iterators and Exceptions are however simply postfixed with "Iterator"
- and "Exception". Examples:
+ Iterators and Exceptions are however simply postfixed with
+ "Iterator" and "Exception."
+ Examples:
 
 
- ArrayIterator
- LogicException
+ ArrayIterator
+ LogicException
 


 
- PHP reserves all function names starting with __ as magical. It is
- recommended that you do not use function names with __ in PHP unless
- you want some documented magic functionality. Examples:
+ PHP reserves all symbols starting with __
+ as magical. It is recommended that you do not create symbols starting
+ with __ in PHP unless
+ you want to use documented magical functionality. Examples:
 
 
  __get
@@ -96,12 +99,12 @@
  
   Tips
   
-   In order to write future proof code it is therefore recommended to prefix
-   (or postfix) anything that goes into the global namespace with a fairly
-   random 3-4 letter prefix (or postfix) separated with an underscore. It is
+   In order to write future-proof code, it is recommended that you prefix
+   (or suffix) anything that goes into the global namespace with an uncommon
+   3-4 letter prefix (or suffix) separated with an underscore. It is
recommended that in order to prevent namespace clashes with other userland
-   code that projects research existing prefixes (or postfixes) used in other
-   projects and advertise their chosen prefix (or postfix) appropriately.
+   code that projects research existing prefixes (or suffixes) used in other
+   projects and advertise their chosen prefix (or suffix) appropriately.
Examples:
   
 


Re: [PHP-DOC] #38337 [Opn->Bgs]: explode function's return value is incorrect

2006-08-04 Thread Sean Coates
> Many functions return FALSE if something goes wrong/data has been
> exhausted/the function does not find what the developer was looking
> for.
> 
> In fact, we'd have to mark a great number of functions in the manual
> "mixed" if we followed the convention you propose. Instead, we mark
> return values as the most common case(s), and avoid error situations.
> 
> See strpos(), each(), mysql_fetch_assoc(), etc.

Is this actually in the manual, anywhere?
I don't see it... but I know we follow this convention.

If so, please tell me where (-:
If not, I propose we add something like the above to language.pseudo-types

S


[PHP-DOC] cvs: phpdoc / manual.xml.in /en/appendices userlandnaming.xml /entities global.ent

2006-07-27 Thread Sean Coates
seanThu Jul 27 20:59:29 2006 UTC

  Added files: 
/phpdoc/en/appendices   userlandnaming.xml 

  Modified files:  
/phpdoc manual.xml.in 
/phpdoc/entitiesglobal.ent 
  Log:
  Userland Naming guide -- from Lukas Smith
  
http://cvs.php.net/viewvc.cgi/phpdoc/manual.xml.in?r1=1.213&r2=1.214&diff_format=u
Index: phpdoc/manual.xml.in
diff -u phpdoc/manual.xml.in:1.213 phpdoc/manual.xml.in:1.214
--- phpdoc/manual.xml.in:1.213  Sun Jan 15 00:47:45 2006
+++ phpdoc/manual.xml.inThu Jul 27 20:59:29 2006
@@ -2,7 +2,7 @@
 
+
 
 
 
@@ -172,6 +172,7 @@
   &appendices.transports;
   &appendices.comparisons;
   &appendices.tokens;
+  &appendices.userlandnaming;
   &appendices.about;
   &appendices.license;
   &global.function-index;
http://cvs.php.net/viewvc.cgi/phpdoc/entities/global.ent?r1=1.267&r2=1.268&diff_format=u
Index: phpdoc/entities/global.ent
diff -u phpdoc/entities/global.ent:1.267 phpdoc/entities/global.ent:1.268
--- phpdoc/entities/global.ent:1.267Wed Jul 26 12:01:04 2006
+++ phpdoc/entities/global.ent  Thu Jul 27 20:59:29 2006
@@ -1,6 +1,6 @@
 

 Userland Naming Guide
 
  The following is a guide for how to best choose names for identifiers
  in PHP userland code. When choosing names for any code that creates symbols
  in the global namespace it is important to take into account the following
  guide lines to prevent future version of PHP to clash with userland code.
 

 
  Global Namespace
  
   Here is an overview of code constructs that go into the global namespace:
  

  
   functions
   classes
   interfaces
   constants (not class constants)
   
variables defined outside of functions/methods
   
  
 

 
  Rules
  
   The following list gives an overview of what rights the PHP project
   reserves itself when choosing names for new internal identifiers. Note
   that the definitive guide is the official
   CODING STANDARDS:
  

  
   

 PHP owns the top-level namespace but tries to find decent descriptive
 names and avoid any obvious clashes.

   
   

 Function names use underscores between words, while class names use
 the lower bumpy camel rule (there are some exceptions for older
 classes and functions).

   
   

 PHP will prefix any global symbols of an extension with the name of
 the extension (note that in the past there have been numerous
 exceptions to this rule). Examples:



 curl_close
 mysql_query
 PREG_SPLIT_DELIM_CAPTURE
 new DOMDocument()
 
  
   strpos (example of a past mistake)
  
 
 new SplFileObject()

   
   

 Iterators and Exceptions are however simply postfixed with "Iterator"
 and "Exception". Examples:


 ArrayIterator
 LogicException

   
   

 PHP reserves all function names starting with __ as magical. It is
 recommended that you do not use function names with __ in PHP unless
 you want some documented magic functionality. Examples:


 __get
 __autoload

   
  
 

 
  Tips
  
   In order to write future proof code it is therefore recommended to prefix
   (or postfix) anything that goes into the global namespace with a fairly
   random 3-4 letter prefix (or postfix) separated with an underscore. It is
   recommended that in order to prevent namespace clashes with other userland
   code that projects research existing prefixes (or postfixes) used in other
   projects and advertise their chosen prefix (or postfix) appropriately.
   Examples:
  

  
   MyPx_someFunc()
   Foo_Date
   $asdf_dbh
  
 





Re: [PHP-DOC] cvs: phpdoc /entities global.ent

2006-07-26 Thread Sean Coates
anatoly techtonik wrote:
> ||*()*|| Hi, Nuno.
> 
> I wonder if there is any link checker which runs once a month through
> documentation to catch all missing and/or outdated links?
> It can also save link contents with status 200, 302, "checked manually
> - ok" to detect when the pages are no longer contain desired content.

http://doc.php.net/php/checkent.php

S


[PHP-DOC] phpdoc: kr, ja

2006-07-24 Thread Sean Coates
FYI, I just did:
bash-2.05b# rm -r /local/repository/phpdoc/ja /local/repository/phpdoc/kr

on y1, at Nuno/Philip's request -- these old directories were
conflicting with the phpdoc-ja, phpdoc-kr modules.

S


Re: [PHP-DOC] http docs

2006-07-24 Thread Sean Coates
Michael Wallner wrote:
> Richard A. Quadling wrote:
>> The XML files are not well formed.
>>
>> You've got a leading space in front of the lines.
>>
>> Attempting to make the manual ...
>>
>> /cygdrive/D/cygwin/home/RichardQ/phpdoc/en/reference/http/HttpQueryStrin
>> g.xml:1: parser error : XML declaration allowed only at the start of the
>> document
>>  
> 
> Fixed, thanks.
> 

You can prevent this by running make test in the doc root -- don't
worry, it doesn't take nearly as long as make.

S


Re: [PHP-DOC] Starting on Unicode docs

2006-07-19 Thread Sean Coates
> Since all appropriate functions will be unicode compatible in PHP 6.0.0
> this seems like information overload and not something that should be
> mentioned in every functions documentation. Perhaps have a list offsite,
> maybe on docweb, for alpha/beta testers.

Good point. I agree.
This list already exists:
http://www.php.net/~scoates/unicode/

S


Re: [PHP-DOC] Starting on Unicode docs

2006-07-19 Thread Sean Coates
Welcome,

> I just wanted to shoot a quick email to the list to see when we could
> start work on docs for Unicode upgrades (PHP 6). The main thing, IMO, is
> having a way to mark functions as Unicode compatible and also have a
> section (per-function) for any Unicode-related notes. Any other thoughts
> on this?

A few things..

First, phpdoc contribution seems to be at a low. There's not much going
on right now, and seemingly not many people willing to pitch in (myself
included -- I've been lax lately).

That said, technically, we could probably pretty easily add a proto "U"
parser and add a &unicode.safe; entity to most applicable
functions/sections.

Adding unicode notes could be done on a function-by-function basis; no
need for a dedicated section, as this hopefully won't affect most
functions. If the same issues affect a large subset of functions, we can
come up with entities for this, too.

Another thing that you and I have discussed, but I've never passed on to
the list is the new proto markup for traditional strings vs. unicode
strings vs. binary strings. Anyone got thoughts on this?

S


Re: [PHP-DOC] Contractions in the English PHP Documentation and supporting scripts/files.

2006-07-05 Thread Sean Coates
Ford, Mike wrote:
> On 05 July 2006 12:48, Nuno Lopes wrote:
> 
>> No way
>>
>> We cannot start breaking translators' work. Anyway, what's
>> the problem with
>> contractions? When I studied English (British) I learned that
>> contractions weren't so formal, but they aren't wrong per se.
>>
>> Any English native speaker correct me if I'm wrong.
> 
> As a former long-time technical editor, I'd say you're not wrong but it very 
> much depends on context and meaning.  In this case, I'd agree with the change 
> as it shifts the emphasis of the sentence on to the very important "not", 
> thus making it harder to misread the sentence.  It's also a fairly formal 
> definition of the return value, so a contraction is (slightly) less good on 
> that score too.

As a current technical/copy editor, I also agree that contractions
aren't (are not!) bad.

In fact, I think that they add to the manual by making it more readable
and they improve flow. The magazine is less formal than the manual, but
they're similar in many ways, and I'm for contractions.

S


Re: [PHP-DOC] cvs: phpdoc /en/reference/simplexml/functions simplexml-element-getDocNamespaces.xml simplexml-element-getNamespaces.xml simplexml-element-registerXPathNamespace.xml simplexml-load-file.

2006-06-26 Thread Sean Coates
> So it's not clear to me that Ben is in the wrong here.

In any case, I un-volunteer to mess with >300 files on the CVS server.

S


Re: [PHP-DOC] cvs: phpdoc /en/reference/simplexml/functions simplexml-element-getDocNamespaces.xmlsimplexml-element-getNamespaces.xml simplexml-element-registerXPathNamespace.xmlsimplexml-load-file.xm

2006-06-26 Thread Sean Coates
>> I can just cvs remove the existing files and re-add them with their
>> lowercase names, but this will lose the history information attached to
>> the files? Is there another way you recommend I handle this?
> 
> This will upset translators. (-:
> 
> I can move the files in CVS.
> 
> Translators: will that work for you?

I was about to make this change, but stopped.
I came to the conclusion that the proverbial uppercasefilename cat is is
out of the bag.

[EMAIL PROTECTED]:~/php/cvs/phpdoc/en$ find . | egrep "[A-Z]" | grep -v
CVS | wc -l
572

Meaning? There are ~572 files that need to be renamed -- and that's only
in the en/ tree. No thanks.
Let's not pick on Ben and SimpleXML (-:

S


Re: [PHP-DOC] cvs: phpdoc /en/reference/simplexml/functions simplexml-element-getDocNamespaces.xmlsimplexml-element-getNamespaces.xml simplexml-element-registerXPathNamespace.xmlsimplexml-load-file.xm

2006-06-22 Thread Sean Coates
> By the way, how do you recommend I go about this?
> 
> I can just cvs remove the existing files and re-add them with their
> lowercase names, but this will lose the history information attached to
> the files? Is there another way you recommend I handle this?

This will upset translators. (-:

I can move the files in CVS.

Translators: will that work for you?

Systems: is this OKK? (renaming files from (e.g.)
simplexml-element-asXML.xml to simplexml-element-asxml.xml)

S


Re: [PHP-DOC] cvs: phpdoc /en/language constants.xml

2006-06-11 Thread Sean Coates
> +it can never be changed or undefined. Unlike functions, constants need to
> +be defined before they are referenced.

This isn't _necessarily_ true.
Example:
[EMAIL PROTECTED]:~$ php5 -r ' if (0) { function foo() { echo "foo"; } }
foo();'

Fatal error: Call to undefined function foo() in Command line code on line 1

I think this note should be moved to the define() page, and it should
say something like:
"define() defines a constant at runtime. If a script's execution never
reaches the call to define(), the constant will not be defined."

S


Re: [PHP-DOC] Proposal

2006-05-19 Thread Sean Coates
Oliver Block wrote:
> I don't know, if you discussed on that lately/in the past but wouldn't it be 
> a 
> good idea, if pages that give an overview over the functions of an extension 
> would be sorted differently?

I like the output, but this listing is currently generated by scripts,
so in order to implement, the doc build process would need to be changed
(pretty heavily, I think).

S


Re: [PHP-DOC] cvs: phpdoc /en/reference/simplexml/functions simplexml-element-addAttribute.xml simplexml-element-addChild.xml simplexml-element-getDocNamespaces.xml simplexml-element-getName.xml simpl

2006-05-12 Thread Sean Coates
Ben Ramsey wrote:
> I added the notes so that people reading the docs wouldn't get confused
> and assume that, since they are running PHP 5, they can use these new
> functions.

This is a logistical problem with docbook and OOP.
There's no actual simplexml_element_addAttribute() function, for example.

I guess functable should be fixed to accommodate, if possible, but that
big blob of AWK scares me (I won't touch it).

Hartmut? Rasmus?

S


Re: [PHP-DOC] cvs: phpdoc /en/language types.xml

2006-05-03 Thread Sean Coates
Philip Olson wrote:
> philipThu May  4 02:21:29 2006 UTC
> 
>   Modified files:  
> /phpdoc/en/language   types.xml 
>   Log:
>   $str{42} isn't deprecated (yet?), but $str[42] is preferred. We'll mention 
> that.

Deprecated != doesn't work (see dl())

I think the other text was better, as the official core-devs party line
is "{ } is gone"

S


Re: [PHP-DOC] Re: [PHP-DEV] Summer of Code

2006-05-03 Thread Sean Coates
> Thats why I've applied as mentor. I would like to mentor something about
> livedocs or the gcov.php.net site. (you can still apply as well)

FWIW, I'm also a mentor, and I'm available to help if anyone wants to
take/develop the livedocs project.

S


Re: [PHP-DOC] &listendand;

2006-04-09 Thread Sean Coates
> The policy was to convert the pages to the "new" doc style, that doesn't
> use &listendand; at all.

Makes sense. That's why I asked. Thanks.

S


[PHP-DOC] &listendand;

2006-04-07 Thread Sean Coates
Hello.

Do we have a current policy on using &listendand; in See Also blocks?

S


Re: [PHP-DOC] Distribuite PHP Documentation

2006-04-03 Thread Sean Coates
Francesco Caccavella wrote:
> Hello, I'M Francesco Caccavella, content strategist for HTML.it, an
> italian site with a lot of documentation about web design.
> 
> I would like to offer to my visitor the downloadable english and italian
> version of the PHP Documentation, without modification or other changes.
> 
> I can?

Why not just link to ours?

http://www.php.net/docs.php
http://www.php.net/download-docs.php

S


Re: [PHP-DOC] #35356 [Opn]: docs for preg_replace_callback do not document the limit and count parameters

2006-04-03 Thread Sean Coates
>  ID:   35356
> It's not only limit and count, also array() syntax of $pattern and
> $subject should be mentioned.
> 
> "See preg_replace() for description of other parameters."

Why not actually copy the descriptions to the preg_replace_callback page?

S


Re: [PHP-DOC] Re: [PHP-NOTES] note 63699 added to language.oop5.autoload

2006-03-28 Thread Sean Coates
> How would you do that scan? Currently the entry/user-note.php script
> checks with a dns black-list that also includes zombie machines, but
> most seem that aren't detected.

Erm. I wrote up a quick script to check this, but failed to come up with
any hits, so I guess my theory is unsubstantiated..

(http://www.phpdoc.info/proxy_scan.phps if anyone's interested)

Carry on (-:

S


[PHP-DOC] Re: [PHP-NOTES] note 63699 added to language.oop5.autoload

2006-03-28 Thread Sean Coates
> The X-Spam-Status isn't always the same :) its almost the same.. I have
> already seen one different :) The spamassassin needs training to be
> useful to us.

Well, that may gain some accuracy, but I stand by my idea that
spamassassin will not work properly for notes because SA is designed to
handle mail (this is obvious when notes fail a test like
"DATE_MISSING,FROM_NO_LOWER"

> The IPs are correct. the server IP should belong to a PHP.net mirror and
> the probable submiter is the IP that sent the note to the php.net mirror
> (unless someone is posting notes directly without using the mirrors).

Ok.
The reason I asked is because a large number of notes seem to be coming
from RIPE-owned IPs.

I just submitted one, and my ISP showed up.
...

Anyway, what I'm getting at is:
 - notes are broken (we already agree on this)
 - spammers submit notes from open proxies and zombie machines

Perhaps we could scan submitting IP addresses for open proxies before
accepting a note?

The user would have to consent to this scan.

Thoughts?

S


[PHP-DOC] [Fwd: Re: [PHP-NOTES] note 63699 added to language.oop5.autoload]

2006-03-28 Thread Sean Coates
Oops. Accidentally sent this to php-doc-chm

S
--- Begin Message ---
> 
> Server IP: 194.109.193.119
> Probable Submitter: 80.56.58.248
> 
> X-Spam-Status: No, hits=3.1 required=5.0 tests=DATE_MISSING,FROM_NO_LOWER 
>   autolearn=no version=2.64
> 


What is the status of these messages?
Are the IPs actually correct?
I guess the X-Spam-Status is bogus (always the same).

S

-- 
PHP Notes Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php


--- End Message ---


[PHP-DOC] cvs: phpdoc /en/reference/apc/functions apc-cache-info.xml apc-clear-cache.xml

2006-03-26 Thread Sean Coates
seanSun Mar 26 22:05:05 2006 UTC

  Modified files:  
/phpdoc/en/reference/apc/functions  apc-cache-info.xml 
apc-clear-cache.xml 
  Log:
  describe clear_cache (param)
  
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/apc/functions/apc-cache-info.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/apc/functions/apc-cache-info.xml
diff -u phpdoc/en/reference/apc/functions/apc-cache-info.xml:1.2 
phpdoc/en/reference/apc/functions/apc-cache-info.xml:1.3
--- phpdoc/en/reference/apc/functions/apc-cache-info.xml:1.2Fri Aug 19 
15:11:25 2005
+++ phpdoc/en/reference/apc/functions/apc-cache-info.xmlSun Mar 26 
22:05:05 2006
@@ -1,5 +1,5 @@
 
-
+
 
  
   apc_cache_info
@@ -28,6 +28,24 @@
   
  
 
+ 
+  &reftitle.parameters;
+  
+   
+
+ cache_type
+ 
+  
+   If cache_type is "user", the
+   user cache will be cleared; otherwise, the system cache (cached files)
+   will be cleared.
+  
+ 
+
+   
+  
+ 
+
  
   &reftitle.examples;
   
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/apc/functions/apc-clear-cache.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/apc/functions/apc-clear-cache.xml
diff -u phpdoc/en/reference/apc/functions/apc-clear-cache.xml:1.2 
phpdoc/en/reference/apc/functions/apc-clear-cache.xml:1.3
--- phpdoc/en/reference/apc/functions/apc-clear-cache.xml:1.2   Fri Aug 19 
15:11:25 2005
+++ phpdoc/en/reference/apc/functions/apc-clear-cache.xml   Sun Mar 26 
22:05:05 2006
@@ -1,5 +1,5 @@
 
-
+
 
  
   apc_clear_cache
@@ -14,6 +14,32 @@
stringcache_type
   
  
+
+ 
+  &reftitle.returnvalues;
+  
+   &return.success;
+  
+ 
+
+ 
+  &reftitle.parameters;
+  
+   
+
+ cache_type
+ 
+  
+   If cache_type is "user", the
+   user cache will be cleared; otherwise, the system cache (cached files)
+   will be cleared.
+  
+ 
+
+   
+  
+ 
+
 
 
 

Re: [PHP-DOC] Re: [PHP-NOTES] Note spam

2006-03-23 Thread Sean Coates
> Do we need to approve? I guess we have not enough "man-power" for that.
> Simply post the note after we receive the token.

That's what I meant. Note is approved when the token URL is clicked.

>> Max 5 notes per address per day. Or x notes per domain/IP per day..
> 
> x notes per domain/IP per day will for sure not work. Think of people
> behind proxies
> 
> We should not limit the notes per day. To much to track, imho, no?

I suspect that these spammers would just register example.com and create
[EMAIL PROTECTED] [EMAIL PROTECTED] etc.

>> Yes, the evil side COULD be automated, but it's a lot more difficult
>> than a simple post.
> 
> I like this proposal, but Nuno's point stands: who's gonna implement that?

Not sure. (-:
I'd love to find time to do it, but I don't have it right now.

Either way, notes are a mess.

S


[PHP-DOC] Re: [PHP-NOTES] Note spam

2006-03-23 Thread Sean Coates
[resend: not sure why this didn't make it through, yesterday;
re-sending; sorry if it's a dupe -S]

Nuno Lopes wrote:
> Well we have already tried a couple of methods but none of them worked
> so far, including DNS blacklists, spamassassin and a simple words
> blacklisting.
> I've run out of ideas. Training spamassassin would probably work, but
> I'm not sure if it wouldn't cause disturbs in the mail server.

Did we drop the double opt-in idea?

- User submits a note (with valid email address)
- We send mail with a token URL
- User clicks URL
- Note is approved and posted

Max 5 notes per address per day. Or x notes per domain/IP per day..

Yes, the evil side COULD be automated, but it's a lot more difficult
than a simple post.

S


[PHP-DOC] cvs: phpdoc /en language-snippets.ent

2006-03-08 Thread Sean Coates
seanThu Mar  9 03:08:37 2006 UTC

  Modified files:  
/phpdoc/en  language-snippets.ent 
  Log:
  <\!-- Keep 'em sorted -->
  
http://cvs.php.net/viewcvs.cgi/phpdoc/en/language-snippets.ent?r1=1.162&r2=1.163&diff_format=u
Index: phpdoc/en/language-snippets.ent
diff -u phpdoc/en/language-snippets.ent:1.162 
phpdoc/en/language-snippets.ent:1.163
--- phpdoc/en/language-snippets.ent:1.162   Thu Mar  9 03:07:13 2006
+++ phpdoc/en/language-snippets.ent Thu Mar  9 03:08:37 2006
@@ -1,4 +1,4 @@
-
+
 
 
 
@@ -24,6 +24,11 @@
 array containing an object reference and a method name can also be
 supplied.'>
 
+Because this function depends on the
+current scope to determine parameter details, it cannot be used as a
+function parameter. If you must pass this value, assign the results to a
+variable, and pass the variable.'>
+
 If you are having problems
 with PHP not recognizing the line endings when reading files either on or
 created by a Macintosh computer, you might want to enable the
@@ -69,11 +74,6 @@
 This function uses
 Output Buffering.'>
 
-Because this function depends on the
-current scope to determine parameter details, it cannot be used as a
-function parameter. If you must pass this value, assign the results to a
-variable, and pass the variable.'>
-
 
 
 You can use a URL as a


[PHP-DOC] cvs: phpdoc /en language-snippets.ent

2006-03-08 Thread Sean Coates
seanThu Mar  9 03:07:13 2006 UTC

  Modified files:  
/phpdoc/en  language-snippets.ent 
  Log:
  fix build; please expand on this
  
http://cvs.php.net/viewcvs.cgi/phpdoc/en/language-snippets.ent?r1=1.161&r2=1.162&diff_format=u
Index: phpdoc/en/language-snippets.ent
diff -u phpdoc/en/language-snippets.ent:1.161 
phpdoc/en/language-snippets.ent:1.162
--- phpdoc/en/language-snippets.ent:1.161   Tue Feb  7 17:36:53 2006
+++ phpdoc/en/language-snippets.ent Thu Mar  9 03:07:13 2006
@@ -1,4 +1,4 @@
-
+
 
 
 
@@ -66,6 +66,9 @@
 etc. have  been available.  For more information, read the manual section 
 on &link.superglobals;'>
 
+This function uses
+Output Buffering.'>
+
 Because this function depends on the
 current scope to determine parameter details, it cannot be used as a
 function parameter. If you must pass this value, assign the results to a


Re: [PHP-DOC] build failure en (2006-03-08)

2006-03-08 Thread Sean Coates
> Please commit the entity for note.ob

Make that note.uses-ob

S


Re: [PHP-DOC] build failure en (2006-03-08)

2006-03-08 Thread Sean Coates
[EMAIL PROTECTED] wrote:
> /usr/bin/openjade:/dat/dev/php/phpdoc/en/reference/misc/functions/highlight-file.xml:28:18:E:
>  character data is not allowed here
> /usr/bin/openjade:/dat/dev/php/phpdoc/en/reference/misc/functions/highlight-string.xml:28:18:E:
>  character data is not allowed here
> /usr/bin/openjade:/dat/dev/php/phpdoc/en/reference/var/functions/print-r.xml:77:18:E:
>  character data is not allowed here
> /usr/bin/openjade:/dat/dev/php/phpdoc/en/reference/var/functions/var-export.xml:43:20:E:
>  character data is not allowed here
> make: *** [html/index.html] Error 1

Jakub,

Please commit the entity for note.ob

S


Re: [PHP-DOC] php.net search data aggregation

2006-03-05 Thread Sean Coates
> PHP 5 uptake is also speeding up and there are a couple of areas of the
> manual that are confusing.  A search for "xml" or going to php.net/xml
> lands you on php.net/manual/en/ref.xml.php which has no mention of the
> different xml implementations available.

The best way to handle this, probably, is to add a very high level "XML
Processing in PHP" appendix and link xml there. The appendix could then
link the the various sections: DOM, libxml, SimpleXML, ref.xml, etc.

S


Re: [PHP-DOC] [patch] changes in en/reference/ncurses/constants.xml

2006-02-28 Thread Sean Coates
> The final decision will be of course up to you guys, but I would hope
> that the patch be applied.  The patch would make the page a little too
> big, like you say, but I would vote for the consistency in page format
> (I don't see constants given as ranges elsewhere), than a slight page
> size increase in just one extension.

I agree with Nuno, here. Readability over hard consistency rules, IMO.
I think your best bet is to craw the XML as you do now, and apply local
overlays on your end.

S


Re: [PHP-DOC] Gabor resigns from the editor post

2006-02-28 Thread Sean Coates
> he probably has more time than Sean

Yes, I appreciate the thought, but I certainly don't consistently have
any extra time to devote to phpdoc -- sorry.

S


Re: [PHP-DOC] spam comments at phpdoc.info

2006-02-26 Thread Sean Coates
> It would be nice to do something about the tremendous amount of spam
> comments around phpdoc.info... Like:
> 
>   http://wiki.phpdoc.info/CurtZirzow?show_comments=1

Ew. what a mess.
I made the comment ACL to logged in users only (need @php.net to log
in), and I removed all comments that had "http" in them. Sorry if I
removed any legit comments.

S


Re: [PHP-DOC] spam protection for user notes

2006-02-25 Thread Sean Coates
> I did something like this in my quick tests:

Nevermind, I see you've got it under control.

S


Re: [PHP-DOC] spam protection for user notes

2006-02-25 Thread Sean Coates
> actually its not a config file, its a config dir :)
> I have many files in /usr/share/spamassassin, although not all are
> needed for us.

Ok.. what directives are you using? (-:

> Anyway, I think the best thing to do now is to implement a function to
> pass the note through spamassassin and display the result (X-Spam-Status
> line) in the e-mail that is sent to the notes list, so that we can check
> if we need to tweak the configuration.

I did something like this in my quick tests:

$d = array(
  0 => array("pipe", "r"), // stin
  1 => array("pipe", "w"), // stdout
  2 => array("pipe", "w")  // stderr
);
$proc = proc_open('/path/to/spamassassin -L -e 8', $d, $p);
fclose($p[2]); // keep it open if you want to read stderr
fwrite($p[0], $originalNoteText);
fclose($p0]);
$noteWithHeaders = stream_get_contents($p[1]);
fclose($p[1]);

S


Re: [PHP-DOC] spam protection for user notes

2006-02-25 Thread Sean Coates
>> Piping user notes through spamassassin won't help--at least without some
>> special config that I don't know about.
> 
> man spamassassin says:
> -C path, --configpath=path, --config-file=path
>   Path to standard configuration dir

Cool. Out of curiosity, what does your config file look like?

S


Re: [PHP-DOC] spam protection for user notes

2006-02-25 Thread Sean Coates
> spam assasin is already there:
> /opt/ecelerity/3rdParty/bin/spamassassin -L -e 8

Piping user notes through spamassassin won't help--at least without some
special config that I don't know about.

For example, all notes would end up with headers like the following,
because they're not actually mail:
X-Spam-Level:
X-Spam-Status: No, score=-1.3 required=5.0
tests=ALL_TRUSTED,MISSING_SUBJECT
autolearn=failed version=3.0.1

ALL_TRUSTED means that the message didn't pass through any untrusted
SMTP hosts (no hosts in this case).

It's also obviously missing a subject header.

S


Re: [PHP-DOC] spam protection for user notes

2006-02-25 Thread Sean Coates
>> Run the note's text through a spam checker on the server before posting
>> it...

> OK, if you are able to setup that on the master server, please do so ;)
> I'll then patch the user notes script to use it (just tell me what I
> need to run).

Spam checkers don't work (particularly well). Especially for non-mail.

I'd prefer the dual-opt-in-like behaviour where the user is mailed and
asked to confirm that he/she submitted the note.

After say 10 unconfirmed mails by a particular address, they could get
blacklisted.

BTW, I just made some changes to the notes scripts to use new, shorter URLs.

S


Re: [PHP-DOC] Gabor resigns from the editor post

2006-02-24 Thread Sean Coates
> I hope that my reasons are understandable, and I am certain that we will
> be able to manage to execute some smooth process of handing the
> reposibilities and the credits over. It was a great pleasure to work
> with you, and shape the PHP Documentation into what it is today.

Well, Goba, let me be the first to say (publicly) that you will be
missed. Personally, I have appreciated your leadership and guidance. It
seems that as members of the documentation team evolve our personal
lives, we've less and less time to devote to phpdoc. That is to say that
your reasons are well understood.

Thank you for your service. You've been a clear head when we needed it,
and a pleasure to work with on all occasions. I'm glad you won't be
disappearing from php.net, entirely.

S


Re: [PHP-DOC] spam protection for user notes

2006-02-21 Thread Sean Coates
Sebastian-H. Picklum wrote:
> Ohhh. Since when do we have that? Seems that  I missed the news... :-)

It's been around for quite a while. 1.5 years, I'd guess. I blogged
about it a few months back.

S


Re: [PHP-DOC] spam protection for user notes

2006-02-21 Thread Sean Coates
> Another option (in the short-term) is to simply required a valid email
> address (most of the spam seems to come from the default
> '[EMAIL PROTECTED]' or 'php-general@lists.php.net').

Haven't checked the code recently, but I'm pretty sure a blank name
results in php-general@lists.php.net and a name with no domain ("Bob")
gets osu1 appended ("[EMAIL PROTECTED]").

S


  1   2   3   4   5   >