diff --git a/.mailmap b/.mailmap new file mode 100644 index 0000000000000000000000000000000000000000..be65edfe08244c5cb04935c6f525308f5936d2e6 --- /dev/null +++ b/.mailmap @@ -0,0 +1,39 @@ +# +# This list is used by git-shortlog to fix a few botched name translations +# in the git archive, either because the author's full name was messed up +# and/or not always written the same way, making contributions from the +# same person appearing not to be so or badly displayed. + +Anthony Mallet <anthony.mallet@laas.fr> + +Olivier Stasse <grxuser@jrl005.a01.aist.go.jp> +Olivier Stasse <olivier.stasse@aist.go.jp> +Olivier Stasse <stasse@dhcpt1243.a02.aist.go.jp> +Olivier Stasse <stasse@jrl005.a01.aist.go.jp> +Olivier Stasse <olivier.stasse@aist.go.jp> +Olivier Stasse <stasse@stasse-laptop.(none)> +Olivier Stasse <olivier.stasse@aist.go.jp> +Olivier Stasse <stasse@dhcpt1059.a02.aist.go.jp> +Olivier Stasse <stasse@jrl005.a01.aist.go.jp> +Olivier Stasse <stasse@jrl005.a02.aist.go.jp> +Olivier Stasse <olivier.stasse@aist.go.jp> +Olivier Stasse <stasse@jrl006.(none)> +Olivier Stasse <stasse@stasse-laptop.(none)> + + +Nicolas Mansard <nmansard@devgiri.(none)> +Nicolas Mansard <nmansard@jorasse.(none)> +Nicolas Mansard <nmansard@laas.fr> + + +Florent Lamiraux <florent@big-laptop.(none)> +Florent Lamiraux <florent@dhcpt1253.a02.aist.go.jp> +Florent Lamiraux <florent@florent-laptop.laas.fr> +Florent Lamiraux <florent@florent-laptop.(none)> +Florent Lamiraux <florent@laas.fr> +Florent Lamiraux <Florent Lamiraux florent@laas.fr> +Florent Lamiraux <florent@florent-laptop.(none)> +Florent Lamiraux <Florent Lamiraux florent@laas.fr> +Florent Lamiraux <florent@localhost.localdomain> +Florent Lamiraux <florent@poullenc.laas.fr> +Florent Lamiraux <florent@poullenc.(none)> diff --git a/debian/control b/debian/control index 9eca5ec3797f3f55fea89cf238d2b4a252ae9e69..8b0e4c146a01f5f7f1d8463a3bbb54e4085890b5 100644 --- a/debian/control +++ b/debian/control @@ -4,6 +4,7 @@ Maintainer: Thomas Moulard <thomas.moulard@gmail.com> Build-Depends: debhelper (>= 7.0.50~), cmake (>= 2.6), doxygen (>= 1.6.3), pkg-config (>= 0.22), + perl (>= 5.10.1), libboost-dev (>= 1.33.1), libboost-thread-dev (>= 1.33.1) Standards-Version: 3.8.4 diff --git a/debian/libdynamic-graph1.0.0.99.install b/debian/libdynamic-graph1.0.0.99.install index 351a815f53ab8096d729a3f6f92c65c6db8ff9ce..df696c1e2acb68204e8f5a3b530c87a93428aee4 100644 --- a/debian/libdynamic-graph1.0.0.99.install +++ b/debian/libdynamic-graph1.0.0.99.install @@ -1,3 +1,4 @@ usr/bin/* usr/lib/*.so.* usr/lib/plugin/*.so +usr/share/man/* diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 57f97849a1e7a43f8a278e599c0063155908ab16..bd3aa9bb9c676b4708f0f9de41ea10c3ba2c2563 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,32 +1,73 @@ -# -# Copyright -# +# Copyright 2010, Olivier Stasse, JRL, CNRS/AIST +# +# This file is part of dynamic-graph. +# dynamic-graph is free software: you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public License +# as published by the Free Software Foundation, either version 3 of +# the License, or (at your option) any later version. +# +# dynamic-graph is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Lesser Public License for more details. You should have +# received a copy of the GNU Lesser General Public License along with +# dynamic-graph. If not, see <http://www.gnu.org/licenses/>. -# Configure package.dox file -CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/package.dox.cmake - ${CMAKE_CURRENT_BINARY_DIR}/package.dox -) +# MANPAGE +# ------- +# +# Generate a pod man page from a template, then +# generate the man page and compress it. +# This macro also adds the installation rules. +# +MACRO(MANPAGE NAME) + FIND_PROGRAM(POD2MAN pod2man) + CONFIGURE_FILE(${NAME}.pod.in ${NAME}.pod @ONLY) + ADD_CUSTOM_COMMAND( + OUTPUT ${NAME}.1 + COMMAND ${POD2MAN} --section=1 + --center="LOCAL USER COMMANDS" + --release ${PROJECT_NAME} ${NAME}.pod + > ${NAME}.1 + DEPENDS ${BUILD_DIR}/${NAME}.pod) -ADD_CUSTOM_COMMAND(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/html/index.html - COMMAND ${DOXYGEN_EXECUTABLE} \"${CMAKE_CURRENT_BINARY_DIR}/package.dox\" -) + ADD_CUSTOM_COMMAND( + OUTPUT ${NAME}.1.gz + COMMAND gzip -c ${NAME}.1 > ${NAME}.1.gz + DEPENDS ${BUILD_DIR}/${NAME}.1) + INSTALL(FILES ${BUILD_DIR}/${NAME}.1.gz DESTINATION share/man/man1) +ENDMACRO(MANPAGE) -ADD_CUSTOM_TARGET(documentation ALL - DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html/index.html) -# -# Install html documentation -# -# html files -INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html - DESTINATION share/doc/dynamic-graph) +SET(BUILD_DIR ${CMAKE_BINARY_DIR}/doc) + +SET(DOCDIR share/doc/${PROJECT_NAME}) +SET(HTMLDIR ${DOCDIR}/html) + +# Add `doc' target. +ADD_CUSTOM_TARGET( + doc ALL + DEPENDS html/index.html dg-shell.1.gz dg-shell-plugin.1.gz) + + +# Generate Doxygen configuration file. +CONFIGURE_FILE(package.dox.cmake package.dox) + +# Generating the Doxygen documentation +ADD_CUSTOM_COMMAND( + OUTPUT html/index.html + COMMAND ${DOXYGEN_EXECUTABLE} package.dox + COMMENT Generating Doxygen documentation +) + +# Doxygen documentation installation rules. +INSTALL(DIRECTORY ${BUILD_DIR}/html DESTINATION ${DOCDIR}) +INSTALL(FILES ${BUILD_DIR}/${PROJECT_NAME}.doxytag DESTINATION ${HTMLDIR}) +INSTALL(DIRECTORY pictures DESTINATION ${HTMLDIR}) -# doxytag -INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.doxytag - DESTINATION share/doc/dynamic-graph/html) -# pictures -INSTALL(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/pictures - DESTINATION share/doc/dynamic-graph/html) +# Man page generation. +MANPAGE(dg-shell) +MANPAGE(dg-shell-plugin) diff --git a/doc/dg-shell-plugin.pod.in b/doc/dg-shell-plugin.pod.in new file mode 100644 index 0000000000000000000000000000000000000000..1c09563f6d87775f82507468fa14b7fdfd44b308 --- /dev/null +++ b/doc/dg-shell-plugin.pod.in @@ -0,0 +1,26 @@ +=head1 NAME + +dg-shell-plugin - Stack of tasks shell with all plug-ins loaded + + +=head1 SYNOPSIS + +dg-shell-plugin + + +=head1 DESCRIPTION + +Start the stack of tasks with all core plug-ins loaded. + +=head1 AUTHORS + +This software has been developed at CNRS/AIST and LAAS-CNRS laboratories. + +See <@CMAKE_INSTALL_PREFIX@/share/doc/libdg-middleware-dev/AUTHORS> to +see the list of all contributors. + + +=head1 SEE ALSO + dg-shell(1) + +See also <@PROJECT_URL@> for additional resources. diff --git a/doc/dg-shell.pod.in b/doc/dg-shell.pod.in new file mode 100644 index 0000000000000000000000000000000000000000..28341a7f56c15f738aa874c706378a1f5c95a027 --- /dev/null +++ b/doc/dg-shell.pod.in @@ -0,0 +1,31 @@ +=head1 NAME + +dg-shell - Stack of tasks shell + + +=head1 SYNOPSIS + +dg-shell [FILE] + + +=head1 DESCRIPTION + +Start the stack of tasks and provides to the user an interactive shell +to control the data-flow. + +Optionally, a file which will be interpreted at start-up can be given +to the program. + + +=head1 AUTHORS + +This software has been developed at CNRS/AIST and LAAS-CNRS laboratories. + +See <@CMAKE_INSTALL_PREFIX@/share/doc/libdg-middleware-dev/AUTHORS> to +see the list of all contributors. + + +=head1 SEE ALSO + dg-shell-plugin(1) + +See also <@PROJECT_URL@> for additional resources. diff --git a/tools/CMakeLists.txt b/tools/CMakeLists.txt index 0fded757c31c82d3ae49c0558d1cc91d99f8a583..f2b85f70f02880914bb065f5b842af6b13082b0c 100644 --- a/tools/CMakeLists.txt +++ b/tools/CMakeLists.txt @@ -1,22 +1,30 @@ +# Copyright 2010, Olivier Stasse, JRL, CNRS/AIST # -# Copyright +# This file is part of dynamic-graph. +# dynamic-graph is free software: you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public License +# as published by the Free Software Foundation, either version 3 of +# the License, or (at your option) any later version. # - -### tools -SET(tools - sot-shell -) - -### Configure shell launch script -CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/sot-shell-plugin.cmake - ${${PROJECT_NAME}_BINARY_DIR}/tools/sot-shell-plugin) +# dynamic-graph is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Lesser Public License for more details. You should have +# received a copy of the GNU Lesser General Public License along with +# dynamic-graph. If not, see <http://www.gnu.org/licenses/>. + +SET(tools dg-shell) + +# Configure shell launch script. +CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/dg-shell-plugin.cmake + ${${PROJECT_NAME}_BINARY_DIR}/tools/dg-shell-plugin) INSTALL( FILES - ${${PROJECT_NAME}_BINARY_DIR}/tools/sot-shell-plugin + ${${PROJECT_NAME}_BINARY_DIR}/tools/dg-shell-plugin DESTINATION bin PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ - GROUP_EXECUTE GROUP_READ ) + GROUP_EXECUTE GROUP_READ) FOREACH(tool_name ${tools}) SET(EXECUTABLE_NAME ${tool_name}) diff --git a/tools/sot-shell-plugin.cmake b/tools/dg-shell-plugin.cmake similarity index 85% rename from tools/sot-shell-plugin.cmake rename to tools/dg-shell-plugin.cmake index 6cb924858d52cdfed3f34db6607fdffaf28227ad..5a680046db9175682828f7ae9f099841b94f6807 100644 --- a/tools/sot-shell-plugin.cmake +++ b/tools/dg-shell-plugin.cmake @@ -3,4 +3,4 @@ tmp=`mktemp` echo "-- Launching dynamic-graph C shell with default plugins" echo "loadPlugin ${CMAKE_INSTALL_PREFIX}/lib/plugin/shell-functions.so" > $tmp echo "loadPlugin ${CMAKE_INSTALL_PREFIX}/lib/plugin/shell-procedure.so" >> $tmp -${CMAKE_INSTALL_PREFIX}/bin/sot-shell $tmp +${CMAKE_INSTALL_PREFIX}/bin/dg-shell $tmp diff --git a/tools/sot-shell.cpp b/tools/dg-shell.cpp similarity index 100% rename from tools/sot-shell.cpp rename to tools/dg-shell.cpp