From: Miguel A. Figueroa-V. <mi...@ie...> - 2009-05-15 12:51:23
Attachments:
vxl-Experimental-doxygen.cmake
|
Hello, I have implemented in config/cmake/doxygen support for building the vxl documentation with cmake. To build it you need to turn on the BUILD_DOCUMENTATION option and then run the build_doxygen_doc target. By default it will build the documentation in ${CMAKE_BINARY_DIR}/doxy, but you can select the desired DOXYGEN_OUTPUT_DIR to any location on the filesystem. I use the attached ctest script to build the documentation (this could be used in a cron job to automatically build the documentation nightly). Notice the CTEST_BUILD_COMMAND, and DOXYGEN_OUTPUT_DIR. The only problem in the dashboard so far is with a build that uses cmake 2.4.5. We agreed a while back to raise the minimum required cmake version to 2.6.X. We should proceed, since the 2.4.5 version doesn't support the function command. Well, I hope you find this helpful. Below is some more information on customizing and timing. --Miguel ------------------------------------------- Other variables you can customize are: - DOXYGEN_INDEX_FILE: this defaults to index.html; the index will be created in ${DOXYGEN_OUTPUT_DIR}/html/${DOXYGEN_INDEX_FILE} - DOXYGEN_MERGE_DOCS_WITH: defaults to empty string; this is useful for integrating internal libraries with vxl. For example, if you do the following: cd vxl_bin cmake ../vxl_src |----- BUILD_DOCUMENTATION=ON |----- DOXYGEN_OUTPUT_DIR=/.../docs/vxl |----- DOXYGEN_INDEX_FILE=vxl.html make build_doxygen_doc cd internal_bin cmake ../internal_src |----- BUILD_DOCUMENTATION=ON |----- DOXYGEN_OUTPUT_DIR=/.../docs/vxl # same output dir as above |----- DOXYGEN_INDEX_FILE=index.html |----- DOXYGEN_MERGE_DOCS_WITH=vxl.html # previously selected index make build_doxygen_doc Then this will genertate an index with the vxl docs and internal docs together (book and doxygen). ------------------------------------------- The time for building from scratch (but with an already downloaded vxl tree) is: $ time ./dashboard-scripts/run_dashboard_submission.sh -p vxl -m Experimental --doxygen real 16m7.019s user 13m12.606s sys 2m27.781s For building a second time, but with no changes in the repository since last build, nor changes in the working copy: $ time ./dashboard-scripts/run_dashboard_submission.sh -p vxl -m Experimental --doxygen real 0m40.952s user 0m13.353s sys 0m3.180s It will detect changes per lib/book directory to determine if it builds that particular lib/book. |
From: Matthew L. <mat...@gm...> - 2009-05-16 02:06:14
|
Miguel, That one build with cmake 2.4.5 is my responsibility. I'm totally on board with 2.6 as a minimum requirement, but that machine is currently running some other services (not VXL or CMake related) that still rely on an outdated version of Debian. I'll check next week to see if I can update CMake. If not, I'll just shut that build down. Matt On May 15, 2009, at 8:51 AM, Miguel A. Figueroa-Villanueva wrote: > Hello, > > I have implemented in config/cmake/doxygen support for building the > vxl documentation with cmake. To build it you need to turn on the > BUILD_DOCUMENTATION option and then run the build_doxygen_doc target. > By default it will build the documentation in > ${CMAKE_BINARY_DIR}/doxy, but you can select the desired > DOXYGEN_OUTPUT_DIR to any location on the filesystem. > > I use the attached ctest script to build the documentation (this could > be used in a cron job to automatically build the documentation > nightly). Notice the CTEST_BUILD_COMMAND, and DOXYGEN_OUTPUT_DIR. > > The only problem in the dashboard so far is with a build that uses > cmake 2.4.5. We agreed a while back to raise the minimum required > cmake version to 2.6.X. We should proceed, since the 2.4.5 version > doesn't support the function command. > > Well, I hope you find this helpful. Below is some more information on > customizing and timing. > > --Miguel > > ------------------------------------------- > Other variables you can customize are: > > - DOXYGEN_INDEX_FILE: this defaults to index.html; the index will be > created in ${DOXYGEN_OUTPUT_DIR}/html/${DOXYGEN_INDEX_FILE} > > - DOXYGEN_MERGE_DOCS_WITH: defaults to empty string; this is useful > for integrating internal libraries with vxl. For example, if you do > the following: > > cd vxl_bin > cmake ../vxl_src > |----- BUILD_DOCUMENTATION=ON > |----- DOXYGEN_OUTPUT_DIR=/.../docs/vxl > |----- DOXYGEN_INDEX_FILE=vxl.html > make build_doxygen_doc > > cd internal_bin > cmake ../internal_src > |----- BUILD_DOCUMENTATION=ON > |----- DOXYGEN_OUTPUT_DIR=/.../docs/vxl # same output dir as > above > |----- DOXYGEN_INDEX_FILE=index.html > |----- DOXYGEN_MERGE_DOCS_WITH=vxl.html # previously selected index > make build_doxygen_doc > > Then this will genertate an index with the vxl docs and internal docs > together (book and doxygen). > > ------------------------------------------- > The time for building from scratch (but with an already downloaded > vxl tree) is: > > $ time ./dashboard-scripts/run_dashboard_submission.sh -p vxl -m > Experimental --doxygen > real 16m7.019s > user 13m12.606s > sys 2m27.781s > > For building a second time, but with no changes in the repository > since last build, nor changes in the working copy: > > $ time ./dashboard-scripts/run_dashboard_submission.sh -p vxl -m > Experimental --doxygen > real 0m40.952s > user 0m13.353s > sys 0m3.180s > > It will detect changes per lib/book directory to determine if it > builds that particular lib/book. > <vxl-Experimental- > doxygen > .cmake > > > ------------------------------------------------------------------------------ > Crystal Reports - New Free Runtime and 30 Day Trial > Check out the new simplified licensing option that enables > unlimited royalty-free distribution of the report engine > for externally facing server and web deployment. > http://p.sf.net/sfu/businessobjects_______________________________________________ > Vxl-maintainers mailing list > Vxl...@li... > https://lists.sourceforge.net/lists/listinfo/vxl-maintainers |
From: Bill H. <bil...@ki...> - 2009-05-18 15:36:23
|
Matthew Leotta wrote: > Miguel, > > That one build with cmake 2.4.5 is my responsibility. I'm totally > on board with 2.6 as a minimum requirement, but that machine is > currently running some other services (not VXL or CMake related) that > still rely on an outdated version of Debian. I'll check next week to > see if I can update CMake. If not, I'll just shut that build down. > > Matt > Why not just use a bootstrapped CMake, or a binary from www.cmake.org? CMake does not even have to be in the PATH, or installed as root to be used for a dashboard run. -Bill |
From: Matthew L. <mat...@gm...> - 2009-05-18 16:38:37
|
Bill, Thanks for the suggestion, that's probably the quickest fix. I'll do that if we are still unable to update the whole OS. This might be a good opportunity for someone else at Brown to take over as admin of this machine since, as you know, I won't be at Brown much longer. Matt On May 18, 2009, at 11:36 AM, Bill Hoffman wrote: > Matthew Leotta wrote: >> Miguel, >> That one build with cmake 2.4.5 is my responsibility. I'm >> totally on board with 2.6 as a minimum requirement, but that >> machine is currently running some other services (not VXL or CMake >> related) that still rely on an outdated version of Debian. I'll >> check next week to see if I can update CMake. If not, I'll just >> shut that build down. >> Matt > > Why not just use a bootstrapped CMake, or a binary from > www.cmake.org? CMake does not even have to be in the PATH, or > installed as root to be used for a dashboard run. > > -Bill |