[ 
https://issues.apache.org/jira/browse/KARAF-257?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12934873#action_12934873
 ] 

Ioannis Canellos commented on KARAF-257:
----------------------------------------

Feature now has two new properties Description (as an attribute on feature 
element) and details as nested element inside feature element.

Example:

<feature name='aries-tx' description="Transaction Manager OSGi Service" 
version='0.2-incubating'>
        <details>The Aries JTA project will focus on making container managed 
transactions available as OSGi services.</details>
        
<bundle>mvn:org.apache.aries.transaction/org.apache.aries.transaction.blueprint/0.2-incubating</bundle>
        
<bundle>mvn:org.apache.aries.transaction/org.apache.aries.transaction.manager/0.2-incubating</bundle>
</feature>

The description (short) is display by features:list command.
The details is desplayed by the features:info command.

I will leave this issue open for a week or so, in case we want to add 
additional functionality around this.

> Features - Add description attribute and have it listed in the features 
> overview
> --------------------------------------------------------------------------------
>
>                 Key: KARAF-257
>                 URL: https://issues.apache.org/jira/browse/KARAF-257
>             Project: Karaf
>          Issue Type: New Feature
>    Affects Versions: 2.1.0
>            Reporter: Claus Ibsen
>            Assignee: Ioannis Canellos
>            Priority: Minor
>
> It would be nice if the features had a description attribute so you can type 
> in some information which the end user can see when the features is listed in 
> the console.
> Maybe even have 2 attributes so you can have a brief summary and a more 
> detailed description. in the XML the detailed description could be a sub 
> element.
> This allows to refer to any additional documentation or important information 
> the end user may need to know when using that feature

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply via email to