Re: [drlvm][doc] doxygen documentation
On Dec 27, 2006, at 6:13 AM, Tim Ellison wrote: Geir Magnusson Jr. wrote: On Dec 19, 2006, at 10:27 AM, Morozova, Nadezhda wrote: I'm also concerned about the place: don't want to store these in site svn. Crazy idea: do you think we can store the doc bundle archives as we store builds? Like, you can download the code and/or pre-generated documentation. Well, in the past, I've have a similar problem with javadoc - I didn't feel it worth putting in the site SVN, so I just generated it, scp- ed it to the staging machine, and unzipped the tarball in the right spot. the downside is that in the event of a catastrophic failure, the site isn't regenerated just from SVN, but this isn't a critical thing, IMO... Well it can, but with the extra step of regenerating the doc from code in SVN, i.e. it is reproducible. What I meant was that our website wouldn't be down... just incomplete, and what would be missing would be something generally for specialists... geir Regards, Tim
Re: [drlvm][doc] doxygen documentation
Geir Magnusson Jr. wrote: > On Dec 19, 2006, at 10:27 AM, Morozova, Nadezhda wrote: >> I'm also concerned about the place: don't want to store these in site >> svn. Crazy idea: do you think we can store the doc bundle archives as we >> store builds? Like, you can download the code and/or pre-generated >> documentation. > > Well, in the past, I've have a similar problem with javadoc - I didn't > feel it worth putting in the site SVN, so I just generated it, scp-ed it > to the staging machine, and unzipped the tarball in the right spot. > > the downside is that in the event of a catastrophic failure, the site > isn't regenerated just from SVN, but this isn't a critical thing, IMO... Well it can, but with the extra step of regenerating the doc from code in SVN, i.e. it is reproducible. Regards, Tim
Re: [drlvm][doc] doxygen documentation
On the 0x24C day of Apache Harmony Geir Magnusson, Jr. wrote: > On Dec 19, 2006, at 10:27 AM, Morozova, Nadezhda wrote: > > >> -Original Message- > >> From: Geir Magnusson Jr. [mailto:[EMAIL PROTECTED] > >> Sent: Tuesday, December 19, 2006 6:16 PM > >> To: [email protected] > >> Subject: Re: [drlvm][doc] doxygen documentation > >> > >> > >> > >> Morozova, Nadezhda wrote: > > >> > >> > >>> Generated versions are stored at http://people.apache.org/ > >>> ~nadinem/ - > >>> intf_doc, drlvm_intf_doc, and vmcore_doc. I'll regenerate once in > > while > >>> to reflect recent functionality changes. Note that the files have > >>> the > >>> nice starting page with the table (also taken from HARMONY-2024), > >>> but > >>> you won't have it if you run Doxygen over your sources. To get the > >>> starting page locally, apply the patch for vm.h to your source > >>> files. > >> > >> Can we start hanging this on the website somewhere? That would be > >> useful > > [Nadya] which ones? There are 3 bundle - the huge dirty one, the > > external interfaces and the one for vmcore. If we decide to post, I > > recommend the external interfaces one. > > Ok! > > > I'm also concerned about the place: don't want to store these in site > > svn. Crazy idea: do you think we can store the doc bundle archives > > as we > > store builds? Like, you can download the code and/or pre-generated > > documentation. > > Well, in the past, I've have a similar problem with javadoc - I > didn't feel it worth putting in the site SVN, so I just generated it, > scp-ed it to the staging machine, and unzipped the tarball in the > right spot. that promises to be great for the doxygen bundle(s) > the downside is that in the event of a catastrophic failure, the site > isn't regenerated just from SVN, but this isn't a critical thing, > IMO... > > geir > > >> > >> geir > >> > >>> > >>> Statistics on the quality/quantity of the Doxygen documentation is > >>> collected on the Wiki page, > >>> http://wiki.apache.org/harmony/DRLVM_Documentation_Quality > >>> > >>> Cheers Nadya > >>> > >>> > > -- Egor Pasko
Re: [drlvm][doc] doxygen documentation
On Dec 19, 2006, at 10:27 AM, Morozova, Nadezhda wrote: -Original Message- From: Geir Magnusson Jr. [mailto:[EMAIL PROTECTED] Sent: Tuesday, December 19, 2006 6:16 PM To: [email protected] Subject: Re: [drlvm][doc] doxygen documentation Morozova, Nadezhda wrote: Generated versions are stored at http://people.apache.org/ ~nadinem/ - intf_doc, drlvm_intf_doc, and vmcore_doc. I'll regenerate once in while to reflect recent functionality changes. Note that the files have the nice starting page with the table (also taken from HARMONY-2024), but you won't have it if you run Doxygen over your sources. To get the starting page locally, apply the patch for vm.h to your source files. Can we start hanging this on the website somewhere? That would be useful [Nadya] which ones? There are 3 bundle - the huge dirty one, the external interfaces and the one for vmcore. If we decide to post, I recommend the external interfaces one. Ok! I'm also concerned about the place: don't want to store these in site svn. Crazy idea: do you think we can store the doc bundle archives as we store builds? Like, you can download the code and/or pre-generated documentation. Well, in the past, I've have a similar problem with javadoc - I didn't feel it worth putting in the site SVN, so I just generated it, scp-ed it to the staging machine, and unzipped the tarball in the right spot. the downside is that in the event of a catastrophic failure, the site isn't regenerated just from SVN, but this isn't a critical thing, IMO... geir geir Statistics on the quality/quantity of the Doxygen documentation is collected on the Wiki page, http://wiki.apache.org/harmony/DRLVM_Documentation_Quality Cheers Nadya
Re: [drlvm][doc] doxygen documentation
I would prefer the huge one either.
- Original Message -
From: "Andrey Yakushev" <[EMAIL PROTECTED]>
To:
Sent: Wednesday, December 20, 2006 7:15 PM
Subject: Re: [drlvm][doc] doxygen documentation
>I suggest several improvements for these config files. They are placed
> in the patch in HARMONY-2814.
>
[snip]
> - Correcting the default classlib placement from
> ${basedir}/../../../../classlib/trunk to
> ${basedir}/../../../working_classlib
Agree. :-)
>
> Any comments or suggestions are welcome.
>
> Thanks,
> Andrey
>
>
> On 12/19/06, Morozova, Nadezhda <[EMAIL PROTECTED]> wrote:
>> Hi all,
>>
>> I've committed new config files to drlvm/trunk/vm/doc so that you can
>> build Doxygen documentation for drlvm interfaces locally. These script
>> files are taken from HARMONY-2024. Suggestions/feedback welcome.
>>
>> Generated versions are stored at http://people.apache.org/~nadinem/ -
>> intf_doc, drlvm_intf_doc, and vmcore_doc. I'll regenerate once in while
>> to reflect recent functionality changes. Note that the files have the
>> nice starting page with the table (also taken from HARMONY-2024), but
>> you won't have it if you run Doxygen over your sources. To get the
>> starting page locally, apply the patch for vm.h to your source files.
>>
>> Statistics on the quality/quantity of the Doxygen documentation is
>> collected on the Wiki page,
>> http://wiki.apache.org/harmony/DRLVM_Documentation_Quality
>>
>> Cheers Nadya
>>
>>
>>
Re: [drlvm][doc] doxygen documentation
On the 0x244 day of Apache Harmony Nadezhda Morozova wrote: > >-Original Message- > >From: Geir Magnusson Jr. [mailto:[EMAIL PROTECTED] > >Sent: Tuesday, December 19, 2006 6:16 PM > >To: [email protected] > >Subject: Re: [drlvm][doc] doxygen documentation > > > > > > > >Morozova, Nadezhda wrote: > >> Hi all, > >> > >> I've committed new config files to drlvm/trunk/vm/doc so that you can > >> build Doxygen documentation for drlvm interfaces locally. These > script > >> files are taken from HARMONY-2024. Suggestions/feedback welcome. > >> > > > >If you are working on that JIRA, I think that you should assign to > >yourself and keep working on it. > [Nadya] ok, actually forgot :) thanks for reminding > > > > > >> Generated versions are stored at http://people.apache.org/~nadinem/ - > >> intf_doc, drlvm_intf_doc, and vmcore_doc. I'll regenerate once in > while > >> to reflect recent functionality changes. Note that the files have the > >> nice starting page with the table (also taken from HARMONY-2024), but > >> you won't have it if you run Doxygen over your sources. To get the > >> starting page locally, apply the patch for vm.h to your source files. > > > >Can we start hanging this on the website somewhere? That would be > >useful > [Nadya] which ones? There are 3 bundle - the huge dirty one, the > external interfaces and the one for vmcore. If we decide to post, I > recommend the external interfaces one. I would prefer the huge one > I'm also concerned about the place: don't want to store these in site > svn. Crazy idea: do you think we can store the doc bundle archives as we > store builds? Like, you can download the code and/or pre-generated > documentation. IMHO, if a developer wants a brief look at sources, s/he goes to the website Doxygen, if s/he wants a thorough look, s/he gets it from SVN. Easy to run scripts that generate Doxygen docs solve the problem (in the presence of tools...eh). So, I am feeling it is not worth the effort to create doc bundles.. > >geir > > > >> > >> Statistics on the quality/quantity of the Doxygen documentation is > >> collected on the Wiki page, > >> http://wiki.apache.org/harmony/DRLVM_Documentation_Quality > >> > >> Cheers Nadya > >> > >> > -- Egor Pasko
Re: [drlvm][doc] doxygen documentation
On the 0x244 day of Apache Harmony Geir Magnusson, Jr. wrote: > Morozova, Nadezhda wrote: > > Hi all, > > I've committed new config files to drlvm/trunk/vm/doc so that you can > > build Doxygen documentation for drlvm interfaces locally. These script > > files are taken from HARMONY-2024. Suggestions/feedback welcome. > > If you are working on that JIRA, I think that you should assign to > yourself and keep working on it. > > > > Generated versions are stored at http://people.apache.org/~nadinem/ - > > intf_doc, drlvm_intf_doc, and vmcore_doc. I'll regenerate once in while > > to reflect recent functionality changes. Note that the files have the > > nice starting page with the table (also taken from HARMONY-2024), but > > you won't have it if you run Doxygen over your sources. To get the > > starting page locally, apply the patch for vm.h to your source > > files. > > Can we start hanging this on the website somewhere? That would be > useful +1 > geir > > > Statistics on the quality/quantity of the Doxygen documentation is > > collected on the Wiki page, > > http://wiki.apache.org/harmony/DRLVM_Documentation_Quality Cheers > > Nadya > > > -- Egor Pasko
Re: [drlvm][doc] doxygen documentation
I suggest several improvements for these config files. They are placed
in the patch in HARMONY-2814.
This patch adds mainpage for doxygen generated interfaces documentation.
Mainpage source is placed at vm/include/open/mainpage.html file
Patch also contains several minor documentation improvements:
- README.html for vm/doc with easy navigation to all doxygen generated bundles
- New generated bundle combining all existed bundles together
- Splitting erroneously combined port and tests bundles
- Correcting the default classlib placement from
${basedir}/../../../../classlib/trunk to
${basedir}/../../../working_classlib
Any comments or suggestions are welcome.
Thanks,
Andrey
On 12/19/06, Morozova, Nadezhda <[EMAIL PROTECTED]> wrote:
Hi all,
I've committed new config files to drlvm/trunk/vm/doc so that you can
build Doxygen documentation for drlvm interfaces locally. These script
files are taken from HARMONY-2024. Suggestions/feedback welcome.
Generated versions are stored at http://people.apache.org/~nadinem/ -
intf_doc, drlvm_intf_doc, and vmcore_doc. I'll regenerate once in while
to reflect recent functionality changes. Note that the files have the
nice starting page with the table (also taken from HARMONY-2024), but
you won't have it if you run Doxygen over your sources. To get the
starting page locally, apply the patch for vm.h to your source files.
Statistics on the quality/quantity of the Doxygen documentation is
collected on the Wiki page,
http://wiki.apache.org/harmony/DRLVM_Documentation_Quality
Cheers Nadya
RE: [drlvm][doc] doxygen documentation
>-Original Message- >From: Geir Magnusson Jr. [mailto:[EMAIL PROTECTED] >Sent: Tuesday, December 19, 2006 6:16 PM >To: [email protected] >Subject: Re: [drlvm][doc] doxygen documentation > > > >Morozova, Nadezhda wrote: >> Hi all, >> >> I've committed new config files to drlvm/trunk/vm/doc so that you can >> build Doxygen documentation for drlvm interfaces locally. These script >> files are taken from HARMONY-2024. Suggestions/feedback welcome. >> > >If you are working on that JIRA, I think that you should assign to >yourself and keep working on it. [Nadya] ok, actually forgot :) thanks for reminding > > >> Generated versions are stored at http://people.apache.org/~nadinem/ - >> intf_doc, drlvm_intf_doc, and vmcore_doc. I'll regenerate once in while >> to reflect recent functionality changes. Note that the files have the >> nice starting page with the table (also taken from HARMONY-2024), but >> you won't have it if you run Doxygen over your sources. To get the >> starting page locally, apply the patch for vm.h to your source files. > >Can we start hanging this on the website somewhere? That would be >useful [Nadya] which ones? There are 3 bundle - the huge dirty one, the external interfaces and the one for vmcore. If we decide to post, I recommend the external interfaces one. I'm also concerned about the place: don't want to store these in site svn. Crazy idea: do you think we can store the doc bundle archives as we store builds? Like, you can download the code and/or pre-generated documentation. > >geir > >> >> Statistics on the quality/quantity of the Doxygen documentation is >> collected on the Wiki page, >> http://wiki.apache.org/harmony/DRLVM_Documentation_Quality >> >> Cheers Nadya >> >>
Re: [drlvm][doc] doxygen documentation
Morozova, Nadezhda wrote: Hi all, I've committed new config files to drlvm/trunk/vm/doc so that you can build Doxygen documentation for drlvm interfaces locally. These script files are taken from HARMONY-2024. Suggestions/feedback welcome. If you are working on that JIRA, I think that you should assign to yourself and keep working on it. Generated versions are stored at http://people.apache.org/~nadinem/ - intf_doc, drlvm_intf_doc, and vmcore_doc. I'll regenerate once in while to reflect recent functionality changes. Note that the files have the nice starting page with the table (also taken from HARMONY-2024), but you won't have it if you run Doxygen over your sources. To get the starting page locally, apply the patch for vm.h to your source files. Can we start hanging this on the website somewhere? That would be useful geir Statistics on the quality/quantity of the Doxygen documentation is collected on the Wiki page, http://wiki.apache.org/harmony/DRLVM_Documentation_Quality Cheers Nadya
