[forge-issues] [JBoss JIRA] (FORGE-2088) Man page documentation is incorrect. Required options being displayed as optional in SYNOPSIS

[Lincoln Baxter III (JIRA)]

    [ https://issues.jboss.org/browse/FORGE-2088?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13014402#comment-13014402 ] 

Lincoln Baxter III edited comment on FORGE-2088 at 10/22/14 3:19 PM:
---------------------------------------------------------------------

the correct command is:

'addons-remove --addons ADDONID ADDONID ADDONID'

But the man page synopsis docs show --addons as [optional] when it is not. Brackets should be removed

{code}NAME
  addon-remove -- Forge/Manage
 
SYNOPSIS
  addon-remove [-] [--addons] AddonId 
 
DESCRIPTION
  Command to remove a Furnace 2 addon.
     --addons
    Installed addons - The installed addons in mutable addon repositories that may be removed [AddonId] (required) Valid choices: [] 
 
 

 
RESOURCES
  forge: <http://forge.jboss.org/>
 
COPYING
  Copyright 2014 Red Hat, Inc. and/or its affiliates.
    Licensed under the Eclipse Public License version 1.0, available at http://www.eclipse.org/legal/epl-v10.html {code}


was (Author: lincolnthree):
the correct command is:

{code}NAME
  addon-remove -- Forge/Manage
 
SYNOPSIS
  addon-remove [-] [--addons] AddonId 
 
DESCRIPTION
  Command to remove a Furnace 2 addon.
     --addons
    Installed addons - The installed addons in mutable addon repositories that may be removed [AddonId] (required) Valid choices: [] 
 
 

 
RESOURCES
  forge: <http://forge.jboss.org/>
 
COPYING
  Copyright 2014 Red Hat, Inc. and/or its affiliates.
    Licensed under the Eclipse Public License version 1.0, available at http://www.eclipse.org/legal/epl-v10.html {code}

> Man page documentation is incorrect. Required options being displayed as optional in SYNOPSIS
> ---------------------------------------------------------------------------------------------
>
>                 Key: FORGE-2088
>                 URL: https://issues.jboss.org/browse/FORGE-2088
>             Project: Forge
>          Issue Type: Bug
>    Affects Versions: 2.12.1.Final
>            Reporter: Ondrej Zizka
>
> Not sure if bug or feature, either way - I'd expect that feeding addon-remove an item from addon-list would remove it. Not the case:
> $ addon-list 
> Currently installed addons:
> ...
> org.jboss.windup.qs:WindupQuickstart,2.0.0.Beta2
> ...
> [javaee-WLServlet]$ addon-remove org.jboss.windup.qs:WindupQuickstart,2.0.0.Beta2
> ***ERROR*** Installed addons must be specified



--
This message was sent by Atlassian JIRA
(v6.3.1#6329)