Egon Schmid wrote:

> From: "Hartmut Holzgraefe" <[EMAIL PROTECTED]>
> 
>>>eschmid Sat Jan 12 15:09:32 2002 EDT
>>>
>>>  Modified files:
>>>    /phpdoc funclist.txt funcsummary.txt
>>>  Log:
>>>  Update of funclist.txt and funcsummary.txt
>>>
>>do we realy need these auto generated files in CVS,
>>
> 
> These files are not auto generated 


so we have different definitions of "auto generated"

"make funclist.txt" is auto generation for me

and it is common practice (for a reason) not to include
files in CVS that can easiely and automaticly created
from other files within that repository



> and yes we need them.


haven't looked at them for quite a while, and even if i
wanted to i would just "make" them


> 
> 
>>or are they just left over from the time when php
>>source and documentation were in the same repository?
>>
> 
> No, the scripts was written by Rasmus between PHP 3.0.6 and 3.0.7.
> 
> 
>>don't think they make much sense in CVS any longer
>>as everyone checking out the manual now should be
>>able to generate them himself
>>
> 


> Please donīt touch them. They are needed for editors (programs and
> humans) and translators.

translators definetly do not need them, all they need are the
english originals and knowledge of untranslated or outdated stuff,
both of which may be found elsewhere but definetly *not* in these
two files

writers might find them helpfull, at least funcsummary.txt,
but IMHO you get a better insight on an undocumented extension
or function from eg. the source or my function tables than from
this file

> I donīt see that everyone checkout the manual and PHP 3 or 4.

so how do you document a yet undocumented function? by shere guess?
you usualy need some information besides the proto description
unless it's a realy trivial one


>>same for quickref.txt


quickref.txt is of even less use for writers and translators
*and* it is even more likely that everybody serious about
this project is able to generate it



i don't say that these files are useless in themselves, just
that they are not important enough and not hard enough to create
to viloiate the "do not include into CVS what can be built from it"
rule

howto.html.tgz is an example for a valid exception as it gets
people started, the *.txt files are not IMHO


> The same goes here, your auto-generate rules doesnīt help because
> the automatic build system is broken.


even if it weren't (and is hasn't been for long and should work again
by tomorrow, it'S just hard to debug without documentation on what it
does on that machine and with only one shot a day) that would make
no difference right now as the files are not published or at least
not announced on php.net, although *that* would perfectly make sense

"if you can't create these files yourself you can fetch a (maybe
  slightly outdated) copy from http://php.net/.../funclist.txt";

that's a place were these files should live instead of being
pushed around in CVS for almost no use ...





-- 
Hartmut Holzgraefe  [EMAIL PROTECTED]  http://www.six.de  +49-711-99091-77



Reply via email to