API review

Proposer: Tully Foote

Present at review:

  • List reviewers

Question / concerns / comments

Enter your thoughts on the API and any questions / concerns you have here. Please sign your name. Anything you want to address in the API review should be marked down here before the start of the meeting.

Proposed API

Returning to simple API as discussed a long time ago.


  • rosinstall ~/ros URI


  • rosinstall -u [.]


  • rosinstall --ros-root [.]


  • rosinstall --package-path [.]



  • Download rosinstall from URI and diff to local.rosinstall, prompt on conflict
  • save resolved conflicts into local.rosinstall
  • call update


  • iterate through local.rosinstall and either update or checkout
  • warn of extra paths


  • return the ROS_ROOT if defined


  • return a list of package_paths in this rosinstall file

Complementary API

Extending Josh and Eitan's work, or as another subcommand.

`rosenv setup ~/ros ~/ros_pkg ~/ros_other -d ~/misc_pkg_dir`

Where ~/ros etc are rosinstall paths, and ~/misc_pkg_dir is a directory to arbitrarily add to the path

Necessary commands:

  • generate setup from scratch (command line or file)
  • add directory
  • remove directory
  • add rosinstall directories
  • remove rosinstall directories

Meeting agenda

To be filled out by proposer based on comments gathered during API review period


Package status change mark change manifest)

  • /!\ Action items that need to be taken.

  • {X} Major issues that need to be resolved

  • Keep current rosinstall -f -o and setup.sh capabilities
  • extend reference rosdistro file and varient, pulling release-svn

  uri: http://ros.org/etc
  variant: pr2
  • future extension to list packages to pull from dev
  • feature request generate version locked version of rosinstall file
  • move --ros-root and --ros-pkg-path into future rosenv

Wiki: rosinstall/Reviews/2010-03-23_API_Review (last edited 2010-03-23 23:07:50 by TullyFoote)