关于catkin_make中出现的问题记录

关于catkin_make中出现的问题记录

catkin_make最先被编译的是那个在src下的公用的CMakeList.txt文件(即根目录src下带锁的CMakeLists.txt)
这个文件的大部分内容都是在找catkin这个包的位置。最后执行一个cmake函数catkin_workspace。这个函数在/opt/ros/kinetic/share/catkin/cmake/catkin_workspace.cmake文件中定义。这个函数对catkin_make执行时的参数进行解析，比如CATKIN_WHITELIST_PACKAGES。然后开始遍历工作空间中的文件夹，如果文件夹中有package.xml文件就将其当作一个软件包。同时对每个软件包调用add_subdirectory。add_subdirectory是一个cmake的内置函数，会调用这个文件夹内的CMakeList.txt文件。这样就开始了每个软件包的编译了。
所以如果catkin_make本身出了问题就要在这个过程中去Debug。

软件包编译过程：
首先是指明cmake版本，项目名称，软件包依赖之类的常见操作。然后执行了catkin_package这个函数。这个函数做了大量的工作。catkin_package在/opt/ros/kinetic/share/catkin/cmake/catkin_package.cmake文件中定义。devel和build文件夹内的内容基本都是由其生成的。
这个函数解析package.xml文件，提取出里面的参数，由这些参数给find_package和pkg-config生成对应的配置文件。这样其他的对这个软件包有依赖的程序就可以方便的使用了。
所以需要重点分析的就是catkin_package这个函数。
对于编译程序最重要的就是头文件的位置和链接库的位置。也就是include directory 和 library directory。这个函数就是在为软件包配置这些参数。它自动的根据依赖关系把依赖的程序的头文件和链接库目录加入到当前的变量中。然后根据这些参数和对应的模板文件生成对应的配置文件。比如根据/opt/ros/kinetic/share/catkin/cmake/templates/pkgConfig.cmake.in生成软件包的pkgConfig.cmake文件。这样这个软件包就可以被其他的软件包用find_package找到。
如果在编译过程中发现有软件包的路径出了问题，那么就要在这个过程去debug。很有可能是生产pkgConfig.cmake时的参数不对。最终可能是依赖包中的软件包路径问题(有挺多的ros软件包都是把路径写死的，这样很不好)。

bin内是被编译的可执行文件。lib是pkg.pc文件和python的库文件。pkg.pc是pkg-config的配置文件(关于pkg-config可以看另外一篇帖子)。 include用来放置头文件。 share是放置生成的pkgConfig.cmake文件的，在cmake文件中find_package就会用到这些文件

总结整个编译的过程

1. 执行catkin_make
2. 执行catkin_workspace。解析catkin_make的参数同时遍历整个工作空间把所有的有package.xml的文件夹添加进软件包列表里面。对每个软件包执行add_subdirectory
3. 执行每个软件包内部的CMakeList.txt文件。
4. 执行 catkin_package。解析package.xml文件，载入对应的参数。根据依赖参数，载入对应的软件包参数。根据载入参数生成当前软件包的配置文件。

catkin_package(…) 在做什么
DEPENDS 和 CATKIN_DEPENDS 用来告诉 catkin 需要将你程序包的哪些依赖项传递给使用 find_package(…) 查找你的程序包的程序包。
find_package 是 cmake 中常见的宏，用于加载 catkin 宏和指定对其他 ROS 功能包的依赖关系，完成找头文件和库的目的。
catkin_package 宏是 catkin 的宏之一，声明要传递给依赖项目的内容，生成 cmake 配置文件。也就是说它对依赖于此功能包的其他功能包来说具有重要作用。用于为catkin提供构建、生成pkg-config和CMake文件所需要的信息。
有五个参数可选：
INCLUDE_DIRS - 声明给其它package的include路径
LIBRARIES - 声明给其它package的库
CATKIN_DEPENDS - 本包依赖的catkin package
DEPENDS - 本包依赖的非catkin package
CFG_EXTRAS - 其它配置参数
当前我的DEPENS包含了Boost库，当其他功能包调用这个功能包也需要Boost库的时候，就可以不需要再find_package(Boost).但是如果功能包明确需要使用库的话，仍然建议显式寻找库find_package(Boost)，而不是通过包含其他功能包隐式寻找，这么做的目的是避免其他功能包修改依赖项导致功能包编译失败。