Skip to content

13.license.md

Latest commit

 

History

History
62 lines (52 loc) · 3.07 KB

13.license.md

File metadata and controls

62 lines (52 loc) · 3.07 KB
Raw
icon file-certificate
description SPDX License (TYPE: NON_ENFORCED)

13.License

  • This is Optional & can be left empty or removed completely (TYPE: NON_ENFORCED)
  • Is copied (installed) as $APP_PATH1/LICENSE
  • Use repology/projects/$pkg/information to quickly fetch this Information
  • If used, it can only contain (One of these):

{% hint style="success" %}

  • url : Is always preferred as the 1st Choice, & CAN NOT BE used with others.
  • This refers to a raw url containing a LICENSE file & is downloaded + saved at: ${SBUILD_OUTDIR}/LICENSE
  • If used, only ONE entry is supported
#Example ONLY
license:
  - id: "MIT"
    url: "https://raw.githubusercontent.com/pkgforge/soar/refs/heads/main/LICENSE" #Would be downloaded & saved as ${SBUILD_OUTDIR}/LICENSE

{% endhint %}

{% hint style="success" %}

  • file : Is ONLY preferred, if url was NOT USED ( non-existent/empty), as the 2nd Choice
  • This refers to a direct path to a LICENSE file produced during an sbuild.
  • While Multiple Entries are supported, the builder will stop checking upon the first successful find
  • The first valid LICENSE file is copied to ${SBUILD_OUTDIR}/LICENSE

{% code overflow="wrap" %}

#Example ONLY
# (All paths are assumed to be inside ${SBUILD_OUTDIR} i.e ${SBUILD_OUTDIR} == /
license:
  - id: "MIT"
    file: "/MIT.license" #Is assumed as ${SBUILD_OUTDIR}/MIT.license & copied to ${SBUILD_OUTDIR}/LICENSE
  - id: "GPL3"  
    file: "/SBUILD_TMPDIR/foo/bar.license" #Is assumed as ${SBUILD_OUTDIR}/SBUILD_TMPDIR/foo/bar.license & copied to ${SBUILD_OUTDIR}/LICENSE, IF & ONLY IF ${SBUILD_OUTDIR}/MIT.license wasn't found

{% endcode %} {% endhint %}

{% hint style="warning" %} If you can't find a direct URL to the LICENSE file & it's also not produced during build anywhere inside ${SBUILD_OUTDIR} , then you may use:

#Example ONLY
license:
  - "GPL-2+"
  - "GPL-2.0"
  - "GPL-2.0-only"
  - "GPL-2.0-or-later"
  - "GPL2"
  - "GPLv3"
  - "Unfree"

{% endhint %}

Footnotes

  1. $APP_PATH refers to the directory soar installs the respective APP ↩