-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Improve rosdep: 1) Friendlier to beginners, 2) Clarifying rosdep is ROS-agnostic #3719
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
overall, i am good to take this improvement, probably we can keep this open for more feedback.
406efbc
to
e7d4f3a
Compare
32447af
to
4bc3c18
Compare
@130s FYI, I spent some time and cleaned this up to be closer to what I think it should look like. What I did was to get rid of the separate "define_dependencies" file, and moved that content into Rosdep.rst. Once that was done, there was no need to move the Rosdep file, so I moved that back to its original location. Then I went through and did a bunch of editing, cleaning things up so most of the information is there but in a different order. I think I've preserved the essence of what you've done, but please take a look and let me know what you think. |
:local: | ||
|
||
Author: Steve Macenski | ||
|
||
This tutorial will explain how to manage external dependencies using ``rosdep``. | ||
|
||
What is rosdep? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider adding a why as well. The motivation for rosdep
isn't always clear, leading to questions such as why rosdep instead of others? and When should I use rosdep and when should I use apt or pip?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added a couple of sentences about this in fcdc39d . Let me know what you think.
4bc3c18
to
fcdc39d
Compare
@clalancette I "approved" (if there were a button I'd hit it). Thanks for cleaning my PR. In one of the links @gavanderhoorn referred to, I found that there's yet another good set of documentation about |
Yes, good point. That is independent of any ROS distributions, so we can include a link here. I'll find a place to put it. |
- Avoid giving an impression that `rosdep` is ros-dependent. It is actually widely applicable than ROS projects. - This matters IMO where the development involves non-ROS environment e.g. corporate, where people tend to end up inventing their own dependency management framework that runs alongside of `rosdep`, resulted in `rosdep` not being contributed. - Trying to make it friendlier to non-expert readers by clarifyig `rosdistro` website and some jargons. - Explanation of `<*depend>` is missing in ros2 doc set. Something detailed like http://docs.ros.org/en/melodic/api/catkin/html/howto/format2/catkin_library_dependencies.html - Thought I'd add those in here but ran out of time. I don't know if rosdep page is the best for such info anyways.
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Chris Lalancette <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
fcdc39d
to
4fbf3dd
Compare
…OS-agnostic (#3719) * Improve: rosdep - Avoid giving an impression that `rosdep` is ros-dependent. It is actually widely applicable than ROS projects. - This matters IMO where the development involves non-ROS environment e.g. corporate, where people tend to end up inventing their own dependency management framework that runs alongside of `rosdep`, resulted in `rosdep` not being contributed. - Trying to make it friendlier to non-expert readers by clarifyig `rosdistro` website and some jargons. - Explanation of `<*depend>` is missing in ros2 doc set. Something detailed like http://docs.ros.org/en/melodic/api/catkin/html/howto/format2/catkin_library_dependencies.html - Thought I'd add those in here but ran out of time. I don't know if rosdep page is the best for such info anyways. * Improve: rosdep: Add link to detail about the types of dependency Co-authored-by: Tomoya Fujita <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> (cherry picked from commit 00e2140)
…OS-agnostic (#3719) * Improve: rosdep - Avoid giving an impression that `rosdep` is ros-dependent. It is actually widely applicable than ROS projects. - This matters IMO where the development involves non-ROS environment e.g. corporate, where people tend to end up inventing their own dependency management framework that runs alongside of `rosdep`, resulted in `rosdep` not being contributed. - Trying to make it friendlier to non-expert readers by clarifyig `rosdistro` website and some jargons. - Explanation of `<*depend>` is missing in ros2 doc set. Something detailed like http://docs.ros.org/en/melodic/api/catkin/html/howto/format2/catkin_library_dependencies.html - Thought I'd add those in here but ran out of time. I don't know if rosdep page is the best for such info anyways. * Improve: rosdep: Add link to detail about the types of dependency Co-authored-by: Tomoya Fujita <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> (cherry picked from commit 00e2140)
…OS-agnostic (#3719) (#3820) * Improve: rosdep - Avoid giving an impression that `rosdep` is ros-dependent. It is actually widely applicable than ROS projects. - This matters IMO where the development involves non-ROS environment e.g. corporate, where people tend to end up inventing their own dependency management framework that runs alongside of `rosdep`, resulted in `rosdep` not being contributed. - Trying to make it friendlier to non-expert readers by clarifyig `rosdistro` website and some jargons. - Explanation of `<*depend>` is missing in ros2 doc set. Something detailed like http://docs.ros.org/en/melodic/api/catkin/html/howto/format2/catkin_library_dependencies.html - Thought I'd add those in here but ran out of time. I don't know if rosdep page is the best for such info anyways. * Improve: rosdep: Add link to detail about the types of dependency Co-authored-by: Tomoya Fujita <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> (cherry picked from commit 00e2140) Co-authored-by: Isaac Saito <[email protected]>
…OS-agnostic (#3719) (#3821) * Improve: rosdep - Avoid giving an impression that `rosdep` is ros-dependent. It is actually widely applicable than ROS projects. - This matters IMO where the development involves non-ROS environment e.g. corporate, where people tend to end up inventing their own dependency management framework that runs alongside of `rosdep`, resulted in `rosdep` not being contributed. - Trying to make it friendlier to non-expert readers by clarifyig `rosdistro` website and some jargons. - Explanation of `<*depend>` is missing in ros2 doc set. Something detailed like http://docs.ros.org/en/melodic/api/catkin/html/howto/format2/catkin_library_dependencies.html - Thought I'd add those in here but ran out of time. I don't know if rosdep page is the best for such info anyways. * Improve: rosdep: Add link to detail about the types of dependency Co-authored-by: Tomoya Fujita <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> (cherry picked from commit 00e2140) Co-authored-by: Isaac Saito <[email protected]>
Current rendition is great, then I noticed there might be some more things the beginners and experienced
rosdep
users like to know.Issue
rosdep
is ros-dependent. It is actually widely applicable in non-ROS projects.rosdep
being non-ros dependent matters IMO where the development involves non-ROS environment e.g. corporate, where people tend to end up inventing their own dependency management framework that runs alongside ofrosdep
, resulted inrosdep
not receiving contribution.rosdistro
website and some jargons.<*depend>
is missing.Solution approach
rosdep
is ros-dependent. It is actually widely applicable than ROS projects.rosdistro
website and some jargons.