[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[certi-cvs] certi/doc CMakeLists.txt certi_install.cnf.in c...
|
From: |
certi-cvs |
|
Subject: |
[certi-cvs] certi/doc CMakeLists.txt certi_install.cnf.in c... |
|
Date: |
Sat, 11 Oct 2008 21:40:18 +0000 |
CVSROOT: /sources/certi
Module name: certi
Changes by: Eric NOULARD <erk> 08/10/11 21:40:17
Modified files:
doc : CMakeLists.txt certi_install.cnf.in
certi_install.dox certi_user.cnf.in
certi_developer.cnf.in DoxyTools.cmake
Added files:
doc : certi_user.dox
Log message:
Small doxygen doc update
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/doc/CMakeLists.txt?cvsroot=certi&r1=1.6&r2=1.7
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install.cnf.in?cvsroot=certi&r1=3.2&r2=3.3
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install.dox?cvsroot=certi&r1=3.2&r2=3.3
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user.cnf.in?cvsroot=certi&r1=3.1&r2=3.2
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_developer.cnf.in?cvsroot=certi&r1=3.1&r2=3.2
http://cvs.savannah.gnu.org/viewcvs/certi/doc/DoxyTools.cmake?cvsroot=certi&r1=3.1&r2=3.2
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user.dox?cvsroot=certi&rev=3.1
Patches:
Index: CMakeLists.txt
===================================================================
RCS file: /sources/certi/certi/doc/CMakeLists.txt,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- CMakeLists.txt 10 Oct 2008 12:37:07 -0000 1.6
+++ CMakeLists.txt 11 Oct 2008 21:40:16 -0000 1.7
@@ -28,10 +28,10 @@
DoxyTools_ADD_DocSet(Install
CONFIG_FILE certi_install.cnf
INPUT_FILES certi_install_header.html
certi_footer.html
- DOC_TYPE html
+ DOC_TYPE "html;pdf"
OUTPUT_DIR ${CMAKE_BINARY_DIR}/doc/install
COMMENTS "CERTI installation documentation"
- )
+ VERBOSE)
ENDIF (BUILD_DOC_INSTALL)
#user documentation
@@ -39,7 +39,7 @@
DoxyTools_ADD_DocSet(User
CONFIG_FILE certi_user.cnf
INPUT_FILES certi_header.html certi_footer.html
- DOC_TYPE html
+ DOC_TYPE "html;pdf"
OUTPUT_DIR ${CMAKE_BINARY_DIR}/doc/user
COMMENTS "CERTI user documentation"
)
@@ -50,10 +50,10 @@
DoxyTools_ADD_DocSet(Developer
CONFIG_FILE certi_developer.cnf
INPUT_FILES certi_header.html certi_footer.html
- DOC_TYPE html
+ DOC_TYPE "html"
OUTPUT_DIR ${CMAKE_BINARY_DIR}/doc/developer
COMMENTS "CERTI developer documentation"
- VERBOSE)
+ )
ENDIF (BUILD_DOC_DEVELOPER)
ENDIF (DOXYGEN_FOUND)
Index: certi_install.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_install.cnf.in,v
retrieving revision 3.2
retrieving revision 3.3
diff -u -b -r3.2 -r3.3
--- certi_install.cnf.in 10 Oct 2008 12:37:06 -0000 3.2
+++ certi_install.cnf.in 11 Oct 2008 21:40:16 -0000 3.3
@@ -593,7 +593,7 @@
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
# generate HTML output.
-GENERATE_HTML = YES
+GENERATE_HTML = @Install_DOC_GENERATE_HTML@
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
@@ -705,7 +705,7 @@
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
-GENERATE_LATEX = YES
+GENERATE_LATEX = @Install_DOC_GENERATE_LATEX@
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Index: certi_install.dox
===================================================================
RCS file: /sources/certi/certi/doc/certi_install.dox,v
retrieving revision 3.2
retrieving revision 3.3
diff -u -b -r3.2 -r3.3
--- certi_install.dox 10 Oct 2008 12:37:06 -0000 3.2
+++ certi_install.dox 11 Oct 2008 21:40:16 -0000 3.3
@@ -1,8 +1,8 @@
/**
- * \page install Installing CERTI SDK
+ * \page install Installing CERTI
*
* \addindex installation
- * CERTI SDK comes as either as an installer (binary) or compressed tar source
archives.
+ * CERTI comes as either as an installer (binary) or compressed tar source
archives.
* The primary distribution format is gzip compressed tar source archive
(.tar.gz)
* or ZIP archive (.zip) and may be found on Savannah CERTI download area: <a
href="http://download.savannah.nongnu.org/releases/certi/";>
http://download.savannah.nongnu.org/releases/certi/ </a>.
*
@@ -22,7 +22,7 @@
* on various platforms: <a
href="http://www.cmake.org/cmake/help/runningcmake.html";>Running CMake,
http://www.cmake.org/cmake/help/runningcmake.html://www.cmake.org/ </a>
* or you may try to follow the below CERTI CMake usage.
*
- * \section certi_sdk_TARGZ Tarball based SDK
+ * \section certi_unix_build Building CERTI on Unix with Makefile generator
*
* If you get a tarball source CERTI distribution such as you may found in the
download
* section of the Savannah project
@@ -60,4 +60,13 @@
* </ol>
* After that you will have a compiled and usable CERTI package.
*
+ * \section certi_unix_build_GUI Building CERTI on Unix (GUI)
+ *
+ * CMake 2.6.0 and up comes with a nice and handy graphical user interface
+ * which may be invoked with the cmake-gui command.
+ *
+ * \section certi_win32_build Building CERTI on Windows
+ *
+ * CMake 2.
+ *
*/
Index: certi_user.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_user.cnf.in,v
retrieving revision 3.1
retrieving revision 3.2
diff -u -b -r3.1 -r3.2
--- certi_user.cnf.in 9 Oct 2008 23:39:57 -0000 3.1
+++ certi_user.cnf.in 11 Oct 2008 21:40:16 -0000 3.2
@@ -444,14 +444,9 @@
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = "${CMAKE_BINARY_DIR}/include" \
- "${CMAKE_SOURCE_DIR}/include" \
- "${CMAKE_SOURCE_DIR}/libCERTI" \
- "${CMAKE_SOURCE_DIR}/libRTI" \
- "${CMAKE_SOURCE_DIR}/libHLA" \
- "${CMAKE_SOURCE_DIR}/RTIG" \
- "${CMAKE_SOURCE_DIR}/RTIA" \
- "${CMAKE_SOURCE_DIR}/doc"
+INPUT = "${CMAKE_SOURCE_DIR}/doc/certi_user_doc.tree" \
+ "${CMAKE_SOURCE_DIR}/doc/certi_introduction.dox" \
+ "${CMAKE_SOURCE_DIR}/doc/certi_user.dox"
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -609,7 +604,7 @@
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
# generate HTML output.
-GENERATE_HTML = YES
+GENERATE_HTML = @User_DOC_GENERATE_HTML@
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
@@ -721,7 +716,7 @@
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
-GENERATE_LATEX = NO
+GENERATE_LATEX = @User_DOC_GENERATE_LATEX@
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Index: certi_developer.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_developer.cnf.in,v
retrieving revision 3.1
retrieving revision 3.2
diff -u -b -r3.1 -r3.2
--- certi_developer.cnf.in 9 Oct 2008 23:39:58 -0000 3.1
+++ certi_developer.cnf.in 11 Oct 2008 21:40:16 -0000 3.2
@@ -599,7 +599,7 @@
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
# generate HTML output.
-GENERATE_HTML = YES
+GENERATE_HTML = @Developer_DOC_GENERATE_HTML@
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
@@ -711,7 +711,7 @@
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
-GENERATE_LATEX = NO
+GENERATE_LATEX = @Developer_DOC_GENERATE_LATEX@
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Index: DoxyTools.cmake
===================================================================
RCS file: /sources/certi/certi/doc/DoxyTools.cmake,v
retrieving revision 3.1
retrieving revision 3.2
diff -u -b -r3.1 -r3.2
--- DoxyTools.cmake 9 Oct 2008 23:39:57 -0000 3.1
+++ DoxyTools.cmake 11 Oct 2008 21:40:17 -0000 3.2
@@ -56,6 +56,20 @@
ENDIF(DoxyTools_VERBOSE)
SET(${DOCSET}_DOC_OUTPUT_DIR ${DoxyTools_OUTPUT_DIR} CACHE PATH "${DOCSET}
doc output dir")
+ # Define appropriate doc type generation for Doxygen
+ LIST_CONTAINS(genpdf "pdf" ${DoxyTools_DOC_TYPE})
+ IF (genpdf)
+ SET(${DOCSET}_DOC_GENERATE_LATEX "YES")
+ ELSE (genpdf)
+ SET(${DOCSET}_DOC_GENERATE_LATEX "NO")
+ ENDIF(genpdf)
+
+ LIST_CONTAINS(genhtml "html" ${DoxyTools_DOC_TYPE})
+ IF (genhtml)
+ SET(${DOCSET}_DOC_GENERATE_HTML "YES")
+ ELSE (genhtml)
+ SET(${DOCSET}_DOC_GENERATE_HTML "NO")
+ ENDIF(genhtml)
# configure Doxygen config file if .in exists
IF (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${DoxyTools_CONFIG_FILE}.in)
@@ -65,15 +79,16 @@
CONFIGURE_FILE(${DoxyTools_CONFIG_FILE}.in
${CMAKE_CURRENT_BINARY_DIR}/${DoxyTools_CONFIG_FILE})
ENDIF(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${DoxyTools_CONFIG_FILE}.in)
- IF (DoxyTools_DOC_TYPE STREQUAL "html")
+ IF (genhtml)
SET(OUTPUT_FILE ${DoxyTools_OUTPUT_DIR}/html/index.html)
FOREACH(arg ${DoxyTools_INPUT_FILES})
CONFIGURE_FILE(${arg} ${DoxyTools_OUTPUT_DIR}/html/${arg} COPYONLY)
ENDFOREACH(arg)
- ENDIF(DoxyTools_DOC_TYPE STREQUAL "html")
+ ENDIF(genhtml)
# create output directory
FILE(MAKE_DIRECTORY ${DoxyTools_OUTPUT_DIR})
+ IF(OUTPUT_FILE)
ADD_CUSTOM_COMMAND(
OUTPUT ${OUTPUT_FILE}
COMMAND ${CMAKE_COMMAND} -E echo_append "Building CERTI ${DOCSET}
Documentation..."
@@ -81,8 +96,8 @@
COMMAND ${CMAKE_COMMAND} -E echo "Done."
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${DoxyTools_CONFIG_FILE})
-
ADD_CUSTOM_TARGET(${DOCSET}_doc ALL DEPENDS ${OUTPUT_FILE})
+ ENDIF(OUTPUT_FILE)
ADD_CUSTOM_TARGET(${DOCSET}_doc_forced
COMMAND ${CMAKE_COMMAND} -E echo_append "Building CERTI ${DOCSET}
Documentation..."
@@ -90,5 +105,9 @@
COMMAND ${CMAKE_COMMAND} -E echo "Done."
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
+ IF (genhtml)
+ MESSAGE(STATUS "Will install ${DoxyTools_OUTPUT_DIR}")
INSTALL(DIRECTORY ${DoxyTools_OUTPUT_DIR} DESTINATION share/doc/certi)
+ ENDIF (genhtml)
+
ENDMACRO(DoxyTools_ADD_DocSet)
\ No newline at end of file
Index: certi_user.dox
===================================================================
RCS file: certi_user.dox
diff -N certi_user.dox
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ certi_user.dox 11 Oct 2008 21:40:17 -0000 3.1
@@ -0,0 +1,63 @@
+/**
+ * \page install Installing CERTI SDK
+ *
+ * \addindex installation
+ * CERTI SDK comes as either as an installer (binary) or compressed tar source
archives.
+ * The primary distribution format is gzip compressed tar source archive
(.tar.gz)
+ * or ZIP archive (.zip) and may be found on Savannah CERTI download area: <a
href="http://download.savannah.nongnu.org/releases/certi/";>
http://download.savannah.nongnu.org/releases/certi/ </a>.
+ *
+ * CERTI build system uses <a href="http://www.cmake.org/";>CMake,
http://www.cmake.org/ </a>
+ * which is a cross-platform build system generator. CMake should be used to
+ * compile CERTI SDK on a variety of platform/compiler combination like:
+ * <ul>
+ * <li> Linux x86 / gcc </li>
+ * <li> Linux x86_64 / gcc </li>
+ * <li> Solaris Sparc / Sun Studio </li>
+ * <li> Windows / Visual Studio </li>
+ * <li> Windows / Code::Blocks+MinGW </li>
+ * <li> ... </li>
+ * </ul>
+ *
+ * You may follow generic CMake usage instruction for building CERTI
+ * on various platforms: <a
href="http://www.cmake.org/cmake/help/runningcmake.html";>Running CMake,
http://www.cmake.org/cmake/help/runningcmake.html://www.cmake.org/ </a>
+ * or you may try to follow the below CERTI CMake usage.
+ *
+ * \section certi_sdk_TARGZ Tarball based SDK
+ *
+ * If you get a tarball source CERTI distribution such as you may found in the
download
+ * section of the Savannah project
+ * <a>http://download.savannah.nongnu.org/releases/certi/</a>,
+ * you should follow these steps:
+ * <ol>
+ * <li>untar the archive: tar zxvf certi-\<version\>-Source.tar.gz
+ * this should create a certi-\<version\>-Source directory
+ * </li>
+ * \verbatim
+ tar zxvf certi-3.2.4-Source.tar.gz
+ ... wait for tar ending ... \endverbatim
+ * <li>Prepare separate build directory and run CMake
+ * </li>
+ * \verbatim
+ mkdir build_certi
+ cd build_certi
+ cmake -DCMAKE_INSTALL_PREFIX=/path/to/install
/path/to/certi-\<version\>-Source
+ ... wait for cmake run ending ... \endverbatim
+ * <li>compile your certi</li>
+ * \verbatim
+ make
+ ... wait the compilation end ... \endverbatim
+ <li> Then you may either install CERTI or build
+ a binary package that will be usable for installation</li>
+ <ul>
+ * <li>install CERTI</li>
+ * \verbatim
+ make install
+ ... wait for make install end ... \endverbatim
+ * <li>build your binary package </li>
+ * \verbatim
+ make package \endverbatim
+ </ul>
+ * </ol>
+ * After that you will have a compiled and usable CERTI package.
+ *
+ */
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [certi-cvs] certi/doc CMakeLists.txt certi_install.cnf.in c...,
certi-cvs <=