Uploaded image for project: 'Maven'
  1. Maven
  2. MNG-6681

improve documentation: dependency type = file classifier(optional)+extension + additional hints on dependency features

    XMLWordPrintableJSON

    Details

    • Type: Task
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 3.6.1
    • Fix Version/s: 3.6.2
    • Component/s: None
    • Labels:
      None

      Description

      Documentation for dependency type is currently misleading: https://maven.apache.org/ref/3.6.1/maven-model/maven.html#class_dependency
      The type of dependency. While it usually represents the extension on the filename of the dependency, that is not always the case. A type can be mapped to a different extension and a classifier. The type often corresponds to the packaging used, though this is also not always the case. Some examples are jar, war, ejb-client and test-jar
      Reading that, people understand that type is extension

      This has to be rephrased a little bit to have people keep in mind: A type can be mapped to an extension and a classifier (and the extension value may match the type, but not always)

      The "While it usually represents the extension on the filename of the dependency, that is not always the case." as first explanation is totally misleading

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                hboutemy Herve Boutemy
                Reporter:
                hboutemy Herve Boutemy
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 20m
                  20m