Karaf
  1. Karaf
  2. KARAF-753

commandlist --help points to help for jaas:pending

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.2.2
    • Fix Version/s: 2.2.3, 3.0.0
    • Component/s: karaf-shell
    • Labels:
      None

      Description

      Not sure why (can't find the problem in the source code), but commandlist --help is pointing to another command:

      karaf@root> commandlist --help
      DESCRIPTION
      jaas:pending

      Lists the modification on the active realm/module.

      SYNTAX
      jaas:pending [options]

      OPTIONS
      --help
      Display this help message

      karaf@root>

        Activity

        Transition Time In Source Status Execution Times Last Executer Last Execution Date
        Open Open In Progress In Progress
        39d 7h 49m 1 Jean-Baptiste Onofré 29/Aug/11 08:47
        In Progress In Progress Resolved Resolved
        28m 39s 1 Jean-Baptiste Onofré 29/Aug/11 09:16
        Resolved Resolved Closed Closed
        144d 8h 3m 1 Jamie goodyear 20/Jan/12 16:20
        Jamie goodyear made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Jean-Baptiste Onofré made changes -
        Status In Progress [ 3 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Hide
        Jean-Baptiste Onofré added a comment -

        Fixed on karaf-2.2.x: revision 1162672.

        Show
        Jean-Baptiste Onofré added a comment - Fixed on karaf-2.2.x: revision 1162672.
        Hide
        Jean-Baptiste Onofré added a comment -

        Fixed on trunk: revision 1162670.

        Show
        Jean-Baptiste Onofré added a comment - Fixed on trunk: revision 1162670.
        Jean-Baptiste Onofré made changes -
        Status Open [ 1 ] In Progress [ 3 ]
        Jean-Baptiste Onofré made changes -
        Fix Version/s 2.2.3 [ 12316685 ]
        Hide
        Jean-Baptiste Onofré added a comment -

        It makes sense Glen.

        Just for explanation, in the blueprint descriptor, we have:

        <command name="jaas/commandlist">
        <action class="org.apache.karaf.jaas.command.ListPendingCommand"/>
        </command>

        So we can see the command name (jaas/commandlist) linked to the ListPendingCommand bean.

        That's why we have a mix between the command name and the real command

        I'm agree with your plan, I will do it in this way.

        Show
        Jean-Baptiste Onofré added a comment - It makes sense Glen. Just for explanation, in the blueprint descriptor, we have: <command name="jaas/commandlist"> <action class="org.apache.karaf.jaas.command.ListPendingCommand"/> </command> So we can see the command name (jaas/commandlist) linked to the ListPendingCommand bean. That's why we have a mix between the command name and the real command I'm agree with your plan, I will do it in this way.
        Hide
        Glen Mazza added a comment -

        I'm confused--first, I think you mean "commandlist" and not "listcommand". Secondly, I'm confused why OSGi Blueprint dependency injection would define anything concerning the jaas:pending command (the Blueprint schema: http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd includes nothing with the phrase "command" or "pending".)

        My general recommendation, would be yes, to name the method whatever it should be named in the 2.x series, adding an alias if necessary but to not include the alias in the 3.0 series (if the only reason why you would do so is for backward compatibility). Because major version upgrades are where you get rid of old commands/APIs.

        But whatever you do, when I enter karaf>

        {command} --help, when I see the help for it, I should see that same {command}

        in the DESCRIPTION field of the help text. The present commandlist in one and jaas:pending in the other looks like a strange bug to most users.

        Show
        Glen Mazza added a comment - I'm confused--first, I think you mean "commandlist" and not "listcommand". Secondly, I'm confused why OSGi Blueprint dependency injection would define anything concerning the jaas:pending command (the Blueprint schema: http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd includes nothing with the phrase "command" or "pending".) My general recommendation, would be yes, to name the method whatever it should be named in the 2.x series, adding an alias if necessary but to not include the alias in the 3.0 series (if the only reason why you would do so is for backward compatibility). Because major version upgrades are where you get rid of old commands/APIs. But whatever you do, when I enter karaf> {command} --help, when I see the help for it, I should see that same {command} in the DESCRIPTION field of the help text. The present commandlist in one and jaas:pending in the other looks like a strange bug to most users.
        Hide
        Jean-Baptiste Onofré added a comment -

        It's "normal".

        The listcommand (defined in blueprint) correspond to the ListPendingCommand.

        That's why "listcommand --help" displays the ListPendingCommand help.

        I propose:
        1/ to rename listcommand to jaas:pending (which should be the case)
        2/ for backward compatibility, I propose to add an alias listcommand to jaas:pending

        WDYT ?

        Show
        Jean-Baptiste Onofré added a comment - It's "normal". The listcommand (defined in blueprint) correspond to the ListPendingCommand. That's why "listcommand --help" displays the ListPendingCommand help. I propose: 1/ to rename listcommand to jaas:pending (which should be the case) 2/ for backward compatibility, I propose to add an alias listcommand to jaas:pending WDYT ?
        Jean-Baptiste Onofré made changes -
        Field Original Value New Value
        Assignee Jean-Baptiste Onofré [ jbonofre ]
        Fix Version/s 3.0.0 [ 12316040 ]
        Component/s karaf-shell [ 12313723 ]
        Glen Mazza created issue -

          People

          • Assignee:
            Jean-Baptiste Onofré
            Reporter:
            Glen Mazza
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development