You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by "Alexei Fedotov (JIRA)" <ji...@apache.org> on 2006/10/31 17:54:44 UTC
[jira] Created: (HARMONY-2024) [drlvm][build] no docs are generated
for DRLVM
[drlvm][build] no docs are generated for DRLVM
----------------------------------------------
Key: HARMONY-2024
URL: http://issues.apache.org/jira/browse/HARMONY-2024
Project: Harmony
Issue Type: Bug
Components: DRLVM
Reporter: Alexei Fedotov
Attachments: vm_cfg.patch
Nadezhda Morozova wrote at
http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200610.mbox/%3c523F3D8D8C97554AA47E53DF1A05466A587B5B@nnsmsx411.ccr.corp.intel.com%3e
AFAIU, we want to have the following:
1. Ability to generate docs locally from source code [...]
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (HARMONY-2024) [drlvm][build] no docs are generated
for DRLVM
Posted by "Alexei Fedotov (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-2024?page=all ]
Alexei Fedotov updated HARMONY-2024:
------------------------------------
Attachment: README.txt
vm.cfg
I attached a configuration file vm.cfg which is created from kernel.cfg by means of the patch. I added a small instruction how to invoke Doxygen with this file. They both can be committed to $DRLVM_DIR/doc directory.
> [drlvm][build] no docs are generated for DRLVM
> ----------------------------------------------
>
> Key: HARMONY-2024
> URL: http://issues.apache.org/jira/browse/HARMONY-2024
> Project: Harmony
> Issue Type: Bug
> Components: DRLVM
> Reporter: Alexei Fedotov
> Attachments: README.txt, vm.cfg, vm_cfg.patch
>
>
> Nadezhda Morozova wrote at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200610.mbox/%3c523F3D8D8C97554AA47E53DF1A05466A587B5B@nnsmsx411.ccr.corp.intel.com%3e
> AFAIU, we want to have the following:
> 1. Ability to generate docs locally from source code [...]
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (HARMONY-2024) [drlvm][build] no docs are generated
for DRLVM
Posted by "Alexei Fedotov (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-2024?page=all ]
Alexei Fedotov updated HARMONY-2024:
------------------------------------
Attachment: check_doc_quality.sh
html_to_list.pl
These two scripts can be used to estimate DRLVM documentation quality. They also can be committed to drlvm/trunk/doc to check documentation quality on a regular basis.
> [drlvm][build] no docs are generated for DRLVM
> ----------------------------------------------
>
> Key: HARMONY-2024
> URL: http://issues.apache.org/jira/browse/HARMONY-2024
> Project: Harmony
> Issue Type: Bug
> Components: DRLVM
> Reporter: Alexei Fedotov
> Attachments: check_doc_quality.sh, drlvm_intf_doc.zip, html_to_list.pl, README.txt, vm.cfg, vm_cfg.patch
>
>
> Nadezhda Morozova wrote at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200610.mbox/%3c523F3D8D8C97554AA47E53DF1A05466A587B5B@nnsmsx411.ccr.corp.intel.com%3e
> AFAIU, we want to have the following:
> 1. Ability to generate docs locally from source code [...]
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (HARMONY-2024) [drlvm][build] no docs are generated
for DRLVM
Posted by "Alexei Fedotov (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-2024?page=all ]
Alexei Fedotov updated HARMONY-2024:
------------------------------------
Attachment: vm_cfg.patch
A quick solution on Linux to get Doxygen for DRLVM can look like follows:
$ cd $DRLVM_DIR
$ mkdir doc
$ cd doc
$ cp $CLASSLIB_DIR/doc/kernel/kernel.cfg vm.cfg
Patch vm.cfg using attached vm_cfg.patch
$ DRLVM_DOC_DIR=. CLASSLIB_DOC_DIR=$CLASSLIB_DIR/doc doxygen vm.cfg
Enjoy!
> [drlvm][build] no docs are generated for DRLVM
> ----------------------------------------------
>
> Key: HARMONY-2024
> URL: http://issues.apache.org/jira/browse/HARMONY-2024
> Project: Harmony
> Issue Type: Bug
> Components: DRLVM
> Reporter: Alexei Fedotov
> Attachments: vm_cfg.patch
>
>
> Nadezhda Morozova wrote at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200610.mbox/%3c523F3D8D8C97554AA47E53DF1A05466A587B5B@nnsmsx411.ccr.corp.intel.com%3e
> AFAIU, we want to have the following:
> 1. Ability to generate docs locally from source code [...]
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (HARMONY-2024) [drlvm][build] no docs are generated
for DRLVM
Posted by "Alexei Fedotov (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-2024?page=all ]
Alexei Fedotov updated HARMONY-2024:
------------------------------------
Attachment: drlvm_intf_doc.zip
Nadya suggested the following:
>2. Ability to see docs on the website - manually copy a local
> bundle of docs to the website and add a link
I'm attaching an archive to be put to the web site.
Note, it's better to use Linux while working with this archive:
$ unzip -l drlvm_intf_doc.zip | grep xceptions
77324 11-01-06 00:25 drlvm_intf_doc/html/exceptions_8h.html
1772 11-01-06 00:25 drlvm_intf_doc/html/Exceptions_8h.html
> [drlvm][build] no docs are generated for DRLVM
> ----------------------------------------------
>
> Key: HARMONY-2024
> URL: http://issues.apache.org/jira/browse/HARMONY-2024
> Project: Harmony
> Issue Type: Bug
> Components: DRLVM
> Reporter: Alexei Fedotov
> Attachments: drlvm_intf_doc.zip, README.txt, vm.cfg, vm_cfg.patch
>
>
> Nadezhda Morozova wrote at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200610.mbox/%3c523F3D8D8C97554AA47E53DF1A05466A587B5B@nnsmsx411.ccr.corp.intel.com%3e
> AFAIU, we want to have the following:
> 1. Ability to generate docs locally from source code [...]
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira