Re: Portscanner class

On Fri, 16 Nov 2001 11:35:15 -0500 (EST), Joao Prado Maia wrote: >On Fri, 16 Nov 2001, Martin Jansen wrote: > >> >Now, looking at the current 'PEAR manual' I got a little doubt. Are we >> >going to document _all_ PEAR classes on the PEAR manual ? >> >> It think, all elements of PEAR should be documented, no? > >Well, I guess the real question is rather if _all_ PEAR classes will be >documented and stored on '/manual'. That will become pretty big, I guess :-). >And aren't we thinking on relaxing more on the requirements for new >classes / packages to be included in PEAR ? This would mean a lot more >stuff in the 'manual'. What do you mean with that? >Yet another question is related to the classes that are not mantained on >the php.net CVS server, but stored on the upcoming pear.php.net >repository. Would all of those classes / packages have to be on the >manual ? Why not? Of course, it will become big, but harddisk space is not the problem here: bash-2.05$ df -m Filesystem 1M-blocks Used Avail Capacity Mounted on /dev/ad0s1a 992 43 869 5% / /dev/ad0s1f 24441 6241 16245 28% /usr /dev/ad0s1e 1984 923 902 51% /var procfs 0 0 0 100% /proc bash-2.05$ So we have 16GB for documentation :-). I don't think it will be generally a problem to have the documentation for all code on pear.php.net/manual/. The manual structure can for example look like this: 1. About PEAR 1.1: What is PEAR 1.2: Coding Standards 2. Contributing 2.1: ... 3. PEAR foundation classes 3.1: PEAR 3.2: DB 3.3: Log 3.4: ... 4. "other stuff" 4.1: Networking 4.1.1: Net_Portscan 4.1.2: Net_Finger 4.2: HTML 4.2.1: HTML_Table 4.2.2: HTML_OOH_Forms etc. etc. When you request http://pear.php.net/manual/, you only see points 1-4 (without nesting). So the manual will be still handy and easy to search. So we can allow contributors to put their documentation on pear.php.net. If they don't want to do so, they can leave it on their site or at SourceForge. But like every time: I'm open to suggestions. - Martin