API review

Proposer: Brian Gerkey

Present at review:

  • List reviewers


Goal: provide a way to install a built ROS tree, mirroring standard UNIX installation patterns as much as possible.


  • Installed tree is minimal (excludes unnecessary files)
  • rpath linkage is corrected during installation
  • The resulting installed tree will be amenable for inclusion into OS package managers (e.g., Ubuntu's .deb repo).

What gets installed?

  • Installation must include (runtime):
    • files needed at runtime (executables, shared C++ libraries, launch files, configuration files, manifests, scripts, Python libraries)
  • Installation might include (development):
    • C++ headers, static C++ libraries
  • Installation must exclude:
    • C++ source files, object files, downloaded tarballs, built trees of 3rdparty code, test infrastructure (?)


  • Clone the ROS package tree, in some prefix location, e.g., /var/lib.

rosbuild API changes

  • Need to affirmatively declare everything that will be installed.
    • executables and C++ libraries come for free
    • need to declare:
      • C++ headers
      • all Python code
      • scripts
      • launch / configuration files

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.

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

Wiki: rosbuild/Reviews/2010-05-11 API Review (last edited 2010-05-11 20:47:33 by BrianGerkey)