3.6 自定义你的程序包

3.6 自定义你的功能包

本部分教程将剖析catkin_create_pkg命令生成的每个文件并详细描述这些文件的组成部分以及如何自定义这些文件。

3.6.1更新 package.xml

自动生成的package.xml文件应该在你的新功能包中。

现在让我们一起来看看新生成的package.xml文件以及每一个需要你注意的标签元素。

3.6.1.1 description 标签

首先更新描述标签：

<description>The beginner_tutorials package</description>

将描述信息修改为任何你喜欢的内容，但是按照约定第一句话应该简短一些，因为它覆盖了功能包的范围。

如果用一句话难以描述完全那就需要换行了。

3.6.1.２ maintainer 标签

接下来是维护者标签：

  <!-- One maintainer tag required, multiple allowed, one person per tag -->
  <!-- Example:  -->
  <!-- <maintainer email="jane.doe@example.com">Jane Doe</maintainer> -->
  <maintainer email="user@todo.todo">user</maintainer>

这是package.xml中要求填写的一个重要标签，因为它能够让其他人联系到功能包的相关人员。至少需要填写一个维护者名称，但如果有需要的话你可以添加多个。

除了在标签里面填写维护者的名称外，还应该在标签的email属性中填写邮箱地址：

<maintainer email="you@yourdomain.tld">Your Name</maintainer>

3.6.1.３ license 标签

再接下来是许可标签，同样的也需要：

  <!-- One license tag required, multiple allowed, one license per tag -->
  <!-- Commonly used license strings: -->
  <!--   BSD, MIT, Boost Software License, GPLv2, GPLv3, LGPLv2.1, LGPLv3 -->
  <license>TODO</license>

你应该选择一种许可协议并将它填写到这里。一些常见的开源许可协议有BSD、MIT、Boost Software License、GPLv2、GPLv3、LGPLv2.1和LGPLv3。你可以在Open Source Initiative中阅读其中的若干个许可协议的相关信息。

对于本教程我们将使用BSD协议，因为ROS核心组件的剩余部分已经使用了该协议：

<license>BSD</license>

3.6.1.４ dependencies 标签

接下来的标签用来描述功能包的各种依赖项，这些依赖项分为:

build_depend
buildtool_depend
run_depend
test_depend

关于这些标签的更详细介绍请参考Catkin Dependencies相关的文档。

在之前的操作中，因为我们将std_msgs、roscpp、rospy作为catkin_create_pkg命令的参数，所以生成的依赖项看起来如下：

  <!-- The *_depend tags are used to specify dependencies -->
  <!-- Dependencies can be catkin packages or system dependencies -->
  <!-- Examples: -->
  <!-- Use build_depend for packages you need at compile time: -->
  <!--   <build_depend>genmsg</build_depend> -->
  <!-- Use buildtool_depend for build tool packages: -->
  <!--   <buildtool_depend>catkin</buildtool_depend> -->
  <!-- Use exec_depend for packages you need at runtime: -->
  <!--   <exec_depend>python-yaml</exec_depend> -->
  <!-- Use test_depend for packages you need only for testing: -->
  <!--   <test_depend>gtest</test_depend> -->
  <buildtool_depend>catkin</buildtool_depend>
  <build_depend>roscpp</build_depend>
  <build_depend>rospy</build_depend>
  <build_depend>std_msgs</build_depend>

除了catkin中默认提供的buildtool_depend，所有我们列出的依赖包都已经被添加到build_depend标签中。

在本例中，因为在编译和运行时我们需要用到所有指定的依赖包，因此还需要将每一个依赖包分别添加到run_depend标签中

  <buildtool_depend>catkin</buildtool_depend>

  <build_depend>roscpp</build_depend>
  <build_depend>rospy</build_depend>
  <build_depend>std_msgs</build_depend>

  <exec_depend>roscpp</exec_depend>
  <exec_depend>rospy</exec_depend>
  <exec_depend>std_msgs</exec_depend>

3.6.1.5 最终的package.xml

现在看下面最后去掉了注释和未使用标签后的package.xml文件就显得更加简洁了：

<?xml version="1.0"?>
<package format="2">
  <name>beginner_tutorials</name>
  <version>0.1.0</version>
  <description>The beginner_tutorials package</description>

  <maintainer email="you@yourdomain.tld">Your Name</maintainer>
  <license>BSD</license>
  <url type="website">http://wiki.ros.org/beginner_tutorials</url>
  <author email="you@yourdomain.tld">Jane Doe</author>

  <buildtool_depend>catkin</buildtool_depend>

  <build_depend>roscpp</build_depend>
  <build_depend>rospy</build_depend>
  <build_depend>std_msgs</build_depend>

  <exec_depend>roscpp</exec_depend>
  <exec_depend>rospy</exec_depend>
  <exec_depend>std_msgs</exec_depend>

</package>

3.6.2 更新 CMakeLists.txt

到此，这个包含功能包元信息的package.xml文件已经按照需要完成了裁剪整理，现在你可以继续下面的教程了。

catkin_create_pkg命令生成的CMakeLists.txt文件将在后续关于编译ROS程序代码的教程中讲述。

现在你已经创建了一个新的ROS功能包，接下来我们开始编译这个功能包

Previous3.5 程序包依赖关系 Next4 编译ROS程序包(packages)

Last updated 7 years ago