Re: Documention problems
| From: | Tomas V.V.Cox | Date: | Sat, 11 Aug 2001 23:29:16 +0000 |
| Subject: | Re: Documention problems | ||
| References: | 1 2 3 4 5 6 7 8 9 10 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-1398@lists.php.net to get a copy of this message | ||
"Stig S. Bakken" wrote:
>
> Chuck Hagenbuch wrote:
>
> > Quoting Stig Sæther Bakken <ssb@alltheweb.com>:
> >
> >> I could give more examples of how messy a shared tree would be, but I
> >> hope this gives you an idea of the grief it would cause.
> >
> > Yes. Note that I didn't say that the tree organization was wrong; I said that
> > the disconnect between it and the install organization causes confusion. Am I
> > correct in thinking that if we run phpdoc on a checkout that's organized like
> > the classes are installed, then there aren't any problems?
>
> I guess that would work. But a bit down the road we are going to have
> to deal with generating or installing documentation from the installer.
> Then either the installer or packager has to do it. I guess the path
> of least resistance would be to let the packager do it, but then you
> will need to update some index files and such during installation.
> Anyway, we'll cope with that later.
>
I'll be glad to implement that, also a command line PHPDoc generation
script, but PHPDoc have to be completed before.
I think that we need a central "doc" directory, where we could install
package documentation: doc/<pear_package_name-version>/. What if I
implement it to the installer?
Tomas V.V.Cox