Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FIx license snippets on package.xml and setup.py (backport #4395) #4396

Merged
merged 1 commit into from
May 8, 2024
Merged

FIx license snippets on package.xml and setup.py (backport #4395) #4396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Packages.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ Here is the content of those three files:
<version>0.0.0</version>
<description>talker</description>
<maintainer email="[email protected]">Brian Gerkey</maintainer>
<license>Apache 2.0</license>
<license>Apache-2.0</license>
<buildtool_depend>catkin</buildtool_depend>
<build_depend>roscpp</build_depend>
<build_depend>std_msgs</build_depend>
Expand Down Expand Up @@ -617,7 +617,7 @@ Putting it all together, our ``package.xml`` now looks like this:
<version>0.0.0</version>
<description>talker</description>
<maintainer email="[email protected]">Brian Gerkey</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>
<!-- <buildtool_depend>catkin</buildtool_depend> -->
<buildtool_depend>ament_cmake</buildtool_depend>
<!-- <build_depend>roscpp</build_depend> -->
Expand Down
2 changes: 1 addition & 1 deletion source/How-To-Guides/Using-Variants.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To do so you need only create two files:
<version>1.0.0</version>
<description>A package to aggregate all packages in my_project.</description>
<maintainer email="maintainer-email">Maintainer Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>
<!-- packages in my_project -->
<exec_depend>my_project_msgs</exec_depend>
<exec_depend>my_project_services</exec_depend>
Expand Down
2 changes: 1 addition & 1 deletion source/Tutorials/Advanced/Recording-A-Bag-From-Your-Own-Node-CPP.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ As always, though, make sure to add the description, maintainer email and name,

<description>C++ bag writing tutorial</description>
<maintainer email="[email protected]">Your Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>

2 Write the C++ node
^^^^^^^^^^^^^^^^^^^^
Expand Down
4 changes: 2 additions & 2 deletions source/Tutorials/Advanced/Recording-A-Bag-From-Your-Own-Node-Py.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ As always, though, make sure to add the description, maintainer email and name,

<description>Python bag writing tutorial</description>
<maintainer email="[email protected]">Your Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>

Also be sure to add this information to the ``setup.py`` file as well.

Expand All @@ -82,7 +82,7 @@ Also be sure to add this information to the ``setup.py`` file as well.
maintainer='Your Name',
maintainer_email='[email protected]',
description='Python bag writing tutorial',
license='Apache License 2.0',
license='Apache-2.0',

2 Write the Python node
^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
4 changes: 2 additions & 2 deletions source/Tutorials/Beginner-Client-Libraries/Creating-Your-First-ROS2-Package.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,11 +461,11 @@ Then, edit the ``description`` line to summarize the package:
Then, update the ``license`` line.
You can read more about open source licenses `here <https://opensource.org/licenses/alphabetical>`__.
Since this package is only for practice, it's safe to use any license.
We'll use ``Apache License 2.0``:
We'll use ``Apache-2.0``:

.. code-block:: xml

<license>Apache License 2.0</license>
<license>Apache-2.0</license>

Don't forget to save once you're done editing.

Expand Down
2 changes: 1 addition & 1 deletion source/Tutorials/Beginner-Client-Libraries/Using-Parameters-In-A-Class-CPP.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ As always, though, make sure to add the description, maintainer email and name,

<description>C++ parameter tutorial</description>
<maintainer email="[email protected]">Your Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>

2 Write the C++ node
^^^^^^^^^^^^^^^^^^^^
Expand Down
4 changes: 2 additions & 2 deletions source/Tutorials/Beginner-Client-Libraries/Using-Parameters-In-A-Class-Python.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ As always, though, make sure to add the description, maintainer email and name,

<description>Python parameter tutorial</description>
<maintainer email="[email protected]">Your Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>

2 Write the Python node
^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -194,7 +194,7 @@ Again, match the ``maintainer``, ``maintainer_email``, ``description`` and ``lic
maintainer='YourName',
maintainer_email='[email protected]',
description='Python parameter tutorial',
license='Apache License 2.0',
license='Apache-2.0',

Add the following line within the ``console_scripts`` brackets of the ``entry_points`` field:

Expand Down
2 changes: 1 addition & 1 deletion ...als/Beginner-Client-Libraries/Writing-A-Simple-Cpp-Publisher-And-Subscriber.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ As mentioned in the :doc:`previous tutorial <./Creating-Your-First-ROS2-Package>

<description>Examples of minimal publisher/subscriber using rclcpp</description>
<maintainer email="[email protected]">Your Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>

Add a new line after the ``ament_cmake`` buildtool dependency and paste the following dependencies corresponding to your node's include statements:

Expand Down
2 changes: 1 addition & 1 deletion ...Tutorials/Beginner-Client-Libraries/Writing-A-Simple-Cpp-Service-And-Client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ As always, though, make sure to add the description, maintainer email and name,

<description>C++ client server tutorial</description>
<maintainer email="[email protected]">Your Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>


2 Write the service node
Expand Down
4 changes: 2 additions & 2 deletions ...ials/Beginner-Client-Libraries/Writing-A-Simple-Py-Publisher-And-Subscriber.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ As mentioned in the :doc:`previous tutorial <./Creating-Your-First-ROS2-Package>

<description>Examples of minimal publisher/subscriber using rclpy</description>
<maintainer email="[email protected]">Your Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>

After the lines above, add the following dependencies corresponding to your node's import statements:

Expand All @@ -245,7 +245,7 @@ Again, match the ``maintainer``, ``maintainer_email``, ``description`` and ``lic
maintainer='YourName',
maintainer_email='[email protected]',
description='Examples of minimal publisher/subscriber using rclpy',
license='Apache License 2.0',
license='Apache-2.0',

Add the following line within the ``console_scripts`` brackets of the ``entry_points`` field:

Expand Down
4 changes: 2 additions & 2 deletions .../Tutorials/Beginner-Client-Libraries/Writing-A-Simple-Py-Service-And-Client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ As always, though, make sure to add the description, maintainer email and name,

<description>Python client server tutorial</description>
<maintainer email="[email protected]">Your Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>

1.2 Update ``setup.py``
~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -84,7 +84,7 @@ Add the same information to the ``setup.py`` file for the ``maintainer``, ``main
maintainer='Your Name',
maintainer_email='[email protected]',
description='Python client server tutorial',
license='Apache License 2.0',
license='Apache-2.0',

2 Write the service node
^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion source/Tutorials/Intermediate/Monitoring-For-Parameter-Changes-CPP.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ As always, though, make sure to add the description, maintainer email and name,

<description>C++ parameter events client tutorial</description>
<maintainer email="[email protected]">Your Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>

2 Write the C++ node
^^^^^^^^^^^^^^^^^^^^
Expand Down
4 changes: 2 additions & 2 deletions source/Tutorials/Intermediate/Monitoring-For-Parameter-Changes-Python.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ As always, though, make sure to add the description, maintainer email and name,

<description>Python parameter events client tutorial</description>
<maintainer email="[email protected]">Your Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>

2 Write the Python node
^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -172,7 +172,7 @@ Again, match the ``maintainer``, ``maintainer_email``, ``description`` and ``lic
maintainer='YourName',
maintainer_email='[email protected]',
description='Python parameter tutorial',
license='Apache License 2.0',
license='Apache-2.0',

Add the following line within the ``console_scripts`` brackets of the ``entry_points`` field:

Expand Down
2 changes: 1 addition & 1 deletion source/Tutorials/Intermediate/Tf2/Writing-A-Tf2-Static-Broadcaster-Cpp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ As mentioned in the :doc:`Create a package <../../Beginner-Client-Libraries/Crea

<description>Learning tf2 with rclcpp</description>
<maintainer email="[email protected]">Your Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>

Make sure to save the file.

Expand Down
2 changes: 1 addition & 1 deletion source/Tutorials/Intermediate/Tf2/Writing-A-Tf2-Static-Broadcaster-Py.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ As mentioned in the :doc:`Create a package <../../Beginner-Client-Libraries/Crea

<description>Learning tf2 with rclpy</description>
<maintainer email="[email protected]">Your Name</maintainer>
<license>Apache License 2.0</license>
<license>Apache-2.0</license>

After the lines above, add the following dependencies corresponding to your node’s import statements:

Expand Down
Loading