Uploaded image for project: 'ServiceMix'
  1. ServiceMix
  2. SM-1525

significant typo in servicemix classloader documentation

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • 3.2.1, 3.2.2
    • 3.2.3
    • documentation
    • None
    • This is a documentation typo so it affects all os's and all platforms

    Description

      There are two places on the page describing servicemix classloaders where the
      nonOverridable element is misspelled as nonOverrideable. The link to the erroneous page is:

      http://servicemix.apache.org/classloaders.html

      If I had copied and pasted from the doc,
      I would no doubt have gotten an xml parsing error. But I read the documentation and just
      typed it in manually and picked the wrong spelling. I didn't get any runtime error on the xml - it apparently just ignored my misspelled element. So it took me a long time to figure out what the real problem was.
      I finally looked at your source code to see that it was looking for nonOverridable.

      The two places to be fixed look like:

      <classpath [inverse="true"]>
      [<nonOverrideable>xxx</nonOverridable>]*
      [<hidden>xxx</hidden>]*
      [<location>xxx</location>]*
      </classpath>

      and

      <classpath [inverse="true"]>
      [<nonOverrideable>xxx</nonOverridable>]*
      [<hidden>xxx</hidden>]*
      [<location>xxx</location>]*
      [<library>xxx</library>]*
      [<component>xxx</component>]*
      </classpath>

      The documentation should be fixed as soon as possible as it it quite confusing and misleading.
      If there were some way to have the code check for unknown elements and give
      an error or at least a warning, that would be even better.

      Attachments

        Activity

          People

            bsnyder Bruce Snyder
            njrnjr Nancy Rosenfield
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: