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.

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

Replace setup bag with subset bag #4049

Closed
wants to merge 152 commits into from
Closed

Replace setup bag with subset bag #4049

wants to merge 152 commits into from

Conversation

songyuc
Copy link
Contributor

@songyuc songyuc commented Dec 4, 2023

This pull request addresses a typographical error found in the ROS 2 Iron documentation, specifically in the "Reading from a bag file (C++)" tutorial. The tutorial erroneously references a "setup bag" when it should actually be "subset bag". This confusion was discussed and clarified in Issue #4048.

The correction ensures that the documentation accurately reflects the content of the tutorials, particularly where it guides users in generating and using bag files in ROS 2.

mergify bot and others added 30 commits April 28, 2023 14:07
The original Fedora installation page was written back in
the mists of time, and haven't changed a whole lot since
then.  However, the tooling to enable development of ROS 2
on Fedora *has* changed considerably (thanks in no small
part to the efforts of @cottsay).

In particular, developing on Fedora is 90% the same as
developing on RHEL, with the only difference being that
no additional repositories need to be enabled on Fedora.
So merge together the Fedora and RHEL installation
instructions.  Note that we also redirect the old
Fedora links to the RHEL installation page.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 87835ae)

Co-authored-by: Chris Lalancette <[email protected]>
* Switch to ros2-testing for pre-release testing

Signed-off-by: Yadunund <[email protected]>
Co-authored-by: Chris Lalancette <[email protected]>
…3492)

If the users follow the instructions as-is right now, they
will fail to apt update before trying to install ros-dev-tools,
which will lead to failure.  Update the instructions here
for that.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit f4b9ed2)

Co-authored-by: Chris Lalancette <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit e789cf8)

Co-authored-by: Chris Lalancette <[email protected]>
…#3499)

On arm64, rmw_connextdds doesn't exist so that one makes sense
to skip.  For amd64, it does exist but it doesn't matter if
we skip the key; the binary archive is providing it.

I'm not quite sure why iceoryx_binding_c doesn't work as a
rosdep key, but like above it doesn't matter; the binary
archive is providing it.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit c7db197)

Co-authored-by: Chris Lalancette <[email protected]>
In particular, point to the page on docs.ros.org that
shows how to use the bridge on Ubuntu Jammy.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 103a331)

Co-authored-by: Chris Lalancette <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit ccdb82e)

Co-authored-by: Chris Lalancette <[email protected]>
… (#3510)

That is, to temporarily skip packages it is probably a better
idea for people to use --packages-skip, rather than doing a
COLCON_IGNORE.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 1b6f302)

Co-authored-by: Chris Lalancette <[email protected]>
* Go directly to chocolately install page
* Bump OpenSSL version

Signed-off-by: Michael Carroll <[email protected]>
Signed-off-by: Yadunund <[email protected]>
(cherry picked from commit cb18f79)

Co-authored-by: Yadu <[email protected]>
Mostly fixups for typos.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit a3d1f50)

Co-authored-by: Chris Lalancette <[email protected]>
* Fix wildcard search for launch files

Signed-off-by: Yadunund <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit c732a25)

Co-authored-by: Yadu <[email protected]>
* Update Using-Parameters-In-A-Class-Python.rst

Updating to a more accurate description of the expected output (py).

* Update Using-Parameters-In-A-Class-CPP.rst

Updating to a more accurate description of the expected output (cpp).

(cherry picked from commit 8a6ad2f)

Co-authored-by: Mario Prats <[email protected]>
Make it more consistent with what is in the Glossary.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 045377e)

Co-authored-by: Chris Lalancette <[email protected]>
That is, give a more realistic example of the package contents
in Creating-Your-First-ROS2-Package.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 1b680f2)

Co-authored-by: Chris Lalancette <[email protected]>
We print more information nowadays, so show that in the
tutorial.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 1e44d0e)

Co-authored-by: Chris Lalancette <[email protected]>
Updating section 2.3 to remove lines that already exist in CMakeLists.txt.

(cherry picked from commit 14929e4)

Co-authored-by: Mario Prats <[email protected]>
This makes it easier for people to see what a launch file
with composition should look like.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit a3ed45c)

Co-authored-by: Chris Lalancette <[email protected]>
Updating tutorial to most recent version of turtle_tf2_listener.cpp

(cherry picked from commit 2faff8e)

Co-authored-by: Mario Prats <[email protected]>
* ros2pkg generates license warning messages.

  osrf/ros2_test_cases#954

* use `--license` option for the tutorial with ros2pkg command.

Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit f29796f)

Co-authored-by: Tomoya Fujita <[email protected]>
…3542) (#3564)

* Inform users to install zlib

Signed-off-by: Yadunund <[email protected]>
(cherry picked from commit a64e887)

Co-authored-by: Yadu <[email protected]>
(cherry picked from commit d7ac403)

Co-authored-by: Steve Macenski <[email protected]>
* Fix using-python-packages note issue

Co-authored-by: Chris Lalancette <[email protected]>
(cherry picked from commit 882713f)

Co-authored-by: Antoine Van Malleghem <[email protected]>
) (#3574)

The explanation is no longer valid.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 09c2be5)

Co-authored-by: Chris Lalancette <[email protected]>
…3575)

* Replace boolean gender field in interface tutorial (#3533)

Co-authored-by: Tomoya Fujita <[email protected]>
(cherry picked from commit 5f528a9)

Co-authored-by: Tim Player <[email protected]>
…3578)

* use --cmake-clean-cache only since it implicitly forces CMake configure step

Signed-off-by: Chen Lihui <[email protected]>
(cherry picked from commit 8d3501f)

Co-authored-by: Chen Lihui <[email protected]>
* Switch the name of the custom action interface package.

This is so we don't collide with an existing package name
in the examples.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit d0271c1)

Co-authored-by: Chris Lalancette <[email protected]>
…)" (#3583) (#3589)

* Update code references to match previous tutorials. Add hint to build before executing the launch commands.

(cherry picked from commit 551221e)

Co-authored-by: Boris Boutillier <[email protected]>
As far as I understand, docker-compose is the V1 version
of the tool (which will stop being supported in June 2023).
'docker compose' is the V2 version of the tool, which
is still supported.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 0f48507)

Co-authored-by: Chris Lalancette <[email protected]>
mergify bot and others added 20 commits October 25, 2023 16:15
Signed-off-by: Tomoya.Fujita <[email protected]>
(cherry picked from commit 8347522)

Co-authored-by: Tomoya Fujita <[email protected]>
…3978)

* Update Windows-Install-Binary.rst to include link to releases page

Previous Ros2 distros include this link in the install section of their documentation. This allows users to easily find the download page for the windows package

Signed-off-by: Quinn <[email protected]>
Co-authored-by: Chris Lalancette <[email protected]>
* Update Community representatives

Signed-off-by: Francisco Martín Rico <[email protected]>
Co-authored-by: David V. Lu!! <[email protected]>
Co-authored-by: Chris Lalancette <[email protected]>
(cherry picked from commit 83984cf)

Co-authored-by: Francisco Martín Rico <[email protected]>
In particular, do 2 things:

1.  Make the installation instructions less Linux-centric.
2.  Remove unnecessary options and explanations in the beginner
    tutorial.  Since it is for beginners, they don't need to know
    every specific.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit e405435)

Co-authored-by: Chris Lalancette <[email protected]>
This makes it look much more like the service section,
with more explanation.  It also gets rid of an inconsistency
where it was referencing a while loop that is no longer
there.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 53921ee)

Co-authored-by: Chris Lalancette <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 245730d)

Co-authored-by: Chris Lalancette <[email protected]>
* New urdf_launch usage, change to turtlebot reference

Signed-off-by: David V. Lu!! <[email protected]>
Co-authored-by: Chris Lalancette <[email protected]>
(cherry picked from commit a252fad)

Co-authored-by: David V. Lu!! <[email protected]>
* Update Installation-Troubleshooting.rst with Conda conflict

Signed-off-by: hu-po <[email protected]>
Co-authored-by: Chris Lalancette <[email protected]>
(cherry picked from commit 2468c46)

Co-authored-by: hu-po <[email protected]>
(cherry picked from commit e4c459b)

Co-authored-by: Katherine Scott <[email protected]>
* Remove incorrect text for Iron.

Signed-off-by: Chris Lalancette <[email protected]>
… documentation (#3621) (#4018)

Signed-off-by: Oren Bell <[email protected]>
Signed-off-by: Christophe Bedard <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
(cherry picked from commit b63b967)

Co-authored-by: Oren Bell <[email protected]>
* Add commands for Windows

* Remove all uses of ~

Signed-off-by: songyuc <[email protected]>
Co-authored-by: Chris Lalancette <[email protected]>
Signed-off-by: Tomoya.Fujita <[email protected]>
(cherry picked from commit b98004f)

Co-authored-by: Tomoya Fujita <[email protected]>
)

* Added new IDEs page and started filling it in for PyCharm

* Changed style of labels + Added link to Colcon build

* Added note about package dependencies

Signed-off-by: Robert <[email protected]>
Co-authored-by: Chris Lalancette <[email protected]>
(cherry picked from commit 8d6eb04)

Co-authored-by: Robert <[email protected]>
)

* add note for LoanedMessages's unsafety issue and setting.

* add redirection from previous file.

Signed-off-by: Tomoya.Fujita <[email protected]>
(cherry picked from commit 97bd9fe)

Co-authored-by: Tomoya Fujita <[email protected]>
* Added notes for VSCode

(cherry picked from commit d9c53f0)

Co-authored-by: Robert <[email protected]>
* Update Understanding-ROS2-Topics.rst

onto -> into

Signed-off-by: Breno Cabral <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 2bc462e)

Co-authored-by: Breno Cabral <[email protected]>
Signed-off-by: contradict <[email protected]>
(cherry picked from commit 8e023d1)

Co-authored-by: contradict <[email protected]>
@songyuc
Copy link
Contributor Author

songyuc commented Dec 4, 2023

Hi, @clalancette,

I would greatly appreciate it if you could take a look at this pull request and provide any further feedback or approval as needed.

Thank you for your time and guidance on this matter.

Copy link
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@songyuc can you target this PR against rolling? and then we can backport the fix to iron and humble as well. thanks!

@songyuc songyuc changed the base branch from iron to rolling December 5, 2023 06:56
@songyuc
Copy link
Contributor Author

songyuc commented Dec 5, 2023

@songyuc can you target this PR against rolling? and then we can backport the fix to iron and humble as well. thanks!

Hi, @fujitatomoya,
I tried changing the base against rolling, however, which cause a lot of files changes and conflicts.
Do I need to change it back to iron branch?

@fujitatomoya
Copy link
Collaborator

@songyuc i guess it is because https://github.com/songyuc/ros2_documentation/tree/new-feature is not rebased on rolling. can you rebase it on https://github.com/ros2/ros2_documentation/tree/rolling?

@songyuc
Copy link
Contributor Author

songyuc commented Dec 5, 2023

@songyuc i guess it is because https://github.com/songyuc/ros2_documentation/tree/new-feature is not rebased on rolling. can you rebase it on https://github.com/ros2/ros2_documentation/tree/rolling?

Yes, I can. Please give me some time to do it.

@songyuc songyuc closed this Dec 5, 2023
@songyuc songyuc deleted the new-feature branch December 5, 2023 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants