harmony-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Tim Ellison <t.p.elli...@gmail.com>
Subject Re: [classlib][doc]Recommend to remove trunk\doc\kernel_doc and trunk\doc\vm_doc from svn repository.
Date Thu, 28 Sep 2006 10:46:38 GMT
Morozova, Nadezhda wrote:
> Do you think we can have the docs built on a regular basis (like, a
> script that triggers Doxygen build say 2 times a week + on demand to
> push updates if needed) and resulting docs stored on the website?
> This way, you don't have SVN versioning for auto-generated content and
> keep info available for all.

May need to keep it a manual update for now since we have no scripts
that update the website regularly.  These Doxygen docs describe APIs so
hopefully they are not changing regularly (at least, not twice a week).

Regards,
Tim

> -----Original Message-----
> From: Mark Hindess [mailto:mark.hindess@googlemail.com] 
> Sent: Thursday, September 28, 2006 1:08 PM
> To: harmony-dev@incubator.apache.org
> Subject: Re: [classlib][doc]Recommend to remove trunk\doc\kernel_doc and
> trunk\doc\vm_doc from svn repository. 
> 
> 
> This has been a problem for some time - I recall commenting out the call
> to an ant target that cleaned that svn-checked out documentation.
> 
> If we are going to remove them, then I think we need to add them to the
> website and ensure we update them regularly.  (So that they exist in a
> form we can link to - I recall seeing links to the versions in svn in
> the past.)
> 
> Regards,
>  Mark.
> 
> On 28 September 2006 at 16:30, Paulex Yang <paulex.yang@gmail.com>
> wrote:
>> Leo Li wrote:
>>> Hi, all:
>>>     I have fixed the script to generate vm_doc but there is a
> problem: 
>>> the
>>> newly generated vm_doc will override the original one which is under
> 
>>> control
>>> of svn. Thus it will lead to build failure since vm_doc lacks from
> the
>>> perspective of svn. 
>> LOL, is it a problem of build script?
>>> Since the content under the directories
>>> of  trunk\doc\kernel_doc and trunk\doc\vm_doc can be generated 
>>> accordingly,
>>> I recommend to remove them from svn control as the doc of classlib
> does.
>> Hmm...just had a look at the classlib/trunk/doc directory, I agree
> that 
>> current structure is interesting, there are three config files for 
>> Doxygen: kernel/kernel.cfg, classlib/classlib.cfg and 
>> vminterface/natives.cfg(I guess, for kernel class, classlib and native
> 
>> vmi respectively), while only two directories with Doxygen genereated 
>> documents: kernel_doc and vm_doc. IMHO, there is no reason to put the 
>> Doxygen generated files into SVN, which just like .class compiled by 
>> javac. I vote to remove the two directories, and keep the config files
> 
>> only. And, maybe we can add a "build-doc" target in the 
>> classlib/trunk/build.xml to make document creation more handy.
>>
>> -- 
>> Paulex Yang
>> China Software Development Lab
>> IBM
>>
>>
>>
>> ---------------------------------------------------------------------
>> Terms of use : http://incubator.apache.org/harmony/mailing.html
>> To unsubscribe, e-mail: harmony-dev-unsubscribe@incubator.apache.org
>> For additional commands, e-mail: harmony-dev-help@incubator.apache.org
>>
> 
> 
> 
> ---------------------------------------------------------------------
> Terms of use : http://incubator.apache.org/harmony/mailing.html
> To unsubscribe, e-mail: harmony-dev-unsubscribe@incubator.apache.org
> For additional commands, e-mail: harmony-dev-help@incubator.apache.org
> 
> ---------------------------------------------------------------------
> Terms of use : http://incubator.apache.org/harmony/mailing.html
> To unsubscribe, e-mail: harmony-dev-unsubscribe@incubator.apache.org
> For additional commands, e-mail: harmony-dev-help@incubator.apache.org
> 
> 

-- 

Tim Ellison (t.p.ellison@gmail.com)
IBM Java technology centre, UK.

---------------------------------------------------------------------
Terms of use : http://incubator.apache.org/harmony/mailing.html
To unsubscribe, e-mail: harmony-dev-unsubscribe@incubator.apache.org
For additional commands, e-mail: harmony-dev-help@incubator.apache.org


Mime
View raw message