ROS Resources: Documentation | Support | Discussion Forum | Index | Service Status | ros @ Robotics Stack Exchange
Ask Your Question

Support for 'short description' in package.xml / Bloom?

asked 2013-12-24 00:38:41 -0500

gvdhoorn gravatar image

updated 2015-06-16 03:37:20 -0500

Is there any way for Bloom to generate 'short descriptions' like what rosbuild used to do?

manifest.xml actually had an explicit brief attribute on the description tag, which seems to have been removed in package.xml. There are a number of packages in Groovy and Hydro (in Ubuntu) that have very long package descriptions, where a succinct short description would definitely help make things a bit more readable.

Update (2015-06-16): an initial implementation for this was added to Bloom with the merge of ros-infrastructure/bloom/pull/366. Short descriptions (or synopses) are automatically extracted from the package manifest description field. Only the rosdebian generator supports this for now.

edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted

answered 2013-12-24 10:57:39 -0500

William gravatar image

updated 2015-05-08 03:58:51 -0500

gvdhoorn gravatar image

Are you talking about the description in the debs themselves?

I think this was removed from the package.xml spec because it was pretty much always not set or completely redundant to the description.

I could conceive that we use an approach like doxygen, where the first line, if followed by a new line character, is considered the brief.

In fact, the Debian guidelines for control files says the first line is considered the brief:

The bloom template simply plops the whole description down in the description: field, so if you put a new line after the first line in your package's description, it should get processed by debs as the brief:

There are some other interesting rules in there, which we could take advantage of, perhaps bloom could intelligently change the contents of the package.xml description to use some of those rules. If you think that is value, please open a ticket to that effect in bloom's tracker.

edit flag offensive delete link more


Yes, short descriptions in debs. I sort of expected Bloom to do that, seeing how it generates the control file. Am I right to think that Bloom strips any HTML tags out of the description tag before generating the control file? Are newlines preserved in that case? I'll open a ticket.

gvdhoorn gravatar image gvdhoorn  ( 2013-12-25 05:07:41 -0500 )edit

Question Tools

1 follower


Asked: 2013-12-24 00:38:41 -0500

Seen: 309 times

Last updated: Jun 16 '15