Uploaded image for project: 'Forge'
  1. Forge
  2. FORGE-2088

Man page documentation is incorrect. Required options being displayed as optional in SYNOPSIS

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Major Major
    • 3.0.0.Final
    • 2.12.1.Final
    • None
    • None

      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

            [FORGE-2088] Man page documentation is incorrect. Required options being displayed as optional in SYNOPSIS

            Ondrej Zizka (Inactive) added a comment -

            I would change the name of this issue, but this project disallows that.

            Ondrej Zizka (Inactive) added a comment - I would change the name of this issue, but this project disallows that.

            Ondrej Zizka (Inactive) added a comment -

            Figured out: It needs the --addons part. However, in man addon-remove, it shows [--addons], which, by convention, means optional. Which it should be, in this case.

            Ondrej Zizka (Inactive) added a comment - Figured out: It needs the --addons part. However, in man addon-remove, it shows [--addons] , which, by convention, means optional. Which it should be, in this case.

            Lincoln Baxter III (Inactive) added a comment - - edited

            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

            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

            Lincoln Baxter III (Inactive) added a comment - - edited 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 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

              Unassigned Unassigned
              ozizka_jira Ondrej Zizka (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: