Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 1.5, 1.6
    • Fix Version/s: 1.7, 2.x
    • Component/s: Documentation
    • Labels:
      None

      Description

      There is a misleading information on the dependency page(http://velocity.apache.org/engine/releases/velocity-1.5/dependencies.html , These dependencies are required to compile and run the application) about oro.

      "The most common case is the integration of the Velocity runtime into your application. In this case, you must add commons-collections, commons-lang and oro to your application (and optional logging if required). If you already have one or more of these libraries in your application, you should check if you need to update their versions. "

      also

      "These dependencies are required to compile and run the application"

      Except if Velocity is configured to escape references, oro is not need it at runtime, only at compile time(most of the users don't care about compile time).

      1. velocity-617.patch
        0.9 kB
        Jarkko Viinamäki

        Activity

        Hide
        Nathan Bubna added a comment -

        Resolved as it's going to get for now...

        Show
        Nathan Bubna added a comment - Resolved as it's going to get for now...
        Hide
        Nathan Bubna added a comment -

        Yeah, WebMacro is already gone in 2.x. I'll mark it deprecated in the trunk.

        Also, the 2.x branch should really drop ORO and just the jdk regex stuff, if anyone wants to patch that.

        Show
        Nathan Bubna added a comment - Yeah, WebMacro is already gone in 2.x. I'll mark it deprecated in the trunk. Also, the 2.x branch should really drop ORO and just the jdk regex stuff, if anyone wants to patch that.
        Hide
        Christoph Reck added a comment -

        I suggest to deprecate org.apache.velocity.convert.WebMacro, since it was an utility to migrate from it in early days when the clean room re-implementation was made.
        Now WM has changed a lot and I believe this class file is not useful any more.

        Show
        Christoph Reck added a comment - I suggest to deprecate org.apache.velocity.convert.WebMacro, since it was an utility to migrate from it in early days when the clean room re-implementation was made. Now WM has changed a lot and I believe this class file is not useful any more.
        Hide
        Jarkko Viinamäki added a comment -

        This patch marks ORO dependency as optional (which is I guess the only possible way to mark this kind of dependency). AFAIK there is no way to change the text on the Maven generated dependencies.html page.

        ORO is only used by this runtime class:
        org.apache.velocity.app.event.implement.EscapeReference

        So if that handler is not used, ORO is not needed during runtime. This patch also updates Velocity Developer Guide.

        During compile time ORO is obviously needed and there are two other classes that use ORO:
        org.apache.velocity.test.BaseTestCase
        org.apache.velocity.convert.WebMacro

        Show
        Jarkko Viinamäki added a comment - This patch marks ORO dependency as optional (which is I guess the only possible way to mark this kind of dependency). AFAIK there is no way to change the text on the Maven generated dependencies.html page. ORO is only used by this runtime class: org.apache.velocity.app.event.implement.EscapeReference So if that handler is not used, ORO is not needed during runtime. This patch also updates Velocity Developer Guide. During compile time ORO is obviously needed and there are two other classes that use ORO: org.apache.velocity.test.BaseTestCase org.apache.velocity.convert.WebMacro
        Hide
        Nathan Bubna added a comment -

        Rest of the fix will probably wait until after 1.6 is released.

        Show
        Nathan Bubna added a comment - Rest of the fix will probably wait until after 1.6 is released.
        Hide
        Nathan Bubna added a comment -

        I can change the more prominently linked dependency file:

        http://velocity.apache.org/engine/devel/jar-dependencies.html

        But this one is entirely Maven produced:

        http://velocity.apache.org/engine/devel/dependencies.html

        I don't know how to change the POM to have Maven display the proper info there. There's more that's wrong on that page than just the stuff about Oro.

        Show
        Nathan Bubna added a comment - I can change the more prominently linked dependency file: http://velocity.apache.org/engine/devel/jar-dependencies.html But this one is entirely Maven produced: http://velocity.apache.org/engine/devel/dependencies.html I don't know how to change the POM to have Maven display the proper info there. There's more that's wrong on that page than just the stuff about Oro.

          People

          • Assignee:
            Unassigned
            Reporter:
            Adrian Tarau
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development