Skip to content

Commit

Permalink
Update code style guide for stricter package.xml specification
Browse files Browse the repository at this point in the history
  • Loading branch information
gizatt committed Oct 10, 2017
1 parent 7880a9b commit b747a09
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions drake/doc/code_style_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,10 @@ When adding a model to Drake
(typically in `drake-distro/drake/examples/ <https://github.com/RobotLocomotion/drake/tree/master/drake/examples>`_),
you will need to add a ``package.xml`` file to the example's directory to enable
modeling files like URDF and SDF to refer to resources like mesh files contained
within the example's directory. While a full ``package.xml`` file that contains
every `required field <http://wiki.ros.org/catkin/package.xml#Required_Tags>`_
would be ideal, for Drake's purposes, the following minimal ``package.xml`` file
is sufficient::
within the example's directory. Please ensure that your ``package.xml`` file
contains every
`required field <http://wiki.ros.org/catkin/package.xml#Required_Tags>`_.
The following minimal ``package.xml`` file can get you started::

<!--
This XML file is used by:
Expand All @@ -181,6 +181,12 @@ is sufficient::

<package format="2">
<name>package_name</name>
<version>0.0.0</version>
<description>
A description of your package.
</description>
<maintainer email="[email protected]">Drake Users</maintainer>
<license>BSD</license>
</package>

In the above example, replace "package_name" with the name of your package. This
Expand Down

0 comments on commit b747a09

Please sign in to comment.