Imported Upstream version 0.10.27

parents
*.orig
*.swp
*.pyc
*.DS_Store
*~
*.log
.coverage
nosetests.xml
target
build
deb_dist
dist
src/rosdep.egg-info
syntax: glob
*.orig
*.swp
*.pyc
*.DS_Store
*~
*.log
.coverage
nosetests.xml
syntax: regexp
(target|build|dist)/.*
language: python
python:
- "2.6"
- "2.7"
- "3.3"
# command to install dependencies
install:
# develop seems to be required by travis since 02/2013
- pip install PyYAML argparse rospkg vcstools catkin_pkg python-dateutil distribute rosdistro
- python setup.py build develop
- pip install nose coverage
# command to run tests
script:
- nosetests --with-coverage --cover-package=rosdep2 --with-xunit test
notifications:
email: false
# Copyright (c) 2013, Willow Garage, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the Willow Garage, Inc. nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
.PHONY: all setup clean_dist distro clean install testsetup test
NAME='rosdep'
VERSION=`python setup.py -V`
all:
echo "noop for debbuild"
setup:
echo "building version ${VERSION}"
clean_dist:
-rm -f MANIFEST
-rm -rf dist
-rm -rf deb_dist
distro: setup clean_dist
python setup.py sdist
clean: clean_dist
echo "clean"
install: distro
sudo checkinstall python setup.py install
testsetup:
echo "running rosdep tests"
test: testsetup
nosetests --with-coverage --cover-package=rosdep2 --with-xunit test
rosdep
------
rosdep is a command-line tool for installing system dependencies. For *end-users*, rosdep helps you install system dependencies for software that you are building from source. For *developers*, rosdep simplifies the problem of installing system dependencies on different platforms. Instead of having to figure out which debian package on Ubuntu Oneiric contains Boost, you can just specify a dependency on 'boost'.
[rosdep Users/Developers Guide](http://docs.ros.org/independent/api/rosdep/html/)
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/rosdep.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/rosdep.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/rosdep"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/rosdep"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
make -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
upload: html
# set write permission for group so that everybody can overwrite existing files on the webserver
chmod -R g+w _build/html/
scp -pr _build/html/ rosbot@ros.osuosl.org:/home/rosbot/docs/independent/api/rosdep
{% extends "layout.html" %}
{% set title = 'ROS packages' %}
{% block body %}
<h1>Welcome</h1>
<p>
rosdep is a command-line tool for installing system dependencies.
For *end-users*, rosdep helps you install system dependencies for
software that you are building from source.
For *developers*, rosdep simplifies the problem of installing
system dependencies on different platforms. Instead of having to
figure out which debian package on Ubuntu Oneiric contains Boost,
you can just specify a dependency on 'boost'.
rosdep is supported on a variety of platforms/package managers:
<ul>
<li>Ubuntu (apt)</li>
<li>Debian (apt)</li>
<li>OS X (Homebrew)</li>
<li>Red Hat Enterprise Linux (rpm/experimental)</li>
<li>Arch (pacman/experimental)</li>
<li>Gentoo (equery/experimental)</li>
<li>Cygwin (experimental)</li>
</ul>
</p>
<h2>Documentation</h2>
<table class="contentstable" align="center" style="margin-left: 30px"><tr>
<td width="50%">
<p class="biglink"><a class="biglink" href="{{ pathto("overview") }}">Overview</a><br/>
<span class="linkdescr">Installing and using rosdep</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("commands") }}">Command-line reference</a><br/>
<span class="linkdescr">rosdep command usage</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("contributing_rules") }}">Contributing rosdep rules</a><br/>
<span class="linkdescr">How to submit new/updated rules for rosdep</span></p>
</td><td width="50%">
<p class="biglink"><a class="biglink" href="{{ pathto("rosdep_yaml_format") }}">Rosdep YAML format</a><br/>
<span class="linkdescr">Specification of the rosdep.yaml file formats</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("developers_guide") }}">Developers Guide</a><br/>
<span class="linkdescr">How to contribute new OS/package managers to rosdep</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("rosdep2_api") }}">Python API</a><br/>
<span class="linkdescr"><em>Unstable</em> Python API for using rosdep as a library</span></p>
</td></tr>
</table>
{% endblock %}
rosdep command reference
========================
.. _rosdep_usage:
Synopsis
--------
**rosdep** <*command*> [*options*] [*args*]
Description
-----------
The **rosdep** command helps you install external dependencies in an
OS-independent manner. For example, what Debian packages do you need
in order to get the OpenGL headers on Ubuntu? How about OS X? Fedora?
rosdep can answer this question for your platform and install the
necessary package(s).
Run ``rosdep -h`` or ``rosdep <command> -h`` to access the built-in tool
documentation.
Commands
--------
**check <stacks-and-packages>...**
Check if the dependencies of ROS package(s) have been met.
**db**
Display the local rosdep database.
**init**
Initialize /etc/ros/sources.list.d/ configuration. May require sudo.
**install <stacks-and-packages>...**
Install dependencies for specified ROS packages.
**keys <stacks-and-packages>...**
List the rosdep keys that the ROS packages depend on.
**resolve <rosdeps>...**
Resolve <rosdeps> to system dependencies
**update**
Update the local rosdep database based on the rosdep sources.
**what-needs <rosdeps>...**
Print a list of packages that declare a rosdep on (at least
one of) <rosdeps>
**where-defined <rosdeps>...**
Print a list of YAML files that declare a rosdep on (at least
one of) <rosdeps>
Options
-------
**--os=OS_NAME:OS_VERSION**
Override OS name and version (colon-separated), e.g. ubuntu:lucid
**-c SOURCES_CACHE_DIR, --sources-cache-dir=SOURCES_CACHE_DIR**
Override default sources cache directory (local rosdep database).
**-a, --all**
Select all ROS packages. Only valid for commands that take <stacks-and-packages> as arguments.
**-h, --help**
Show usage information
**-v, --verbose**
Enable verbose output
**--version**
Print version and exit.
Install Options
---------------
**--reinstall**
(re)install all dependencies, even if already installed
**-y, --default-yes**
Tell the package manager to default to y or fail when installing
**-s, --simulate**
Simulate install
**-r**
Continue installing despite errors.
**-R**
Install implicit/recursive dependencies.
# -*- coding: utf-8 -*-
#
# rosdep documentation build configuration file, created by
# sphinx-quickstart on Mon Sep 12 17:13:25 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
import sys
sys.path.insert(0, '../src')
import catkin_sphinx
from rosdep2 import __version__
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'contents'
# General information about the project.
project = u'rosdep'
copyright = u'2011, Willow Garage'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = __version__
# The full version, including alpha/beta/rc tags.
release = __version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme_path = [os.path.join(os.path.dirname(catkin_sphinx.__file__), 'theme')]
html_theme = 'ros-theme'
html_logo = 'ros.png'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
html_additional_pages = {'index': 'index.html'}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'rosdepdoc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('rosdep.tex', u'rosdep Documentation',
u'Tully Foote, Ken Conley', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('man/rosdep', 'rosdep', u'rosdep command', [u'Tully Foote, Ken Conley'], 1)
]
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
Contents
========
.. toctree::
:maxdepth: 2
overview
commands
contributing_rules
rosdep_yaml_format
sources_list
developers_guide
rosdep2_api
Contributing rosdep rules
=========================
In order to contribute rosdep rules, you should first make sure that
you are familiar with the :ref:`rosdep.yaml format <rosdep_yaml>`.
Summary
'''''''
There are several steps to contributing rosdep rules. You will create
a copy of the database on GitHub, point your own rosdep to use it,
make some changes, and then ask that they be included back in the main
database.
In short:
1. Fork https://github.com/ros/rosdistro
2. Update your ``/etc/ros/rosdep/sources.list.d`` to use this fork
3. Modify your fork to have new rules
4. Test your changes
5. Send a pull request to have your changes included in the main database
Fork the rosdistro GitHub repository
------------------------------------
The main rosdep database is stored in files in the "rosdistro"
repository in the "ros" project on GitHub:
`https://github.com/ros/rosdistro <https://github.com/ros/rosdistro>`_
Start by forking this repository so you have your own copy of the
database to work with. Next, you'll point your local rosdep to use
this database instead.
Point your sources.list.d at your forked repository
---------------------------------------------------
The default sources list for rosdep uses the following files::
yaml https://github.com/ros/rosdistro/raw/master/rosdep/base.yaml
yaml https://github.com/ros/rosdistro/raw/master/rosdep/python.yaml
yaml https://github.com/ros/rosdistro/raw/master/rosdep/osx-homebrew.yaml osx
Create a new file in ``/etc/ros/rosdep/sources.list.d/`` that points
at your forked repository instead. The filename should use a lower
number so it is processed first.
Now that your rosdep is using the new database, you're ready to make
and test your changes.
Make your changes to your forked repository
-------------------------------------------
The repository contains the following files:
- ``rosdep/osx-homebrew.yaml``: Rules for OS X Homebrew
- ``rosdep/python.yaml``: Python-specific dependencies
- ``rosdep/base.yaml``: Everything else
Edit the appropriate file(s) for your change, i.e., if you are