[ros-ros] 01/01: Improve and clarify package descriptions
Wookey
wookey at moszumanska.debian.org
Thu Nov 12 13:54:41 UTC 2015
This is an automated email from the git hooks/post-receive script.
wookey pushed a commit to branch master
in repository ros-ros.
commit 5b8525f689734c408a90cc8d29b2779786fe3cbe
Author: Wookey <wookey at wookware.org>
Date: Thu Nov 12 13:54:07 2015 +0000
Improve and clarify package descriptions
---
debian/control | 130 +++++++++++++++++++++++++++++++--------------------------
1 file changed, 70 insertions(+), 60 deletions(-)
diff --git a/debian/control b/debian/control
index 502faff..6af4578 100644
--- a/debian/control
+++ b/debian/control
@@ -26,66 +26,72 @@ Section: devel
Architecture: all
Depends: ${misc:Depends}
Multi-Arch: foreign
-Description: rosmake mk files
- A collection of .mk include files for building ROS architectural elements.
- Most package authors should use cmake .mk, which calls CMake for the build of
- the package. The other files in this package are intended for use in exotic
- situations that mostly arise when importing 3rdparty code.
+Description: Robot OS make file helpers
+ This package is part of Robot OS (ROS). It is a collection of make
+ include files for building ROS architectural elements. Most package
+ authors should use cmake.mk, which calls CMake for the build of the
+ package. The other files in this package are intended for use in
+ exotic situations that mostly arise when importing 3rdparty code.
Package: rosbuild
Section: devel
Architecture: all
Depends: ${misc:Depends}, ${python:Depends}, python
Multi-Arch: foreign
-Description: scripts for managing the ROS build system
- Rosbuild solves the core problem of gathering appropriate build flags
- from and track dependencies in the ROS package tree. The macros provided by
- rosbuild, automatically inherit the union of build flags exported by
- packages on which your package depends.
+Description: scripts for managing the Robot OS build system
+ This package is part of Robot OS (ROS). Rosbuild solves the core
+ problem of gathering appropriate build flags from, and tracking
+ dependencies in, the ROS package tree. The macros provided by
+ rosbuild automatically inherit the union of build flags exported by
+ packages on which your package depends.
Package: roslang
Section: devel
Architecture: all
Depends: ${misc:Depends}
Multi-Arch: foreign
-Description: Common package that all ROS client libraries depend on
- This is mainly used to find client libraries (via 'rospack depends-on1
- roslang'). The roslang package is only of interest to those implementing a
- ROS client library. Client libraries marks themselves as such by depending
- on the roslang package, which allows rosbuild and other tools to perform
- appropriate actions, such as msg- and srv-based code generation. The roslang
- package itself contains no actual code.
+Description: Common meta-package for all Robot OS client libraries
+ This package is part of Robot OS (ROS). It is mainly used to find
+ client libraries (via 'rospack depends-on1 roslang'). The roslang
+ package is only of interest to those implementing a ROS client
+ library. Client libraries mark themselves as such by depending on
+ the roslang package, which allows rosbuild and other tools to perform
+ appropriate actions, such as msg- and srv-based code generation. The
+ roslang package itself contains no actual code.
Package: libroslib-dev
Section: libdevel
Architecture: any
Depends: libroslib0d (= ${binary:Version}), ${misc:Depends}
-Description: development files for libroslib
- Base dependencies and support libraries for ROS. roslib contains many of
- the common data structures and tools that are shared across ROS client
- library implementations.
+Description: development files for roslib (Robot OS)
+ This package is part of Robot OS (ROS). It provides the base
+ dependencies and support libraries for ROS. roslib contains many of
+ the common data structures and tools that are shared across ROS
+ client library implementations.
.
This package contains the development files for the library.
Package: libroslib0d
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: library for roslib
- Base dependencies and support libraries for ROS. roslib contains many of
- the common data structures and tools that are shared across ROS client
- library implementations.
+Description: library for roslib (Robot OS)
+ This package is part of Robot OS (ROS). It provides the base
+ dependencies and support libraries for ROS. roslib contains many of
+ the common data structures and tools that are shared across ROS
+ client library implementations.
.
- This package contains the library.
+ This package contains the C library.
Package: python-roslib
Section: python
Architecture: all
Multi-Arch: allowed
Depends: ${python:Depends}, ${shlibs:Depends}, ${misc:Depends}, python-rospkg, catkin
-Description: Python library for roslib
- Base dependencies and support libraries for ROS. roslib contains many of
- the common data structures and tools that are shared across ROS client
- library implementations.
+Description: Python library for roslib (Robot OS)
+ This package is part of Robot OS (ROS). It provides base dependencies
+ and support libraries for ROS. roslib contains many of the common
+ data structures and tools that are shared across ROS client library
+ implementations.
.
This package contains the Python library.
@@ -95,13 +101,14 @@ Architecture: all
Depends: ${misc:Depends}
Recommends: bash-completion
Multi-Arch: foreign
-Description: Assorted shell commands for using ROS with bash
- The rosbash package contains some useful bash functions and adds
- tab-completion to a large number of the basic ros utilities. The package
- includes limited support for zsh and tcsh by way of sourcing the roszsh or
- rostcsh files respectively. It doesn't provide documentation on
- these shells, though much of the functionality is similar to the
- bash shell extensions.
+Description: Assorted shell commands for using Robot OS with bash
+ This package is part of Robot OS (ROS). The rosbash package contains
+ some useful bash functions and adds tab-completion to a large number
+ of the basic ros utilities. The package includes limited support for
+ zsh and tcsh by way of sourcing the roszsh or rostcsh files
+ respectively. It doesn't provide documentation on these shells,
+ though much of the functionality is similar to the bash shell
+ extensions.
Package: python-rosboost-cfg
Section: python
@@ -109,11 +116,10 @@ Architecture: all
Multi-Arch: allowed
Depends: ${python:Depends}, ${shlibs:Depends}, ${misc:Depends}
Provides: ${python:Provides}
-Description: Contains scripts used by the rosboost-cfg tool
- It used for determining cflags/lflags/etc. of boost on your system
- when you use is a ROS environtment. ROS is a meta-operating system for your
- robot. It provides language-independent and network-transparent
- communication for a distributed robot control system.
+Description: Contains scripts used by the Robot OS rosboost-cfg tool
+ This package is part of Robot OS (ROS). It is used for determining
+ build flags (cflags/lflags/etc.) for boost on your system when you
+ use it in a ROS environment.
Package: python-rosclean
Section: python
@@ -121,10 +127,11 @@ Architecture: all
Multi-Arch: allowed
Depends: ${python:Depends}, ${shlibs:Depends}, ${misc:Depends}
Provides: ${python:Provides}
-Description: cleanup filesystem resources (e.g. log files)
- rosclean purge will remove directories associated with storing ROS-related
- log files. You will be asked to confirm each deletion and it is important
- that you verify the command that rosclean purge executes is correct.
+Description: cleanup Robot OS filesystem resources (e.g. logs)
+ This package is part of Robot OS (ROS). rosclean purge will remove
+ directories associated with storing ROS-related log files. You will
+ be asked to confirm each deletion and it is important that you verify
+ the command that rosclean purge executes is correct.
Package: python-roscreate
Section: python
@@ -132,12 +139,13 @@ Architecture: all
Multi-Arch: allowed
Depends: ${python:Depends}, ${shlibs:Depends}, ${misc:Depends}
Provides: ${python:Provides}
-Description: Tool that assists in the creation of ROS filesystem resources
- It provides: roscreate-pkg, which creates a new package directory, including
- the appropriate build and manifest files. It creates a new ROS package with
- common package files: manifest.xml, CMakeLists.txt, mainpage.dox, and
- Makefile. It addresses the common problem of packages being created using
- pre-existing packages, which leads to errors in build files and manifests.
+Description: Robot OS empty package template creator
+ This package is part of Robot OS (ROS). It provides roscreate-pkg
+ which creates empty ROS package templates and thus addresses the
+ common problem of packages being created using pre-existing packages,
+ which leads to errors in build files and manifests. The tool creates a
+ new package directory, including the appropriate build and manifest
+ files.
Package: python-rosmake
Section: python
@@ -145,10 +153,11 @@ Architecture: all
Multi-Arch: allowed
Depends: ${python:Depends}, ${shlibs:Depends}, ${misc:Depends}
Provides: ${python:Provides}
-Description: rosmake is a ros dependency aware build tool
- Tool to assist with building ROS packages. It facilitates
- building packages that have dependencie, which can be used to build
- all dependencies in the correct order.
+Description: rosmake is a Robot OS dependency aware build tool
+ This package is part of Robot OS (ROS). rosmake is a tool to assist
+ with building ROS packages. It facilitates building packages that
+ have dependencies, allowing all dependencies to be built in the
+ correct order.
Package: python-rosunit
Section: python
@@ -157,7 +166,8 @@ Multi-Arch: allowed
Depends: ${python:Depends}, ${shlibs:Depends}, ${misc:Depends}
Provides: ${python:Provides}
Description: Unit-testing package for ROS
- This is a lower-level library for rostest and handles unit tests, whereas
- rostest handles integration tests. It's an internal tool for running unit
- tests within ROS. While it can be run by a regular user, most users will
- generally use rosunit indirectly via rosbuild test macros.
+ This package is part of Robot OS (ROS). python-rosunit is a
+ lower-level library for rostest and handles unit tests, whereas
+ rostest handles integration tests. It's an internal tool for running
+ unit tests within ROS. While it can be run by a regular user, most
+ users will generally use rosunit indirectly via rosbuild test macros.
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/ros/ros-ros.git
More information about the debian-science-commits
mailing list