adding a script which cleans up build spaces

Author: markusgft

ct/build_ct.sh

@@ -19,7 +19,6 @@ if [ -d "../$1" ]; then
   echo "Building with the following flags ... "
   printf '%s\n' "${build_flags[@]}"
 
-  make clean
   cmake .. ${build_flags[*]}
   make -j4
   sudo make install  >/dev/null

ct/build_doc.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+build_doc(){
+# if module directory exists
+if [ -d "../$1" ]; then  
+
+  echo " === Starting doc for module " $1 " === "
+  # go to that module
+  cd ../$1  
+  echo "Current directory is " $PWD
+
+  # make and go to build directory
+  mkdir -p build && cd build
+  
+  cmake .. 
+  make doc
+  cd ..
+  echo " === completed doc for " $1 "."
+else
+    echo "ERROR: an error occurred during building the doc."
+    exit 1
+fi
+}
+
+## get current folder and make sure it is *ct*
+curr_folder=${PWD##*/}
+if [ $curr_folder != "ct" ]; then
+    echo "ERROR: you need to start the doc build from the control-toolbox/ct directory."
+    exit 1
+fi
+
+
+build_doc ct_core 
+build_doc ct_optcon
+build_doc ct_rbd
+build_doc ct_models
+build_doc ct_doc
+
+exit 0

ct/clean_ct.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+clean_module(){
+# if module directory exists
+if [ -d "../$1" ]; then  
+
+  echo "Now cleaning module " $1 " ... "
+  # go to that module
+  cd ../$1  
+
+  # make and go to build directory
+  mkdir -p build && cd build
+  rm -r -f *
+  cd ..
+else
+    echo "ERROR: an error occurred during cleaning. Try cleaning manually."
+    exit 1
+fi
+}
+
+## get current folder and make sure it is *ct*
+curr_folder=${PWD##*/}
+if [ $curr_folder != "ct" ]; then
+    echo "ERROR: you need to start the cleaner from the control-toolbox/ct directory."
+    exit 1
+fi
+
+clean_module ct_core
+clean_module ct_optcon
+clean_module ct_rbd
+clean_module ct_models
+clean_module ct_doc
+
+exit 0

ct_doc/CMakeLists.txt

@@ -20,11 +20,10 @@ if(DOXYGEN_FOUND)
         COMMAND ${CMAKE_COMMAND} -E echo_append "Building API Documentation..."
         COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile}
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doc
-        COMMAND ${CMAKE_COMMAND} -E echo_append "API Documentation built in ${CMAKE_CURRENT_SOURCE_DIR}/doc"
-#       COMMAND sensible-browser ${CMAKE_CURRENT_SOURCE_DIR}/doc/html/index.html
+        COMMAND ${CMAKE_COMMAND} -E echo_append "API Documentation built in ${CMAKE_CURRENT_SOURCE_DIR}/doc ."
+        COMMAND sensible-browser ${CMAKE_CURRENT_SOURCE_DIR}/doc/html/index.html
         VERBATIM)
 
-    install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doc/html DESTINATION share/ct_doc/doc)
 endif()
 
 

ct_doc/doc/ct_doc.doxyfile

@@ -44,7 +44,7 @@ PROJECT_NUMBER         = 3.0.1
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = ""
+PROJECT_BRIEF          = "  - 3.0.1 Documentation"
 
 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
 # the documentation. The maximum height of the logo should not exceed 55 pixels

ct_models/doc/CMakeLists.txt

@@ -6,8 +6,6 @@ if(DOXYGEN_FOUND)
         COMMAND ${CMAKE_COMMAND} -E echo_append "Building API Documentation..."
         COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile_in}
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        COMMAND ${CMAKE_COMMAND} -E echo_append "API Documentation built in ${CMAKE_CURRENT_SOURCE_DIR}"
+        COMMAND ${CMAKE_COMMAND} -E echo_append "API Documentation built in ${CMAKE_CURRENT_SOURCE_DIR} ."
         VERBATIM)
-
-    install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/html DESTINATION share/ct_models/doc)
 endif()

ct_optcon/doc/CMakeLists.txt

@@ -10,5 +10,4 @@ if(DOXYGEN_FOUND)
         COMMAND ${CMAKE_COMMAND} -E echo_append "API Documentation built in ${CMAKE_CURRENT_SOURCE_DIR}"
         VERBATIM)
 
-    install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/html DESTINATION share/ct_optcon/doc)
 endif()

ct_rbd/doc/CMakeLists.txt

@@ -9,5 +9,4 @@ if(DOXYGEN_FOUND)
     COMMAND ${CMAKE_COMMAND} -E echo_append "API Documentation built in ${CMAKE_CURRENT_SOURCE_DIR}"
     VERBATIM)
 
-    install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/html DESTINATION share/ct_rbd/doc)
 endif()