pax_global_header 0000666 0000000 0000000 00000000064 13143526451 0014516 g ustar 00root root 0000000 0000000 52 comment=2e1805e59c498e2d7150e68deb9c6fc1743ff986
ros-rosdep-0.11.8/ 0000775 0000000 0000000 00000000000 13143526451 0013702 5 ustar 00root root 0000000 0000000 ros-rosdep-0.11.8/.gitignore 0000664 0000000 0000000 00000000173 13143526451 0015673 0 ustar 00root root 0000000 0000000 *.orig
*.swp
*.pyc
*.DS_Store
*~
*.log
.coverage
nosetests.xml
target
build
deb_dist
dist
src/rosdep.egg-info
nose*
_build
ros-rosdep-0.11.8/.travis.yml 0000664 0000000 0000000 00000000663 13143526451 0016020 0 ustar 00root root 0000000 0000000 language: python
python:
- "2.6"
- "2.7"
- "3.4"
# 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 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
ros-rosdep-0.11.8/CHANGELOG.rst 0000664 0000000 0000000 00000005271 13143526451 0015730 0 ustar 00root root 0000000 0000000 0.11.8 (2017-08-03)
-------------------
- Fix handling of metapackages
- https://github.com/ros-infrastructure/rosdep/pull/535
- regression of https://github.com/ros-infrastructure/rosdep/pull/531
0.11.7 (2017-08-01)
-------------------
- Changed the way virtual packages are checked in apt to use ``apt-cache``
- https://github.com/ros-infrastructure/rosdep/pull/533
- Fixed a bug where the dependencies of metapackages were not being installed
- https://github.com/ros-infrastructure/rosdep/pull/531
- Improved error handling of failed downloads or invalid source files
- https://github.com/ros-infrastructure/rosdep/pull/523
0.11.6 (2017-07-27)
-------------------
- Added resinstall option for ``pip`` installer
- https://github.com/ros-infrastructure/rosdep/pull/450
- Fixed detection and handling of virtual packages in ``apt`` (more changes to follow)
- https://github.com/ros-infrastructure/rosdep/pull/468
- https://github.com/ros-infrastructure/rosdep/pull/515
- Added support for Slackware
- https://github.com/ros-infrastructure/rosdep/pull/469
- Fixed flags being passed to pacman on Arch Linux
- https://github.com/ros-infrastructure/rosdep/pull/472
- https://github.com/ros-infrastructure/rosdep/pull/476
- No longer uses ``sudo`` when already root
- https://github.com/ros-infrastructure/rosdep/pull/474
- Added more information to ``rosdep --version``
- https://github.com/ros-infrastructure/rosdep/pull/481
- https://github.com/ros-infrastructure/rosdep/pull/499
- Fixed bug when using ``--verbose`` with ``rosdep install`` on macOS with Homebrew
- https://github.com/ros-infrastructure/rosdep/pull/525
- Fixed bug with the ``depends:`` part of a stanze not being used to ordered installations correctly
- https://github.com/ros-infrastructure/rosdep/pull/529
- Fixed Python3 bug on macOS
- https://github.com/ros-infrastructure/rosdep/pull/441
0.11.5 (2016-05-23)
-------------------
- add ca-certificates as a dependency to support https urls
- add quiet option for ``pip``
- Documentation updates
- Elementary support improvements
0.11.4 (2015-09-25)
-------------------
- Fix bug in `pip` package detection code.
0.11.3 (2015-09-24)
-------------------
- Added an option to print out only apt and pip installable packages as commands.
- Added warning when neither the ``ROS_DISTRO`` environment variable is set nor the ``--rosdistro`` option is used.
- Fixed a bug related to group id resolution.
- Switched to using DNF instead of YUM for Fedora 22+.
- Fixed a bug where pip packages were not detected for older versions of ``pip``.
- Fixed a bug where dependencies of packages were gotten from the wrong ``package.xml`` when that package was being overlaid with local packages.
ros-rosdep-0.11.8/LICENSE 0000664 0000000 0000000 00000003055 13143526451 0014712 0 ustar 00root root 0000000 0000000 # 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.
ros-rosdep-0.11.8/Makefile 0000664 0000000 0000000 00000001004 13143526451 0015335 0 ustar 00root root 0000000 0000000 .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
ros-rosdep-0.11.8/README.md 0000664 0000000 0000000 00000001001 13143526451 0015151 0 ustar 00root root 0000000 0000000 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/)
ros-rosdep-0.11.8/doc/ 0000775 0000000 0000000 00000000000 13143526451 0014447 5 ustar 00root root 0000000 0000000 ros-rosdep-0.11.8/doc/Makefile 0000664 0000000 0000000 00000011317 13143526451 0016112 0 ustar 00root root 0000000 0000000 # 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 ' where 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
ros-rosdep-0.11.8/doc/_templates/ 0000775 0000000 0000000 00000000000 13143526451 0016604 5 ustar 00root root 0000000 0000000 ros-rosdep-0.11.8/doc/_templates/index.html 0000664 0000000 0000000 00000004414 13143526451 0020604 0 ustar 00root root 0000000 0000000 {% extends "layout.html" %}
{% set title = 'ROS packages' %}
{% block body %}
Welcome
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:
Developers Guide How to contribute new OS/package managers to rosdep
Python API Unstable Python API for using rosdep as a library
{% endblock %}
ros-rosdep-0.11.8/doc/commands.rst 0000664 0000000 0000000 00000001301 13143526451 0016775 0 ustar 00root root 0000000 0000000 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 -h`` to access the built-in tool
documentation.
Commands
--------
.. rosdep_cli_help:: commands
Options
-------
.. rosdep_cli_help:: options
Install Options
---------------
.. rosdep_cli_help:: install
ros-rosdep-0.11.8/doc/conf.py 0000664 0000000 0000000 00000016573 13143526451 0015762 0 ustar 00root root 0000000 0000000 # -*- 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 os
import sys
sys.path.insert(0, './')
sys.path.insert(0, '../src')
import catkin_sphinx # noqa
from rosdep2 import __version__ # noqa
# 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',
'rosdep_doc_utils',
]
# 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
# " v 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 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}
ros-rosdep-0.11.8/doc/contents.rst 0000664 0000000 0000000 00000000250 13143526451 0017033 0 ustar 00root root 0000000 0000000 Contents
========
.. toctree::
:maxdepth: 2
overview
commands
contributing_rules
rosdep_yaml_format
sources_list
developers_guide
rosdep2_api
ros-rosdep-0.11.8/doc/contributing_rules.rst 0000664 0000000 0000000 00000006102 13143526451 0021121 0 ustar 00root root 0000000 0000000 Contributing rosdep rules
=========================
In order to contribute rosdep rules, you should first make sure that
you are familiar with the :ref:`rosdep.yaml format `.
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 `_
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
contributing a Homebrew rule, only edit ``osx-homebrew.yaml``, if you
are contributing a rule for a Python library, only edit
``python.yaml``, and, otherwise, put your rule in ``base.yaml``.
To edit, change the ``https://`` url to a local path using the format
``file:///abs/path``.
Make sure that your rules work
------------------------------
Update your local index::
rosdep update
Test your new rules::
rosdep resolve
Test with different OS rules::
rosdep resolve --os=OS_NAME:OS_VERSION
Submit a pull request with your updated rules
---------------------------------------------
Use GitHub's pull request mechanism to request that your updates get
included in the main databases.
There are guidelines for submitting pull requests at: https://github.com/ros/rosdistro/blob/master/CONTRIBUTING.md
And include instructions how to prevalidate your changes using the unit tests.
After your request has been accepted, you can undo your changes to
``/etc/ros/rosdep/sources.list.d``.
ros-rosdep-0.11.8/doc/developers_guide.rst 0000664 0000000 0000000 00000012277 13143526451 0020537 0 ustar 00root root 0000000 0000000 .. _dev_guide:
Developer's Guide
=================
Python API reference
--------------------
In progress, please see :ref:`Python API `.
REP 114: rospkg standalone library
----------------------------------
The rosdep library is being developed using the ROS REP process. It
is necessary to be familiar with these REPs in order to make sure
that rosdep continues to follow the relevant specifications.
- `REP 111: Multiple Package Manager Support for Rosdep `_.
- `REP 112: Source Package Manager for Rosdep `_.
- `REP 125: rosdep 2 `_.
Bug reports and feature requests
--------------------------------
- `Submit a bug report `_
- `Submit a feature request `_
Getting the code
----------------
The rosdep codebase is hosted on GitHub. To get started contributing patches, please create a fork:
https://github.com/ros-infrastructure/rosdep
Supporting a new OS/package manager
-----------------------------------
Adding new platforms to rosdep can be separated into two steps: adding
support for a new package manager, and adding support for a new OS.
NOTE: There are numerous examples in :mod:`rosdep2.platforms` that you
can follow.
Declaring a new OS
''''''''''''''''''
Adding support for a new OS is fairly straightforward: you just
have to provide rosdep2 the keys that are associated with your OS and the
keys of the installers that your OS supports.
Implementations must provide a ``register_platforms(context)`` call
which sets up the keys used for the OS and package managers. The
registration only sets up associated keys -- it does not specify the
implementation. OS keys should be pulled from ``rospkg.os_detect`` if
they are available.
This example registers the ``gentoo`` OS and adds support for the
``equery`` and ``source`` package managers. It then sets the default
package manager to ``equery``::
from rospkg.os_detect import OS_GENTOO
def register_platforms(context):
context.add_os_installer_key(OS_GENTOO, EQUERY_INSTALLER)
context.add_os_installer_key(OS_GENTOO, SOURCE_INSTALLER)
context.set_default_os_installer_key(OS_GENTOO, EQUERY_INSTALLER)
Declaring a new installer
'''''''''''''''''''''''''
A new installer is registered with the system using a
``register_installers(context)`` call. This call aqssociates the
installer key with an implementation.
This example declares that ``pip`` is implemented using the
``PipInstaller()`` class. We also declare the ``PIP_INSTALLER``
variable so that other code can use it symbolically.::
PIP_INSTALLER = 'pip'
def register_installers(context):
context.set_installer(PIP_INSTALLER, PipInstaller())
Most installers are implemented using the the
:class:`PackageManagerInstaller` API. The following is the implementation
of the ``PipInstaller``::
class PipInstaller(PackageManagerInstaller):
def __init__(self):
super(PipInstaller, self).__init__(pip_detect, supports_depends=True)
def get_install_command(self, resolved, interactive=True, reinstall=False):
if not is_pip_installed():
raise InstallFailed((PIP_INSTALLER, "pip is not installed"))
# convenience function that calls outs to our detect function
packages = self.get_packages_to_install(resolved, reinstall=reinstall)
if not packages:
return []
else:
return [['sudo', 'pip', 'install', '-U', p] for p in packages]
The pattern is fairly simple to implement for other package managers.
You must provide a ``detect_function(package_names)``
(e.g. ``pip_detect()``) that returns a list of package names that are
already installed. You must also implement ``get_install_command()``
which must return a *list* of commands to execute in order to install
the relevant packages.
Testing
-------
If you contribute a support for a new OS/package manager, you *must*
provide complete unit test coverage. For example, if your detector
relies on parsing the output of a package manager, you must submit
example output along with tests that parse them correctly.
Test files for os detection should be placed in ``test/os_name``.
Setup
::
pip install nose
pip install mock
rosdep2 uses `Python nose `_
for testing, which is a fairly simple and straightfoward test
framework. You just have to write a function start with the name
``test`` and use normal ``assert`` statements for your tests.
rosdep2 also uses `mock `_ to
create mocks for testing.
You can run the tests, including coverage, as follows:
::
cd rosdep2/test
nosetests
Documentation
-------------
Sphinx is used to provide API documentation for rospkg. The documents
are stored in the ``doc`` subdirectory.
In order to build the docs, you need the 'ros-theme', which should be stored
in `~/sphinx/ros-theme`. You can get a copy of ros-theme from:
https://github.com/willowgarage/catkin-sphinx/tree/master/theme
ros-rosdep-0.11.8/doc/make.bat 0000664 0000000 0000000 00000010637 13143526451 0016063 0 ustar 00root root 0000000 0000000 @ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^` where ^ 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. text to make text files
echo. man to make manual pages
echo. changes to make an overview over 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
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
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.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
:end
ros-rosdep-0.11.8/doc/man/ 0000775 0000000 0000000 00000000000 13143526451 0015222 5 ustar 00root root 0000000 0000000 ros-rosdep-0.11.8/doc/man/rosdep.1 0000664 0000000 0000000 00000006420 13143526451 0016602 0 ustar 00root root 0000000 0000000 .TH "ROSDEP" "1" "January 12, 2012" "0.1" "rosdep"
.SH NAME
rosdep \- rosdep command
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
\fBrosdep\fP <\fIcommand\fP> [\fIoptions\fP] [\fIargs\fP]
.SH DESCRIPTION
.sp
The \fBrosdep\fP 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).
.sp
For more information on rosdep, see \fI\%http://ros.org/wiki/rosdep\fP.
.sp
Run "rosdep \-h" or "rosdep \-h" to access the built\-in tool
documentation.
.SH COMMANDS
.sp
\fBcheck ...\fP
.INDENT 0.0
.INDENT 3.5
Check if the dependencies of ROS package(s) have been met.
.UNINDENT
.UNINDENT
.sp
\fBinstall ...\fP
.INDENT 0.0
.INDENT 3.5
Install dependencies for specified ROS packages.
.UNINDENT
.UNINDENT
.sp
\fBdb ...\fP
.INDENT 0.0
.INDENT 3.5
Display the dependency database for package(s).
.UNINDENT
.UNINDENT
.sp
\fBkeys ...\fP
.INDENT 0.0
.INDENT 3.5
List the rosdep keys that the ROS packages depend on.
.UNINDENT
.UNINDENT
.sp
\fBwhat\-needs ...\fP
.INDENT 0.0
.INDENT 3.5
Print a list of packages that declare a rosdep on (at least
one of)
.UNINDENT
.UNINDENT
.sp
\fBwhere\-defined ...\fP
.INDENT 0.0
.INDENT 3.5
Print a list of YAML files that declare a rosdep on (at least
one of)
.UNINDENT
.UNINDENT
.SH OPTIONS
.sp
\fB\-\-os=OS_NAME:OS_VERSION\fP
.INDENT 0.0
.INDENT 3.5
Override OS name and version (colon\-separated), e.g. ubuntu:lucid
.UNINDENT
.UNINDENT
.sp
\fB\-i, \-\-include_duplicates\fP
.INDENT 0.0
.INDENT 3.5
Do not deduplicate
.UNINDENT
.UNINDENT
.sp
\fB\-a, \-\-all\fP
.INDENT 0.0
.INDENT 3.5
Select all ROS packages. Only valid for commands that take as arguments.
.UNINDENT
.UNINDENT
.sp
\fB\-h, \-\-help\fP
.INDENT 0.0
.INDENT 3.5
Show usage information
.UNINDENT
.UNINDENT
.sp
\fB\-v, \-\-verbose\fP
.INDENT 0.0
.INDENT 3.5
Enable verbose output
.UNINDENT
.UNINDENT
.SH INSTALL OPTIONS
.sp
\fB\-\-reinstall\fP
.INDENT 0.0
.INDENT 3.5
(re)install all dependencies, even if already installed
.UNINDENT
.UNINDENT
.sp
\fB\-y, \-\-default\-yes\fP
.INDENT 0.0
.INDENT 3.5
Tell the package manager to default to y or fail when installing
.UNINDENT
.UNINDENT
.sp
\fB\-s, \-\-simulate\fP
.INDENT 0.0
.INDENT 3.5
Simulate install
.UNINDENT
.UNINDENT
.sp
\fB\-r\fP
.INDENT 0.0
.INDENT 3.5
Continue installing despite errors.
.UNINDENT
.UNINDENT
.SH AUTHOR
Tully Foote, Ken Conley
.SH COPYRIGHT
2011, Willow Garage
.\" Generated by docutils manpage writer.
.\"
.
ros-rosdep-0.11.8/doc/man/rosdep.rst 0000664 0000000 0000000 00000001254 13143526451 0017252 0 ustar 00root root 0000000 0000000 :orphan:
rosdep manual page
==================
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 -h`` to access the built-in tool
documentation.
Commands
--------
.. rosdep_cli_help:: commands
Options
-------
.. rosdep_cli_help:: options
Install Options
---------------
.. rosdep_cli_help:: install
ros-rosdep-0.11.8/doc/overview.rst 0000664 0000000 0000000 00000004072 13143526451 0017052 0 ustar 00root root 0000000 0000000 Overview
========
Installing rosdep
-----------------
rosdep2 is available using pip or easy_install::
sudo pip install -U rosdep
or::
sudo easy_install -U rosdep rospkg
Setting up rosdep
-----------------
rosdep needs to be initialized and updated to use::
sudo rosdep init
rosdep update
``sudo rosdep init`` will create a `sources list `_
directory in ``/etc/ros/rosdep/sources.list.d`` that controls where
rosdep gets its data from.
``rosdep update`` reads through this sources list to initialize your
local database.
Updating rosdep
---------------
You can update your rosdep database by running::
rosdep update
Installating rosdeps
--------------------
rosdep takes in the name of a ROS stack or package that you wish to
install the system dependencies for.
Common installation workflow::
$ rosdep check ros_comm
All system dependencies have been satisified
$ rosdep install geometry
If you're worried about ``rosdep install`` bringing in system
dependencies you don't want, you can run ``rosdep install -s ``
instead to "simulate" the installation. You will be able to see the
commands that rosdep would have run.
Example::
$ rosdep install -s ros_comm
#[apt] Installation commands:
sudo apt-get install libapr1-dev
sudo apt-get install libaprutil1-dev
sudo apt-get install libbz2-dev
sudo apt-get install liblog4cxx10-dev
sudo apt-get install pkg-config
sudo apt-get install python-imaging
sudo apt-get install python-numpy
sudo apt-get install python-paramiko
sudo apt-get install python-yaml
You can also query rosdep to find out more information about specific
dependencies::
$ rosdep keys roscpp
pkg-config
$ rosdep resolve pkg-config
pkg-config
$ rosdep keys geometry
eigen
apr
glut
python-sip
python-numpy
graphviz
paramiko
cppunit
libxext
log4cxx
pkg-config
$ rosdep resolve eigen
libeigen3-dev
For more information, please see the :ref:`command reference `.
ros-rosdep-0.11.8/doc/ros.png 0000664 0000000 0000000 00000014770 13143526451 0015771 0 ustar 00root root 0000000 0000000 PNG
IHDR ) Q sRGB pHYs tIME(M IDATx|wtT9NQC
$F a:l`M1a;ϸ-_\b18!`'qB $Pm4sw2H~]Z3ZS{ȿP_j뛝VfCzM-[ZmfkP!: ۥ` $I&)\+,]^fab; |]/}bk5 >4$01Cz\iY_ZPqBDX҅z`b745yO6#( &Iҷe:wj0gMI{r