Harmony
  1. Harmony
  2. HARMONY-2024

[drlvm][build] no docs are generated for DRLVM

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: DRLVM
    • Labels:
      None
    • Patch Info:
      Patch Available
    • Estimated Complexity:
      Novice

      Description

      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 [...]

      1. vm_cfg.patch
        4 kB
        Alexei Fedotov
      2. README.txt
        0.4 kB
        Alexei Fedotov
      3. vm.cfg
        47 kB
        Alexei Fedotov
      4. drlvm_intf_doc.zip
        9.65 MB
        Alexei Fedotov
      5. check_doc_quality.sh
        2 kB
        Alexei Fedotov
      6. html_to_list.pl
        0.8 kB
        Alexei Fedotov
      7. vm_doc.documentation.zip
        1.57 MB
        Alexei Fedotov
      8. vm_doc.scripts.zip
        19 kB
        Alexei Fedotov
      9. cccc.zip
        5.98 MB
        Alexei Fedotov
      10. Doxygen_mainpage.patch
        10 kB
        Andrey Yakushev
      11. DRLVM Interfaces.htm
        10 kB
        Andrey Yakushev

        Issue Links

          Activity

          Hide
          Alexei Fedotov added a comment -

          Nadya, thanks!

          Show
          Alexei Fedotov added a comment - Nadya, thanks!
          Hide
          Nadya Morozova added a comment -

          Scripts for building Doxygen docs from vm source code have been committed to svn. further enhancements can be tracked in other JIRAs. progress on metrics is tracked on Wiki.

          Show
          Nadya Morozova added a comment - Scripts for building Doxygen docs from vm source code have been committed to svn. further enhancements can be tracked in other JIRAs. progress on metrics is tracked on Wiki.
          Hide
          Alexei Fedotov added a comment -

          > Do you think we can close this issue?
          +1

          Show
          Alexei Fedotov added a comment - > Do you think we can close this issue? +1
          Hide
          Nadya Morozova added a comment -

          there seem to be 3 issues in this one:

          • no doxygen docs can be generated; resolved by doc build scripts committed to svn
          • resulting doxygen docs are not optimal and don't have starting pages; in progress in HARMONY-2814
          • quality and quantity of the doxygen docs are not measured; resolved by using the scripts in this issue, results published to Wiki, http://wiki.apache.org/harmony/DRLVM_Documentation_Quality

          It seems there are no unresolved / unaddressed problems. Do you think we can close this issue? What do we do with the metrics scripts?

          thanks, Nadya

          Show
          Nadya Morozova added a comment - there seem to be 3 issues in this one: no doxygen docs can be generated; resolved by doc build scripts committed to svn resulting doxygen docs are not optimal and don't have starting pages; in progress in HARMONY-2814 quality and quantity of the doxygen docs are not measured; resolved by using the scripts in this issue, results published to Wiki, http://wiki.apache.org/harmony/DRLVM_Documentation_Quality It seems there are no unresolved / unaddressed problems. Do you think we can close this issue? What do we do with the metrics scripts? thanks, Nadya
          Hide
          Nadya Morozova added a comment -

          The related issue enhances the scripts donated in this issue and adds other improvements to the output.

          Show
          Nadya Morozova added a comment - The related issue enhances the scripts donated in this issue and adds other improvements to the output.
          Hide
          Nadya Morozova added a comment -

          committed doc scripts into the source tree.

          Show
          Nadya Morozova added a comment - committed doc scripts into the source tree.
          Hide
          Nadya Morozova added a comment -

          Added detailed instructions on how to build both one big bundle (doxygen build) and a set of small bundles (ant script build) to Wiki http://wiki.apache.org/harmony/DRLVM_Documentation_Quality#build_instructions.

          Posted big doc bundle at http://people.apache.org/~nadinem/drlvm_intf_doc/html/
          Posted vmcore doc bundle http://people.apache.org/~nadinem/vmcore_doc/html/
          Posted external interfaces doc bundle http://people.apache.org/~nadinem/intf_doc/html/

          Show
          Nadya Morozova added a comment - Added detailed instructions on how to build both one big bundle (doxygen build) and a set of small bundles (ant script build) to Wiki http://wiki.apache.org/harmony/DRLVM_Documentation_Quality#build_instructions . Posted big doc bundle at http://people.apache.org/~nadinem/drlvm_intf_doc/html/ Posted vmcore doc bundle http://people.apache.org/~nadinem/vmcore_doc/html/ Posted external interfaces doc bundle http://people.apache.org/~nadinem/intf_doc/html/
          Hide
          Andrey Yakushev added a comment -

          New version with shorten links. Previous could be removed.

          Show
          Andrey Yakushev added a comment - New version with shorten links. Previous could be removed.
          Hide
          Andrey Yakushev added a comment -

          DRLVM Interfaces.htm file contains the mainpage after Doxygen_mainpage.patch applying. This file is placed here for convenient review.

          Show
          Andrey Yakushev added a comment - DRLVM Interfaces.htm file contains the mainpage after Doxygen_mainpage.patch applying. This file is placed here for convenient review.
          Hide
          Andrey Yakushev added a comment -

          Doxygen_mainpage.patch is a patch file with suggested initial DRLVM Doxygen mainpage content

          Show
          Andrey Yakushev added a comment - Doxygen_mainpage.patch is a patch file with suggested initial DRLVM Doxygen mainpage content
          Hide
          Alexei Fedotov added a comment -

          The attached file cccc.zip contains source metrics for drlvm. The problematic places are highlighted with red at .cccc/cccc.html.

          Show
          Alexei Fedotov added a comment - The attached file cccc.zip contains source metrics for drlvm. The problematic places are highlighted with red at .cccc/cccc.html.
          Hide
          Alexei Fedotov added a comment -

          1. vm_doc.documentation.zip contains a documentation bundle. It shouldn't be committed, but could be put to the web site.

          2. Three scripts from vm_doc.scripts.zip should be unpacked to drlvm/trunk/vm/doc and committed to the source tree. They build the documentation bundle.

          Show
          Alexei Fedotov added a comment - 1. vm_doc.documentation.zip contains a documentation bundle. It shouldn't be committed, but could be put to the web site. 2. Three scripts from vm_doc.scripts.zip should be unpacked to drlvm/trunk/vm/doc and committed to the source tree. They build the documentation bundle.
          Hide
          Alexei Fedotov added a comment -

          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.

          Show
          Alexei Fedotov added a comment - 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.
          Hide
          Alexei Fedotov added a comment -

          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

          Show
          Alexei Fedotov added a comment - 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
          Hide
          Alexei Fedotov added a comment -

          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.

          Show
          Alexei Fedotov added a comment - 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.
          Hide
          Alexei Fedotov added a comment -

          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!

          Show
          Alexei Fedotov added a comment - 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!

            People

            • Assignee:
              Nadya Morozova
              Reporter:
              Alexei Fedotov
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development