Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A global file nbbuild/rat-exclusions.txt allows excluding groups of files from rat scan. The primary use case are generated files that can't hold license information, because added license would be removed on next change of the base data or can't hold licenses.

Anchor
licenseinfo
licenseinfo
Per file info - licenseinfo.xml

This is a summary - the authorative source is org.netbeans.nbbuild.extlibs.licenseinfo

...

  • Files: If the license file applies to multiple artifacts, these can be listed here and don't need separate copies. The files are separated by space or comma.
  • Source: URL where the source code for the artifact can be found
  • URL: URL where the artifact can be downloaded
  • Comment: Additional explanation for the artifact. For example useful for non-redistributable artifacts to explain their presence and describe how the artifacts are used
  • Type: declare special typed of dependencies, currently supported values are:
    • compile-time: The artifact is not redistributed and only used at build time
    • generated: The artifact is created at build time

Checking licenses

The content of a license file must be checked by humans and is a task that the committer has to do when merging into the repository. To check the structural aspects, there are two ant tasks, that can be run from the root of the repository:

Code Block
languagebash
# Check the licenses for dependencies, that are part of the current build configuration
ant verify-libs-and-licenses
# Check _all_ libraries (this included modules not referenced in a cluster (this also contrib))
ant verify-all-libs-and-licenses

The result of these calls is written to nbbuild/build/verifylibsandlicenses.xml which should be checked if a test failure is reported.