关于package.xml和CMakeList.txt的解读

前言

参考来源：
—https://mp.weixin.qq.com/s/KEI2vZvV4kcT99LYv8YyFA

---

一、关于package.xml文件的讲解？

package.xml是ROS功能包的“功能包清单描述”，这文件指出了当前功能包的一些信息，比如名称啊、版本啊、描述啊、作者信息等等，最重要的是声明了编译工具、编译依赖工具、编译输出依赖和运行依赖。我们通过解读这个文件可以描述功能包的属性，包括功能包的名字、版本号、作者、维护者、通行证以及所以来的功能包。
我们这里先来看一下package.xml的原始文件，这里我以一个名为learning_cplus功能包的package.xml做出介绍。

<?xml version="1.0"?>
<!-- 当前xml版本 -->
 
<package format="2">
  
   <name>learning_cplus</name>
   <!-- 功能包名称是learning_cplus，name，名称 -->
  
   <version>0.0.0</version>
  <!-- 当前功能包版本是0.0.0，version，版本--> 
  
  <description>The learning_cplus package</description>
  <!-- 当前功能包介绍，description，详细 -->
  
  <maintainer email="waveshare@todo.todo">waveshare</maintainer>
  <!-- 当前维护者者信息（邮箱和昵称）-->
 
  <!--   BSD, MIT, Boost Software License, GPLv2, GPLv3, LGPLv2.1, LGPLv3 -->
  <license>TODO</license>
  <!-- 协议版本，默认TODO就可以。有兴趣可以自行了解。-->
 
  <!-- <url type="website">http://wiki.ros.org/learning_cplus</url> -->
  <!-- 可共享路径，你可以把你的这个包上传到ROS社区或者github。-->
 
  <author email="jane.doe@example.com">Jane Doe</author>
  <!-- 当前开发者信息（邮箱和昵称）-->
 
  <!-- The *depend tags are used to specify dependencies -->
  <!-- Dependencies can be catkin packages or system dependencies -->
  <!-- Examples: -->
  <!-- Use depend as a shortcut for packages that are both build and exec dependencies -->
  <!--   <depend>roscpp</depend> -->
  <!--   Note that this is equivalent to the following: -->
  <!--   <build_depend>roscpp</build_depend> -->
  <!--   <exec_depend>roscpp</exec_depend> -->
  <!-- Use build_depend for packages you need at compile time: -->
  <!--   <build_depend>message_generation</build_depend> -->
  <!-- Use build_export_depend for packages you need in order to build against this package: -->
  <!--   <build_export_depend>message_generation</build_export_depend> -->
  <!-- Use buildtool_depend for build tool packages: -->
  <!--   <buildtool_depend>catkin</buildtool_depend> -->
  <!-- Use exec_depend for packages you need at runtime: -->
  <!--   <exec_depend>message_runtime</exec_depend> -->
  <!-- Use test_depend for packages you need only for testing: -->
  <!--   <test_depend>gtest</test_depend> -->
  <!-- Use doc_depend for packages you need only for building documentation: -->
  <!--   <doc_depend>doxygen</doc_depend> -->
  
  <buildtool_depend>catkin</buildtool_depend>
  <!--编译工具是catkin -->
  
  <build_depend>roscpp</build_depend>
  <!--编译依赖roscpp -->
  <build_depend>rospy</build_depend>
  <!--编译依赖rospy -->
  <build_depend>std_msgs</build_depend>
  <!--编译依赖std_msgs -->
  
  <build_export_depend>roscpp</build_export_depend>
  <!--编译输出依赖roscpp -->
  <build_export_depend>rospy</build_export_depend>
  <!--编译输出依赖rospy -->
  <build_export_depend>std_msgs</build_export_depend>
  <!--编译输出依赖std_msgs -->
  
  <exec_depend>roscpp</exec_depend>
  <!--运行依赖roscpp -->
  <exec_depend>rospy</exec_depend>
  <!--运行依赖rospy -->
  <exec_depend>std_msgs</exec_depend>
  <!--运行依赖std_msgs -->
 
 
  <!-- The export tag contains other, unspecified, tags -->
  <export>
    <!-- Other tools can request additional information be placed here -->
    <!-- 输出 -->
  </export>
</package>

二、关于CMakeList.txt文件的讲解

CMakeList.txt文件是CMake编译系统编译软件包过程的输入文件。任何CMake兼容包都包含一个或多个CMakeLists.txt文件，这些文件描述了如何编译代码以及将其安装到哪里。将CMakeLists.txt文件应用于一个catkin项目时，它就作为一个标准的附带一些限制条件的vanilla CMakeLists.txt文件。使用CMake编译程序时，cmake指令依据CMakeLists.txt 文件生成makefiles文件，make命令再依据makefiles文件编译链接生成可执行文件。
catkin是ROS官方的一个编译构建系统，是原本的ROS的编译构建系统rosbuild的发展。catkin_make是将cmake与make的编译方式做了一个封装的指令工具，规范了工作路径与生成文件路径。
CMakeList.txt的一个总体结构和顺序如下。

1.必需的CMake版本：cmake_minimum_required()

代码如下（示例）：

cmake_minimum_required(VERSION 3.0.2)

2.软件包名：project()

代码如下（示例）：

project(learning_cplus)

3.查找编译依赖的其他CMake/Catkin包（声明依赖库）：find_package()

代码如下（示例）：

## Find catkin macros and libraries
## if COMPONENTS list like find_package(catkin REQUIRED COMPONENTS xyz)
## is used, also find other catkin packages
find_package(catkin REQUIRED COMPONENTS
  roscpp
  rospy
  std_msgs
)
 
## System dependencies are found with CMake's conventions
# find_package(Boost REQUIRED COMPONENTS system)

4.启动Python模块支持：catkin_python_package()

代码如下（示例）：

## Uncomment this if the package has a setup.py. This macro ensures
## modules and global scripts declared therein get installed
## See http://ros.org/doc/api/catkin/html/user_guide/setup_dot_py.html
# catkin_python_setup()